- Cal3D 0.11 API Reference -

CalAnimationAction Class Reference

Inheritance diagram for CalAnimationAction:
CalAnimation

List of all members.

Public Member Functions

 CalAnimationAction (CalCoreAnimation *pCoreAnimation)
 Constructs the animation action instance.
bool execute (float delayIn, float delayOut, float weightTarget=1.0f, bool autoLock=false)
 Executes the animation action instance.
bool update (float deltaTime)
 Updates the animation action instance.

Constructor & Destructor Documentation

CalAnimationAction::CalAnimationAction ( CalCoreAnimation pCoreAnimation  ) 

Constructs the animation action instance.

This function is the default constructor of the animation action instance.


Member Function Documentation

bool CalAnimationAction::execute ( float  delayIn,
float  delayOut,
float  weightTarget = 1.0f,
bool  autoLock = false 
)

Executes the animation action instance.

This function executes the animation action instance.

Parameters:
delayIn The time in seconds until the animation action instance reaches the full weight from the beginning of its execution.
delayOut The time in seconds in which the animation action instance reaches zero weight at the end of its execution.
weightTarget No doxygen comment for this. FIXME.
autoLock This prevents the Action from being reset and removed on the last keyframe if true.
Returns:
One of the following values:
  • true if successful
  • false if an error happend
bool CalAnimationAction::update ( float  deltaTime  ) 

Updates the animation action instance.

This function updates the animation action instance for a given amount of time.

Parameters:
deltaTime The elapsed time in seconds since the last update.
Returns:
One of the following values:
  • true if the animation action instance is still active
  • false if the execution of the animation action instance has ended

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

Generated at Thu Nov 5 17:21:00 2009 by The Cal3D Team with Doxygen 1.6.1