NumberParameter.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; version 2.1 of the License.

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/licenses/old-licenses/lgpl-2.1.html
-----------------------------------------------------------------------------
*/


#ifndef NUMBERPARAMETER_H
#define NUMBERPARAMETER_H

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

namespace Frapper {

class FRAPPER_CORE_EXPORT NumberParameter : public Parameter
{

public: // nested enumerations

    enum InputMethod {
        IM_SpinBox = 0,
        IM_Slider,
        IM_SliderPlusSpinBox,

        IM_NumInputMethods
    };

public: // static functions

    static InputMethod decodeInputMethod ( const QString &inputMethodString );

public: // constructors and destructors

    NumberParameter ( const QString &name, Type type, const QVariant &value );

    NumberParameter ( const NumberParameter &parameter, Node* node = 0  );

    virtual ~NumberParameter ();

public: // functions

    virtual AbstractParameter * clone ();

    virtual void setDirty ( bool dirty );

    virtual void setEnabled ( bool enabled, bool propagate /*= true*/ );

    InputMethod getInputMethod () const;

    void setInputMethod ( InputMethod inputMethod );

    QVariant getMinValue () const;

    void setMinValue (const QVariant &minValue );

    QVariant getMaxValue () const;

    float getAbsMaxValue () const;

    void setMaxValue ( const QVariant &maxValue );

    QVariant getStepSize () const;

    void setStepSize ( const QVariant &stepSize );

    QString getUnit () const;

    void setUnitScale ( const float scale );

    float getUnitScale ( ) const;

    void setUnit ( const QString &unit );

    void setTime ( const QVariant &timeValue );

    void calculateExtrema ();

    void scaleValues( const float &scaleFactor);

public: // animation functions

    bool isAnimated () const;

    void addKey ( Key *key );

    void addKey ( const int &time );

    void addKey ( const QVariant &value );

    void addKey ( const float &value );

    void addKeyPresorted ( Key *key );

    void setKeys ( const QList<float> *keys );

    unsigned int numKeys () const;

    bool isEmpty () const;

    void removeKey ( const float &time );

    void removeKey ( const int &index );

    void removeKeys ( const float &minTime, const float &maxTime );

    void removeKeys ( const int &minIndex, const int &maxIndex );

    void clearKeys ( );

    Key * getKey ( const float &time );

    Key * getKey ( const unsigned int &index );

    QList<Key *> * getKeys ();

    unsigned int getKeysSize () const;

    inline QVariant getKeyValueInterpol ( const QVariant &time );

    QVariant getKeyValuePos ( const float &time );

    QVariant getKeyValueIndex ( const unsigned int &index ) const;

    QVariant getValue ( bool triggerEvaluation = false ) ;



protected: // functions

    inline QList<Key *>::iterator findIndex ( const float &time );

    inline QList<Key *>::iterator findIndex ( const Key *key );

protected: // helper functions

    static inline bool lessThan ( const Key *k1, const Key *k2 );

private: // data

    InputMethod m_inputMethod;

    QVariant m_minValue;

    QVariant m_maxValue;

    QVariant m_stepSize;

    QString m_unit;

    QList<Key *> m_keys;

    float m_unitScale;
};

} // end namespace Frapper

#endif