OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::NodeAnimationTrack Class Reference

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

#include <OgreAnimationTrack.h>

+ Inheritance diagram for Ogre::NodeAnimationTrack:

Public Member Functions

 NodeAnimationTrack (Animation *parent, unsigned short handle)
 Constructor. More...
 
 NodeAnimationTrack (Animation *parent, unsigned short handle, Node *targetNode)
 Constructor, associates with a Node. More...
 
virtual ~NodeAnimationTrack ()
 Destructor. More...
 
void _applyBaseKeyFrame (const KeyFrame *base)
 Internal method to re-base the keyframes relative to a given keyframe. More...
 
NodeAnimationTrack_clone (Animation *newParent) const
 Clone this track (internal use only) More...
 
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...
 
virtual void applyToNode (Node *node, const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
 As the 'apply' method but applies to a specified Node instead of associated node. More...
 
virtual TransformKeyFramecreateNodeKeyFrame (Real timePos)
 Creates a new KeyFrame and adds it to this animation at the given time index. More...
 
virtual NodegetAssociatedNode (void) const
 Returns a pointer to the associated Node object (if any). 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 TransformKeyFramegetNodeKeyFrame (unsigned short index) const
 Returns the KeyFrame at the specified index. More...
 
virtual bool getUseShortestRotationPath () const
 Gets the method of rotation calculation. 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 setAssociatedNode (Node *node)
 Sets the associated Node object which will be automatically affected by calls to 'apply'. More...
 
virtual void setUseShortestRotationPath (bool useShortestPath)
 Sets the method of rotation calculation. More...
 
- Public Member Functions inherited from Ogre::AnimationTrack
 AnimationTrack (Animation *parent, unsigned short handle)
 Constructor. More...
 
virtual ~AnimationTrack ()
 
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 KeyFramecreateKeyFrame (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 KeyFramegetKeyFrame (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...
 
virtual unsigned short getNumKeyFrames (void) const
 Returns the number of keyframes in this animation. More...
 
AnimationgetParent () const
 Returns the parent Animation object for this track. 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...
 

Detailed Description

Specialised AnimationTrack for dealing with node transforms.

Constructor & Destructor Documentation

◆ NodeAnimationTrack() [1/2]

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

Constructor.

◆ NodeAnimationTrack() [2/2]

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

Constructor, associates with a Node.

◆ ~NodeAnimationTrack()

virtual Ogre::NodeAnimationTrack::~NodeAnimationTrack ( )
virtual

Destructor.

Member Function Documentation

◆ createNodeKeyFrame()

virtual TransformKeyFrame* Ogre::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
timePosThe time from which this KeyFrame will apply.

◆ getAssociatedNode()

virtual Node* Ogre::NodeAnimationTrack::getAssociatedNode ( void  ) const
virtual

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

◆ setAssociatedNode()

virtual void Ogre::NodeAnimationTrack::setAssociatedNode ( Node node)
virtual

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

◆ applyToNode()

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

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

◆ setUseShortestRotationPath()

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

Sets the method of rotation calculation.

◆ getUseShortestRotationPath()

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

Gets the method of rotation calculation.

◆ getInterpolatedKeyFrame()

virtual void Ogre::NodeAnimationTrack::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
timeIndexThe time (in relation to the whole animation sequence)
kfKeyframe object to store results

Implements Ogre::AnimationTrack.

◆ apply()

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

Applies an animation track to the designated target.

Parameters
timeIndexThe time position in the animation to apply.
weightThe influence to give to this track, 1.0 for full influence, less to blend with other animations.
scaleThe scale to apply to translations and scalings, useful for adapting an animation to a different size target.

Implements Ogre::AnimationTrack.

◆ _keyFrameDataChanged()

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

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

◆ getNodeKeyFrame()

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

Returns the KeyFrame at the specified index.

◆ hasNonZeroKeyFrames()

virtual bool Ogre::NodeAnimationTrack::hasNonZeroKeyFrames ( void  ) const
virtual

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

◆ optimise()

virtual void Ogre::NodeAnimationTrack::optimise ( void  )
virtual

Optimise the current track by removing any duplicate keyframes.

Reimplemented from Ogre::AnimationTrack.

◆ _clone()

NodeAnimationTrack* Ogre::NodeAnimationTrack::_clone ( Animation newParent) const

Clone this track (internal use only)

◆ _applyBaseKeyFrame()

void Ogre::NodeAnimationTrack::_applyBaseKeyFrame ( const KeyFrame base)
virtual

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

Reimplemented from Ogre::AnimationTrack.


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