- Cal3D 0.9 API Reference -

             

---

CalCoreKeyframe Class Reference

The core keyframe class. More...

#include <corekeyframe.h>

List of all members.

Public Methods
	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 CalQuaternion &	getRotation ()
	Returns the rotation. More...
float	getTime ()
	Returns the time. More...
const CalVector &	getTranslation ()
	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 (    )

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: rotation  The rotation as quaternion.

void CalCoreKeyframe::setTime (  float    time )

Sets the time. This function sets the time of the core keyframe instance. Parameters: rotation  The time in seconds.

void CalCoreKeyframe::setTranslation (  const CalVector &    translation )

Sets the translation. This function sets the translation of the core keyframe instance. Parameters: rotation  The translation as vector.

---

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

• corekeyframe.h
• corekeyframe.cpp

---

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