iSkeletonAnimNode2 Struct Reference
[Mesh plugins]
Base type for nodes in the hierarchical blending tree for skeletal animation system. More...
#include <imesh/skeleton2anim.h>

Public Member Functions | |
virtual void | AddAnimationCallback (iSkeletonAnimCallback2 *callback)=0 |
Add a new animation callback to a node. | |
virtual void | BlendState (csSkeletalState2 *state, float baseWeight=1.0f)=0 |
Blend the state of this node into the global state. | |
virtual iSkeletonAnimNode2 * | FindNode (const char *name)=0 |
Find a sub-node with given name. | |
virtual float | GetDuration () const =0 |
Get the length of the node. | |
virtual iSkeletonAnimNodeFactory2 * | GetFactory () const =0 |
Get the node factory. | |
virtual float | GetPlaybackPosition () const =0 |
Get the current playback position (time). | |
virtual float | GetPlaybackSpeed () const =0 |
Get the playback speed. | |
virtual bool | IsActive () const =0 |
Is this or any sub-node active and needs any blending. | |
virtual void | Play ()=0 |
Start playing the node. | |
virtual void | RemoveAnimationCallback (iSkeletonAnimCallback2 *callback)=0 |
Remove a animation callback from a node. | |
virtual void | SetPlaybackPosition (float time)=0 |
Set the current playback position. | |
virtual void | SetPlaybackSpeed (float speed)=0 |
Set the playback speed. | |
virtual void | Stop ()=0 |
Stop playing the node (deactivate it). | |
virtual void | TickAnimation (float dt)=0 |
Update the animation state. |
Detailed Description
Base type for nodes in the hierarchical blending tree for skeletal animation system.
Definition at line 339 of file skeleton2anim.h.
Member Function Documentation
virtual void iSkeletonAnimNode2::AddAnimationCallback | ( | iSkeletonAnimCallback2 * | callback | ) | [pure virtual] |
Add a new animation callback to a node.
- Parameters:
-
callback the callback object
virtual void iSkeletonAnimNode2::BlendState | ( | csSkeletalState2 * | state, | |
float | baseWeight = 1.0f | |||
) | [pure virtual] |
Blend the state of this node into the global state.
- Parameters:
-
state The global blend state to blend into baseWeight Global weight for this node
virtual iSkeletonAnimNode2* iSkeletonAnimNode2::FindNode | ( | const char * | name | ) | [pure virtual] |
Find a sub-node with given name.
virtual float iSkeletonAnimNode2::GetDuration | ( | ) | const [pure virtual] |
Get the length of the node.
virtual iSkeletonAnimNodeFactory2* iSkeletonAnimNode2::GetFactory | ( | ) | const [pure virtual] |
Get the node factory.
virtual float iSkeletonAnimNode2::GetPlaybackPosition | ( | ) | const [pure virtual] |
Get the current playback position (time).
virtual float iSkeletonAnimNode2::GetPlaybackSpeed | ( | ) | const [pure virtual] |
Get the playback speed.
virtual bool iSkeletonAnimNode2::IsActive | ( | ) | const [pure virtual] |
Is this or any sub-node active and needs any blending.
virtual void iSkeletonAnimNode2::Play | ( | ) | [pure virtual] |
Start playing the node.
Exactly what this results in depends on the specific node type.
virtual void iSkeletonAnimNode2::RemoveAnimationCallback | ( | iSkeletonAnimCallback2 * | callback | ) | [pure virtual] |
Remove a animation callback from a node.
- Parameters:
-
callback the callback object
virtual void iSkeletonAnimNode2::SetPlaybackPosition | ( | float | time | ) | [pure virtual] |
Set the current playback position.
If set beyond the end of the animation it will be capped.
virtual void iSkeletonAnimNode2::SetPlaybackSpeed | ( | float | speed | ) | [pure virtual] |
Set the playback speed.
virtual void iSkeletonAnimNode2::Stop | ( | ) | [pure virtual] |
Stop playing the node (deactivate it).
virtual void iSkeletonAnimNode2::TickAnimation | ( | float | dt | ) | [pure virtual] |
Update the animation state.
- Parameters:
-
dt Time since last update
The documentation for this struct was generated from the following file:
- imesh/skeleton2anim.h
Generated for Crystal Space 1.4.1 by doxygen 1.7.1