PLMesh::JointAni Class Reference

Joint animation class. More...

#include <JointAni.h>

Inheritance diagram for PLMesh::JointAni:

List of all members.

Classes
class	AniJoint
	Holds information about which joint components are animated. More...
Public Types
enum	EAttribute {   AX = 1<<0, AY = 1<<1, AZ = 1<<2, AYaw = 1<<3,   APitch = 1<<4, ARoll = 1<<5, AW = 1<<6 }
	Tell which attribute the track modify. More...
Public Member Functions
PLMESH_API	JointAni ()
	Constructor.
virtual PLMESH_API	~JointAni ()
	Destructor.
PLMESH_API PLCore::Array < AniJoint > &	GetJoints ()
	Returns the animation joints.
PLMESH_API bool	ApplyJointStates (PLCore::Array< JointHandler > &lstJointHandlers, PLCore::uint32 nFrame, float fWeight=1.0f) const
	Applies the joint states from the given joint animation frame to the given joint states.
PLMESH_API bool	ApplyJointStates (PLCore::Array< JointHandler > &lstJointHandlers, PLCore::uint32 nFrame1, PLCore::uint32 nFrame2, float fTime, float fWeight=1.0f) const
	Applies the blended joint states from the given joint animation frames to the given joint states.
virtual PLMESH_API JointAni &	operator= (const JointAni &cSource)

---

Detailed Description

Joint animation class.

Remarks:

This class manages the predefined joint animation data which is sometimes also called 'offline animation'.

---

Member Enumeration Documentation

enum PLMesh::JointAni::EAttribute

Tell which attribute the track modify.

Enumerator:

AX	The x component of the position is modified
AY	The y component of the position is modified
AZ	The z component of the position is modified
AYaw	The yaw component of the rotation is modified
APitch	The pitch component of the rotation is modified
ARoll	The roll component of the rotation is modified
AW	The w component of the rotation is modified

---

Constructor & Destructor Documentation

PLMESH_API PLMesh::JointAni::JointAni

(

)

Constructor.

virtual PLMESH_API PLMesh::JointAni::~JointAni

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLMESH_API PLCore::Array<AniJoint>& PLMesh::JointAni::GetJoints

(

)

Returns the animation joints.

Returns:

Skeleton animation joints

PLMESH_API bool PLMesh::JointAni::ApplyJointStates	(	PLCore::Array< JointHandler > &	lstJointHandlers,
		PLCore::uint32	nFrame,
		float	fWeight = 1.0f
	)		const

Applies the joint states from the given joint animation frame to the given joint states.

Parameters:

[out]	lstJointHandlers	Joint handlers to manipulate
[in]	nFrame	Joint animation frame
[in]	fWeight	Weight (0.0-1.0)

Returns:

'true' if all went fine, else 'false' (maybe no skeleton set?)

PLMESH_API bool PLMesh::JointAni::ApplyJointStates	(	PLCore::Array< JointHandler > &	lstJointHandlers,
		PLCore::uint32	nFrame1,
		PLCore::uint32	nFrame2,
		float	fTime,
		float	fWeight = 1.0f
	)		const

Applies the blended joint states from the given joint animation frames to the given joint states.

Parameters:

[out]	lstJointHandlers	Joint handlers to manipulate
[in]	nFrame1	Joint animation frame 1
[in]	nFrame2	Joint animation frame 2
[in]	fTime	Joint animation time (0.0-1.0)
[in]	fWeight	Weight (0.0-1.0)

Returns:

'true' if all went fine, else 'false' (maybe no skeleton set?)

virtual PLMESH_API JointAni& PLMesh::JointAni::operator=

(

const JointAni &

cSource

)

[virtual]

---

The documentation for this class was generated from the following file:

• JointAni.h