Référence de la classe castor3d::SkeletonAnimation

#include <SkeletonAnimation.hpp>

Graphe d'héritage de castor3d::SkeletonAnimation:

Graphe de collaboration de castor3d::SkeletonAnimation:

Fonctions membres publiques
C3D_API	SkeletonAnimation (Animable &animable, castor::String const &name=castor::cuEmptyString)
	Constructeur.
C3D_API	SkeletonAnimation (SkeletonAnimation &&rhs)=default
	Constructeur par déplacement.
C3D_API SkeletonAnimation &	operator= (SkeletonAnimation &&rhs)=delete
	Opérateur d'affectation par déplacement.
C3D_API	SkeletonAnimation (SkeletonAnimation const &rhs)=delete
	Constructeur par copie.
C3D_API SkeletonAnimation &	operator= (SkeletonAnimation const &rhs)=delete
	Opérateur d'affectation par copie.
C3D_API SkeletonAnimationObjectRPtr	addObject (SkeletonNode &node, SkeletonAnimationObject const *parent)
	Crée et ajoute un noeud mouvant.
C3D_API SkeletonAnimationObjectRPtr	addObject (BoneNode &bone, SkeletonAnimationObject const *parent)
	Crée et ajoute un os mouvant.
C3D_API SkeletonAnimationObjectRPtr	addObject (SkeletonAnimationObjectUPtr object, SkeletonAnimationObject const *parent)
	Ajoute un objet animé.
C3D_API bool	hasObject (SkeletonNodeType type, castor::String const &name) const
	Dit si l'animation a l'objet animé.
C3D_API SkeletonAnimationObjectRPtr	getObject (SkeletonNode const &node) const
	Récupère un noeud animé.
C3D_API SkeletonAnimationObjectRPtr	getObject (BoneNode const &bone) const
	Récupère un os animé.
C3D_API SkeletonAnimationObjectRPtr	getObject (SkeletonNodeType type, castor::String const &name) const
	Récupère un objet animé.
auto const &	getObjects () const
SkeletonAnimationObjectArray const &	getRootObjects () const
	Récupère le nombre d'objets mouvants.
Fonctions membres publiques hérités de castor3d::AnimationT< Engine >
	AnimationT (Engine &handler, AnimationType type, AnimableT< Engine > &animable, castor::String const &name=castor::cuEmptyString)
	Constructeur.
	AnimationT (Engine &handler, AnimationType type, castor::String const &name=castor::cuEmptyString)
	Constructeur.
void	addKeyFrame (AnimationKeyFrameUPtr keyFrame)
	Ajoute une keyframe à l'animation.
AnimationKeyFrameArray::iterator	find (castor::Milliseconds const &time)
	Trouve une keyframe à l'index de temps donné.
void	findKeyFrame (castor::Milliseconds const &time, AnimationKeyFrameArray::iterator &prv, AnimationKeyFrameArray::iterator &cur) const
	Trouve une keyframe à l'index de temps donné.
void	updateLength ()
	Initialise la longueur de l'animation.
bool	isEmpty () const
size_t	size () const
AnimationKeyFrameArray::const_iterator	begin () const
AnimationKeyFrameArray::iterator	begin ()
AnimationKeyFrameArray::const_iterator	end () const
AnimationKeyFrameArray::iterator	end ()
AnimationType	getType () const
castor::Milliseconds const &	getLength () const
AnimableT< Engine > *	getAnimable () const
C3D_API	AnimationT (AnimationT &&rhs) noexcept=default
C3D_API	AnimationT (AnimationT const &rhs)=delete
C3D_API AnimationT &	operator= (AnimationT &&rhs) noexcept=delete
C3D_API AnimationT &	operator= (AnimationT const &rhs)=delete
virtual C3D_API	~AnimationT () noexcept=default
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept
Fonctions membres publiques hérités de castor::OwnedBy< Owner >
Owner *	getOwner () const
	L'objet propriétaire.

Types protégés
using	ObjectMap = castor::StringMap< SkeletonAnimationObjectUPtr >

Attributs protégés
SkeletonAnimationObjectArray	m_rootObjects
ObjectMap	m_toMove
Attributs protégés hérités de castor3d::AnimationT< Engine >
AnimableT< Engine > *	m_animable
AnimationType	m_type
castor::Milliseconds	m_length
AnimationKeyFrameArray	m_keyframes
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Amis
class	BinaryWriter< SkeletonAnimation >
class	BinaryParser< SkeletonAnimation >
class	SkeletonAnimationInstance

Membres hérités additionnels
Fonctions membres protégées hérités de castor::OwnedBy< Owner >
	OwnedBy (Owner &owner)
	Constructeur.

Documentation des définitions de type membres

ObjectMap

using castor3d::SkeletonAnimation::ObjectMap = castor::StringMap< SkeletonAnimationObjectUPtr >

protected

Documentation des constructeurs et destructeur

SkeletonAnimation() [1/3]

C3D_API castor3d::SkeletonAnimation::SkeletonAnimation ( Animable & animable, castor::String const & name = castor::cuEmptyString )

explicit

Constructeur.

Paramètres

[in]	animable	L'objet animable parent.
[in]	name	Le nom de l'animation.

SkeletonAnimation() [2/3]

C3D_API castor3d::SkeletonAnimation::SkeletonAnimation ( SkeletonAnimation && rhs )

default

Constructeur par déplacement.

SkeletonAnimation() [3/3]

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

delete

Constructeur par copie.

Documentation des fonctions membres

addObject() [1/3]

C3D_API SkeletonAnimationObjectRPtr castor3d::SkeletonAnimation::addObject	(	BoneNode &	bone,
		SkeletonAnimationObject const *	parent )

Crée et ajoute un os mouvant.

Paramètres

[in]	bone	L'os.
[in]	parent	Le parent de l'objet déplaçable.

addObject() [2/3]

C3D_API SkeletonAnimationObjectRPtr castor3d::SkeletonAnimation::addObject	(	SkeletonAnimationObjectUPtr	object,
		SkeletonAnimationObject const *	parent )

Ajoute un objet animé.

Paramètres

[in]	object	L'objet animé.
[in]	parent	Le parent de l'objet déplaçable.

addObject() [3/3]

C3D_API SkeletonAnimationObjectRPtr castor3d::SkeletonAnimation::addObject	(	SkeletonNode &	node,
		SkeletonAnimationObject const *	parent )

Crée et ajoute un noeud mouvant.

Paramètres

[in]	node	Le noeud.
[in]	parent	Le parent de l'objet déplaçable.

getObject() [1/3]

C3D_API SkeletonAnimationObjectRPtr castor3d::SkeletonAnimation::getObject

(

BoneNode const &

bone

)

const

Récupère un os animé.

Paramètres

[in]

bone

L'os.

getObject() [2/3]

C3D_API SkeletonAnimationObjectRPtr castor3d::SkeletonAnimation::getObject

(

SkeletonNode const &

node

)

const

Récupère un noeud animé.

Paramètres

[in]

node

Le noeud.

getObject() [3/3]

C3D_API SkeletonAnimationObjectRPtr castor3d::SkeletonAnimation::getObject	(	SkeletonNodeType	type,
		castor::String const &	name ) const

Récupère un objet animé.

Paramètres

[in]	type	Le type d'objet.
[in]	name	Le nom de l'objet.

getObjects()

auto const & castor3d::SkeletonAnimation::getObjects ( ) const

inline

Renvoie

Les objets mouvants.

Références m_toMove.

getRootObjects()

SkeletonAnimationObjectArray const & castor3d::SkeletonAnimation::getRootObjects ( ) const

inline

Récupère le nombre d'objets mouvants.

Renvoie

Les objets mouvants racines.

Références m_rootObjects.

hasObject()

C3D_API bool castor3d::SkeletonAnimation::hasObject	(	SkeletonNodeType	type,
		castor::String const &	name ) const

Dit si l'animation a l'objet animé.

Paramètres

[in]	type	Le type de l'objet.
[in]	name	Le nom de l'objet.

operator=() [1/2]

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

delete

Opérateur d'affectation par déplacement.

operator=() [2/2]

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

delete

Opérateur d'affectation par copie.

Documentation des fonctions amies et associées

BinaryParser< SkeletonAnimation >

friend class BinaryParser< SkeletonAnimation >

friend

BinaryWriter< SkeletonAnimation >

friend class BinaryWriter< SkeletonAnimation >

friend

SkeletonAnimationInstance

friend class SkeletonAnimationInstance

friend

Documentation des données membres

m_rootObjects

SkeletonAnimationObjectArray castor3d::SkeletonAnimation::m_rootObjects

protected

Les objets mouvants racine.

Référencé par getRootObjects().

m_toMove

ObjectMap castor3d::SkeletonAnimation::m_toMove

protected

Les objets mouvants.

Référencé par getObjects().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Castor3D/Model/Skeleton/Animation/SkeletonAnimation.hpp