This interface handles engine animations. More...

Inheritance diagram for VgEngine::VgAnimation:

Collaboration diagram for VgEngine::VgAnimation:

Public Types
typedef VgAnimationDescriptor	Descriptor
Public Member Functions
	~VgAnimation ()
	Class destructor.
void	start ()
	This method starts the animation at it's current time value.
void	stop ()
	This method stops the animation and sets back the time value to 0.
void	pause ()
	This method pauses the animation at it's current time value.
Protected Member Functions
	VgAnimation ()
	This constructor does nothing, the class VgIAnimation can not be instanciated directly (it is abstract).
Protected Attributes
Private *	mPrivate
Friends
class	VgInstanceFactory
class	VgObjectBridge

Detailed Description

This interface handles engine animations.

Time management is done per-instance, this means that when the animation is started it applies to all objects using it.

Member Typedef Documentation

VgEngine::VgAnimation::~VgAnimation ( )

Class destructor.

VgEngine::VgAnimation::VgAnimation ( ) [protected]

This constructor does nothing, the class VgIAnimation can not be instanciated directly (it is abstract).

To create an animation, animation descriptors (VgEngine::VgAnimationDescriptor) must be used and passed to the animation instantiation method in the animation manager (VgEngine::VgIAnimationManager).

void VgEngine::VgAnimation::pause ( )

This method pauses the animation at it's current time value.

Use start to resume animation playback, stop to reset the animation.

void VgEngine::VgAnimation::start ( )

This method starts the animation at it's current time value.

void VgEngine::VgAnimation::stop ( )

This method stops the animation and sets back the time value to 0.

friend class VgInstanceFactory [friend]

friend class VgObjectBridge [friend]

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