- Cal3D 0.11 API Reference -

Public Member Functions | Protected Attributes | List of all members
CalCoreKeyframe Class Reference

The core keyframe class. More...

#include <corekeyframe.h>

Public Member Functions

 CalCoreKeyframe ()
 Constructs the core keyframe instance. More...
 
virtual ~CalCoreKeyframe ()
 Destructs the core keyframe instance. More...
 
bool create ()
 Creates the core keyframe instance. More...
 
void destroy ()
 Destroys the core keyframe instance. More...
 
const CalQuaterniongetRotation ()
 Returns the rotation. More...
 
float getTime () const
 Returns the time. More...
 
const CalVectorgetTranslation ()
 Returns the translation. More...
 
void setRotation (const CalQuaternion &rotation)
 Sets the rotation. More...
 
void setTime (float time)
 Sets the time. More...
 
void setTranslation (const CalVector &translation)
 Sets the translation. More...
 

Protected Attributes

float m_time
 
CalVector m_translation
 
CalQuaternion m_rotation
 

Detailed Description

The core keyframe class.

Constructor & Destructor Documentation

CalCoreKeyframe::CalCoreKeyframe ( )

Constructs the core keyframe instance.

This function is the default constructor of the core keyframe instance.

CalCoreKeyframe::~CalCoreKeyframe ( )
virtual

Destructs the core keyframe instance.

This function is the destructor of the core keyframe instance.

Member Function Documentation

bool CalCoreKeyframe::create ( )

Creates the core keyframe instance.

This function creates the core keyframe instance.

Returns
One of the following values:
  • true if successful
  • false if an error happend
void CalCoreKeyframe::destroy ( )

Destroys the core keyframe instance.

This function destroys all data stored in the core keyframe instance and frees all allocated memory.

const CalQuaternion & CalCoreKeyframe::getRotation ( )

Returns the rotation.

This function returns the rotation of the core keyframe instance.

Returns
The rotation as quaternion.
float CalCoreKeyframe::getTime ( ) const
inline

Returns the time.

This function returns the time of the core keyframe instance.

Returns
The time in seconds.
const CalVector & CalCoreKeyframe::getTranslation ( )

Returns the translation.

This function returns the translation of the core keyframe instance.

Returns
The translation as vector.
void CalCoreKeyframe::setRotation ( const CalQuaternion rotation)

Sets the rotation.

This function sets the rotation of the core keyframe instance.

Parameters
rotationThe rotation as quaternion.
void CalCoreKeyframe::setTime ( float  time)

Sets the time.

This function sets the time of the core keyframe instance.

Parameters
rotationThe time in seconds.
void CalCoreKeyframe::setTranslation ( const CalVector translation)

Sets the translation.

This function sets the translation of the core keyframe instance.

Parameters
rotationThe translation as vector.

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

Generated at Wed Nov 26 2014 05:33:20 by The Cal3D Team with Doxygen 1.8.7