GAF Library
Generic Animation Format
 All Classes Functions Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GAFAnimation Class Reference
Inheritance diagram for GAFAnimation:
GAFAnimatedObject

Public Member Functions

bool init (GAFAsset *anAnimationData)
 
virtual void processAnimation ()
 
virtual void start ()
 
virtual void pauseAnimation ()
 
virtual void resumeAnimation ()
 
virtual void stop ()
 
virtual void step ()
 
bool isDone () const
 
bool isAnimationRunning () const
 
bool isLooped () const
 
void setLooped (bool looped)
 
bool isReversed () const
 
void setReversed (bool reversed)
 
int totalFrameCount () const
 
int currentFrameIndex () const
 
bool setFrame (int index)
 
bool gotoAndStop (const char *frameLabel)
 Plays specified frame and then stops.
 
bool gotoAndStop (int frameNumber)
 
bool gotoAndPlay (const char *frameLabel)
 Plays animation from specified frame.
 
bool gotoAndPlay (int frameNumber)
 
int getStartFrame (const char *frameLabel)
 
int getEndFrame (const char *frameLabel)
 
bool playSequence (const char *name, bool looped=false, bool resume=true, AnimSetSequenceHint hint=ASSH_RESTART)
 
void clearSequence ()
 
void setSequenceDelegate (GAFSequenceDelegate *delegate)
 
void setAnimationPlaybackDelegate (GAFAnimationPlaybackDelegate *delegate)
 
bool hasSequences () const
 

Protected Member Functions

void setAnimationRunning (bool value)
 
bool getIsRunning () const
 

Protected Attributes

GAFAsset_asset
 
int _currentFrameIndex
 

Member Function Documentation

bool GAFAnimation::isDone ( ) const
Returns
true if the animation is finished, otherwise NO
bool GAFAnimation::playSequence ( const char *  name,
bool  looped = false,
bool  resume = true,
AnimSetSequenceHint  hint = ASSH_RESTART 
)

Plays animation sequence with specified name

Parameters
namea sequence name
loopedif true - sequence should play in cycle
resumeif true - animation will be played immediately, if false - playback will be paused after the first frame is shown
hintspecific animation playback parameters
void GAFAnimation::setAnimationPlaybackDelegate ( GAFAnimationPlaybackDelegate delegate)
Note
do not forget to call setAnimationPlaybackDelegate(NULL) before deleting your subscriber
void GAFAnimation::setSequenceDelegate ( GAFSequenceDelegate delegate)
Note
do not forget to call setSequenceDelegate(NULL) before deleting your subscriber

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