Ogre::NodeAnimationTrack Class Reference

Specialised AnimationTrack for dealing with node transforms. More...

#include <OgreAnimationTrack.h>

Inheritance diagram for Ogre::NodeAnimationTrack:

Collaboration diagram for Ogre::NodeAnimationTrack:

Classes
struct	Splines

Public Member Functions
	NodeAnimationTrack (Animation *parent, unsigned short handle)
	Constructor. More...
	NodeAnimationTrack (Animation *parent, unsigned short handle, Node *targetNode)
	Constructor, associates with a Node. More...
virtual	~NodeAnimationTrack ()
	Destructor. More...
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. More...
NodeAnimationTrack *	_clone (Animation *newParent) const
	Clone this track (internal use only) More...
virtual void	_collectKeyFrameTimes (vector< Real >::type &keyFrameTimes)
	Internal method to collect keyframe times, in unique, ordered format. More...
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. More...
virtual void	apply (const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
	Applies an animation track to the designated target. More...
virtual void	applyToNode (Node *node, const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
	As the 'apply' method but applies to a specified Node instead of associated node. More...
virtual KeyFrame *	createKeyFrame (Real timePos)
	Creates a new KeyFrame and adds it to this animation at the given time index. More...
virtual TransformKeyFrame *	createNodeKeyFrame (Real timePos)
	Creates a new KeyFrame and adds it to this animation at the given time index. More...
virtual Node *	getAssociatedNode (void) const
	Returns a pointer to the associated Node object (if any). More...
unsigned short	getHandle (void) const
	Get the handle associated with this track. More...
virtual void	getInterpolatedKeyFrame (const TimeIndex &timeIndex, KeyFrame *kf) const
	Gets a KeyFrame object which contains the interpolated transforms at the time index specified. More...
virtual KeyFrame *	getKeyFrame (unsigned short index) const
	Returns the KeyFrame at the specified index. More...
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. More...
virtual TransformKeyFrame *	getNodeKeyFrame (unsigned short index) const
	Returns the KeyFrame at the specified index. More...
virtual unsigned short	getNumKeyFrames (void) const
	Returns the number of keyframes in this animation. More...
Animation *	getParent () const
	Returns the parent Animation object for this track. More...
virtual bool	getUseShortestRotationPath () const
	Gets the method of rotation calculation. More...
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. More...
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 *)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info More...
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new More...
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void *	operator new[] (size_t sz)
virtual void	optimise (void)
	Optimise the current track by removing any duplicate keyframes. More...
virtual void	removeAllKeyFrames (void)
	Removes all the KeyFrames from this track. More...
virtual void	removeKeyFrame (unsigned short index)
	Removes a KeyFrame by it's index. More...
virtual void	setAssociatedNode (Node *node)
	Sets the associated Node object which will be automatically affected by calls to 'apply'. More...
virtual void	setListener (Listener *l)
	Set a listener for this track. More...
virtual void	setUseShortestRotationPath (bool useShortestPath)
	Sets the method of rotation calculation. More...

Protected Types
typedef vector< ushort >::type	KeyFrameIndexMap
	Map used to translate global keyframe time lower bound index to local lower bound index. More...
typedef vector< KeyFrame * >::type	KeyFrameList

Protected Member Functions
virtual void	buildInterpolationSplines (void) const
KeyFrame *	createKeyFrameImpl (Real time)
	Specialised keyframe creation. More...
virtual void	populateClone (AnimationTrack *clone) const
	Internal method for clone implementation. More...

Protected Attributes
unsigned short	mHandle
KeyFrameIndexMap	mKeyFrameIndexMap
KeyFrameList	mKeyFrames
Listener *	mListener
Animation *	mParent
bool	mSplineBuildNeeded
Splines *	mSplines
Node *	mTargetNode
bool	mUseShortestRotationPath
	Defines if rotation is done using shortest path. More...

Detailed Description

Specialised AnimationTrack for dealing with node transforms.

Definition at line 322 of file OgreAnimationTrack.h.

Member Typedef Documentation

typedef vector<ushort>::type Ogre::AnimationTrack::KeyFrameIndexMap

protectedinherited

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

Definition at line 246 of file OgreAnimationTrack.h.

typedef vector<KeyFrame*>::type Ogre::AnimationTrack::KeyFrameList

protectedinherited

Definition at line 239 of file OgreAnimationTrack.h.

Constructor & Destructor Documentation

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

Constructor.

Ogre::NodeAnimationTrack::NodeAnimationTrack	(	Animation *	parent,
		unsigned short	handle,
		Node *	targetNode
	)

Constructor, associates with a Node.

virtual Ogre::NodeAnimationTrack::~NodeAnimationTrack ( )

virtual

Destructor.

Member Function Documentation

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

virtualinherited

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

NodeAnimationTrack* Ogre::NodeAnimationTrack::_clone

(

Animation *

newParent

)

const

Clone this track (internal use only)

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

virtualinherited

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

void Ogre::NodeAnimationTrack::_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 from Ogre::AnimationTrack.

virtual void Ogre::NodeAnimationTrack::apply ( const TimeIndex &  timeIndex, Real  weight = 1.0, Real  scale = 1.0f  )

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.

Implements Ogre::AnimationTrack.

virtual void Ogre::NodeAnimationTrack::applyToNode ( Node *  node, const TimeIndex &  timeIndex, Real  weight = 1.0, Real  scale = 1.0f  )

virtual

As the 'apply' method but applies to a specified Node instead of associated node.

virtual void Ogre::NodeAnimationTrack::buildInterpolationSplines ( void  ) const

protectedvirtual

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

virtualinherited

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.

KeyFrame* Ogre::NodeAnimationTrack::createKeyFrameImpl ( Real  time )

protectedvirtual

Specialised keyframe creation.

Implements Ogre::AnimationTrack.

virtual TransformKeyFrame* Ogre::NodeAnimationTrack::createNodeKeyFrame ( 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 Node* Ogre::NodeAnimationTrack::getAssociatedNode ( void  ) const

virtual

Returns a pointer to the associated Node object (if any).

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

inlineinherited

Get the handle associated with this track.

Definition at line 145 of file OgreAnimationTrack.h.

virtual void Ogre::NodeAnimationTrack::getInterpolatedKeyFrame ( const TimeIndex &  timeIndex, KeyFrame *  kf  ) const

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

Implements Ogre::AnimationTrack.

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

virtualinherited

Returns the KeyFrame at the specified index.

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

virtualinherited

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 TransformKeyFrame* Ogre::NodeAnimationTrack::getNodeKeyFrame ( unsigned short  index ) const

virtual

Returns the KeyFrame at the specified index.

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

virtualinherited

Returns the number of keyframes in this animation.

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

inlineinherited

Returns the parent Animation object for this track.

Definition at line 237 of file OgreAnimationTrack.h.

virtual bool Ogre::NodeAnimationTrack::getUseShortestRotationPath ( ) const

virtual

Gets the method of rotation calculation.

virtual bool Ogre::NodeAnimationTrack::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 from Ogre::AnimationTrack.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

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 )

inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::NodeAnimationTrack::optimise ( void  )

virtual

Optimise the current track by removing any duplicate keyframes.

Reimplemented from Ogre::AnimationTrack.

virtual void Ogre::AnimationTrack::populateClone ( AnimationTrack *  clone ) const

protectedvirtualinherited

Internal method for clone implementation.

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

virtualinherited

Removes all the KeyFrames from this track.

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

virtualinherited

Removes a KeyFrame by it's index.

virtual void Ogre::NodeAnimationTrack::setAssociatedNode ( Node *  node )

virtual

Sets the associated Node object which will be automatically affected by calls to 'apply'.

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

inlinevirtualinherited

Set a listener for this track.

Definition at line 234 of file OgreAnimationTrack.h.

virtual void Ogre::NodeAnimationTrack::setUseShortestRotationPath ( bool  useShortestPath )

virtual

Sets the method of rotation calculation.

Member Data Documentation

unsigned short Ogre::AnimationTrack::mHandle

protectedinherited

Definition at line 242 of file OgreAnimationTrack.h.

KeyFrameIndexMap Ogre::AnimationTrack::mKeyFrameIndexMap

protectedinherited

Definition at line 247 of file OgreAnimationTrack.h.

KeyFrameList Ogre::AnimationTrack::mKeyFrames

protectedinherited

Definition at line 240 of file OgreAnimationTrack.h.

Listener* Ogre::AnimationTrack::mListener

protectedinherited

Definition at line 243 of file OgreAnimationTrack.h.

Animation* Ogre::AnimationTrack::mParent

protectedinherited

Definition at line 241 of file OgreAnimationTrack.h.

bool Ogre::NodeAnimationTrack::mSplineBuildNeeded

mutableprotected

Definition at line 398 of file OgreAnimationTrack.h.

Splines* Ogre::NodeAnimationTrack::mSplines

mutableprotected

Definition at line 397 of file OgreAnimationTrack.h.

Node* Ogre::NodeAnimationTrack::mTargetNode

protected

Definition at line 395 of file OgreAnimationTrack.h.

bool Ogre::NodeAnimationTrack::mUseShortestRotationPath

mutableprotected

Defines if rotation is done using shortest path.

Definition at line 400 of file OgreAnimationTrack.h.

---

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

• OgreAnimationTrack.h