ParameterPlugin.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of FRAPPER
research.animationsinstitut.de
sourceforge.net/projects/frapper

Copyright (c) 2008-2009 Filmakademie Baden-Wuerttemberg, Institute of Animation 

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/



#ifndef PARAMETERPLUGIN_H
#define PARAMETERPLUGIN_H

#include "FrapperPrerequisites.h"
#include "Parameter.h"
#include "NumberParameter.h"
#include "Key.h"

namespace Frapper {

class FRAPPER_CORE_EXPORT ParameterPlugin : public Parameter
{
    Q_OBJECT
public: // constructors and destructors : public Parameter


    ParameterPlugin ( const QString &name, QString type, QMap<QString, QVariant> flags, const QVariant &value );

    ParameterPlugin ( const QString &name, QString type, const QVariant &value );

    ParameterPlugin ( const QString &name, const QVariant &value );

    ParameterPlugin ( ParameterPlugin * parameter );

    virtual ~ParameterPlugin ();

public: // functions

    void setFlags(QMap<QString, QVariant> flags);

    void addFlag(QString key, QVariant value);

    QMap<QString, QVariant> getFlags();

    QVariant getFlag(QString flag);

    QString getCall();

    void setCall(QString call);

    void triggerWidgetRedraw();

    //                                                                                                                                                                  //
    //                                                                                                                                                                  //
    //  the following functions are still in developement and not intended for use              //
    //                                                                                                                                                                  //
    //                                                                                                                                                                  //

    void copyParameterValue(Parameter * parameter);

    void copyNumberParameterValue(NumberParameter * numberParameter);

    bool getIntegerFlag(QString flag, int &number);

    bool getFloatFlag(QString flag, float &number);

    bool getStringFlag(QString flag, QString &string);

    bool getBoolFlag(QString flag, bool &boolean);

    QVariant::Type getFlagType(QString flag);

    QVariant::Type getParameterType();

    QList<QVariant> * TransformFloatToVariantList(QList<float> * list);

    QList<float> * TransformVariantToFloatList(QList<QVariant> * list);

private: // data

    QString m_call;

    QMap<QString, QVariant> m_flags;

signals:

    void forceRedraw();
};

} // end namespace Frapper

#endif