- Cal3D 0.9 API Reference -

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

CalAnimationAction Class Reference

The animation action class. More...

#include <animation_action.h>

Inheritance diagram for CalAnimationAction:

CalAnimation List of all members.

Public Member Functions

 CalAnimationAction ()
 Constructs the animation action instance.
virtual ~CalAnimationAction ()
 Destructs the animation action instance.
bool create (CalCoreAnimation *pCoreAnimation)
 Creates the animation action instance.
void destroy ()
 Destroys 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.

Protected Attributes

float m_delayIn
float m_delayOut
float m_delayTarget
float m_weightTarget
bool m_autoLock

Detailed Description

The animation action class.


Constructor & Destructor Documentation

CalAnimationAction::CalAnimationAction  ) 
 

Constructs the animation action instance.

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

CalAnimationAction::~CalAnimationAction  )  [virtual]
 

Destructs the animation action instance.

This function is the destructor of the animation action instance.


Member Function Documentation

bool CalAnimationAction::create CalCoreAnimation pCoreAnimation  )  [virtual]
 

Creates the animation action instance.

This function creates the animation action instance based on a core animation.

Parameters:
pCoreAnimation A pointer to the core animation on which this animation action instance should be based on.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

Implements CalAnimation.

void CalAnimationAction::destroy  )  [virtual]
 

Destroys the animation action instance.

This function destroys all data stored in the animation action instance and frees all allocated memory.

Reimplemented from CalAnimation.

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 Fri Nov 19 03:49:19 2004 by The Cal3D Team with doxygen 1.3.9.1 © 1997-2001 Dimitri van Heesch