The animation class encapsulates a set of animation segments and provides complex translation, rotation and scaling movements for visual glam components

Public Methods

	GmAnimation (GmTypes::AnimationType animationType) Standard constructor.
virtual void	addSegment (GmAnimationSegment* animationSegment) Adds an animation segment to the end of the animation.
virtual void	applyAnimationTransforms () Applies all animation motions associated with this animation
float	getLength () Gets the total temporal length of this animation in seconds.
virtual bool	isFinished () The current state of animation playback can be determined by calling this method.
virtual void	registerAnimHandler (GmAnimationEventHandler* eventHandler) Registers an animation event handler with this animation.
virtual void	startAnimation () Starts running this animation using the current time as the starting time.
virtual void	unregisterAnimHandler (GmAnimationEventHandler* eventHandler) Unregisters an animation event handler from this animation.
virtual	~GmAnimation () Standard destructor

Protected Fields

vector<GmAnimationEventHandler*>	mAnimHandlers A set of animation event handlers that have registered themselves with this animation.
unsigned int	mAnimLength Total animation length in milliseconds
unsigned int*	mAnimTimecodes [2] Animation segment time codes for the end of each animation segment.
GmTypes::AnimationType	mAnimationType The type of animation this animation object encompasses
vector<GmAnimationSegment*>	mSegments A set of animation segments that constitute a complete animation
unsigned int	mStartTime The time that this animation started playback, the value is in milliseconds since application started
unsigned int	mTimecodeOffset The current timecode offset, which is the current animation segment being played back.

Protected Methods

virtual void

recalculateAnimLength () Recalculates the length of the animation as well as several internal variables that are used for housekeeping

Documentation

The animation class encapsulates a set of animation segments and provides complex translation, rotation and scaling movements for visual glam components

GmTypes::AnimationType mAnimationType

The type of animation this animation object encompasses

vector<GmAnimationSegment*> mSegments

A set of animation segments that constitute a complete animation

vector<GmAnimationEventHandler*> mAnimHandlers

A set of animation event handlers that have registered themselves with this animation. The animation event handlers are notified whenever a particular animation event occurs (such as when an animation finishes playing).

unsigned int mStartTime

The time that this animation started playback, the value is in milliseconds since application started

unsigned int mAnimLength

Total animation length in milliseconds

unsigned int* mAnimTimecodes[2]

Animation segment time codes for the end of each animation segment. These values allow us to determine the correct animation segment to evaluate for the current time.

unsigned int mTimecodeOffset

The current timecode offset, which is the current animation segment being played back. This member variable is used to keep track of which animation segment we are currently evaluating.

virtual void recalculateAnimLength()

Recalculates the length of the animation as well as several internal variables that are used for housekeeping

GmAnimation(GmTypes::AnimationType animationType)

Standard constructor.

Parameters:

animationType - the type of animation that this is (mouse press, idle, keypress, focus, etc)

virtual ~GmAnimation()

Standard destructor

virtual void startAnimation()

Starts running this animation using the current time as the starting time. The animation will run until the total length of the animation has elapsed, at which point isFinished() will return true. If the animation has already started running, it will restart from the beginning.

virtual bool isFinished()

The current state of animation playback can be determined by calling this method.

Returns:

true if the animation has finished playback, false if it has not.

float getLength()

Gets the total temporal length of this animation in seconds. This value is a sum of all the length of the animation segments that are part of this animation.

Returns:

the total temporal length of this animation in seconds.

virtual void applyAnimationTransforms()

Applies all animation motions associated with this animation

virtual void addSegment(GmAnimationSegment* animationSegment)

Adds an animation segment to the end of the animation.

Parameters:

animationSegment - the animation segment to add to the end of this animation.

virtual void registerAnimHandler(GmAnimationEventHandler* eventHandler)

Registers an animation event handler with this animation. An animation event handler processes animation-based events such as animation start, completion, etc.

Parameters:

eventHandler - the handler to register with this animation.

virtual void unregisterAnimHandler(GmAnimationEventHandler* eventHandler)

Unregisters an animation event handler from this animation. An animation event handler processes animation-based events such as animation start, completion, etc.

Parameters:

eventHandler - the animation event handler to unregister

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java