| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Member Functions | List of all members
Ogre::NumericAnimationTrack Class Reference
Core » Animation

Specialised AnimationTrack for dealing with generic animable values. More...

`#include <OgreAnimationTrack.h>`

Inheritance diagram for Ogre::NumericAnimationTrack:
[legend]

## Public Member Functions
| NumericAnimationTrack (Animation *parent, unsigned short handle)
| Constructor. More...
| NumericAnimationTrack (Animation *parent, unsigned short handle, AnimableValuePtr &target)
| Constructor, associates with an AnimableValue. More...
virtual void | _applyBaseKeyFrame (const KeyFrame *base)
| Internal method to re-base the keyframes relative to a given keyframe. More...
virtual void | _buildKeyFrameIndexMap (const std::vector< Real > &keyFrameTimes)
| Internal method to build keyframe time index map to translate global lower bound index to local lower bound index. More...
NumericAnimationTrack * | _clone (Animation *newParent) const
| Clone this track (internal use only) More...
virtual void | _collectKeyFrameTimes (std::vector< Real > &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)
| Applies an animation track to the designated target. More...
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. More...
virtual KeyFrame * | createKeyFrame (Real timePos)
| Creates a new KeyFrame and adds it to this animation at the given time index. More...
virtual NumericKeyFrame * | createNumericKeyFrame (Real timePos)
| Creates a new KeyFrame and adds it to this animation at the given time index. More...
virtual const AnimableValuePtr & | getAssociatedAnimable (void) const
| Returns a pointer to the associated animable 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...
NumericKeyFrame * | getNumericKeyFrame (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 | 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...
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 | setAssociatedAnimable (const AnimableValuePtr &val)
| Sets the associated animable object which will be automatically affected by calls to 'apply'. More...
virtual void | setListener (Listener *l)
| Set a listener for this track. More...

## Detailed Description

Specialised AnimationTrack for dealing with generic animable values.

## Constructor & Destructor Documentation

## ◆ NumericAnimationTrack() [1/2]

Ogre::NumericAnimationTrack::NumericAnimationTrack | ( | Animation * | parent,
|  | unsigned short | handle
| ) |  |

Constructor.

## ◆ NumericAnimationTrack() [2/2]

Ogre::NumericAnimationTrack::NumericAnimationTrack | ( | Animation * | parent,
|  | unsigned short | handle,
|  | AnimableValuePtr & | target
| ) |  |

Constructor, associates with an AnimableValue.

## Member Function Documentation

## ◆ createNumericKeyFrame()

virtual NumericKeyFrame* Ogre::NumericAnimationTrack::createNumericKeyFrame | ( | 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.

## ◆ getInterpolatedKeyFrame()

virtual void Ogre::NumericAnimationTrack::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.

## ◆ apply()

virtual void Ogre::NumericAnimationTrack::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.

## ◆ applyToAnimable()

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.

Parameters

  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.

## ◆ getAssociatedAnimable()

virtual const AnimableValuePtr& Ogre::NumericAnimationTrack::getAssociatedAnimable | ( | void |  | ) | const
| virtual

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

## ◆ setAssociatedAnimable()

virtual void Ogre::NumericAnimationTrack::setAssociatedAnimable | ( | const AnimableValuePtr & | val | ) |
| virtual

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

## ◆ getNumericKeyFrame()

NumericKeyFrame* Ogre::NumericAnimationTrack::getNumericKeyFrame | ( | unsigned short | index | ) | const

Returns the KeyFrame at the specified index.

## ◆ _clone()

NumericAnimationTrack* Ogre::NumericAnimationTrack::_clone | ( | Animation * | newParent | ) | const

Clone this track (internal use only)

## ◆ getHandle()

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

Get the handle associated with this track.

Referenced by Ogre::Lod0Stripifier::StripLod0Vertices().

## ◆ getNumKeyFrames()

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

Returns the number of keyframes in this animation.

## ◆ getKeyFrame()

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

Returns the KeyFrame at the specified index.

## ◆ getKeyFramesAtTime()

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

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 .

## ◆ createKeyFrame()

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

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.

## ◆ removeKeyFrame()

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

Removes a KeyFrame by it's index.

## ◆ removeAllKeyFrames()

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

Removes all the KeyFrames from this track.

## ◆ _keyFrameDataChanged()

virtual void Ogre::AnimationTrack::_keyFrameDataChanged | ( | void |  | ) | const
| inline virtual inherited

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.

## ◆ hasNonZeroKeyFrames()

virtual bool Ogre::AnimationTrack::hasNonZeroKeyFrames | ( | void |  | ) | const
| inline virtual inherited

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

## ◆ optimise()

virtual void Ogre::AnimationTrack::optimise | ( | void |  | ) |
| inline virtual inherited

Optimise the current track by removing any duplicate keyframes.

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

## ◆ _collectKeyFrameTimes()

virtual void Ogre::AnimationTrack::_collectKeyFrameTimes | ( | std::vector< Real > & | keyFrameTimes | ) |
| virtual inherited

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

## ◆ _buildKeyFrameIndexMap()

virtual void Ogre::AnimationTrack::_buildKeyFrameIndexMap | ( | const std::vector< Real > & | keyFrameTimes | ) |
| virtual inherited

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

## ◆ _applyBaseKeyFrame()

virtual void Ogre::AnimationTrack::_applyBaseKeyFrame | ( | const KeyFrame * | base | ) |
| virtual inherited

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

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

## ◆ setListener()

virtual void Ogre::AnimationTrack::setListener | ( | Listener * | l | ) |
| inline virtual inherited

Set a listener for this track.

## ◆ getParent()

Animation* Ogre::AnimationTrack::getParent | ( |  | ) | const
| inline inherited

Returns the parent Animation object for this track.

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

- OgreAnimationTrack.h