AnimationManager.h

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

    purpose:    Defines the interface for the AnimationManager object
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIAnimationManager_h_
#define _CEGUIAnimationManager_h_

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

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

// Start of CEGUI namespace section
namespace CEGUI
{

class CEGUIEXPORT AnimationManager :
    public Singleton<AnimationManager>,
    public AllocatedObject<AnimationManager>
{
public:
    static const String XMLSchemaName;

    /*************************************************************************
        Construction and Destruction
    *************************************************************************/
    AnimationManager(void);


    ~AnimationManager(void);

    void addInterpolator(Interpolator* interpolator);

    void removeInterpolator(Interpolator* interpolator);

    Interpolator* getInterpolator(const String& type) const;

    Animation* createAnimation(const String& name = "");

    void destroyAnimation(Animation* animation);

    void destroyAnimation(const String& name);
    
    void destroyAllAnimations();

    Animation* getAnimation(const String& name) const;

    bool isAnimationPresent(const String& name) const;

    Animation* getAnimationAtIdx(size_t index) const;

    size_t getNumAnimations() const;

    AnimationInstance* instantiateAnimation(Animation* animation);

    AnimationInstance* instantiateAnimation(const String& name);

    void destroyAnimationInstance(AnimationInstance* instance);

    void destroyAllInstancesOfAnimation(Animation* animation);
    
    void destroyAllAnimationInstances();

    AnimationInstance* getAnimationInstanceAtIdx(size_t index) const;

    size_t getNumAnimationInstances() const;

    void autoStepInstances(float delta);

    void loadAnimationsFromXML(const String& filename,
                               const String& resourceGroup = "");

    void loadAnimationsFromString(const String& source);

    void writeAnimationDefinitionToStream(const Animation& animation, OutStream& out_stream) const;

    String getAnimationDefinitionAsString(const Animation& animation) const;

    static void setDefaultResourceGroup(const String& resourceGroup)
    {
        s_defaultResourceGroup = resourceGroup;
    }

    static const String& getDefaultResourceGroup()
    {
        return s_defaultResourceGroup;
    }

private:
    typedef std::map<String, Interpolator*, std::less<String>
        CEGUI_MAP_ALLOC(String, Interpolator*)> InterpolatorMap;
    String generateUniqueAnimationName();
    
    InterpolatorMap d_interpolators;
    typedef std::vector<Interpolator*
        CEGUI_VECTOR_ALLOC(Interpolator*)> BasicInterpolatorList;
    BasicInterpolatorList d_basicInterpolators;

    typedef std::map<String, Animation*> AnimationMap;
    AnimationMap d_animations;

    typedef std::multimap<Animation*, AnimationInstance*, std::less<Animation*>
        CEGUI_MULTIMAP_ALLOC(Animation*, AnimationInstance*)> AnimationInstanceMap;
    AnimationInstanceMap d_animationInstances;
    static String s_defaultResourceGroup;
    static const String GeneratedAnimationNameBase;
    unsigned long d_uid_counter;
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIAnimationManager_h_