#include <OgreAnimationTrack.h>
Public Types | ||||||||||
enum | TargetMode { TM_SOFTWARE, TM_HARDWARE } | |||||||||
The target animation mode. More... | ||||||||||
Public Member Functions | ||||||||||
VertexAnimationTrack (Animation *parent, unsigned short handle, VertexAnimationType animType) | ||||||||||
Constructor. | ||||||||||
VertexAnimationTrack (Animation *parent, unsigned short handle, VertexAnimationType animType, VertexData *targetData, TargetMode target=TM_SOFTWARE) | ||||||||||
Constructor, associates with target VertexData and temp buffer (for software). | ||||||||||
VertexAnimationType | getAnimationType (void) const | |||||||||
Get the type of vertex animation we're performing. | ||||||||||
virtual VertexMorphKeyFrame * | createVertexMorphKeyFrame (Real timePos) | |||||||||
Creates a new morph KeyFrame and adds it to this animation at the given time index. | ||||||||||
virtual VertexPoseKeyFrame * | createVertexPoseKeyFrame (Real timePos) | |||||||||
Creates the single pose KeyFrame and adds it to this animation. | ||||||||||
virtual void | getInterpolatedKeyFrame (const TimeIndex &timeIndex, KeyFrame *kf) const | |||||||||
This method in fact does nothing, since interpolation is not performed inside the keyframes for this type of track. | ||||||||||
virtual void | apply (const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f) | |||||||||
Applies an animation track to the designated target.
| ||||||||||
virtual void | applyToVertexData (VertexData *data, const TimeIndex &timeIndex, Real weight=1.0, const PoseList *poseList=0) | |||||||||
As the 'apply' method but applies to specified VertexData instead of associated data. | ||||||||||
VertexMorphKeyFrame * | getVertexMorphKeyFrame (unsigned short index) const | |||||||||
Returns the morph KeyFrame at the specified index. | ||||||||||
VertexPoseKeyFrame * | getVertexPoseKeyFrame (unsigned short index) const | |||||||||
Returns the pose KeyFrame at the specified index. | ||||||||||
void | setAssociatedVertexData (VertexData *data) | |||||||||
Sets the associated VertexData which this track will update. | ||||||||||
VertexData * | getAssociatedVertexData (void) const | |||||||||
Gets the associated VertexData which this track will update. | ||||||||||
void | setTargetMode (TargetMode m) | |||||||||
Set the target mode. | ||||||||||
TargetMode | getTargetMode (void) const | |||||||||
Get the target mode. | ||||||||||
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. | ||||||||||
virtual void | optimise (void) | |||||||||
Optimise the current track by removing any duplicate keyframes. | ||||||||||
VertexAnimationTrack * | _clone (Animation *newParent) const | |||||||||
Clone this track (internal use only). | ||||||||||
unsigned short | getHandle (void) const | |||||||||
Get the handle associated with this track. | ||||||||||
virtual unsigned short | getNumKeyFrames (void) const | |||||||||
Returns the number of keyframes in this animation. | ||||||||||
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 KeyFrame * | createKeyFrame (Real timePos) | |||||||||
Creates a new KeyFrame and adds it to this animation at the given time index. | ||||||||||
virtual void | removeKeyFrame (unsigned short index) | |||||||||
Removes a KeyFrame by it's index. | ||||||||||
virtual void | removeAllKeyFrames (void) | |||||||||
Removes all the KeyFrames from this track. | ||||||||||
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. | ||||||||||
virtual void | _collectKeyFrameTimes (std::vector< Real > &keyFrameTimes) | |||||||||
Internal method to collect keyframe times, in unique, ordered format. | ||||||||||
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. | ||||||||||
Protected Types | ||||||||||
typedef std::vector < KeyFrame * > | KeyFrameList | |||||||||
typedef std::vector < ushort > | KeyFrameIndexMap | |||||||||
Map used to translate global keyframe time lower bound index to local lower bound index. | ||||||||||
Protected Member Functions | ||||||||||
KeyFrame * | createKeyFrameImpl (Real time) | |||||||||
Create a keyframe implementation - must be overridden. | ||||||||||
void | applyPoseToVertexData (const Pose *pose, VertexData *data, Real influence) | |||||||||
Utility method for applying pose animation. | ||||||||||
virtual void | populateClone (AnimationTrack *clone) const | |||||||||
Internal method for clone implementation. | ||||||||||
Protected Attributes | ||||||||||
VertexAnimationType | mAnimationType | |||||||||
Animation type. | ||||||||||
VertexData * | mTargetVertexData | |||||||||
Target to animate. | ||||||||||
TargetMode | mTargetMode | |||||||||
Mode to apply. | ||||||||||
KeyFrameList | mKeyFrames | |||||||||
Animation * | mParent | |||||||||
unsigned short | mHandle | |||||||||
KeyFrameIndexMap | mKeyFrameIndexMap |
Definition at line 452 of file OgreAnimationTrack.h.
typedef std::vector<KeyFrame*> Ogre::AnimationTrack::KeyFrameList [protected, inherited] |
Definition at line 216 of file OgreAnimationTrack.h.
typedef std::vector<ushort> Ogre::AnimationTrack::KeyFrameIndexMap [protected, inherited] |
Map used to translate global keyframe time lower bound index to local lower bound index.
Definition at line 222 of file OgreAnimationTrack.h.
The target animation mode.
TM_SOFTWARE | Interpolate vertex positions in software. |
TM_HARDWARE | Bind keyframe 1 to position, and keyframe 2 to a texture coordinate for interpolation in hardware. |
Definition at line 456 of file OgreAnimationTrack.h.
Ogre::VertexAnimationTrack::VertexAnimationTrack | ( | Animation * | parent, | |
unsigned short | handle, | |||
VertexAnimationType | animType | |||
) |
Constructor.
Ogre::VertexAnimationTrack::VertexAnimationTrack | ( | Animation * | parent, | |
unsigned short | handle, | |||
VertexAnimationType | animType, | |||
VertexData * | targetData, | |||
TargetMode | target = TM_SOFTWARE | |||
) |
Constructor, associates with target VertexData and temp buffer (for software).
VertexAnimationType Ogre::VertexAnimationTrack::getAnimationType | ( | void | ) | const |
Get the type of vertex animation we're performing.
Definition at line 471 of file OgreAnimationTrack.h.
virtual VertexMorphKeyFrame* Ogre::VertexAnimationTrack::createVertexMorphKeyFrame | ( | Real | timePos | ) | [virtual] |
Creates a new morph KeyFrame and adds it to this animation at the given time index.
timePos | The time from which this KeyFrame will apply. |
virtual VertexPoseKeyFrame* Ogre::VertexAnimationTrack::createVertexPoseKeyFrame | ( | Real | timePos | ) | [virtual] |
Creates the single pose KeyFrame and adds it to this animation.
virtual void Ogre::VertexAnimationTrack::getInterpolatedKeyFrame | ( | const TimeIndex & | timeIndex, | |
KeyFrame * | kf | |||
) | const [virtual] |
This method in fact does nothing, since interpolation is not performed inside the keyframes for this type of track.
Implements Ogre::AnimationTrack.
Definition at line 489 of file OgreAnimationTrack.h.
virtual void Ogre::VertexAnimationTrack::apply | ( | const TimeIndex & | timeIndex, | |
Real | weight = 1.0 , |
|||
Real | scale = 1.0f | |||
) | [virtual] |
Applies an animation track to the designated target.
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.
virtual void Ogre::VertexAnimationTrack::applyToVertexData | ( | VertexData * | data, | |
const TimeIndex & | timeIndex, | |||
Real | weight = 1.0 , |
|||
const PoseList * | poseList = 0 | |||
) | [virtual] |
As the 'apply' method but applies to specified VertexData instead of associated data.
VertexMorphKeyFrame* Ogre::VertexAnimationTrack::getVertexMorphKeyFrame | ( | unsigned short | index | ) | const |
Returns the morph KeyFrame at the specified index.
VertexPoseKeyFrame* Ogre::VertexAnimationTrack::getVertexPoseKeyFrame | ( | unsigned short | index | ) | const |
Returns the pose KeyFrame at the specified index.
void Ogre::VertexAnimationTrack::setAssociatedVertexData | ( | VertexData * | data | ) |
Sets the associated VertexData which this track will update.
Definition at line 508 of file OgreAnimationTrack.h.
VertexData* Ogre::VertexAnimationTrack::getAssociatedVertexData | ( | void | ) | const |
Gets the associated VertexData which this track will update.
Definition at line 510 of file OgreAnimationTrack.h.
void Ogre::VertexAnimationTrack::setTargetMode | ( | TargetMode | m | ) |
TargetMode Ogre::VertexAnimationTrack::getTargetMode | ( | void | ) | const |
virtual bool Ogre::VertexAnimationTrack::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.
virtual void Ogre::VertexAnimationTrack::optimise | ( | void | ) | [virtual] |
Optimise the current track by removing any duplicate keyframes.
Reimplemented from Ogre::AnimationTrack.
VertexAnimationTrack* Ogre::VertexAnimationTrack::_clone | ( | Animation * | newParent | ) | const |
Clone this track (internal use only).
void Ogre::VertexAnimationTrack::applyPoseToVertexData | ( | const Pose * | pose, | |
VertexData * | data, | |||
Real | influence | |||
) | [protected] |
Utility method for applying pose animation.
unsigned short Ogre::AnimationTrack::getHandle | ( | void | ) | const [inherited] |
virtual unsigned short Ogre::AnimationTrack::getNumKeyFrames | ( | void | ) | const [virtual, inherited] |
Returns the number of keyframes in this animation.
virtual KeyFrame* Ogre::AnimationTrack::getKeyFrame | ( | unsigned short | index | ) | const [virtual, inherited] |
Returns the KeyFrame at the specified index.
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.
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 incase the caller needs it. |
Creates a new KeyFrame and adds it to this animation at the given time index.
timePos | The time from which this KeyFrame will apply. |
virtual void Ogre::AnimationTrack::removeKeyFrame | ( | unsigned short | index | ) | [virtual, inherited] |
Removes a KeyFrame by it's index.
virtual void Ogre::AnimationTrack::removeAllKeyFrames | ( | void | ) | [virtual, inherited] |
Removes all the KeyFrames from this track.
virtual void Ogre::AnimationTrack::_keyFrameDataChanged | ( | void | ) | const [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.
Definition at line 197 of file OgreAnimationTrack.h.
virtual void Ogre::AnimationTrack::_collectKeyFrameTimes | ( | std::vector< Real > & | keyFrameTimes | ) | [virtual, inherited] |
Internal method to collect keyframe times, in unique, ordered format.
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.
virtual void Ogre::AnimationTrack::populateClone | ( | AnimationTrack * | clone | ) | const [protected, virtual, inherited] |
Internal method for clone implementation.
VertexData* Ogre::VertexAnimationTrack::mTargetVertexData [protected] |
TargetMode Ogre::VertexAnimationTrack::mTargetMode [protected] |
KeyFrameList Ogre::AnimationTrack::mKeyFrames [protected, inherited] |
Definition at line 217 of file OgreAnimationTrack.h.
Animation* Ogre::AnimationTrack::mParent [protected, inherited] |
Definition at line 218 of file OgreAnimationTrack.h.
unsigned short Ogre::AnimationTrack::mHandle [protected, inherited] |
Definition at line 219 of file OgreAnimationTrack.h.
KeyFrameIndexMap Ogre::AnimationTrack::mKeyFrameIndexMap [protected, inherited] |
Definition at line 223 of file OgreAnimationTrack.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:25:15 2008