![]() |
OGRE-Next
3.0.0
Object-Oriented Graphics Rendering Engine
|
An animation sequence. More...
#include <OgreAnimation.h>
Public Types | |
enum | InterpolationMode { IM_LINEAR , IM_SPLINE } |
The types of animation interpolation available. More... | |
typedef ConstVectorIterator< NodeTrackList > | NodeTrackIterator |
typedef vector< NodeAnimationTrack * >::type | NodeTrackList |
typedef ConstMapIterator< NumericTrackList > | NumericTrackIterator |
typedef map< unsigned short, NumericAnimationTrack * >::type | NumericTrackList |
typedef ConstMapIterator< OldNodeTrackList > | OldNodeTrackIterator |
typedef map< unsigned short, OldNodeAnimationTrack * >::type | OldNodeTrackList |
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 | _collectIdentityOldNodeTracks (TrackHandleList &tracks) const |
Internal method for collecting identity node tracks. More... | |
void | _destroyOldNodeTracks (const TrackHandleList &tracks) |
Internal method for destroy given node tracks. More... | |
const NodeTrackList & | _getNodeTrackList () const |
Fast access to NON-UPDATEABLE node track list. More... | |
const NumericTrackList & | _getNumericTrackList () const |
Fast access to NON-UPDATEABLE numeric track list. More... | |
const OldNodeTrackList & | _getOldNodeTrackList () const |
Fast access to NON-UPDATEABLE OldNode track list. More... | |
TimeIndex | _getTimeIndex (Real timePos) const |
Internal method used to convert time position to time index object. More... | |
const VertexTrackList & | _getVertexTrackList () const |
Fast access to NON-UPDATEABLE Vertex track list. More... | |
void | _keyFrameListChanged () |
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 (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 | 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, 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 (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 | 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 (OldNode *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 () |
Creates a NodeAnimationTrack for animating a OldNode. More... | |
NodeAnimationTrack * | createNodeTrack (Node *node) |
Creates a new AnimationTrack automatically associated with a OldNode. 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... | |
OldNodeAnimationTrack * | createOldNodeTrack (unsigned short handle) |
Creates a OldNodeAnimationTrack for animating a OldOldNode. More... | |
OldNodeAnimationTrack * | createOldNodeTrack (unsigned short handle, OldNode *node) |
Creates a new AnimationTrack automatically associated with a OldNode. 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 () |
Removes and destroys all tracks making up this animation. More... | |
void | destroyAllNumericTracks () |
Removes and destroys all tracks making up this animation. More... | |
void | destroyAllOldNodeTracks () |
void | destroyAllTracks () |
Removes and destroys all tracks making up this animation. More... | |
void | destroyAllVertexTracks () |
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 | destroyOldNodeTrack (unsigned short handle) |
Destroys the node 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 () const |
Gets the current interpolation mode of this animation. More... | |
Real | getLength () const |
Gets the total length of the animation. More... | |
const String & | getName () const |
Gets the name of this animation. More... | |
NodeAnimationTrack * | getNodeTrack (size_t handle) const |
Gets a node track by it's handle. More... | |
NodeTrackIterator | getNodeTrackIterator () 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 () const |
Get non-updateable iterator over node tracks. More... | |
size_t | getNumNodeTracks () const |
Gets the number of NodeAnimationTrack objects contained in this animation. More... | |
unsigned short | getNumNumericTracks () const |
Gets the number of NumericAnimationTrack objects contained in this animation. More... | |
size_t | getNumOldNodeTracks () const |
Gets the number of OldNodeAnimationTrack objects contained in this animation. More... | |
unsigned short | getNumVertexTracks () const |
Gets the number of VertexAnimationTrack objects contained in this animation. More... | |
OldNodeAnimationTrack * | getOldNodeTrack (unsigned short handle) const |
Gets a node track by it's handle. More... | |
OldNodeTrackIterator | getOldNodeTrackIterator () const |
Get non-updateable iterator over node tracks. More... | |
RotationInterpolationMode | getRotationInterpolationMode () 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 () const |
Get non-updateable iterator over node tracks. More... | |
bool | hasNumericTrack (unsigned short handle) const |
Does a track exist with the given handle? More... | |
bool | hasOldNodeTrack (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 | 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=BLANKSTRING) |
Sets a base keyframe which for the skeletal / pose keyframes in this animation. More... | |
Static Public Member Functions | |
static InterpolationMode | getDefaultInterpolationMode () |
Gets the default interpolation mode for all animations. More... | |
static RotationInterpolationMode | getDefaultRotationInterpolationMode () |
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... | |
An animation sequence.
typedef vector<NodeAnimationTrack *>::type Ogre::v1::Animation::NodeTrackList |
typedef map<unsigned short, NumericAnimationTrack *>::type Ogre::v1::Animation::NumericTrackList |
typedef map<unsigned short, OldNodeAnimationTrack *>::type Ogre::v1::Animation::OldNodeTrackList |
typedef set<ushort>::type Ogre::v1::Animation::TrackHandleList |
A list of track handles.
typedef map<unsigned short, VertexAnimationTrack *>::type Ogre::v1::Animation::VertexTrackList |
|
virtual |
void Ogre::v1::Animation::_applyBaseKeyFrame | ( | ) |
Internal method to adjust keyframes relative to a base keyframe (.
void Ogre::v1::Animation::_collectIdentityOldNodeTracks | ( | 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::v1::Animation::_destroyOldNodeTracks | ( | const TrackHandleList & | tracks | ) |
Internal method for destroy given node tracks.
const NodeTrackList& Ogre::v1::Animation::_getNodeTrackList | ( | ) | const |
Fast access to NON-UPDATEABLE node track list.
const NumericTrackList& Ogre::v1::Animation::_getNumericTrackList | ( | ) | const |
Fast access to NON-UPDATEABLE numeric track list.
const OldNodeTrackList& Ogre::v1::Animation::_getOldNodeTrackList | ( | ) | const |
Fast access to NON-UPDATEABLE OldNode track list.
Internal method used to convert time position to time index object.
timePos | The time position. |
const VertexTrackList& Ogre::v1::Animation::_getVertexTrackList | ( | ) | 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.
void Ogre::v1::Animation::_notifyContainer | ( | AnimationContainer * | c | ) |
void Ogre::v1::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 |
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::v1::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::v1::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::v1::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::v1::Animation::applyToNode | ( | OldNode * | 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::v1::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. |
Clone this animation.
NodeAnimationTrack* Ogre::v1::Animation::createNodeTrack | ( | ) |
Creates a NodeAnimationTrack for animating a OldNode.
handle | Handle to give the track, used for accessing the track later. Must be unique within this Animation. |
NodeAnimationTrack* Ogre::v1::Animation::createNodeTrack | ( | Node * | node | ) |
Creates a new AnimationTrack automatically associated with a OldNode.
NumericAnimationTrack* Ogre::v1::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::v1::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. |
OldNodeAnimationTrack* Ogre::v1::Animation::createOldNodeTrack | ( | unsigned short | handle | ) |
Creates a OldNodeAnimationTrack for animating a OldOldNode.
handle | Handle to give the track, used for accessing the track later. Must be unique within this Animation. |
OldNodeAnimationTrack* Ogre::v1::Animation::createOldNodeTrack | ( | unsigned short | handle, |
OldNode * | node | ||
) |
Creates a new AnimationTrack automatically associated with a OldNode.
VertexAnimationTrack* Ogre::v1::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::v1::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::v1::Animation::destroyAllNodeTracks | ( | ) |
Removes and destroys all tracks making up this animation.
void Ogre::v1::Animation::destroyAllNumericTracks | ( | ) |
Removes and destroys all tracks making up this animation.
void Ogre::v1::Animation::destroyAllOldNodeTracks | ( | ) |
void Ogre::v1::Animation::destroyAllTracks | ( | ) |
Removes and destroys all tracks making up this animation.
void Ogre::v1::Animation::destroyAllVertexTracks | ( | ) |
Removes and destroys all tracks making up this animation.
void Ogre::v1::Animation::destroyNodeTrack | ( | unsigned short | handle | ) |
Destroys the node track with the given handle.
void Ogre::v1::Animation::destroyNumericTrack | ( | unsigned short | handle | ) |
Destroys the numeric track with the given handle.
void Ogre::v1::Animation::destroyOldNodeTrack | ( | unsigned short | handle | ) |
Destroys the node track with the given handle.
void Ogre::v1::Animation::destroyVertexTrack | ( | unsigned short | handle | ) |
Destroys the Vertex track with the given handle.
const String& Ogre::v1::Animation::getBaseKeyFrameAnimationName | ( | ) | const |
If a base keyframe is being used, the Animation that provides that keyframe.
Real Ogre::v1::Animation::getBaseKeyFrameTime | ( | ) | const |
If a base keyframe is being used, the time of that keyframe.
AnimationContainer* Ogre::v1::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::v1::Animation::getInterpolationMode | ( | ) | const |
Gets the current interpolation mode of this animation.
Real Ogre::v1::Animation::getLength | ( | ) | const |
Gets the total length of the animation.
const String& Ogre::v1::Animation::getName | ( | ) | const |
Gets the name of this animation.
NodeAnimationTrack* Ogre::v1::Animation::getNodeTrack | ( | size_t | handle | ) | const |
Gets a node track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
NumericAnimationTrack* Ogre::v1::Animation::getNumericTrack | ( | unsigned short | handle | ) | const |
Gets a numeric track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
size_t Ogre::v1::Animation::getNumNodeTracks | ( | ) | const |
Gets the number of NodeAnimationTrack objects contained in this animation.
unsigned short Ogre::v1::Animation::getNumNumericTracks | ( | ) | const |
Gets the number of NumericAnimationTrack objects contained in this animation.
size_t Ogre::v1::Animation::getNumOldNodeTracks | ( | ) | const |
Gets the number of OldNodeAnimationTrack objects contained in this animation.
unsigned short Ogre::v1::Animation::getNumVertexTracks | ( | ) | const |
Gets the number of VertexAnimationTrack objects contained in this animation.
OldNodeAnimationTrack* Ogre::v1::Animation::getOldNodeTrack | ( | unsigned short | handle | ) | const |
Gets a node track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
RotationInterpolationMode Ogre::v1::Animation::getRotationInterpolationMode | ( | ) | const |
Gets the current rotation interpolation mode of this animation.
bool Ogre::v1::Animation::getUseBaseKeyFrame | ( | ) | const |
Whether a base keyframe is being used for this Animation.
VertexAnimationTrack* Ogre::v1::Animation::getVertexTrack | ( | unsigned short | handle | ) | const |
Gets a Vertex track by it's handle.
|
inline |
Get non-updateable iterator over node tracks.
Referenced by Ogre::Lod0Stripifier::StripLod0Vertices().
bool Ogre::v1::Animation::hasNumericTrack | ( | unsigned short | handle | ) | const |
Does a track exist with the given handle?
bool Ogre::v1::Animation::hasOldNodeTrack | ( | unsigned short | handle | ) | const |
Does a track exist with the given handle?
bool Ogre::v1::Animation::hasVertexTrack | ( | unsigned short | handle | ) | const |
Does a track exist with the given handle?
void Ogre::v1::Animation::optimise | ( | bool | discardIdentityNodeTracks = true | ) |
Optimise an animation by removing unnecessary tracks and keyframes.
discardIdentityNodeTracks | If true, discard identity node tracks. |
|
static |
Sets the default animation interpolation mode.
|
static |
Sets the default rotation interpolation mode.
void Ogre::v1::Animation::setInterpolationMode | ( | InterpolationMode | im | ) |
Tells the animation how to interpolate between keyframes.
void Ogre::v1::Animation::setLength | ( | Real | len | ) |
Sets the length of the animation.
void Ogre::v1::Animation::setRotationInterpolationMode | ( | RotationInterpolationMode | im | ) |
Tells the animation how to interpolate rotations.
void Ogre::v1::Animation::setUseBaseKeyFrame | ( | bool | useBaseKeyFrame, |
Real | keyframeTime = 0.0f , |
||
const String & | baseAnimName = BLANKSTRING |
||
) |
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) |