Crazy Eddie's GUI System  0.8.4
CEGUI::AnimationManager Class Reference
+ Inheritance diagram for CEGUI::AnimationManager:
+ Collaboration diagram for CEGUI::AnimationManager:

List of all members.

Public Member Functions

 AnimationManager (void)
 Constructs a new AnimationManager object.
 ~AnimationManager (void)
 Destructor for AnimationManager objects.
void addInterpolator (Interpolator *interpolator)
 Adds interpolator to be available for Affectors.
void removeInterpolator (Interpolator *interpolator)
 Removes interpolator.
InterpolatorgetInterpolator (const String &type) const
 Retrieves interpolator by type.
AnimationcreateAnimation (const String &name="")
 Creates a new Animation definition.
void destroyAnimation (Animation *animation)
 Destroys given animation definition.
void destroyAnimation (const String &name)
 Destroys given animation definition by name.
void destroyAllAnimations ()
 Destroys all animations in existence!
AnimationgetAnimation (const String &name) const
 Retrieves animation by name.
bool isAnimationPresent (const String &name) const
 Examines the list of Animations to see if one exists with the given 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.
AnimationInstanceinstantiateAnimation (const String &name)
 Instantiates given animation by name.
void destroyAnimationInstance (AnimationInstance *instance)
 Destroys given animation instance.
void destroyAllInstancesOfAnimation (Animation *animation)
 Destroys all instances of given animation.
void destroyAllAnimationInstances ()
 Destroys all instances of all animations.
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 autoStepInstances (float delta)
 Internal method, gets called by CEGUI::System automatically.
void loadAnimationsFromXML (const String &filename, const String &resourceGroup="")
 Parses an XML file containing animation specifications to create and initialise Animation objects.
void loadAnimationsFromString (const String &source)
 Parses XML source containing animation specifications to create and initialise Animation objects.
void writeAnimationDefinitionToStream (const Animation &animation, OutStream &out_stream) const
 Writes given animation definition to the given OutStream.
String getAnimationDefinitionAsString (const Animation &animation) const
 Writes given animation definition and returns the result as String.

Static Public Member Functions

static void setDefaultResourceGroup (const String &resourceGroup)
 Sets the default resource group to be used when loading animation xml data.
static const StringgetDefaultResourceGroup ()
 Returns the default resource group currently set for loading animation xml data.

Static Public Attributes

static const String XMLSchemaName
 Name of the schema used for loading animation xml files.

Constructor & Destructor Documentation

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.

Destructor for AnimationManager objects.

This will properly destroy all remaining AnimationInstance and Animation objects.


Member Function Documentation

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!

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

Only use if you know what you're doing!

Steps animation instances with auto stepping enabled forward by given delta.

Creates a new Animation definition.

See also:
Animation

Writes given animation definition and returns the result as String.

Parameters:
animationAnimation definition to write
Warning:
This is a convenience function and isn't designed to be fast at all! Use the other alternatives if you want performance.
Returns:
String containing the resulting XML
static const String& CEGUI::AnimationManager::getDefaultResourceGroup ( ) [inline, static]

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.

Instantiates given animation.

See also:
AnimationInstance

Instantiates given animation by name.

See also:
AnimationInstance

Examines the list of Animations to see if one exists with the given name.

Parameters:
nameString holding the name of the Animation to look for.
Returns:
true if an Animation was found with a name matching name. false if no matching Animation was found.

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

Parameters:
sourceString object holding the XML source to be processed.
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) [inline, static]

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::writeAnimationDefinitionToStream ( const Animation animation,
OutStream out_stream 
) const

Writes given animation definition to the given OutStream.

Parameters:
animationAnimation definition to write
out_streamOutStream (std::ostream based) object where data is to be sent.
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends