Crazy Eddies GUI System  0.7.2
Public Member Functions | Static Public Member Functions | List of all members
CEGUI::AnimationManager Class Reference
+ Inheritance diagram for CEGUI::AnimationManager:
+ Collaboration diagram for CEGUI::AnimationManager:

Public Member Functions

 AnimationManager (void)
 Constructs a new AnimationManager object. More...
 
 ~AnimationManager (void)
 Destructor for AnimationManager objects. More...
 
void addInterpolator (Interpolator *interpolator)
 Adds interpolator to be available for Affectors. More...
 
void removeInterpolator (Interpolator *interpolator)
 Removes interpolator.
 
InterpolatorgetInterpolator (const String &type) const
 Retrieves interpolator by type.
 
AnimationcreateAnimation (const String &name)
 Creates a new Animation definition. More...
 
void destroyAnimation (Animation *animation)
 Destroys given animation definition.
 
void destroyAnimation (const String &name)
 Destroys given animation definition by name.
 
AnimationgetAnimation (const String &name) const
 Retrieves animation by name.
 
AnimationgetAnimationAtIdx (size_t index) const
 Retrieves animation by index.
 
size_t getNumAnimations () const
 Retrieves number of defined animations.
 
AnimationInstanceinstantiateAnimation (Animation *animation)
 Instantiates given animation. More...
 
AnimationInstanceinstantiateAnimation (const String &name)
 Instantiates given animation by name. More...
 
void destroyAnimationInstance (AnimationInstance *instance)
 Destroys given animation instance.
 
void destroyAllInstancesOfAnimation (Animation *animation)
 Destroys all instances of given animation.
 
AnimationInstancegetAnimationInstanceAtIdx (size_t index) const
 Retrieves animation instance at given index.
 
size_t getNumAnimationInstances () const
 Retrieves number of animation instances, number of times any animation was instantiated.
 
void stepInstances (float delta)
 Internal method, gets called by CEGUI::System automatically. More...
 
void loadAnimationsFromXML (const String &filename, const String &resourceGroup="")
 Parses an XML file containing animation specifications to create and initialise Animation objects. More...
 

Static Public Member Functions

static void setDefaultResourceGroup (const String &resourceGroup)
 Sets the default resource group to be used when loading animation xml data. More...
 
static const StringgetDefaultResourceGroup ()
 Returns the default resource group currently set for loading animation xml data. More...
 
- Static Public Member Functions inherited from CEGUI::Singleton< AnimationManager >
static AnimationManagergetSingleton (void)
 
static AnimationManagergetSingletonPtr (void)
 

Additional Inherited Members

- Static Protected Attributes inherited from CEGUI::Singleton< AnimationManager >
static AnimationManagerms_Singleton
 

Constructor & Destructor Documentation

CEGUI::AnimationManager::AnimationManager ( void  )

Constructs a new AnimationManager object.

NB: Client code should not create AnimationManager objects - they are of limited use to you! The intended pattern of access is to get a pointer to the GUI system's AnimationManager via the System object, and use that.

CEGUI::AnimationManager::~AnimationManager ( void  )

Destructor for AnimationManager objects.

This will properly destroy all remaining AnimationInstance and Animation objects.

Member Function Documentation

void CEGUI::AnimationManager::addInterpolator ( Interpolator interpolator)

Adds interpolator to be available for Affectors.

CEGUI ships with several basic interpolators that are always available, float, bool, colour, UDim, UVector2, ... but you can add your own custom interpolator if needed! just note that AnimationManager only deletes inbuilt interpolators. It will remove your interpolator if you don't do it yourself, but you definitely have to delete it yourself!
Animation* CEGUI::AnimationManager::createAnimation ( const String name)

Creates a new Animation definition.

See Also
Animation
static const String& CEGUI::AnimationManager::getDefaultResourceGroup ( )
inlinestatic

Returns the default resource group currently set for loading animation xml data.

Returns
String describing the default resource group identifier that will be used when loading Animation xml data.
AnimationInstance* CEGUI::AnimationManager::instantiateAnimation ( Animation animation)

Instantiates given animation.

See Also
AnimationInstance
AnimationInstance* CEGUI::AnimationManager::instantiateAnimation ( const String name)

Instantiates given animation by name.

See Also
AnimationInstance
void CEGUI::AnimationManager::loadAnimationsFromXML ( const String filename,
const String resourceGroup = "" 
)

Parses an XML file containing animation specifications to create and initialise Animation objects.

Parameters
filenameString object holding the filename of the XML file to be processed.
resourceGroupResource group identifier to be passed to the resource provider when loading the XML file.
static void CEGUI::AnimationManager::setDefaultResourceGroup ( const String resourceGroup)
inlinestatic

Sets the default resource group to be used when loading animation xml data.

Parameters
resourceGroupString describing the default resource group identifier to be used.
void CEGUI::AnimationManager::stepInstances ( float  delta)

Internal method, gets called by CEGUI::System automatically.

Only use if you know what you're doing!