KeyFrame.h

/***********************************************************************
    filename:   CEGUIKeyFrame.h
    created:    7/8/2010
    author:     Martin Preisler

    purpose:    Defines the interface for the KeyFrame class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to de/al in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIKeyFrame_h_
#define _CEGUIKeyFrame_h_

#include "CEGUI/String.h"

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT KeyFrame :
    public AllocatedObject<KeyFrame>
{
public:
    enum Progression
    {
        P_Linear,
        P_QuadraticAccelerating,
        P_QuadraticDecelerating,
        P_Discrete
    };

    KeyFrame(Affector* parent, float position);

    ~KeyFrame(void);

    Affector* getParent() const;

    size_t getIdxInParent() const;

    void moveToPosition(float newPosition);

    float getPosition() const;

    void setValue(const String& value);

    const String& getValue() const;

    void setSourceProperty(const String& sourceProperty);

    const String& getSourceProperty() const;

    const String& getValueForAnimation(AnimationInstance* instance) const;

    void setProgression(Progression p);

    Progression getProgression() const;

    float alterInterpolationPosition(float position);

    void savePropertyValue(AnimationInstance* instance);

    void notifyPositionChanged(float newPosition);

        void writeXMLToStream(XMLSerializer& xml_stream) const;

private:
    Affector* d_parent;
    float d_position;

    String d_value;
    String d_sourceProperty;
    Progression d_progression;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIKeyFrame_h_