|
| 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 std::vector< Real > &keyFrameTimes) |
| Internal method to build keyframe time index map to translate global lower bound index to local lower bound index. 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)=0 |
| Applies an animation track to the designated target. More...
|
|
virtual KeyFrame * | createKeyFrame (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...
|
|
KeyFrame * | getKeyFrame (size_t 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...
|
|
size_t | 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 | setListener (Listener *l) |
| Set a listener for this track. More...
|
|
A 'track' in an animation sequence, i.e.
a sequence of keyframes which affect a certain type of animable object.
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 Node, there are options in this class for associating the track with a Node 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.
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.
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 |
Implemented in Ogre::VertexAnimationTrack, Ogre::NodeAnimationTrack, and Ogre::NumericAnimationTrack.