29#ifndef __AnimationTrack_H__
30#define __AnimationTrack_H__
65 static const uint INVALID_KEY_INDEX = (
uint)-1;
72 , mKeyIndex(INVALID_KEY_INDEX)
89 return mKeyIndex != INVALID_KEY_INDEX;
146 unsigned short getHandle(
void)
const {
return mHandle; }
176 unsigned short* firstKeyIndex = 0)
const;
298 Real weight = 1.0,
Real scale = 1.0f);
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Listener allowing you to override certain behaviour of a track, for example to drive animation proced...
virtual bool getInterpolatedKeyFrame(const AnimationTrack *t, const TimeIndex &timeIndex, KeyFrame *kf)=0
Get an interpolated keyframe for this track at the given time.
A 'track' in an animation sequence, i.e.
AnimationTrack(Animation *parent, unsigned short handle)
Constructor.
virtual void _keyFrameDataChanged(void) const
Internal method used to tell the track that keyframe data has been changed, which may cause it to reb...
virtual void populateClone(AnimationTrack *clone) const
Internal method for clone implementation.
virtual ~AnimationTrack()
KeyFrameIndexMap mKeyFrameIndexMap
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 * createKeyFrameImpl(Real time)=0
Create a keyframe implementation - must be overridden.
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 void removeKeyFrame(unsigned short index)
Removes a KeyFrame by it's index.
virtual void getInterpolatedKeyFrame(const TimeIndex &timeIndex, KeyFrame *kf) const =0
Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
virtual bool hasNonZeroKeyFrames(void) const
Method to determine if this track has any KeyFrames which are doing anything useful - can be used to ...
vector< ushort >::type KeyFrameIndexMap
Map used to translate global keyframe time lower bound index to local lower bound index.
vector< KeyFrame * >::type KeyFrameList
virtual void _collectKeyFrameTimes(vector< Real >::type &keyFrameTimes)
Internal method to collect keyframe times, in unique, ordered format.
virtual void apply(const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)=0
Applies an animation track to the designated target.
virtual KeyFrame * getKeyFrame(unsigned short index) const
Returns the KeyFrame at the specified index.
virtual void removeAllKeyFrames(void)
Removes all the KeyFrames from this track.
virtual void optimise(void)
Optimise the current track by removing any duplicate keyframes.
virtual void _applyBaseKeyFrame(const KeyFrame *base)
Internal method to re-base the keyframes relative to a given keyframe.
virtual void _buildKeyFrameIndexMap(const vector< Real >::type &keyFrameTimes)
Internal method to build keyframe time index map to translate global lower bound index to local lower...
virtual KeyFrame * createKeyFrame(Real timePos)
Creates a new KeyFrame and adds it to this animation at the given time index.
Animation * getParent() const
Returns the parent Animation object for this track.
virtual void setListener(Listener *l)
Set a listener for this track.
A key frame in an animation sequence defined by an AnimationTrack.
Specialised AnimationTrack for dealing with node transforms.
virtual ~NodeAnimationTrack()
Destructor.
void _keyFrameDataChanged(void) const
Internal method used to tell the track that keyframe data has been changed, which may cause it to reb...
NodeAnimationTrack(Animation *parent, unsigned short handle)
Constructor.
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.
virtual void buildInterpolationSplines(void) const
NodeAnimationTrack * _clone(Animation *newParent) const
Clone this track (internal use only)
virtual Node * getAssociatedNode(void) const
Returns a pointer to the associated Node object (if any).
virtual void setUseShortestRotationPath(bool useShortestPath)
Sets the method of rotation calculation.
bool mUseShortestRotationPath
Defines if rotation is done using shortest path.
virtual void apply(const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
Applies an animation track to the designated target.
virtual TransformKeyFrame * createNodeKeyFrame(Real timePos)
Creates a new KeyFrame and adds it to this animation at the given time index.
virtual bool hasNonZeroKeyFrames(void) const
Method to determine if this track has any KeyFrames which are doing anything useful - can be used to ...
virtual void getInterpolatedKeyFrame(const TimeIndex &timeIndex, KeyFrame *kf) const
Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
virtual TransformKeyFrame * getNodeKeyFrame(unsigned short index) const
Returns the KeyFrame at the specified index.
virtual void setAssociatedNode(Node *node)
Sets the associated Node object which will be automatically affected by calls to 'apply'.
virtual bool getUseShortestRotationPath() const
Gets the method of rotation calculation.
NodeAnimationTrack(Animation *parent, unsigned short handle, Node *targetNode)
Constructor, associates with a Node.
virtual void optimise(void)
Optimise the current track by removing any duplicate keyframes.
void _applyBaseKeyFrame(const KeyFrame *base)
Internal method to re-base the keyframes relative to a given keyframe.
KeyFrame * createKeyFrameImpl(Real time)
Specialised keyframe creation.
Class representing a general-purpose node an articulated scene graph.
Specialised AnimationTrack for dealing with generic animable values.
NumericAnimationTrack * _clone(Animation *newParent) const
Clone this track (internal use only)
NumericAnimationTrack(Animation *parent, unsigned short handle)
Constructor.
void applyToAnimable(const AnimableValuePtr &anim, const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
Applies an animation track to a given animable value.
NumericAnimationTrack(Animation *parent, unsigned short handle, AnimableValuePtr &target)
Constructor, associates with an AnimableValue.
KeyFrame * createKeyFrameImpl(Real time)
Create a keyframe implementation - must be overridden.
virtual void setAssociatedAnimable(const AnimableValuePtr &val)
Sets the associated animable object which will be automatically affected by calls to 'apply'.
AnimableValuePtr mTargetAnim
Target to animate.
virtual const AnimableValuePtr & getAssociatedAnimable(void) const
Returns a pointer to the associated animable object (if any).
virtual void apply(const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
Applies an animation track to the designated target.
virtual void getInterpolatedKeyFrame(const TimeIndex &timeIndex, KeyFrame *kf) const
Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
NumericKeyFrame * getNumericKeyFrame(unsigned short index) const
Returns the KeyFrame at the specified index.
virtual NumericKeyFrame * createNumericKeyFrame(Real timePos)
Creates a new KeyFrame and adds it to this animation at the given time index.
Specialised KeyFrame which stores any numeric value.
A pose is a linked set of vertex offsets applying to one set of vertex data.
This class interpolates orientations (rotations) along a spline using derivatives of quaternions.
A very simple spline class which implements the Catmull-Rom class of splines.
Time index object used to search keyframe at the given position.
Real getTimePos(void) const
uint mKeyIndex
The global keyframe index (in relation to the whole animation sequence) that used to convert to local...
uint getKeyIndex(void) const
TimeIndex(Real timePos, uint keyIndex)
Construct time index object by the given time position and global keyframe index.
Real mTimePos
The time position (in relation to the whole animation sequence)
TimeIndex(Real timePos)
Construct time index object by the given time position.
bool hasKeyIndex(void) const
Specialised AnimationTrack for dealing with changing vertex position information.
VertexAnimationTrack(Animation *parent, unsigned short handle, VertexAnimationType animType)
Constructor.
virtual void apply(const TimeIndex &timeIndex, Real weight=1.0, Real scale=1.0f)
Applies an animation track to the designated target.
VertexData * mTargetVertexData
Target to animate.
VertexData * getAssociatedVertexData(void) const
Gets the associated VertexData which this track will update.
virtual VertexPoseKeyFrame * createVertexPoseKeyFrame(Real timePos)
Creates the single pose KeyFrame and adds it to this animation.
VertexPoseKeyFrame * getVertexPoseKeyFrame(unsigned short index) const
Returns the pose KeyFrame at the specified index.
VertexMorphKeyFrame * getVertexMorphKeyFrame(unsigned short index) const
Returns the morph KeyFrame at the specified index.
VertexAnimationTrack * _clone(Animation *newParent) const
Clone this track (internal use only)
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.
VertexAnimationType mAnimationType
Animation type.
virtual void optimise(void)
Optimise the current track by removing any duplicate keyframes.
TargetMode getTargetMode(void) const
Get the target mode.
void _applyBaseKeyFrame(const KeyFrame *base)
Internal method to re-base the keyframes relative to a given keyframe.
TargetMode mTargetMode
Mode to apply.
VertexAnimationType getAnimationType(void) const
Get the type of vertex animation we're performing.
TargetMode
The target animation mode.
@ TM_SOFTWARE
Interpolate vertex positions in software.
virtual VertexMorphKeyFrame * createVertexMorphKeyFrame(Real timePos)
Creates a new morph KeyFrame and adds it to this animation at the given time index.
void applyPoseToVertexData(const Pose *pose, VertexData *data, Real influence)
Utility method for applying pose animation.
void setAssociatedVertexData(VertexData *data)
Sets the associated VertexData which this track will update.
virtual bool hasNonZeroKeyFrames(void) const
Method to determine if this track has any KeyFrames which are doing anything useful - can be used to ...
virtual void getInterpolatedKeyFrame(const TimeIndex &timeIndex, KeyFrame *kf) const
Gets a KeyFrame object which contains the interpolated transforms at the time index specified.
void setTargetMode(TargetMode m)
Set the target mode.
VertexAnimationTrack(Animation *parent, unsigned short handle, VertexAnimationType animType, VertexData *targetData, TargetMode target=TM_SOFTWARE)
Constructor, associates with target VertexData and temp buffer (for software)
bool getVertexAnimationIncludesNormals() const
Whether the vertex animation (if present) includes normals.
KeyFrame * createKeyFrameImpl(Real time)
Create a keyframe implementation - must be overridden.
Summary class collecting together vertex source information.
Specialised KeyFrame which stores absolute vertex positions for a complete buffer,...
Specialised KeyFrame which references a Mesh::Pose at a certain influence level, which stores offsets...
vector< Pose * >::type PoseList
VertexAnimationType
Type of vertex animation.
@ VAT_MORPH
Morph animation is made up of many interpolated snapshot keyframes.
@ VAT_POSE
Pose animation is made up of a single delta pose keyframe.
float Real
Software floating point type.
RotationalSpline rotationSpline
SimpleSpline positionSpline