Affector.h

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

    purpose:    Defines the interface for the Affector clas
*************************************************************************/
/***************************************************************************
 *   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 deal 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 _CEGUIAffector_h_
#define _CEGUIAffector_h_

#include "CEGUI/String.h"
#include "CEGUI/KeyFrame.h"
#include <map>

#if defined(_MSC_VER)
#   pragma warning(push)
#   pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT Affector : public AllocatedObject<Affector>
{
public:
    enum ApplicationMethod
    {
        AM_Absolute,

        AM_Relative,

        AM_RelativeMultiply
    };

    Affector(Animation* parent);

    ~Affector(void);

    inline Animation* getParent() const
    {
        return d_parent;
    }

    size_t getIdxInParent() const;

    void setApplicationMethod(ApplicationMethod method);

    ApplicationMethod getApplicationMethod() const;

    void setTargetProperty(const String& target);

    const String& getTargetProperty() const;

    void setInterpolator(Interpolator* interpolator);

    void setInterpolator(const String& name);

    Interpolator* getInterpolator() const;

    KeyFrame* createKeyFrame(float position);

    KeyFrame* createKeyFrame(float position, const String& value,
                             KeyFrame::Progression progression = KeyFrame::P_Linear,
                             const String& sourceProperty = "");

    void destroyKeyFrame(KeyFrame* keyframe);

    KeyFrame* getKeyFrameAtPosition(float position) const;

    bool hasKeyFrameAtPosition(float position) const;

    KeyFrame* getKeyFrameAtIdx(size_t index) const;

    size_t getNumKeyFrames() const;

    void moveKeyFrameToPosition(KeyFrame* keyframe, float newPosition);

    void moveKeyFrameToPosition(float oldPosition, float newPosition);

    void savePropertyValues(AnimationInstance* instance);

    void apply(AnimationInstance* instance);

    void writeXMLToStream(XMLSerializer& xml_stream) const;

private:
    Animation* d_parent;
    ApplicationMethod d_applicationMethod;
    String d_targetProperty;
    Interpolator* d_interpolator;

    typedef std::map<float, KeyFrame*, std::less<float>
        CEGUI_MAP_ALLOC(float, KeyFrame*)> KeyFrameMap;
    KeyFrameMap d_keyFrames;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#   pragma warning(pop)
#endif

#endif  // end of guard _CEGUIAffector_h_