Castor3D::KeyFrame Class Reference

The class which manages key frames. More...

Collaboration diagram for Castor3D::KeyFrame:

Classes
class	BinaryParser
	MovingObjectBase binary loader. More...

Public Member Functions
	KeyFrame (real p_timeIndex=0, Castor::Point3r const &p_translate={}, Castor::Quaternion const &p_rotate={}, Castor::Point3r const &p_scale={})
	Constructor. More...
	~KeyFrame ()
	Destructor. More...
void	SetTranslate (Castor::Point3r const &p_value)
	Defines the wanted translation. More...
void	SetRotate (Castor::Quaternion const &p_value)
	Defines the wanted rotation. More...
void	SetScale (Castor::Point3r const &p_value)
	Defines the wanted scaling. More...
Castor::Point3r const &	GetTranslate () const
Castor::Quaternion const &	GetRotate () const
Castor::Point3r const &	GetScale () const
real	GetTimeIndex () const
	Retrieves the start time index. More...
void	SetTimeIndex (real p_value)
	Defines the start time index. More...

Protected Attributes
real	m_timeIndex
	The start time index. More...
Castor::Point3r	m_translate
	The translation at start time. More...
Castor::Quaternion	m_rotate
	The rotation at start time. More...
Castor::Point3r	m_scale
	The scaling at start time. More...

Detailed Description

The class which manages key frames.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarks

Key frames are the frames where the animation must be at a precise state

Constructor & Destructor Documentation

KeyFrame()

Castor3D::KeyFrame::KeyFrame ( real  p_timeIndex = 0, Castor::Point3r const &  p_translate = {}, Castor::Quaternion const &  p_rotate = {}, Castor::Point3r const &  p_scale = {}  )

inline

Constructor.

Parameters

[in]	p_timeIndex	When the key frame starts.
[in]	p_translate	The translation at start time.
[in]	p_rotate	The rotation at start time.
[in]	p_scale	The scaling at start time.

~KeyFrame()

Castor3D::KeyFrame::~KeyFrame ( )

inline

Destructor.

Member Function Documentation

GetRotate()

Castor::Quaternion const& Castor3D::KeyFrame::GetRotate ( ) const

inline

Returns

The rotation.

References m_rotate.

GetScale()

Castor::Point3r const& Castor3D::KeyFrame::GetScale ( ) const

inline

Returns

The scaling.

References m_scale.

GetTimeIndex()

real Castor3D::KeyFrame::GetTimeIndex ( ) const

inline

Retrieves the start time index.

Returns

The time index

References m_timeIndex.

GetTranslate()

Castor::Point3r const& Castor3D::KeyFrame::GetTranslate ( ) const

inline

Returns

The translation.

References m_translate.

SetRotate()

void Castor3D::KeyFrame::SetRotate ( Castor::Quaternion const &  p_value )

inline

Defines the wanted rotation.

Parameters

[in]

p_value

The value

References m_rotate.

SetScale()

void Castor3D::KeyFrame::SetScale ( Castor::Point3r const &  p_value )

inline

Defines the wanted scaling.

Parameters

[in]

p_value

The value

References m_scale.

SetTimeIndex()

void Castor3D::KeyFrame::SetTimeIndex ( real  p_value )

inline

Defines the start time index.

Parameters

[in]

p_value

The time index

References m_timeIndex.

SetTranslate()

void Castor3D::KeyFrame::SetTranslate ( Castor::Point3r const &  p_value )

inline

Defines the wanted translation.

Parameters

[in]

p_value

The value

References m_translate.

Member Data Documentation

m_rotate

Castor::Quaternion Castor3D::KeyFrame::m_rotate

protected

The rotation at start time.

Referenced by GetRotate(), and SetRotate().

m_scale

Castor::Point3r Castor3D::KeyFrame::m_scale

protected

The scaling at start time.

Referenced by GetScale(), and SetScale().

m_timeIndex

real Castor3D::KeyFrame::m_timeIndex

protected

The start time index.

Referenced by GetTimeIndex(), and SetTimeIndex().

m_translate

Castor::Point3r Castor3D::KeyFrame::m_translate

protected

The translation at start time.

Referenced by GetTranslate(), and SetTranslate().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/KeyFrame.hpp