- Cal3D 0.9 API Reference -

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

# CalAnimationCycle Class Reference

The animation cycle class. More...

`#include <animation_cycle.h>`

Inheritance diagram for CalAnimationCycle:

List of all members.

## Public Member Functions

| CalAnimationCycle ()
| Constructs the animation cycle instance.
virtual | ~CalAnimationCycle ()
| Destructs the animation cycle instance.
bool | blend (float weight, float delay)
| Interpolates the weight of the animation cycle instance.
bool | create (CalCoreAnimation *pCoreAnimation)
| Creates the animation cycle instance.
void | destroy ()
| Destroys the animation cycle instance.
void | setAsync (float time, float duration)
| Puts the animation cycle instance into async state.
bool | update (float deltaTime)
| Updates the animation cycle instance.

## Protected Attributes

float | m_targetDelay
float | m_targetWeight

## Detailed Description

The animation cycle class.

## Constructor & Destructor Documentation

CalAnimationCycle::CalAnimationCycle | ( |  | ) |

| Constructs the animation cycle instance. This function is the default constructor of the animation cycle instance.

CalAnimationCycle::~CalAnimationCycle | ( |  | ) | `[virtual]`

| Destructs the animation cycle instance. This function is the destructor of the animation cycle instance.

## Member Function Documentation

bool CalAnimationCycle::blend | ( | float | weight,
|  | float | delay
| ) |

| Interpolates the weight of the animation cycle instance. This function interpolates the weight of the animation cycle instance to a new value in a given amount of time.

Parameters:

  weight | The weight to interpolate the animation cycle instance to.
  delay | The time in seconds until the new weight should be reached.

Returns:
  One of the following values:
  - true if successful
  - false if an error happend

bool CalAnimationCycle::create | ( | CalCoreAnimation * | pCoreAnimation | ) | `[virtual]`

| Creates the animation cycle instance. This function creates the animation cycle instance based on a core animation.

Parameters:

  pCoreAnimation | A pointer to the core animation on which this animation cycle instance should be based on.

Returns:
  One of the following values:
  - true if successful
  - false if an error happend

Implements CalAnimation.

void CalAnimationCycle::destroy | ( |  | ) | `[virtual]`

| Destroys the animation cycle instance. This function destroys all data stored in the animation cycle instance and frees all allocated memory. Reimplemented from CalAnimation.

void CalAnimationCycle::setAsync | ( | float | time,
|  | float | duration
| ) |

| Puts the animation cycle instance into async state. This function puts the animation cycle instance into async state, which means that it will end after the current running cycle.

Parameters:

  time | The time in seconds at which the animation cycle instance was unlinked from the global mixer animation cycle.
  duration | The current duration of the global mixer animation cycle in seconds at the time of the unlinking.

bool CalAnimationCycle::update | ( | float | deltaTime | ) |

| Updates the animation cycle instance. This function updates the animation cycle 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 cycle instance is still active
  - false if the execution of the animation cycle instance has ended

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

- animation_cycle.h
- animation_cycle.cpp

Generated at Wed Apr 7 16:57:17 2004 by The Cal3D Team with 1.3.6 © 1997-2001 Dimitri van Heesch