Ogre::v1::NodeAnimationTrack Class Reference

Specialised AnimationTrack for dealing with node transforms. More...

#include <OgreAnimationTrack.h>

Inheritance diagram for Ogre::v1::NodeAnimationTrack:

Public Member Functions
	NodeAnimationTrack (Animation *parent, unsigned short handle)
	Constructor.
	NodeAnimationTrack (Animation *parent, unsigned short handle, Node *targetNode)
	Constructor, associates with a OldNode.
	~NodeAnimationTrack () override
	Destructor.
void	_applyBaseKeyFrame (const KeyFrame *base) override
	Internal method to re-base the keyframes relative to a given keyframe.
NodeAnimationTrack *	_clone (Animation *newParent) const
	Clone this track (internal use only)
void	_keyFrameDataChanged () const override
	Internal method used to tell the track that keyframe data has been changed, which may cause it to rebuild some internal data.
void	apply (const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f) override
	Applies an animation track to the designated target.
void	applyToNode (Node *node, const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
	As the 'apply' method but applies to a specified OldNode instead of associated node.
virtual TransformKeyFrame *	createNodeKeyFrame (Real timePos)
	Creates a new KeyFrame and adds it to this animation at the given time index.
Node *	getAssociatedNode () const
	Returns a pointer to the associated OldNode object (if any).
void	getInitialState (Vector3 *outPosition, Quaternion *outOrientation, Vector3 *outScale)
	Get the initial state of the node for this track.
void	getInterpolatedKeyFrame (const TimeIndex &timeIndex, KeyFrame *kf) const override
	Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
virtual TransformKeyFrame *	getNodeKeyFrame (unsigned short index) const
	Returns the KeyFrame at the specified index.
virtual bool	getUseShortestRotationPath () const
	Gets the method of rotation calculation.
bool	hasNonZeroKeyFrames () const override
	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	optimise () override
	Optimise the current track by removing any duplicate keyframes.
void	resetNodeToInitialState ()
	Resets the the target node to the initial state.
void	setAssociatedNode (Node *node)
	Sets the associated OldNode object which will be automatically affected by calls to 'apply'.
void	setInitialState (const Vector3 &position, const Quaternion &orientation, const Vector3 &scale)
	Set the initial state of the node for this animation track.
virtual void	setUseShortestRotationPath (bool useShortestPath)
	Sets the method of rotation calculation.
Public Member Functions inherited from Ogre::v1::AnimationTrack
	AnimationTrack (Animation *parent, unsigned short handle)
	Constructor.
virtual	~AnimationTrack ()
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 KeyFrame *	createKeyFrame (Real timePos)
	Creates a new KeyFrame and adds it to this animation at the given time index.
unsigned short	getHandle () const
	Get the handle associated with this track.
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 () const
	Returns the number of keyframes in this animation.
Animation *	getParent () const
	Returns the parent Animation object for this track.
virtual void	removeAllKeyFrames ()
	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.

Detailed Description

Specialised AnimationTrack for dealing with node transforms.

Constructor & Destructor Documentation

NodeAnimationTrack() [1/2]

Ogre::v1::NodeAnimationTrack::NodeAnimationTrack	(	Animation *	parent,
		unsigned short	handle
	)

Constructor.

NodeAnimationTrack() [2/2]

Ogre::v1::NodeAnimationTrack::NodeAnimationTrack	(	Animation *	parent,
		unsigned short	handle,
		Node *	targetNode
	)

Constructor, associates with a OldNode.

~NodeAnimationTrack()

Ogre::v1::NodeAnimationTrack::~NodeAnimationTrack ( )

override

Destructor.

Member Function Documentation

_applyBaseKeyFrame()

void Ogre::v1::NodeAnimationTrack::_applyBaseKeyFrame ( const KeyFrame *  base )

overridevirtual

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

Reimplemented from Ogre::v1::AnimationTrack.

_clone()

NodeAnimationTrack * Ogre::v1::NodeAnimationTrack::_clone

(

Animation *

newParent

)

const

Clone this track (internal use only)

_keyFrameDataChanged()

void Ogre::v1::NodeAnimationTrack::_keyFrameDataChanged ( ) const

overridevirtual

Internal method used to tell the track that keyframe data has been changed, which may cause it to rebuild some internal data.

Reimplemented from Ogre::v1::AnimationTrack.

apply()

void Ogre::v1::NodeAnimationTrack::apply ( const TimeIndex &  timeIndex, Real  weight = 1.0, Real  scale = 1.0f  )

overridevirtual

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::v1::AnimationTrack.

applyToNode()

void Ogre::v1::NodeAnimationTrack::applyToNode	(	Node *	node,
		const TimeIndex &	timeIndex,
		Real	weight = 1.0,
		Real	scale = 1.0f
	)

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

createNodeKeyFrame()

virtual TransformKeyFrame * Ogre::v1::NodeAnimationTrack::createNodeKeyFrame ( 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.

getAssociatedNode()

Node * Ogre::v1::NodeAnimationTrack::getAssociatedNode

(

)

const

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

getInitialState()

void Ogre::v1::NodeAnimationTrack::getInitialState	(	Vector3 *	outPosition,
		Quaternion *	outOrientation,
		Vector3 *	outScale
	)

Get the initial state of the node for this track.

Remarks

Node tracks are based from an initial state, which the node is set to every frame before the node animation is applied See NodeAnimationTrack::getInitialState for more information

getInterpolatedKeyFrame()

void Ogre::v1::NodeAnimationTrack::getInterpolatedKeyFrame ( const TimeIndex &  timeIndex, KeyFrame *  kf  ) const

overridevirtual

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::v1::AnimationTrack.

getNodeKeyFrame()

virtual TransformKeyFrame * Ogre::v1::NodeAnimationTrack::getNodeKeyFrame ( unsigned short  index ) const

virtual

Returns the KeyFrame at the specified index.

getUseShortestRotationPath()

virtual bool Ogre::v1::NodeAnimationTrack::getUseShortestRotationPath ( ) const

virtual

Gets the method of rotation calculation.

hasNonZeroKeyFrames()

bool Ogre::v1::NodeAnimationTrack::hasNonZeroKeyFrames ( ) const

overridevirtual

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 from Ogre::v1::AnimationTrack.

optimise()

void Ogre::v1::NodeAnimationTrack::optimise ( )

overridevirtual

Optimise the current track by removing any duplicate keyframes.

Reimplemented from Ogre::v1::AnimationTrack.

resetNodeToInitialState()

void Ogre::v1::NodeAnimationTrack::resetNodeToInitialState

(

)

Resets the the target node to the initial state.

Remarks

This is called everyframe before the animation is applied.

See also

setInitialState

setAssociatedNode()

void Ogre::v1::NodeAnimationTrack::setAssociatedNode

(

Node *

node

)

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

setInitialState()

void Ogre::v1::NodeAnimationTrack::setInitialState	(	const Vector3 &	position,
		const Quaternion &	orientation,
		const Vector3 &	scale
	)

Set the initial state of the node for this animation track.

Remarks

Node tracks are based from an initial state, which the node is set to every frame before the node animation is applied Most 3D model exporters base each animation frame from a 0 transform, which is the defaults. However in some situations you may want to change this.

Parameters

position	The initial position to set
orientation	The initial orientation to set
scale	The initial scale to set

setUseShortestRotationPath()

virtual void Ogre::v1::NodeAnimationTrack::setUseShortestRotationPath ( bool  useShortestPath )

virtual

Sets the method of rotation calculation.

---

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

• OgreAnimationTrack.h