Animation.h

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

    purpose:    Defines the interface for the Animation 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 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 _CEGUIAnimation_h_
#define _CEGUIAnimation_h_

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

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

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT Animation : public AllocatedObject<Animation>
{
public:
    enum ReplayMode
    {
        RM_Once,
        RM_Loop,
        RM_Bounce
    };

    Animation(const String& name);

    ~Animation(void);

    const String& getName() const;

    void setReplayMode(ReplayMode mode);

    ReplayMode getReplayMode() const;

    void setDuration(float duration);

    float getDuration() const;

    void setAutoStart(bool autoStart);

    bool getAutoStart() const;

    Affector* createAffector(void);

    Affector* createAffector(const String& targetProperty,
                             const String& interpolator);

    void destroyAffector(Affector* affector);

    Affector* getAffectorAtIdx(size_t index) const;

    size_t getNumAffectors(void) const;

    void defineAutoSubscription(const String& eventName, const String& action);

    void undefineAutoSubscription(const String& eventName,
                                  const String& action);

    void undefineAllAutoSubscriptions();

    void autoSubscribe(AnimationInstance* instance);

    void autoUnsubscribe(AnimationInstance* instance);

    void savePropertyValues(AnimationInstance* instance);

    void apply(AnimationInstance* instance);

    void writeXMLToStream(XMLSerializer& xml_stream, const String& name_override = "") const;

private:
    String d_name;

    ReplayMode d_replayMode;
    float d_duration;
    bool d_autoStart;

    typedef std::vector<Affector*
        CEGUI_VECTOR_ALLOC(Affector*)> AffectorList;
    AffectorList d_affectors;

    typedef std::multimap<String, String, std::less<String>
        CEGUI_MAP_ALLOC(String, String)> SubscriptionMap;
    SubscriptionMap d_autoSubscriptions;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIAnimation_h_