castor3d::Skeleton Class Reference

#include <Skeleton.hpp>

Inheritance diagram for castor3d::Skeleton:

Collaboration diagram for castor3d::Skeleton:

Public Member Functions
C3D_API	Skeleton (castor::String name, Scene &scene)
	Constructor.
C3D_API	~Skeleton () noexcept override
	Destructor.
C3D_API SkeletonNode *	createNode (castor::String name)
	Creates a node.
C3D_API BoneNode *	createBone (castor::String name, castor::Matrix4x4f const &inverseTransform)
	Creates a bone.
C3D_API SkeletonNode *	findNode (castor::String const &name) const
	Finds a bone from a name.
C3D_API SkeletonNode *	getRootNode () const
C3D_API void	setNodeParent (SkeletonNode &node, SkeletonNode &parent)
	Adds a node to another node's children.
C3D_API SkeletonAnimation &	createAnimation (castor::String const &name)
	Creates an animation.
C3D_API void	removeAnimation (castor::String const &name)
	Removes an animation.
C3D_API void	computeContainers (Mesh &mesh)
	Computes the bounding box and sphere for each bone, for given mesh.
C3D_API void	cloneInto (Skeleton &output) const
	Clones this object into the given one.
castor::Matrix4x4f const &	getGlobalInverseTransform () const
void	setGlobalInverseTransform (castor::Matrix4x4f const &transform)
castor::Vector< BoneNode * > const &	getBones () const
SkeletonNodePtrArray const &	getNodes () const
size_t	getNodesCount () const
size_t	getBonesCount () const
castor::Vector< castor::BoundingBox > const &	getContainers (Mesh &mesh) const
SceneRPtr	getScene () const
C3D_API	Skeleton (Skeleton &&rhs)=default
C3D_API Skeleton &	operator= (Skeleton &&rhs)=delete
C3D_API	Skeleton (Skeleton const &rhs)=delete
C3D_API Skeleton &	operator= (Skeleton const &rhs)=delete
Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.
T const &	getName () const noexcept
	Retrieves the name.
void	rename (T name) noexcept
Public Member Functions inherited from castor3d::Animable
virtual C3D_API	~Animable () noexcept=default
C3D_API void	cleanupAnimations ()
	Empties the animations map.
virtual C3D_API bool	hasAnimation () const noexcept
C3D_API bool	hasAnimation (castor::String const &name) const
C3D_API Animation const &	getAnimation (castor::String const &name) const
	Retrieves an animation.
C3D_API Animation &	getAnimation (castor::String const &name)
	Retrieves an animation.
C3D_API void	addAnimation (AnimationPtr animation)
	Adds an animation.
AnimationsMap const &	getAnimations () const
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const noexcept
void	setOwner (Engine &owner) noexcept

Static Public Member Functions
static C3D_API void	addParsers (castor::AttributeParsers &result)

Friends
class	BinaryWriter< Skeleton >
class	BinaryParser< Skeleton >

Additional Inherited Members
Protected Types inherited from castor3d::Animable
using	AnimationPtr = castor::UniquePtr< Animation >
using	AnimationsMap = castor::StringMap< AnimationPtr >
Protected Member Functions inherited from castor3d::Animable
C3D_API void	doRemoveAnimation (castor::String const &name)
	Removes an animation.
template<typename AnimationType >
AnimationType &	doGetAnimation (castor::String const &name)
	Retrieves an animation.
template<typename AnimationType >
AnimationType const &	doGetAnimation (castor::String const &name) const
	Retrieves an animation.
C3D_API	Animable (Engine &owner)
C3D_API	Animable (Animable &&rhs) noexcept=default
C3D_API Animable &	operator= (Animable &&rhs) noexcept=delete
C3D_API	Animable (Animable const &rhs)=delete
C3D_API Animable &	operator= (Animable const &rhs)=delete
Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner) noexcept
	Constructor.
Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name
Protected Attributes inherited from castor3d::Animable
AnimationsMap	m_animations

Constructor & Destructor Documentation

Skeleton() [1/3]

C3D_API castor3d::Skeleton::Skeleton ( Skeleton && rhs )

default

name Copy / Move.

Skeleton() [2/3]

C3D_API castor3d::Skeleton::Skeleton ( Skeleton const & rhs )

delete

Skeleton() [3/3]

C3D_API castor3d::Skeleton::Skeleton	(	castor::String	name,
		Scene &	scene )

Constructor.

Parameters

[in]	name	The skeleton name.
[in]	scene	The scene.

~Skeleton()

C3D_API castor3d::Skeleton::~Skeleton ( )

overridenoexcept

Destructor.

Member Function Documentation

addParsers()

static C3D_API void castor3d::Skeleton::addParsers ( castor::AttributeParsers & result )

static

cloneInto()

C3D_API void castor3d::Skeleton::cloneInto

(

Skeleton &

output

)

const

Clones this object into the given one.

Parameters

[in,out]

output

Receives this object's data.

computeContainers()

C3D_API void castor3d::Skeleton::computeContainers

(

Mesh &

mesh

)

Computes the bounding box and sphere for each bone, for given mesh.

createAnimation()

C3D_API SkeletonAnimation & castor3d::Skeleton::createAnimation

(

castor::String const &

name

)

Creates an animation.

Parameters

[in]

name

The animation name

Returns

The animation

createBone()

C3D_API BoneNode * castor3d::Skeleton::createBone	(	castor::String	name,
		castor::Matrix4x4f const &	inverseTransform )

Creates a bone.

Parameters

[in]	name	The bone name.
[in]	inverseTransform	The transfromation matrix from mesh space to bone space.

createNode()

C3D_API SkeletonNode * castor3d::Skeleton::createNode

(

castor::String

name

)

Creates a node.

Parameters

[in]

name

The node name.

findNode()

C3D_API SkeletonNode * castor3d::Skeleton::findNode

(

castor::String const &

name

)

const

Finds a bone from a name.

Parameters

[in]

name

The bone name.

getBones()

castor::Vector< BoneNode * > const & castor3d::Skeleton::getBones ( ) const

inline

getBonesCount()

size_t castor3d::Skeleton::getBonesCount ( ) const

inline

getContainers()

castor::Vector< castor::BoundingBox > const & castor3d::Skeleton::getContainers ( Mesh & mesh ) const

inline

getGlobalInverseTransform()

castor::Matrix4x4f const & castor3d::Skeleton::getGlobalInverseTransform ( ) const

inline

getNodes()

SkeletonNodePtrArray const & castor3d::Skeleton::getNodes ( ) const

inline

getNodesCount()

size_t castor3d::Skeleton::getNodesCount ( ) const

inline

getRootNode()

C3D_API SkeletonNode * castor3d::Skeleton::getRootNode

(

)

const

Returns

The root skeleton node.

getScene()

SceneRPtr castor3d::Skeleton::getScene ( ) const

inline

operator=() [1/2]

C3D_API Skeleton & castor3d::Skeleton::operator= ( Skeleton && rhs )

delete

operator=() [2/2]

C3D_API Skeleton & castor3d::Skeleton::operator= ( Skeleton const & rhs )

delete

removeAnimation()

C3D_API void castor3d::Skeleton::removeAnimation

(

castor::String const &

name

)

Removes an animation.

Parameters

[in]

name

The animation name

setGlobalInverseTransform()

void castor3d::Skeleton::setGlobalInverseTransform ( castor::Matrix4x4f const & transform )

inline

setNodeParent()

C3D_API void castor3d::Skeleton::setNodeParent	(	SkeletonNode &	node,
		SkeletonNode &	parent )

Adds a node to another node's children.

Parameters

[in]	node	The node.
[in]	parent	The parent bone.

Friends And Related Symbol Documentation

BinaryParser< Skeleton >

friend class BinaryParser< Skeleton >

friend

BinaryWriter< Skeleton >

friend class BinaryWriter< Skeleton >

friend

---

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

• Castor3D/Model/Skeleton/Skeleton.hpp