Specialised AnimationTrack for dealing with generic animable values. More...
#include <OgreAnimationTrack.h>
Public Member Functions | |
NumericAnimationTrack (Animation *parent, unsigned short handle) | |
Constructor. | |
NumericAnimationTrack (Animation *parent, unsigned short handle, AnimableValuePtr &target) | |
Constructor, associates with an AnimableValue. | |
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. | |
NumericAnimationTrack * | _clone (Animation *newParent) const |
Clone this track (internal use only) | |
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) |
Applies an animation track to the designated target. | |
void | applyToAnimable (const AnimableValuePtr &anim, const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f) |
Applies an animation track to a given animable value. | |
virtual KeyFrame * | createKeyFrame (Real timePos) |
Creates a new KeyFrame and adds it to this animation at the given time index. | |
virtual NumericKeyFrame * | createNumericKeyFrame (Real timePos) |
Creates a new KeyFrame and adds it to this animation at the given time index. | |
virtual const AnimableValuePtr & | getAssociatedAnimable (void) const |
Returns a pointer to the associated animable object (if any). | |
unsigned short | getHandle (void) const |
Get the handle associated with this track. | |
virtual void | getInterpolatedKeyFrame (const TimeIndex &timeIndex, KeyFrame *kf) const |
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. | |
NumericKeyFrame * | getNumericKeyFrame (unsigned short index) const |
Returns the KeyFrame at the specified index. | |
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 | setAssociatedAnimable (const AnimableValuePtr &val) |
Sets the associated animable object which will be automatically affected by calls to 'apply'. | |
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 | |
KeyFrame * | createKeyFrameImpl (Real time) |
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 |
AnimableValuePtr | mTargetAnim |
Target to animate. | |
Specialised AnimationTrack for dealing with generic animable values.
Definition at line 265 of file OgreAnimationTrack.h.
|
protectedinherited |
Map used to translate global keyframe time lower bound index to local lower bound index.
Definition at line 250 of file OgreAnimationTrack.h.
|
protectedinherited |
Definition at line 243 of file OgreAnimationTrack.h.
Constructor.
Ogre::NumericAnimationTrack::NumericAnimationTrack | ( | Animation * | parent, |
unsigned short | handle, | ||
AnimableValuePtr & | target | ||
) |
Constructor, associates with an AnimableValue.
Internal method to re-base the keyframes relative to a given keyframe.
Reimplemented in Ogre::NodeAnimationTrack, and Ogre::VertexAnimationTrack.
Definition at line 235 of file OgreAnimationTrack.h.
|
virtualinherited |
Internal method to build keyframe time index map to translate global lower bound index to local lower bound index.
NumericAnimationTrack * Ogre::NumericAnimationTrack::_clone | ( | Animation * | newParent | ) | const |
Clone this track (internal use only)
|
virtualinherited |
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.
|
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. |
Implements Ogre::AnimationTrack.
void Ogre::NumericAnimationTrack::applyToAnimable | ( | const AnimableValuePtr & | anim, |
const TimeIndex & | timeIndex, | ||
Real | weight = 1.0 , |
||
Real | scale = 1.0f |
||
) |
Applies an animation track to a given animable value.
anim | The AnimableValue to which to apply the animation |
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. |
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.
Implements Ogre::AnimationTrack.
|
virtual |
Creates a new KeyFrame and adds it to this animation at the given time index.
timePos | The time from which this KeyFrame will apply. |
|
virtual |
Returns a pointer to the associated animable object (if any).
Get the handle associated with this track.
Definition at line 146 of file OgreAnimationTrack.h.
|
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 |
Implements Ogre::AnimationTrack.
Returns the KeyFrame at the specified index.
|
virtualinherited |
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. |
NumericKeyFrame * Ogre::NumericAnimationTrack::getNumericKeyFrame | ( | unsigned short | index | ) | const |
Returns the KeyFrame at the specified index.
Returns the number of keyframes in this animation.
|
inherited |
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.
|
protectedvirtualinherited |
Internal method for clone implementation.
Removes all the KeyFrames from this track.
Removes a KeyFrame by it's index.
|
virtual |
Sets the associated animable object which will be automatically affected by calls to 'apply'.
Set a listener for this track.
Definition at line 238 of file OgreAnimationTrack.h.
Definition at line 246 of file OgreAnimationTrack.h.
|
protectedinherited |
Definition at line 251 of file OgreAnimationTrack.h.
|
protectedinherited |
Definition at line 244 of file OgreAnimationTrack.h.
|
protectedinherited |
Definition at line 247 of file OgreAnimationTrack.h.
|
protectedinherited |
Definition at line 245 of file OgreAnimationTrack.h.
|
protected |
Target to animate.
Definition at line 316 of file OgreAnimationTrack.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.