29 #ifndef __Animation_H__
30 #define __Animation_H__
421 void optimise(
bool discardIdentityNodeTracks =
true);
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
An animation container interface, which allows generic access to sibling animations.
virtual Animation * getAnimation(const String &name) const =0
Retrieve an animation by name.
virtual ~AnimationContainer()
virtual unsigned short getNumAnimations(void) const =0
Gets the number of animations in this container.
virtual Animation * getAnimation(unsigned short index) const =0
Retrieve an animation by index.
virtual void removeAnimation(const String &name)=0
Removes an Animation from this container.
virtual Animation * createAnimation(const String &name, Real length)=0
Create a new animation with a given length owned by this container.
virtual bool hasAnimation(const String &name) const =0
Returns whether this object contains the named animation.
vector< float >::type BoneBlendMask
Typedef for an array of float values used as a bone blend mask.
void _applyBaseKeyFrame()
Internal method to adjust keyframes relative to a base keyframe (.
bool hasNumericTrack(unsigned short handle) const
Does a track exist with the given handle?
void _destroyNodeTracks(const TrackHandleList &tracks)
Internal method for destroy given node tracks.
ConstMapIterator< NodeTrackList > NodeTrackIterator
bool getUseBaseKeyFrame() const
Whether a base keyframe is being used for this Animation.
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.
NodeTrackIterator getNodeTrackIterator(void) const
Get non-updateable iterator over node tracks.
static InterpolationMode getDefaultInterpolationMode(void)
Gets the default interpolation mode for all animations.
NumericAnimationTrack * createNumericTrack(unsigned short handle)
Creates a NumericAnimationTrack for animating any numeric value.
VertexAnimationTrack * createVertexTrack(unsigned short handle, VertexData *data, VertexAnimationType animType)
Creates a VertexAnimationTrack and associates it with VertexData.
bool hasVertexTrack(unsigned short handle) const
Does a track exist with the given handle?
NodeAnimationTrack * createNodeTrack(unsigned short handle)
Creates a NodeAnimationTrack for animating a Node.
void buildKeyFrameTimeList(void) const
Internal method to build global keyframe time list.
void destroyAllTracks(void)
Removes and destroys all tracks making up this animation.
KeyFrameTimeList mKeyFrameTimes
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.
Real getLength(void) const
Gets the total length of the animation.
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.
VertexTrackList mVertexTrackList
Vertex tracks, indexed by handle.
Animation * clone(const String &newName) const
Clone this animation.
const String & getName(void) const
Gets the name of this animation.
NumericTrackIterator getNumericTrackIterator(void) const
Get non-updateable iterator over node tracks.
void destroyAllNodeTracks(void)
Removes and destroys all tracks making up this animation.
static void setDefaultInterpolationMode(InterpolationMode im)
Sets the default animation interpolation mode.
const String & getBaseKeyFrameAnimationName() const
If a base keyframe is being used, the Animation that provides that keyframe.
map< unsigned short, NumericAnimationTrack * >::type NumericTrackList
unsigned short getNumVertexTracks(void) const
Gets the number of VertexAnimationTrack objects contained in this animation.
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.
NumericAnimationTrack * createNumericTrack(unsigned short handle, const AnimableValuePtr &anim)
Creates a NumericAnimationTrack and associates it with an animable.
NodeAnimationTrack * getNodeTrack(unsigned short handle) const
Gets a node track by it's handle.
static RotationInterpolationMode getDefaultRotationInterpolationMode(void)
Gets the default rotation interpolation mode for all animations.
map< unsigned short, NodeAnimationTrack * >::type NodeTrackList
void _collectIdentityNodeTracks(TrackHandleList &tracks) const
Internal method for collecting identity node tracks.
void optimise(bool discardIdentityNodeTracks=true)
Optimise an animation by removing unnecessary tracks and keyframes.
ConstMapIterator< VertexTrackList > VertexTrackIterator
vector< Real >::type KeyFrameTimeList
Global keyframe time list used to search global keyframe index.
RotationInterpolationMode mRotationInterpolationMode
void optimiseVertexTracks(void)
NumericTrackList mNumericTrackList
Numeric tracks, indexed by handle.
void _notifyContainer(AnimationContainer *c)
void destroyNodeTrack(unsigned short handle)
Destroys the node track with the given handle.
unsigned short getNumNodeTracks(void) const
Gets the number of NodeAnimationTrack objects contained in this animation.
void optimiseNodeTracks(bool discardIdentityTracks)
void destroyAllVertexTracks(void)
Removes and destroys all tracks making up this animation.
AnimationContainer * mContainer
void destroyVertexTrack(unsigned short handle)
Destroys the Vertex track with the given handle.
set< ushort >::type TrackHandleList
A list of track handles.
VertexAnimationTrack * createVertexTrack(unsigned short handle, VertexAnimationType animType)
Creates a VertexAnimationTrack for animating vertex position data.
static void setDefaultRotationInterpolationMode(RotationInterpolationMode im)
Sets the default rotation interpolation mode.
void apply(Real timePos, Real weight=1.0, Real scale=1.0f)
Applies an animation given a specific time point and weight.
void setInterpolationMode(InterpolationMode im)
Tells the animation how to interpolate between keyframes.
NumericAnimationTrack * getNumericTrack(unsigned short handle) const
Gets a numeric track by it's handle.
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.
VertexTrackIterator getVertexTrackIterator(void) const
Get non-updateable iterator over node tracks.
map< unsigned short, VertexAnimationTrack * >::type VertexTrackList
InterpolationMode getInterpolationMode(void) const
Gets the current interpolation mode of this animation.
RotationInterpolationMode getRotationInterpolationMode(void) const
Gets the current rotation interpolation mode of this animation.
static RotationInterpolationMode msDefaultRotationInterpolationMode
const NodeTrackList & _getNodeTrackList(void) const
Fast access to NON-UPDATEABLE node track list.
NodeAnimationTrack * createNodeTrack(unsigned short handle, Node *node)
Creates a new AnimationTrack automatically associated with a Node.
InterpolationMode
The types of animation interpolation available.
@ IM_LINEAR
Values are interpolated along straight lines.
void destroyAllNumericTracks(void)
Removes and destroys all tracks making up this animation.
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.
void setLength(Real len)
Sets the length of the animation.
NodeTrackList mNodeTrackList
Node tracks, indexed by handle.
void _keyFrameListChanged(void)
Internal method used to tell the animation that keyframe list has been changed, which may cause it to...
ConstMapIterator< NumericTrackList > NumericTrackIterator
VertexAnimationTrack * getVertexTrack(unsigned short handle) const
Gets a Vertex track by it's handle.
String mBaseKeyFrameAnimationName
TimeIndex _getTimeIndex(Real timePos) const
Internal method used to convert time position to time index object.
AnimationContainer * getContainer()
Retrieve the container of this animation.
void destroyNumericTrack(unsigned short handle)
Destroys the numeric track with the given handle.
bool mKeyFrameTimesDirty
Dirty flag indicate that keyframe time list need to rebuild.
Animation(const String &name, Real length)
You should not use this constructor directly, use the parent object such as Skeleton instead.
const VertexTrackList & _getVertexTrackList(void) const
Fast access to NON-UPDATEABLE Vertex track list.
unsigned short getNumNumericTracks(void) const
Gets the number of NumericAnimationTrack objects contained in this animation.
InterpolationMode mInterpolationMode
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.
Real getBaseKeyFrameTime() const
If a base keyframe is being used, the time of that keyframe.
static InterpolationMode msDefaultInterpolationMode
bool hasNodeTrack(unsigned short handle) const
Does a track exist with the given handle?
void setRotationInterpolationMode(RotationInterpolationMode im)
Tells the animation how to interpolate rotations.
RotationInterpolationMode
The types of rotational interpolation available.
@ RIM_LINEAR
Values are interpolated linearly.
const NumericTrackList & _getNumericTrackList(void) const
Fast access to NON-UPDATEABLE numeric track list.
Concrete IteratorWrapper for const access to the underlying key-value container.
Defines an instance of a discrete, movable object based on a Mesh.
Specialised AnimationTrack for dealing with node transforms.
Class representing a general-purpose node an articulated scene graph.
Specialised AnimationTrack for dealing with generic animable values.
A collection of Bone objects used to animate a skinned mesh.
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Time index object used to search keyframe at the given position.
Specialised AnimationTrack for dealing with changing vertex position information.
Summary class collecting together vertex source information.
VertexAnimationType
Type of vertex animation.
float Real
Software floating point type.