OGRE
1.9.0
|
A 'track' in an animation sequence, i.e. More...
#include <OgreAnimationTrack.h>
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 () |
virtual void | _applyBaseKeyFrame (const KeyFrame *base) |
Internal method to re-base the keyframes relative to a given keyframe. | |
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 | _collectKeyFrameTimes (vector< Real >::type &keyFrameTimes) |
Internal method to collect keyframe times, in unique, ordered format. | |
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 void | apply (const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)=0 |
Applies an animation track to the designated target. | |
virtual KeyFrame * | createKeyFrame (Real timePos) |
Creates a new KeyFrame and adds it to this animation at the given time index. | |
unsigned short | getHandle (void) const |
Get the handle associated with 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 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 unsigned short | getNumKeyFrames (void) const |
Returns the number of keyframes in this animation. | |
Animation * | getParent () const |
Returns the parent Animation object for this track. | |
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. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz) |
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 *ptr) |
placement operator new | |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info | |
virtual void | optimise (void) |
Optimise the current track by removing any duplicate keyframes. | |
virtual void | removeAllKeyFrames (void) |
Removes all the KeyFrames from this track. | |
virtual void | removeKeyFrame (unsigned short index) |
Removes a KeyFrame by it's index. | |
virtual void | setListener (Listener *l) |
Set a listener for this track. | |
Protected Types | |
typedef vector< ushort >::type | KeyFrameIndexMap |
Map used to translate global keyframe time lower bound index to local lower bound index. | |
typedef vector< KeyFrame * >::type | KeyFrameList |
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 | |
unsigned short | mHandle |
KeyFrameIndexMap | mKeyFrameIndexMap |
KeyFrameList | mKeyFrames |
Listener * | mListener |
Animation * | mParent |
A 'track' in an animation sequence, i.e.
a sequence of keyframes which affect a certain type of animable object.
Definition at line 122 of file OgreAnimationTrack.h.
|
protected |
Map used to translate global keyframe time lower bound index to local lower bound index.
Definition at line 250 of file OgreAnimationTrack.h.
|
protected |
Definition at line 243 of file OgreAnimationTrack.h.
|
virtual |
Internal method to re-base the keyframes relative to a given keyframe.
Reimplemented in Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.
|
virtual |
Internal method to build keyframe time index map to translate global lower bound index to local lower bound index.
|
virtual |
Internal method to collect keyframe times, in unique, ordered format.
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 216 of file OgreAnimationTrack.h.
|
pure virtual |
Applies an animation track to the designated target.
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.
Creates a new KeyFrame and adds it to this animation at the given time index.
timePos | The time from which this KeyFrame will apply. |
Create a keyframe implementation - must be overridden.
Implemented in Ogre::NumericAnimationTrack, Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.
Get the handle associated with this track.
Definition at line 146 of file OgreAnimationTrack.h.
|
pure virtual |
Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
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.
Returns the KeyFrame at the specified index.
|
virtual |
Gets the 2 KeyFrame objects which are active at the time given, and the blend value between them.
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 the number of keyframes in this animation.
Animation * Ogre::AnimationTrack::getParent | ( | ) | const |
Returns the parent Animation object for this track.
Definition at line 241 of file OgreAnimationTrack.h.
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 222 of file OgreAnimationTrack.h.
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
Optimise the current track by removing any duplicate keyframes.
Reimplemented in Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.
Definition at line 225 of file OgreAnimationTrack.h.
|
protectedvirtual |
Internal method for clone implementation.
Removes all the KeyFrames from this track.
Removes a KeyFrame by it's index.
Set a listener for this track.
Definition at line 238 of file OgreAnimationTrack.h.
Definition at line 246 of file OgreAnimationTrack.h.
|
protected |
Definition at line 251 of file OgreAnimationTrack.h.
|
protected |
Definition at line 244 of file OgreAnimationTrack.h.
|
protected |
Definition at line 247 of file OgreAnimationTrack.h.
|
protected |
Definition at line 245 of file OgreAnimationTrack.h.