Key.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
-----------------------------------------------------------------------------
*/


#include "FrapperPrerequisites.h"
#include <QtCore/QVariant>

#ifndef KEY_H
#define KEY_H

namespace Frapper {

class NumberParameter;

class FRAPPER_CORE_EXPORT Key
{

public: // constructors and destructors

    Key (const float &index, const QVariant &value, NumberParameter *parameter = 0 );

    Key ();

    Key (const Key &key);

    ~Key ();

public: // functions

    float getIndex () const;

    void setIndex (const float &index );

    QVariant getValue () const;

    void setValue ( const QVariant &value );

    void setParameter ( NumberParameter* parameter );


    inline Key& operator /= ( const float &fScalar )
    {
        register float value;
        if (value = m_value.toFloat())
            m_value = value / fScalar;
        return *this;
    }

private: // data

    float m_index;

    QVariant m_value;

    NumberParameter *m_numberParameter;
};

} // end namespace Frapper

#endif