Castor3D::Skeleton Class Reference

The skeleton, holds each bone. More...

Inheritance diagram for Castor3D::Skeleton:

Collaboration diagram for Castor3D::Skeleton:

Public Member Functions
C3D_API	Skeleton ()
	Constructor. More...
C3D_API	~Skeleton ()
	Destructor. More...
C3D_API void	AddBone (BoneSPtr p_bone)
	Adds a bone to the skeleton. More...
C3D_API void	SetBoneParent (BoneSPtr p_bone, BoneSPtr p_parent)
	Adds a bone to another bone's children. More...
template<typename FuncT >
void	TraverseHierarchy (FuncT p_function)
	Traverses bone hierarchy and applies given function to each bone. More...
Castor::Matrix4x4r const &	GetGlobalInverseTransform () const
	Retrieves the global inverse transform. More...
void	SetGlobalInverseTransform (Castor::Matrix4x4r const &p_transform)
	Sets the global inverse transform. More...
Public Member Functions inherited from Castor3D::Animable
C3D_API AnimationSPtr	CreateAnimation (Castor::String const &p_name)
	Creates an animation. More...
C3D_API void	CleanupAnimations ()
	Empties the animations map. More...
C3D_API AnimationSPtr	GetAnimation (Castor::String const &p_name)
	Retrieves an animation. More...
AnimationPtrStrMap const &	GetAnimations () const

Additional Inherited Members
Protected Member Functions inherited from Castor3D::Animable
	Animable ()
	Constructor. More...
	~Animable ()
	Destructor. More...
Protected Attributes inherited from Castor3D::Animable
AnimationPtrStrMap	m_animations
	All animations. More...

Detailed Description

The skeleton, holds each bone.

Author

Sylvain DOREMUS

Version

0.7.0

Constructor & Destructor Documentation

Skeleton()

C3D_API Castor3D::Skeleton::Skeleton

(

)

Constructor.

~Skeleton()

C3D_API Castor3D::Skeleton::~Skeleton

(

)

Destructor.

Member Function Documentation

AddBone()

C3D_API void Castor3D::Skeleton::AddBone

(

BoneSPtr

p_bone

)

Adds a bone to the skeleton.

Parameters

[in]

p_bone

The bone.

GetGlobalInverseTransform()

Castor::Matrix4x4r const& Castor3D::Skeleton::GetGlobalInverseTransform ( ) const

inline

Retrieves the global inverse transform.

Returns

The value

SetBoneParent()

C3D_API void Castor3D::Skeleton::SetBoneParent	(	BoneSPtr	p_bone,
		BoneSPtr	p_parent
	)

Adds a bone to another bone's children.

Parameters

[in]	p_bone	The bone.
[in]	p_parent	The parent bone.

SetGlobalInverseTransform()

void Castor3D::Skeleton::SetGlobalInverseTransform ( Castor::Matrix4x4r const &  p_transform )

inline

Sets the global inverse transform.

Parameters

[in]

p_transform

The new value

TraverseHierarchy()

template<typename FuncT >

void Castor3D::Skeleton::TraverseHierarchy ( FuncT  p_function )

inline

Traverses bone hierarchy and applies given function to each bone.

Parameters

[in]

p_function

The function to apply.

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Skeleton.hpp