Ogre::TransformKeyFrame Class Reference
[Animation]

Specialised KeyFrame which stores a full transform. More...

#include <OgreKeyFrame.h>

Inheritance diagram for Ogre::TransformKeyFrame:

[legend]

List of all members.

Public Member Functions
	TransformKeyFrame (const AnimationTrack *parent, Real time)
	Default constructor, you should not call this but use AnimationTrack::createKeyFrame instead.
	~TransformKeyFrame ()
virtual void	setTranslate (const Vector3 &trans)
	Sets the translation associated with this keyframe.
const Vector3 &	getTranslate (void) const
	Gets the translation applied by this keyframe.
virtual void	setScale (const Vector3 &scale)
	Sets the scaling factor applied by this keyframe to the animable object at it's time index.
virtual const Vector3 &	getScale (void) const
	Gets the scaling factor applied by this keyframe.
virtual void	setRotation (const Quaternion &rot)
	Sets the rotation applied by this keyframe.
virtual const Quaternion &	getRotation (void) const
	Gets the rotation applied by this keyframe.
KeyFrame *	_clone (AnimationTrack *newParent) const
	Clone a keyframe (internal use only).
Real	getTime (void) const
	Gets the time of this keyframe in the animation sequence.
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void *ptr, void *)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
Protected Attributes
Vector3	mTranslate
Vector3	mScale
Quaternion	mRotate
Real	mTime
const AnimationTrack *	mParentTrack

---

Detailed Description

Specialised KeyFrame which stores a full transform.

Definition at line 102 of file OgreKeyFrame.h.

---

Constructor & Destructor Documentation

Ogre::TransformKeyFrame::TransformKeyFrame	(	const AnimationTrack *	parent,
		Real	time
	)

Default constructor, you should not call this but use AnimationTrack::createKeyFrame instead.

Ogre::TransformKeyFrame::~TransformKeyFrame

(

)

Definition at line 107 of file OgreKeyFrame.h.

---

Member Function Documentation

KeyFrame* Ogre::TransformKeyFrame::_clone

(

AnimationTrack *

newParent

)

const [virtual]

Clone a keyframe (internal use only).

Reimplemented from Ogre::KeyFrame.

virtual const Quaternion& Ogre::TransformKeyFrame::getRotation

(

void

)

const [virtual]

Gets the rotation applied by this keyframe.

virtual const Vector3& Ogre::TransformKeyFrame::getScale

(

void

)

const [virtual]

Gets the scaling factor applied by this keyframe.

Real Ogre::KeyFrame::getTime

(

void

)

const [inherited]

Gets the time of this keyframe in the animation sequence.

Definition at line 65 of file OgreKeyFrame.h.

const Vector3& Ogre::TransformKeyFrame::getTranslate

(

void

)

const

Gets the translation applied by this keyframe.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			[inherited]

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			[inherited]

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete

(

void *

ptr

)

[inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			[inherited]

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]

(

void *

ptr

)

[inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			[inherited]

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new

(

size_t

sz

)

[inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			[inherited]

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]

(

size_t

sz

)

[inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			[inherited]

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::TransformKeyFrame::setRotation

(

const Quaternion &

rot

)

[virtual]

Sets the rotation applied by this keyframe.

Parameters:

rot

The rotation applied; use Quaternion methods to convert from angle/axis or Matrix3 if you don't like using Quaternions directly.

virtual void Ogre::TransformKeyFrame::setScale

(

const Vector3 &

scale

)

[virtual]

Sets the scaling factor applied by this keyframe to the animable object at it's time index.

Parameters:

scale

The vector to scale by (beware of supplying zero values for any component of this vector, it will scale the object to zero dimensions)

virtual void Ogre::TransformKeyFrame::setTranslate

(

const Vector3 &

trans

)

[virtual]

Sets the translation associated with this keyframe.

Remarks:

The translation factor affects how much the keyframe translates (moves) it's animable object at it's time index.

Parameters:

trans

The vector to translate by

---

Member Data Documentation

const AnimationTrack* Ogre::KeyFrame::mParentTrack [protected, inherited]

Definition at line 73 of file OgreKeyFrame.h.

Quaternion Ogre::TransformKeyFrame::mRotate [protected]

Definition at line 143 of file OgreKeyFrame.h.

Vector3 Ogre::TransformKeyFrame::mScale [protected]

Definition at line 142 of file OgreKeyFrame.h.

Real Ogre::KeyFrame::mTime [protected, inherited]

Definition at line 72 of file OgreKeyFrame.h.

Vector3 Ogre::TransformKeyFrame::mTranslate [protected]

Definition at line 141 of file OgreKeyFrame.h.

---

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

• OgreKeyFrame.h