Animation Class Reference

This is the base-class of all Animation -objects. More...

#include <Animation.h>

Inherits NamedObject, and Loader< Animation >.

Inherited by AnimatedPressed, FadedVisibility, SimplePressed, SimpleVisibility, and Spinning.

Collaboration diagram for Animation:

[legend]

List of all members.

Public Member Functions
virtual void	animate (MenuObject *obj)=0
virtual void	unanimate (MenuObject *obj)=0
virtual	~Animation ()
Protected Member Functions
	Animation (XMLNode *xml)

---

Detailed Description

This is the base-class of all Animation -objects.

This is the base-class of all Animation -objects and provides the mechanism for loading the Animation -objects from external *.so-files. The needed information for loading the object is read from an XML-file. For each "Animation"-tag an Animation -object will be created and stored in the Registry, which provides methods for invoking the animation-action.

For each "Animation"-tag in the XML-file exists only one Animation -object. So one Animation -object will be used by multiple widgets and has to be thread-save.

Date:

4th of May 2007

Author:

Thomas Weberndorfer

---

Constructor & Destructor Documentation

Animation::Animation

(

XMLNode *

xml

)

[inline, protected]

The constructor is protected, because only the inherited create-method is allowed to create Animation -objects.

Parameters:

xml

This XMLNode -object has to focus on the right XML-node.

virtual Animation::~Animation

(

)

[inline, virtual]

Nothing to do ...

---

Member Function Documentation

virtual void Animation::animate

(

MenuObject *

obj

)

[pure virtual]

This method animates an object. It is abstract, because this class is just the base-class for Animation -objects.

Parameters:

obj

The animation will be performed on this object.

Implemented in AnimatedPressed, FadedVisibility, SimplePressed, SimpleVisibility, and Spinning.

virtual void Animation::unanimate

(

MenuObject *

obj

)

[pure virtual]

This method has to undo the animation. It is abstract, because this class is just the base-class for Animation -objects.

Parameters:

obj

The animation will be performed on this object.

Implemented in AnimatedPressed, FadedVisibility, SimplePressed, SimpleVisibility, and Spinning.

---

The documentation for this class was generated from the following file:

• tools/libraries/3DMenu/core/Animation.h