CrystalSpace

Public API Reference

iSkeleton2 Struct Reference
[Mesh plugins]

A skeleton instance is a specific copy of a skeleton with base pose and topology defined by the factory but current state internally defined. More...

#include <imesh/skeleton2.h>

Inheritance diagram for iSkeleton2:

List of all members.

Public Member Functions

virtual iSkeletonAnimPacket2GetAnimationPacket () const =0
 Get the animation packet associated with this skeleton.
virtual iSkeletonFactory2GetFactory () const =0
 Get the factory used to create this skeleton instance.
virtual iSceneNodeGetSceneNode ()=0
 Get the scene node associated with the skeleton.
virtual unsigned int GetSkeletonStateVersion () const =0
 Get skeleton update version number.
virtual void RecreateSkeleton ()=0
 Recreate the skeleton structure from the factory.
virtual void SetAnimationPacket (iSkeletonAnimPacket2 *packet)=0
 Set the animation packet associated with this skeleton.
virtual void UpdateSkeleton (float dt)=0
 Update the skeleton.
Bone handling

virtual void GetTransformBoneSpace (BoneID bone, csQuaternion &rot, csVector3 &offset) const =0
 Get the bone transform in bone space.
virtual void SetTransformBoneSpace (BoneID bone, const csQuaternion &rot, const csVector3 &offset)=0
 Set the bone transform in bone space.
virtual void GetTransformAbsSpace (BoneID bone, csQuaternion &rot, csVector3 &offset) const =0
 Get the bone transform in skeleton absolute space.
virtual void SetTransformAbsSpace (BoneID bone, const csQuaternion &rot, const csVector3 &offset)=0
 Set the bone transform in skeleton absolute space.
virtual void GetTransformBindSpace (BoneID bone, csQuaternion &rot, csVector3 &offset) const =0
 Get the bone transform in bind space.
virtual void SetTransformBindSpace (BoneID bone, const csQuaternion &rot, const csVector3 &offset)=0
 Set the bone transform in bind space.
virtual csPtr< csSkeletalState2 > GetStateAbsSpace ()=0
 Get the entire skeleton state (all transforms) in absolute space.
virtual csPtr< csSkeletalState2 > GetStateBoneSpace ()=0
 Get the entire skeleton state (all transforms) in bone space.
virtual csPtr< csSkeletalState2 > GetStateBindSpace ()=0
 Get the entire skeleton state (all transforms) in bind space.

Detailed Description

A skeleton instance is a specific copy of a skeleton with base pose and topology defined by the factory but current state internally defined.

Skeleton instance adds one coordinate space per bone, the bind space. Bind space is defined by the skeleton factory, so bind space is relative transform compared to the default orientation.

See also:
iSkeletonFactory2 for more information on coordinate spaces

Definition at line 231 of file skeleton2.h.


Member Function Documentation

virtual iSkeletonAnimPacket2* iSkeleton2::GetAnimationPacket (  )  const [pure virtual]

Get the animation packet associated with this skeleton.

virtual iSkeletonFactory2* iSkeleton2::GetFactory (  )  const [pure virtual]

Get the factory used to create this skeleton instance.

virtual iSceneNode* iSkeleton2::GetSceneNode (  )  [pure virtual]

Get the scene node associated with the skeleton.

virtual unsigned int iSkeleton2::GetSkeletonStateVersion (  )  const [pure virtual]

Get skeleton update version number.

virtual csPtr<csSkeletalState2> iSkeleton2::GetStateAbsSpace (  )  [pure virtual]

Get the entire skeleton state (all transforms) in absolute space.

virtual csPtr<csSkeletalState2> iSkeleton2::GetStateBindSpace (  )  [pure virtual]

Get the entire skeleton state (all transforms) in bind space.

virtual csPtr<csSkeletalState2> iSkeleton2::GetStateBoneSpace (  )  [pure virtual]

Get the entire skeleton state (all transforms) in bone space.

virtual void iSkeleton2::GetTransformAbsSpace ( BoneID  bone,
csQuaternion rot,
csVector3 offset 
) const [pure virtual]

Get the bone transform in skeleton absolute space.

Parameters:
bone bone id to get the transform for
rot rotation quaternion
offset movement offset
virtual void iSkeleton2::GetTransformBindSpace ( BoneID  bone,
csQuaternion rot,
csVector3 offset 
) const [pure virtual]

Get the bone transform in bind space.

Parameters:
bone bone id to get the transform for
rot rotation quaternion
offset movement offset
virtual void iSkeleton2::GetTransformBoneSpace ( BoneID  bone,
csQuaternion rot,
csVector3 offset 
) const [pure virtual]

Get the bone transform in bone space.

Parameters:
bone bone id to get the transform for
rot rotation quaternion
offset movement offset
virtual void iSkeleton2::RecreateSkeleton (  )  [pure virtual]

Recreate the skeleton structure from the factory.

virtual void iSkeleton2::SetAnimationPacket ( iSkeletonAnimPacket2 packet  )  [pure virtual]

Set the animation packet associated with this skeleton.

virtual void iSkeleton2::SetTransformAbsSpace ( BoneID  bone,
const csQuaternion rot,
const csVector3 offset 
) [pure virtual]

Set the bone transform in skeleton absolute space.

Parameters:
bone bone id to set the transform for
rot rotation quaternion
offset movement offset
virtual void iSkeleton2::SetTransformBindSpace ( BoneID  bone,
const csQuaternion rot,
const csVector3 offset 
) [pure virtual]

Set the bone transform in bind space.

Parameters:
bone bone id to set the transform for
rot rotation quaternion
offset movement offset
virtual void iSkeleton2::SetTransformBoneSpace ( BoneID  bone,
const csQuaternion rot,
const csVector3 offset 
) [pure virtual]

Set the bone transform in bone space.

Parameters:
bone bone id to set the transform for
rot rotation quaternion
offset movement offset
virtual void iSkeleton2::UpdateSkeleton ( float  dt  )  [pure virtual]

Update the skeleton.


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

Generated for Crystal Space 1.4.1 by doxygen 1.7.1