- Cal3D 0.9 API Reference -

             

---

CalAnimationAction Class Reference

The animation action class. More...

#include <animation_action.h>

Inheritance diagram for CalAnimationAction:

List of all members.

Public Methods
	CalAnimationAction ()
	Constructs the animation action instance. More...
virtual	~CalAnimationAction ()
	Destructs the animation action instance. More...
bool	create (CalCoreAnimation *pCoreAnimation)
	Creates the animation action instance. More...
void	destroy ()
	Destroys the animation action instance. More...
bool	execute (float delayIn, float delayOut, float weightTarget=1.0f)
	Executes the animation action instance. More...
bool	update (float deltaTime)
	Updates the animation action instance. More...
Protected Attributes
float	m_delayIn
float	m_delayOut
float	m_delayTarget
float	m_weightTarget

---

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 )

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. 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:

• animation_action.h
• animation_action.cpp

---

Generated at Sun Oct 12 18:38:48 2003 by The Cal3D Team with 1.2.14 © 1997-2001 Dimitri van Heesch