Ogre::AnimationTrack Class Reference
[Animation]

A 'track' in an animation sequence, i.e. More...

#include <OgreAnimationTrack.h>

Inheritance diagram for Ogre::AnimationTrack:

[legend]

Classes
class	Listener
	Listener allowing you to override certain behaviour of a track, for example to drive animation procedurally. More...
Public Member Functions
	AnimationTrack (Animation *parent, unsigned short handle)
	Constructor.
virtual	~AnimationTrack ()
unsigned short	getHandle (void) const
	Get the handle associated with this track.
virtual unsigned short	getNumKeyFrames (void) const
	Returns the number of keyframes in this animation.
virtual KeyFrame *	getKeyFrame (unsigned short index) const
	Returns the KeyFrame at the specified index.
virtual Real	getKeyFramesAtTime (const TimeIndex &timeIndex, KeyFrame keyFrame1, KeyFrame keyFrame2, unsigned short *firstKeyIndex=0) const
	Gets the 2 KeyFrame objects which are active at the time given, and the blend value between them.
virtual KeyFrame *	createKeyFrame (Real timePos)
	Creates a new KeyFrame and adds it to this animation at the given time index.
virtual void	removeKeyFrame (unsigned short index)
	Removes a KeyFrame by it's index.
virtual void	removeAllKeyFrames (void)
	Removes all the KeyFrames from this track.
virtual void	getInterpolatedKeyFrame (const TimeIndex &timeIndex, KeyFrame *kf) const =0
	Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
virtual void	apply (const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)=0
	Applies an animation track to the designated target.
virtual void	_keyFrameDataChanged (void) const
	Internal method used to tell the track that keyframe data has been changed, which may cause it to rebuild some internal data.
virtual bool	hasNonZeroKeyFrames (void) const
	Method to determine if this track has any KeyFrames which are doing anything useful - can be used to determine if this track can be optimised out.
virtual void	optimise (void)
	Optimise the current track by removing any duplicate keyframes.
virtual void	_collectKeyFrameTimes (vector< Real >::type &keyFrameTimes)
	Internal method to collect keyframe times, in unique, ordered format.
virtual void	_buildKeyFrameIndexMap (const vector< Real >::type &keyFrameTimes)
	Internal method to build keyframe time index map to translate global lower bound index to local lower bound index.
virtual void	_applyBaseKeyFrame (const KeyFrame *base)
	Internal method to re-base the keyframes relative to a given keyframe.
virtual void	setListener (Listener *l)
	Set a listener for this track.
Animation *	getParent () const
	Returns the parent Animation object for this track.
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 Types
typedef vector< KeyFrame * >::type	KeyFrameList
typedef vector< ushort >::type	KeyFrameIndexMap
	Map used to translate global keyframe time lower bound index to local lower bound index.
Protected Member Functions
virtual KeyFrame *	createKeyFrameImpl (Real time)=0
	Create a keyframe implementation - must be overridden.
virtual void	populateClone (AnimationTrack *clone) const
	Internal method for clone implementation.
Protected Attributes
KeyFrameList	mKeyFrames
Animation *	mParent
unsigned short	mHandle
Listener *	mListener
KeyFrameIndexMap	mKeyFrameIndexMap

Detailed Description

A 'track' in an animation sequence, i.e.

a sequence of keyframes which affect a certain type of animable object.

Remarks:: This class is intended as a base for more complete classes which will actually animate specific types of object, e.g. a bone in a skeleton to affect skeletal animation. An animation will likely include multiple tracks each of which can be made up of many KeyFrame instances. Note that the use of tracks allows each animable object to have it's own number of keyframes, i.e. you do not have to have the maximum number of keyframes for all animable objects just to cope with the most animated one.; Since the most common animable object is a Node, there are options in this class for associating the track with a Node which will receive keyframe updates automatically when the 'apply' method is called.; By default rotation is done using shortest-path algorithm. It is possible to change this behaviour using setUseShortestRotationPath() method.

Definition at line 121 of file OgreAnimationTrack.h.

Member Typedef Documentation

typedef vector<ushort>::type Ogre::AnimationTrack::KeyFrameIndexMap [protected]

Map used to translate global keyframe time lower bound index to local lower bound index.

Definition at line 249 of file OgreAnimationTrack.h.

typedef vector<KeyFrame*>::type Ogre::AnimationTrack::KeyFrameList [protected]

Definition at line 242 of file OgreAnimationTrack.h.

Constructor & Destructor Documentation

Ogre::AnimationTrack::AnimationTrack	(	Animation *	parent,
		unsigned short	handle
	)

Constructor.

virtual Ogre::AnimationTrack::~AnimationTrack ( ) [virtual]

Member Function Documentation

virtual void Ogre::AnimationTrack::_applyBaseKeyFrame ( const KeyFrame * base ) [virtual]

Internal method to re-base the keyframes relative to a given keyframe.

Reimplemented in Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.

Definition at line 234 of file OgreAnimationTrack.h.

virtual void Ogre::AnimationTrack::_buildKeyFrameIndexMap ( const vector< Real >::type & keyFrameTimes ) [virtual]

Internal method to build keyframe time index map to translate global lower bound index to local lower bound index.

virtual void Ogre::AnimationTrack::_collectKeyFrameTimes ( vector< Real >::type & keyFrameTimes ) [virtual]

Internal method to collect keyframe times, in unique, ordered format.

virtual void Ogre::AnimationTrack::_keyFrameDataChanged ( void ) const [virtual]

Internal method used to tell the track that keyframe data has been changed, which may cause it to rebuild some internal data.

Reimplemented in Ogre::NodeAnimationTrack.

Definition at line 215 of file OgreAnimationTrack.h.

virtual void Ogre::AnimationTrack::apply	(	const TimeIndex &	timeIndex,
		Real	weight = `1.0`,
		Real	scale = `1.0f`
	)			`[pure virtual]`

Applies an animation track to the designated target.

Parameters:

	timeIndex	The time position in the animation to apply.
	weight	The influence to give to this track, 1.0 for full influence, less to blend with other animations.
	scale	The scale to apply to translations and scalings, useful for adapting an animation to a different size target.

Implemented in Ogre::NumericAnimationTrack, Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.

virtual KeyFrame* Ogre::AnimationTrack::createKeyFrame ( Real timePos ) [virtual]

Creates a new KeyFrame and adds it to this animation at the given time index.

Remarks:: It is better to create KeyFrames in time order. Creating them out of order can result in expensive reordering processing. Note that a KeyFrame at time index 0.0 is always created for you, so you don't need to create this one, just access it using getKeyFrame(0);

Parameters:

timePos

The time from which this KeyFrame will apply.

virtual KeyFrame* Ogre::AnimationTrack::createKeyFrameImpl ( Real time ) [protected, pure virtual]

Create a keyframe implementation - must be overridden.

Implemented in Ogre::NumericAnimationTrack, Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.

unsigned short Ogre::AnimationTrack::getHandle ( void ) const

Get the handle associated with this track.

Definition at line 145 of file OgreAnimationTrack.h.

virtual void Ogre::AnimationTrack::getInterpolatedKeyFrame	(	const TimeIndex &	timeIndex,
		KeyFrame *	kf
	)			const `[pure virtual]`

Gets a KeyFrame object which contains the interpolated transforms at the time index specified.

Remarks:: The KeyFrame objects held by this class are transformation snapshots at discrete points in time. Normally however, you want to interpolate between these keyframes to produce smooth movement, and this method allows you to do this easily. In animation terminology this is called 'tweening'.

Parameters:

	timeIndex	The time (in relation to the whole animation sequence)
	kf	Keyframe object to store results

Implemented in Ogre::NumericAnimationTrack, Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.

virtual KeyFrame* Ogre::AnimationTrack::getKeyFrame ( unsigned short index ) const [virtual]

Returns the KeyFrame at the specified index.

virtual Real Ogre::AnimationTrack::getKeyFramesAtTime	(	const TimeIndex &	timeIndex,
		KeyFrame **	keyFrame1,
		KeyFrame **	keyFrame2,
		unsigned short *	firstKeyIndex = `0`
	)			const `[virtual]`

Gets the 2 KeyFrame objects which are active at the time given, and the blend value between them.

Remarks:: At any point in time in an animation, there are either 1 or 2 keyframes which are 'active', 1 if the time index is exactly on a keyframe, 2 at all other times i.e. the keyframe before and the keyframe after.

: This method returns those keyframes given a time index, and also returns a parametric value indicating the value of 't' representing where the time index falls between them. E.g. if it returns 0, the time index is exactly on keyFrame1, if it returns 0.5 it is half way between keyFrame1 and keyFrame2 etc.

Parameters:

	timeIndex	The time index.
	keyFrame1	Pointer to a KeyFrame pointer which will receive the pointer to the keyframe just before or at this time index.
	keyFrame2	Pointer to a KeyFrame pointer which will receive the pointer to the keyframe just after this time index.
	firstKeyIndex	Pointer to an unsigned short which, if supplied, will receive the index of the 'from' keyframe in case the caller needs it.

Returns:: Parametric value indicating how far along the gap between the 2 keyframes the timeIndex value is, e.g. 0.0 for exactly at 1, 0.25 for a quarter etc. By definition the range of this value is: 0.0 <= returnValue < 1.0 .

virtual unsigned short Ogre::AnimationTrack::getNumKeyFrames ( void ) const [virtual]

Returns the number of keyframes in this animation.

Animation* Ogre::AnimationTrack::getParent ( ) const

Returns the parent Animation object for this track.

Definition at line 240 of file OgreAnimationTrack.h.

virtual bool Ogre::AnimationTrack::hasNonZeroKeyFrames ( void ) const [virtual]

Method to determine if this track has any KeyFrames which are doing anything useful - can be used to determine if this track can be optimised out.

Reimplemented in Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.

Definition at line 221 of file OgreAnimationTrack.h.

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::AnimationTrack::optimise ( void ) [virtual]

Optimise the current track by removing any duplicate keyframes.

Reimplemented in Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.

Definition at line 224 of file OgreAnimationTrack.h.

virtual void Ogre::AnimationTrack::populateClone ( AnimationTrack * clone ) const [protected, virtual]

Internal method for clone implementation.

virtual void Ogre::AnimationTrack::removeAllKeyFrames ( void ) [virtual]

Removes all the KeyFrames from this track.

virtual void Ogre::AnimationTrack::removeKeyFrame ( unsigned short index ) [virtual]

Removes a KeyFrame by it's index.

virtual void Ogre::AnimationTrack::setListener ( Listener * l ) [virtual]

Set a listener for this track.

Definition at line 237 of file OgreAnimationTrack.h.

Member Data Documentation

unsigned short Ogre::AnimationTrack::mHandle [protected]

Definition at line 245 of file OgreAnimationTrack.h.

KeyFrameIndexMap Ogre::AnimationTrack::mKeyFrameIndexMap [protected]

Definition at line 250 of file OgreAnimationTrack.h.

KeyFrameList Ogre::AnimationTrack::mKeyFrames [protected]

Definition at line 243 of file OgreAnimationTrack.h.

Listener* Ogre::AnimationTrack::mListener [protected]

Definition at line 246 of file OgreAnimationTrack.h.

Animation* Ogre::AnimationTrack::mParent [protected]

Definition at line 244 of file OgreAnimationTrack.h.

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

OgreAnimationTrack.h

Ogre::AnimationTrack Class Reference [Animation]

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Ogre::AnimationTrack Class Reference
[Animation]