An animation sequence. More...
#include <OgreAnimation.h>
Public Types | |
enum | InterpolationMode { IM_LINEAR, IM_SPLINE } |
The types of animation interpolation available. More... | |
typedef ConstMapIterator < NodeTrackList > | NodeTrackIterator |
typedef map< unsigned short, NodeAnimationTrack * >::type | NodeTrackList |
typedef ConstMapIterator < NumericTrackList > | NumericTrackIterator |
typedef map< unsigned short, NumericAnimationTrack * > ::type | NumericTrackList |
enum | RotationInterpolationMode { RIM_LINEAR, RIM_SPHERICAL } |
The types of rotational interpolation available. More... | |
typedef set< ushort >::type | TrackHandleList |
A list of track handles. More... | |
typedef ConstMapIterator < VertexTrackList > | VertexTrackIterator |
typedef map< unsigned short, VertexAnimationTrack * >::type | VertexTrackList |
Public Member Functions | |
Animation (const String &name, Real length) | |
You should not use this constructor directly, use the parent object such as Skeleton instead. More... | |
virtual | ~Animation () |
void | _applyBaseKeyFrame () |
Internal method to adjust keyframes relative to a base keyframe (. More... | |
void | _collectIdentityNodeTracks (TrackHandleList &tracks) const |
Internal method for collecting identity node tracks. More... | |
void | _destroyNodeTracks (const TrackHandleList &tracks) |
Internal method for destroy given node tracks. More... | |
const NodeTrackList & | _getNodeTrackList (void) const |
Fast access to NON-UPDATEABLE node track list. More... | |
const NumericTrackList & | _getNumericTrackList (void) const |
Fast access to NON-UPDATEABLE numeric track list. More... | |
TimeIndex | _getTimeIndex (Real timePos) const |
Internal method used to convert time position to time index object. More... | |
const VertexTrackList & | _getVertexTrackList (void) const |
Fast access to NON-UPDATEABLE Vertex track list. More... | |
void | _keyFrameListChanged (void) |
Internal method used to tell the animation that keyframe list has been changed, which may cause it to rebuild some internal data. More... | |
void | _notifyContainer (AnimationContainer *c) |
void | apply (Real timePos, Real weight=1.0, Real scale=1.0f) |
Applies an animation given a specific time point and weight. More... | |
void | apply (Skeleton *skeleton, Real timePos, Real weight=1.0, Real scale=1.0f) |
Applies all node tracks given a specific time point and weight to a given skeleton. More... | |
void | apply (Skeleton *skeleton, Real timePos, float weight, const AnimationState::BoneBlendMask *blendMask, Real scale) |
Applies all node tracks given a specific time point and weight to a given skeleton. More... | |
void | apply (Entity *entity, Real timePos, Real weight, bool software, bool hardware) |
Applies all vertex tracks given a specific time point and weight to a given entity. More... | |
void | applyToAnimable (const AnimableValuePtr &anim, Real timePos, Real weight=1.0, Real scale=1.0f) |
Applies all numeric tracks given a specific time point and weight to the specified animable value. More... | |
void | applyToNode (Node *node, Real timePos, Real weight=1.0, Real scale=1.0f) |
Applies all node tracks given a specific time point and weight to the specified node. More... | |
void | applyToVertexData (VertexData *data, Real timePos, Real weight=1.0) |
Applies all vertex tracks given a specific time point and weight to the specified vertex data. More... | |
Animation * | clone (const String &newName) const |
Clone this animation. More... | |
NodeAnimationTrack * | createNodeTrack (unsigned short handle) |
Creates a NodeAnimationTrack for animating a Node. More... | |
NodeAnimationTrack * | createNodeTrack (unsigned short handle, Node *node) |
Creates a new AnimationTrack automatically associated with a Node. More... | |
NumericAnimationTrack * | createNumericTrack (unsigned short handle) |
Creates a NumericAnimationTrack for animating any numeric value. More... | |
NumericAnimationTrack * | createNumericTrack (unsigned short handle, const AnimableValuePtr &anim) |
Creates a NumericAnimationTrack and associates it with an animable. More... | |
VertexAnimationTrack * | createVertexTrack (unsigned short handle, VertexAnimationType animType) |
Creates a VertexAnimationTrack for animating vertex position data. More... | |
VertexAnimationTrack * | createVertexTrack (unsigned short handle, VertexData *data, VertexAnimationType animType) |
Creates a VertexAnimationTrack and associates it with VertexData. More... | |
void | destroyAllNodeTracks (void) |
Removes and destroys all tracks making up this animation. More... | |
void | destroyAllNumericTracks (void) |
Removes and destroys all tracks making up this animation. More... | |
void | destroyAllTracks (void) |
Removes and destroys all tracks making up this animation. More... | |
void | destroyAllVertexTracks (void) |
Removes and destroys all tracks making up this animation. More... | |
void | destroyNodeTrack (unsigned short handle) |
Destroys the node track with the given handle. More... | |
void | destroyNumericTrack (unsigned short handle) |
Destroys the numeric track with the given handle. More... | |
void | destroyVertexTrack (unsigned short handle) |
Destroys the Vertex track with the given handle. More... | |
const String & | getBaseKeyFrameAnimationName () const |
If a base keyframe is being used, the Animation that provides that keyframe. More... | |
Real | getBaseKeyFrameTime () const |
If a base keyframe is being used, the time of that keyframe. More... | |
AnimationContainer * | getContainer () |
Retrieve the container of this animation. More... | |
InterpolationMode | getInterpolationMode (void) const |
Gets the current interpolation mode of this animation. More... | |
Real | getLength (void) const |
Gets the total length of the animation. More... | |
const String & | getName (void) const |
Gets the name of this animation. More... | |
NodeAnimationTrack * | getNodeTrack (unsigned short handle) const |
Gets a node track by it's handle. More... | |
NodeTrackIterator | getNodeTrackIterator (void) const |
Get non-updateable iterator over node tracks. More... | |
NumericAnimationTrack * | getNumericTrack (unsigned short handle) const |
Gets a numeric track by it's handle. More... | |
NumericTrackIterator | getNumericTrackIterator (void) const |
Get non-updateable iterator over node tracks. More... | |
unsigned short | getNumNodeTracks (void) const |
Gets the number of NodeAnimationTrack objects contained in this animation. More... | |
unsigned short | getNumNumericTracks (void) const |
Gets the number of NumericAnimationTrack objects contained in this animation. More... | |
unsigned short | getNumVertexTracks (void) const |
Gets the number of VertexAnimationTrack objects contained in this animation. More... | |
RotationInterpolationMode | getRotationInterpolationMode (void) const |
Gets the current rotation interpolation mode of this animation. More... | |
bool | getUseBaseKeyFrame () const |
Whether a base keyframe is being used for this Animation. More... | |
VertexAnimationTrack * | getVertexTrack (unsigned short handle) const |
Gets a Vertex track by it's handle. More... | |
VertexTrackIterator | getVertexTrackIterator (void) const |
Get non-updateable iterator over node tracks. More... | |
bool | hasNodeTrack (unsigned short handle) const |
Does a track exist with the given handle? More... | |
bool | hasNumericTrack (unsigned short handle) const |
Does a track exist with the given handle? More... | |
bool | hasVertexTrack (unsigned short handle) const |
Does a track exist with the given handle? More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | optimise (bool discardIdentityNodeTracks=true) |
Optimise an animation by removing unnecessary tracks and keyframes. More... | |
void | setInterpolationMode (InterpolationMode im) |
Tells the animation how to interpolate between keyframes. More... | |
void | setLength (Real len) |
Sets the length of the animation. More... | |
void | setRotationInterpolationMode (RotationInterpolationMode im) |
Tells the animation how to interpolate rotations. More... | |
void | setUseBaseKeyFrame (bool useBaseKeyFrame, Real keyframeTime=0.0f, const String &baseAnimName=StringUtil::BLANK) |
Sets a base keyframe which for the skeletal / pose keyframes in this animation. More... | |
Static Public Member Functions | |
static InterpolationMode | getDefaultInterpolationMode (void) |
Gets the default interpolation mode for all animations. More... | |
static RotationInterpolationMode | getDefaultRotationInterpolationMode (void) |
Gets the default rotation interpolation mode for all animations. More... | |
static void | setDefaultInterpolationMode (InterpolationMode im) |
Sets the default animation interpolation mode. More... | |
static void | setDefaultRotationInterpolationMode (RotationInterpolationMode im) |
Sets the default rotation interpolation mode. More... | |
Protected Types | |
typedef vector< Real >::type | KeyFrameTimeList |
Global keyframe time list used to search global keyframe index. More... | |
Protected Member Functions | |
void | buildKeyFrameTimeList (void) const |
Internal method to build global keyframe time list. More... | |
void | optimiseNodeTracks (bool discardIdentityTracks) |
void | optimiseVertexTracks (void) |
Protected Attributes | |
String | mBaseKeyFrameAnimationName |
Real | mBaseKeyFrameTime |
AnimationContainer * | mContainer |
InterpolationMode | mInterpolationMode |
KeyFrameTimeList | mKeyFrameTimes |
bool | mKeyFrameTimesDirty |
Dirty flag indicate that keyframe time list need to rebuild. More... | |
Real | mLength |
String | mName |
NodeTrackList | mNodeTrackList |
Node tracks, indexed by handle. More... | |
NumericTrackList | mNumericTrackList |
Numeric tracks, indexed by handle. More... | |
RotationInterpolationMode | mRotationInterpolationMode |
bool | mUseBaseKeyFrame |
VertexTrackList | mVertexTrackList |
Vertex tracks, indexed by handle. More... | |
Static Protected Attributes | |
static InterpolationMode | msDefaultInterpolationMode |
static RotationInterpolationMode | msDefaultRotationInterpolationMode |
An animation sequence.
Definition at line 90 of file OgreAnimation.h.
|
protected |
Global keyframe time list used to search global keyframe index.
Definition at line 522 of file OgreAnimation.h.
Definition at line 372 of file OgreAnimation.h.
typedef map<unsigned short, NodeAnimationTrack*>::type Ogre::Animation::NodeTrackList |
Definition at line 371 of file OgreAnimation.h.
Definition at line 375 of file OgreAnimation.h.
typedef map<unsigned short, NumericAnimationTrack*>::type Ogre::Animation::NumericTrackList |
Definition at line 374 of file OgreAnimation.h.
typedef set<ushort>::type Ogre::Animation::TrackHandleList |
A list of track handles.
Definition at line 423 of file OgreAnimation.h.
Definition at line 378 of file OgreAnimation.h.
typedef map<unsigned short, VertexAnimationTrack*>::type Ogre::Animation::VertexTrackList |
Definition at line 377 of file OgreAnimation.h.
The types of animation interpolation available.
Enumerator | |
---|---|
IM_LINEAR |
Values are interpolated along straight lines. |
IM_SPLINE |
Values are interpolated along a spline, resulting in smoother changes in direction. |
Definition at line 95 of file OgreAnimation.h.
The types of rotational interpolation available.
Definition at line 104 of file OgreAnimation.h.
|
virtual |
void Ogre::Animation::_applyBaseKeyFrame | ( | ) |
Internal method to adjust keyframes relative to a base keyframe (.
void Ogre::Animation::_collectIdentityNodeTracks | ( | TrackHandleList & | tracks | ) | const |
Internal method for collecting identity node tracks.
tracks | A list of track handle of non-identity node tracks, where this method will remove non-identity node track handles. |
void Ogre::Animation::_destroyNodeTracks | ( | const TrackHandleList & | tracks | ) |
Internal method for destroy given node tracks.
const NodeTrackList& Ogre::Animation::_getNodeTrackList | ( | void | ) | const |
Fast access to NON-UPDATEABLE node track list.
const NumericTrackList& Ogre::Animation::_getNumericTrackList | ( | void | ) | const |
Fast access to NON-UPDATEABLE numeric track list.
Internal method used to convert time position to time index object.
timePos | The time position. |
const VertexTrackList& Ogre::Animation::_getVertexTrackList | ( | void | ) | const |
Fast access to NON-UPDATEABLE Vertex track list.
|
inline |
Internal method used to tell the animation that keyframe list has been changed, which may cause it to rebuild some internal data.
Definition at line 448 of file OgreAnimation.h.
void Ogre::Animation::_notifyContainer | ( | AnimationContainer * | c | ) |
Applies an animation given a specific time point and weight.
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. |
scale | The scale to apply to translations and scalings, useful for adapting an animation to a different size target. |
void Ogre::Animation::apply | ( | Skeleton * | skeleton, |
Real | timePos, | ||
Real | weight = 1.0 , |
||
Real | scale = 1.0f |
||
) |
Applies all node tracks given a specific time point and weight to a given skeleton.
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. |
scale | The scale to apply to translations and scalings, useful for adapting an animation to a different size target. |
void Ogre::Animation::apply | ( | Skeleton * | skeleton, |
Real | timePos, | ||
float | weight, | ||
const AnimationState::BoneBlendMask * | blendMask, | ||
Real | scale | ||
) |
Applies all node tracks given a specific time point and weight to a given skeleton.
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. |
blendMask | The influence array defining additional per bone weights. These will be modulated with the weight factor. |
scale | The scale to apply to translations and scalings, useful for adapting an animation to a different size target. |
void Ogre::Animation::apply | ( | Entity * | entity, |
Real | timePos, | ||
Real | weight, | ||
bool | software, | ||
bool | hardware | ||
) |
Applies all vertex tracks given a specific time point and weight to a given entity.
entity | The Entity to which this animation should be applied |
timePos | The time position in the animation to apply. |
weight | The weight at which the animation should be applied (only affects pose animation) |
software | Whether to populate the software morph vertex data |
hardware | Whether to populate the hardware morph vertex data |
void Ogre::Animation::applyToAnimable | ( | const AnimableValuePtr & | anim, |
Real | timePos, | ||
Real | weight = 1.0 , |
||
Real | scale = 1.0f |
||
) |
Applies all numeric tracks given a specific time point and weight to the specified animable value.
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. |
scale | The scale to apply to translations and scalings, useful for adapting an animation to a different size target. |
void Ogre::Animation::applyToNode | ( | Node * | node, |
Real | timePos, | ||
Real | weight = 1.0 , |
||
Real | scale = 1.0f |
||
) |
Applies all node tracks given a specific time point and weight to the specified node.
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. |
scale | The scale to apply to translations and scalings, useful for adapting an animation to a different size target. |
void Ogre::Animation::applyToVertexData | ( | VertexData * | data, |
Real | timePos, | ||
Real | weight = 1.0 |
||
) |
Applies all vertex tracks given a specific time point and weight to the specified vertex data.
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. |
|
protected |
Internal method to build global keyframe time list.
Clone this animation.
NodeAnimationTrack* Ogre::Animation::createNodeTrack | ( | unsigned short | handle | ) |
Creates a NodeAnimationTrack for animating a Node.
handle | Handle to give the track, used for accessing the track later. Must be unique within this Animation. |
NodeAnimationTrack* Ogre::Animation::createNodeTrack | ( | unsigned short | handle, |
Node * | node | ||
) |
Creates a new AnimationTrack automatically associated with a Node.
NumericAnimationTrack* Ogre::Animation::createNumericTrack | ( | unsigned short | handle | ) |
Creates a NumericAnimationTrack for animating any numeric value.
handle | Handle to give the track, used for accessing the track later. Must be unique within this Animation. |
NumericAnimationTrack* Ogre::Animation::createNumericTrack | ( | unsigned short | handle, |
const AnimableValuePtr & | anim | ||
) |
Creates a NumericAnimationTrack and associates it with an animable.
handle | Handle to give the track, used for accessing the track later. |
anim | Animable object link Must be unique within this Animation. |
VertexAnimationTrack* Ogre::Animation::createVertexTrack | ( | unsigned short | handle, |
VertexAnimationType | animType | ||
) |
Creates a VertexAnimationTrack for animating vertex position data.
handle | Handle to give the track, used for accessing the track later. Must be unique within this Animation, and is used to identify the target. For example when applied to a Mesh, the handle must reference the index of the geometry being modified; 0 for the shared geometry, and 1+ for SubMesh geometry with the same index-1. |
animType | Either morph or pose animation, |
VertexAnimationTrack* Ogre::Animation::createVertexTrack | ( | unsigned short | handle, |
VertexData * | data, | ||
VertexAnimationType | animType | ||
) |
Creates a VertexAnimationTrack and associates it with VertexData.
handle | Handle to give the track, used for accessing the track later. |
data | VertexData object link |
animType | The animation type Must be unique within this Animation. |
void Ogre::Animation::destroyAllNodeTracks | ( | void | ) |
Removes and destroys all tracks making up this animation.
void Ogre::Animation::destroyAllNumericTracks | ( | void | ) |
Removes and destroys all tracks making up this animation.
void Ogre::Animation::destroyAllTracks | ( | void | ) |
Removes and destroys all tracks making up this animation.
void Ogre::Animation::destroyAllVertexTracks | ( | void | ) |
Removes and destroys all tracks making up this animation.
void Ogre::Animation::destroyNodeTrack | ( | unsigned short | handle | ) |
Destroys the node track with the given handle.
void Ogre::Animation::destroyNumericTrack | ( | unsigned short | handle | ) |
Destroys the numeric track with the given handle.
void Ogre::Animation::destroyVertexTrack | ( | unsigned short | handle | ) |
Destroys the Vertex track with the given handle.
const String& Ogre::Animation::getBaseKeyFrameAnimationName | ( | ) | const |
If a base keyframe is being used, the Animation that provides that keyframe.
Real Ogre::Animation::getBaseKeyFrameTime | ( | ) | const |
If a base keyframe is being used, the time of that keyframe.
AnimationContainer* Ogre::Animation::getContainer | ( | ) |
Retrieve the container of this animation.
|
static |
Gets the default interpolation mode for all animations.
|
static |
Gets the default rotation interpolation mode for all animations.
InterpolationMode Ogre::Animation::getInterpolationMode | ( | void | ) | const |
Gets the current interpolation mode of this animation.
Real Ogre::Animation::getLength | ( | void | ) | const |
Gets the total length of the animation.
const String& Ogre::Animation::getName | ( | void | ) | const |
Gets the name of this animation.
NodeAnimationTrack* Ogre::Animation::getNodeTrack | ( | unsigned short | handle | ) | const |
Gets a node track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
Definition at line 384 of file OgreAnimation.h.
NumericAnimationTrack* Ogre::Animation::getNumericTrack | ( | unsigned short | handle | ) | const |
Gets a numeric track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
Definition at line 391 of file OgreAnimation.h.
unsigned short Ogre::Animation::getNumNodeTracks | ( | void | ) | const |
Gets the number of NodeAnimationTrack objects contained in this animation.
unsigned short Ogre::Animation::getNumNumericTracks | ( | void | ) | const |
Gets the number of NumericAnimationTrack objects contained in this animation.
unsigned short Ogre::Animation::getNumVertexTracks | ( | void | ) | const |
Gets the number of VertexAnimationTrack objects contained in this animation.
RotationInterpolationMode Ogre::Animation::getRotationInterpolationMode | ( | void | ) | const |
Gets the current rotation interpolation mode of this animation.
bool Ogre::Animation::getUseBaseKeyFrame | ( | ) | const |
Whether a base keyframe is being used for this Animation.
VertexAnimationTrack* Ogre::Animation::getVertexTrack | ( | unsigned short | handle | ) | const |
Gets a Vertex track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
Definition at line 398 of file OgreAnimation.h.
bool Ogre::Animation::hasNodeTrack | ( | unsigned short | handle | ) | const |
Does a track exist with the given handle?
bool Ogre::Animation::hasNumericTrack | ( | unsigned short | handle | ) | const |
Does a track exist with the given handle?
bool Ogre::Animation::hasVertexTrack | ( | unsigned short | handle | ) | const |
Does a track exist with the given handle?
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
void Ogre::Animation::optimise | ( | bool | discardIdentityNodeTracks = true | ) |
Optimise an animation by removing unnecessary tracks and keyframes.
discardIdentityNodeTracks | If true, discard identity node tracks. |
|
protected |
|
protected |
|
static |
Sets the default animation interpolation mode.
|
static |
Sets the default rotation interpolation mode.
void Ogre::Animation::setInterpolationMode | ( | InterpolationMode | im | ) |
Tells the animation how to interpolate between keyframes.
void Ogre::Animation::setLength | ( | Real | len | ) |
Sets the length of the animation.
void Ogre::Animation::setRotationInterpolationMode | ( | RotationInterpolationMode | im | ) |
Tells the animation how to interpolate rotations.
void Ogre::Animation::setUseBaseKeyFrame | ( | bool | useBaseKeyFrame, |
Real | keyframeTime = 0.0f , |
||
const String & | baseAnimName = StringUtil::BLANK |
||
) |
Sets a base keyframe which for the skeletal / pose keyframes in this animation.
useBaseKeyFrame | Whether a base keyframe should be used |
keyframeTime | The time corresponding to the base keyframe, if any |
baseAnimName | Optionally a different base animation (must contain the same tracks) |
|
protected |
Definition at line 529 of file OgreAnimation.h.
|
protected |
Definition at line 528 of file OgreAnimation.h.
|
protected |
Definition at line 530 of file OgreAnimation.h.
|
protected |
Definition at line 515 of file OgreAnimation.h.
|
mutableprotected |
Definition at line 523 of file OgreAnimation.h.
|
mutableprotected |
Dirty flag indicate that keyframe time list need to rebuild.
Definition at line 525 of file OgreAnimation.h.
|
protected |
Definition at line 513 of file OgreAnimation.h.
|
protected |
Definition at line 511 of file OgreAnimation.h.
|
protected |
Node tracks, indexed by handle.
Definition at line 506 of file OgreAnimation.h.
|
protected |
Numeric tracks, indexed by handle.
Definition at line 508 of file OgreAnimation.h.
|
protected |
Definition at line 516 of file OgreAnimation.h.
|
staticprotected |
Definition at line 518 of file OgreAnimation.h.
|
staticprotected |
Definition at line 519 of file OgreAnimation.h.
|
protected |
Definition at line 527 of file OgreAnimation.h.
|
protected |
Vertex tracks, indexed by handle.
Definition at line 510 of file OgreAnimation.h.