Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

Ogre::AnimationTrack Class Reference

A 'track' in an animation sequence, ie a sequence of keyframes which affect a certain type of animable object. More...

#include <OgreAnimationTrack.h>

Collaboration diagram for Ogre::AnimationTrack:

[legend]List of all members.

Public Methods
	AnimationTrack (Animation *parent)
	Constructor.
	AnimationTrack (Animation parent, Node targetNode)
	Constructor, associates with a Node.
virtual	~AnimationTrack ()
unsigned short	getNumKeyFrames (void) const
	Returns the number of keyframes in this animation.
KeyFrame *	getKeyFrame (unsigned short index) const
	Returns the KeyFrame at the specified index.
Real	getKeyFramesAtTime (Real timePos, 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.
KeyFrame *	createKeyFrame (Real timePos)
	Creates a new KeyFrame and adds it to this animation at the given time index.
void	removeKeyFrame (unsigned short index)
	Removes a KeyFrame by it's index.
void	removeAllKeyFrames (void)
	Removes all the KeyFrames from this track.
KeyFrame	getInterpolatedKeyFrame (Real timeIndex) const
	Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
void	apply (Real timePos, Real weight=1.0, bool accumulate=false)
	Applies an animation track at a certain position to the target node.
Node *	getAssociatedNode (void) const
	Returns a pointer to the associated Node object (if any).
void	setAssociatedNode (Node *node)
	Sets the associated Node object which will be automatically affected by calls to 'apply'.
void	applyToNode (Node *node, Real timePos, Real weight=1.0, bool accumulate=false)
	As the 'apply' method but applies to a specified Node instead of associated node.
void	setUseShortestRotationPath (bool useShortestPath)
	Sets the method of rotation calculation.
bool	getUseShortestRotationPath () const
	Gets the method of rotation calculation.
Protected Types
typedef std::vector< KeyFrame * >	KeyFrameList
Protected Methods
void	buildInterpolationSplines (void) const
Protected Attributes
KeyFrameList	mKeyFrames
Real	mMaxKeyFrameTime
Animation *	mParent
Node *	mTargetNode
bool	mSplineBuildNeeded
SimpleSpline	mPositionSpline
SimpleSpline	mScaleSpline
RotationalSpline	mRotationSpline
bool	mUseShortestRotationPath
	Defines if rotation is done using shortest path.

Detailed Description

A 'track' in an animation sequence, ie 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 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.

Definition at line 54 of file OgreAnimationTrack.h.

Member Typedef Documentation

typedef std::vector<KeyFrame*> Ogre::AnimationTrack::KeyFrameList [protected]

Definition at line 149 of file OgreAnimationTrack.h.

Constructor & Destructor Documentation

Ogre::AnimationTrack::AnimationTrack ( Animation * parent )

Constructor.

Definition at line 41 of file OgreAnimationTrack.cpp.
References mMaxKeyFrameTime, mSplineBuildNeeded, mTargetNode, and mUseShortestRotationPath.

Ogre::AnimationTrack::AnimationTrack ( Animation * parent,

Node * targetNode

)

Constructor, associates with a Node.

Definition at line 49 of file OgreAnimationTrack.cpp.
References mMaxKeyFrameTime, mSplineBuildNeeded, and mUseShortestRotationPath.

Ogre::AnimationTrack::~AnimationTrack ( ) [virtual]

Definition at line 57 of file OgreAnimationTrack.cpp.
References removeAllKeyFrames().

Member Function Documentation

void Ogre::AnimationTrack::apply ( Real timePos,

Real weight = 1.0,

bool accumulate = false

)

Applies an animation track at a certain position to the target node.

Remarks:
When a track has bee associated with a target node, you can eaisly apply the animation to the target by calling this method.
Parameters:

timePos 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.

Definition at line 269 of file OgreAnimationTrack.cpp.
References applyToNode(), mTargetNode, and Ogre::Real.

void Ogre::AnimationTrack::applyToNode ( Node * node,

Real timePos,

Real weight = 1.0,

bool accumulate = false

)

As the 'apply' method but applies to a specified Node instead of associated node.

Definition at line 285 of file OgreAnimationTrack.cpp.
References Ogre::Node::_weightedTransform(), getInterpolatedKeyFrame(), Ogre::KeyFrame::getRotation(), Ogre::KeyFrame::getScale(), Ogre::KeyFrame::getTranslate(), Ogre::Real, Ogre::Node::rotate(), Ogre::Node::scale(), and Ogre::Node::translate().
Referenced by apply().

void Ogre::AnimationTrack::buildInterpolationSplines ( void ) const [protected]

Definition at line 329 of file OgreAnimationTrack.cpp.
References Ogre::RotationalSpline::addPoint(), Ogre::SimpleSpline::addPoint(), Ogre::RotationalSpline::clear(), Ogre::SimpleSpline::clear(), mKeyFrames, mPositionSpline, mRotationSpline, mScaleSpline, mSplineBuildNeeded, Ogre::RotationalSpline::recalcTangents(), Ogre::SimpleSpline::recalcTangents(), Ogre::RotationalSpline::setAutoCalculate(), and Ogre::SimpleSpline::setAutoCalculate().
Referenced by getInterpolatedKeyFrame().

KeyFrame * Ogre::AnimationTrack::createKeyFrame ( Real timePos )

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.

Definition at line 139 of file OgreAnimationTrack.cpp.
References mKeyFrames, mMaxKeyFrameTime, mSplineBuildNeeded, and Ogre::Real.
Referenced by Ogre::SkeletonSerializer::readKeyFrame().

Node * Ogre::AnimationTrack::getAssociatedNode ( void ) const

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

Definition at line 275 of file OgreAnimationTrack.cpp.
References mTargetNode.
Referenced by Ogre::Skeleton::_dumpContents(), and Ogre::SkeletonSerializer::writeAnimationTrack().

KeyFrame Ogre::AnimationTrack::getInterpolatedKeyFrame ( Real timeIndex ) const

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)

Returns:
A new keyframe object containing the interpolated transforms. Note that the position and scaling transforms are linearly interpolated (lerp), whilst the rotation is spherically linearly interpolated (slerp) for the most natural result.

Definition at line 200 of file OgreAnimationTrack.cpp.
References buildInterpolationSplines(), Ogre::Animation::getInterpolationMode(), getKeyFramesAtTime(), Ogre::KeyFrame::getRotation(), Ogre::KeyFrame::getScale(), Ogre::KeyFrame::getTranslate(), Ogre::SimpleSpline::interpolate(), Ogre::RotationalSpline::interpolate(), mParent, mPositionSpline, mRotationSpline, mScaleSpline, mUseShortestRotationPath, Ogre::Real, Ogre::KeyFrame::setRotation(), Ogre::KeyFrame::setScale(), and Ogre::KeyFrame::setTranslate().
Referenced by applyToNode().

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

Returns the KeyFrame at the specified index.

Definition at line 67 of file OgreAnimationTrack.cpp.
References mKeyFrames, and Ogre::ushort.
Referenced by Ogre::Skeleton::_dumpContents(), Ogre::SkeletonSerializer::calcAnimationTrackSize(), and Ogre::SkeletonSerializer::writeAnimationTrack().

Real Ogre::AnimationTrack::getKeyFramesAtTime ( Real timePos,

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.

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:

timePos The time index in seconds.

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 incase the caller needs it.

Returns:
Parametric value indicating how far along the gap between the 2 keyframes the timePos 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 .

Definition at line 75 of file OgreAnimationTrack.cpp.
References Ogre::Animation::getLength(), Ogre::KeyFrame::getTime(), mKeyFrames, mParent, and Ogre::Real.
Referenced by getInterpolatedKeyFrame().

unsigned short Ogre::AnimationTrack::getNumKeyFrames ( void ) const

Returns the number of keyframes in this animation.

Definition at line 62 of file OgreAnimationTrack.cpp.
References mKeyFrames.
Referenced by Ogre::Skeleton::_dumpContents(), Ogre::SkeletonSerializer::calcAnimationTrackSize(), and Ogre::SkeletonSerializer::writeAnimationTrack().

bool Ogre::AnimationTrack::getUseShortestRotationPath ( ) const

Gets the method of rotation calculation.

Definition at line 364 of file OgreAnimationTrack.cpp.
References mUseShortestRotationPath.

void Ogre::AnimationTrack::removeAllKeyFrames ( void )

Removes all the KeyFrames from this track.

Definition at line 185 of file OgreAnimationTrack.cpp.
References mKeyFrames, and mSplineBuildNeeded.
Referenced by ~AnimationTrack().

void Ogre::AnimationTrack::removeKeyFrame ( unsigned short index )

Removes a KeyFrame by it's index.

Definition at line 167 of file OgreAnimationTrack.cpp.
References mKeyFrames, mSplineBuildNeeded, and Ogre::ushort.

void Ogre::AnimationTrack::setAssociatedNode ( Node * node )

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

Definition at line 280 of file OgreAnimationTrack.cpp.
References mTargetNode.
Referenced by Ogre::Animation::createTrack().

void Ogre::AnimationTrack::setUseShortestRotationPath ( bool useShortestPath )

Sets the method of rotation calculation.

Definition at line 358 of file OgreAnimationTrack.cpp.
References mUseShortestRotationPath.

Member Data Documentation

KeyFrameList Ogre::AnimationTrack::mKeyFrames [protected]

Definition at line 150 of file OgreAnimationTrack.h.
Referenced by buildInterpolationSplines(), createKeyFrame(), getKeyFrame(), getKeyFramesAtTime(), getNumKeyFrames(), removeAllKeyFrames(), and removeKeyFrame().

Real Ogre::AnimationTrack::mMaxKeyFrameTime [protected]

Definition at line 151 of file OgreAnimationTrack.h.
Referenced by AnimationTrack(), and createKeyFrame().

Animation* Ogre::AnimationTrack::mParent [protected]

Definition at line 152 of file OgreAnimationTrack.h.
Referenced by getInterpolatedKeyFrame(), and getKeyFramesAtTime().

SimpleSpline Ogre::AnimationTrack::mPositionSpline [protected]

Definition at line 160 of file OgreAnimationTrack.h.
Referenced by buildInterpolationSplines(), and getInterpolatedKeyFrame().

RotationalSpline Ogre::AnimationTrack::mRotationSpline [protected]

Definition at line 162 of file OgreAnimationTrack.h.
Referenced by buildInterpolationSplines(), and getInterpolatedKeyFrame().

SimpleSpline Ogre::AnimationTrack::mScaleSpline [protected]

Definition at line 161 of file OgreAnimationTrack.h.
Referenced by buildInterpolationSplines(), and getInterpolatedKeyFrame().

bool Ogre::AnimationTrack::mSplineBuildNeeded [protected]

Definition at line 159 of file OgreAnimationTrack.h.
Referenced by AnimationTrack(), buildInterpolationSplines(), createKeyFrame(), removeAllKeyFrames(), and removeKeyFrame().

Node* Ogre::AnimationTrack::mTargetNode [protected]

Definition at line 153 of file OgreAnimationTrack.h.
Referenced by AnimationTrack(), apply(), getAssociatedNode(), and setAssociatedNode().

bool Ogre::AnimationTrack::mUseShortestRotationPath [protected]

Defines if rotation is done using shortest path.

Definition at line 164 of file OgreAnimationTrack.h.
Referenced by AnimationTrack(), getInterpolatedKeyFrame(), getUseShortestRotationPath(), and setUseShortestRotationPath().

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

Ogre::AnimationTrack Class Reference

Public Methods

Protected Types

Protected Methods

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation