OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::AnimationTrack Class Referenceabstract

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

#include <OgreAnimationTrack.h>

+ Inheritance diagram for Ogre::AnimationTrack:
+ Collaboration diagram for Ogre::AnimationTrack:

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. More...
 
virtual ~AnimationTrack ()
 
virtual void _applyBaseKeyFrame (const KeyFrame *base)
 Internal method to re-base the keyframes relative to a given keyframe. 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...
 
virtual void _collectKeyFrameTimes (vector< Real >::type &keyFrameTimes)
 Internal method to collect keyframe times, in unique, ordered format. More...
 
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. More...
 
virtual void apply (const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)=0
 Applies an animation track to the designated target. More...
 
virtual KeyFramecreateKeyFrame (Real timePos)
 Creates a new KeyFrame and adds it to this animation at the given time index. More...
 
unsigned short getHandle (void) const
 Get the handle associated with this track. More...
 
virtual void getInterpolatedKeyFrame (const TimeIndex &timeIndex, KeyFrame *kf) const =0
 Gets a KeyFrame object which contains the interpolated transforms at the time index specified. More...
 
virtual KeyFramegetKeyFrame (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 unsigned short getNumKeyFrames (void) const
 Returns the number of keyframes in this animation. More...
 
AnimationgetParent () const
 Returns the parent Animation object for this track. 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 setListener (Listener *l)
 Set a listener for this track. 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 KeyFramecreateKeyFrameImpl (Real time)=0
 Create a keyframe implementation - must be overridden. More...
 
virtual void populateClone (AnimationTrack *clone) const
 Internal method for clone implementation. More...
 

Protected Attributes

unsigned short mHandle
 
KeyFrameIndexMap mKeyFrameIndexMap
 
KeyFrameList mKeyFrames
 
ListenermListener
 
AnimationmParent
 

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 OldNode, there are options in this class for associating the track with a OldNode 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 123 of file OgreAnimationTrack.h.

Member Typedef Documentation

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

Definition at line 251 of file OgreAnimationTrack.h.

Definition at line 244 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)
inlinevirtual

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

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

Definition at line 236 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
inlinevirtual

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::OldNodeAnimationTrack, and Ogre::NodeAnimationTrack.

Definition at line 217 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
timeIndexThe time position in the animation to apply.
weightThe influence to give to this track, 1.0 for full influence, less to blend with other animations.
scaleThe scale to apply to translations and scalings, useful for adapting an animation to a different size target.

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

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
timePosThe time from which this KeyFrame will apply.
virtual KeyFrame* Ogre::AnimationTrack::createKeyFrameImpl ( Real  time)
protectedpure virtual

Create a keyframe implementation - must be overridden.

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

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

Get the handle associated with this track.

Definition at line 147 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
timeIndexThe time (in relation to the whole animation sequence)
kfKeyframe object to store results

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

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
timeIndexThe time index.
keyFrame1Pointer to a KeyFrame pointer which will receive the pointer to the keyframe just before or at this time index.
keyFrame2Pointer to a KeyFrame pointer which will receive the pointer to the keyframe just after this time index.
firstKeyIndexPointer 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
inline

Returns the parent Animation object for this track.

Definition at line 242 of file OgreAnimationTrack.h.

virtual bool Ogre::AnimationTrack::hasNonZeroKeyFrames ( void  ) const
inlinevirtual

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::VertexAnimationTrack, Ogre::OldNodeAnimationTrack, and Ogre::NodeAnimationTrack.

Definition at line 223 of file OgreAnimationTrack.h.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 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 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 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 79 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 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::AnimationTrack::optimise ( void  )
inlinevirtual

Optimise the current track by removing any duplicate keyframes.

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

Definition at line 226 of file OgreAnimationTrack.h.

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

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)
inlinevirtual

Set a listener for this track.

Definition at line 239 of file OgreAnimationTrack.h.

Member Data Documentation

unsigned short Ogre::AnimationTrack::mHandle
protected

Definition at line 247 of file OgreAnimationTrack.h.

KeyFrameIndexMap Ogre::AnimationTrack::mKeyFrameIndexMap
protected

Definition at line 252 of file OgreAnimationTrack.h.

KeyFrameList Ogre::AnimationTrack::mKeyFrames
protected

Definition at line 245 of file OgreAnimationTrack.h.

Listener* Ogre::AnimationTrack::mListener
protected

Definition at line 248 of file OgreAnimationTrack.h.

Animation* Ogre::AnimationTrack::mParent
protected

Definition at line 246 of file OgreAnimationTrack.h.


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