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

#include <SkeletonAnimationInstance.hpp>

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

Graphe de collaboration de castor3d::SkeletonAnimationInstance:

Fonctions membres publiques
C3D_API	SkeletonAnimationInstance (SkeletonAnimationInstance &&rhs) noexcept=default
C3D_API SkeletonAnimationInstance &	operator= (SkeletonAnimationInstance &&rhs) noexcept=delete
C3D_API	SkeletonAnimationInstance (SkeletonAnimationInstance const &rhs)=delete
C3D_API SkeletonAnimationInstance &	operator= (SkeletonAnimationInstance const &rhs)=delete
C3D_API	~SkeletonAnimationInstance () noexcept override=default
C3D_API	SkeletonAnimationInstance (AnimatedSkeleton &object, SkeletonAnimation &animation)
	Constructeur.
C3D_API SkeletonAnimationInstanceObjectRPtr	getObject (BoneNode const &bone) const
	Récupère un os animé.
C3D_API SkeletonAnimationInstanceObjectRPtr	getObject (SkeletonNode const &node) const
	Récupère un noeud animé.
C3D_API SkeletonAnimationInstanceObjectRPtr	getObject (SkeletonNodeType type, castor::String const &name) const
	Récupère un objet animé.
auto	getObjectsCount () const
auto	begin ()
auto	begin () const
auto	end ()
auto	end () const
Fonctions membres publiques hérités de castor3d::AnimationInstance
C3D_API	AnimationInstance (AnimatedObject &object, Animation const &animation, bool looped=false)
	Constructeur.
virtual C3D_API	~AnimationInstance () noexcept=default
	Destructeur.
C3D_API void	update (castor::Milliseconds const &elapsed)
	Met l'animation à jour, met à jour les key frames aux bons index de temps.
C3D_API void	play ()
	Démarre l'animation.
C3D_API void	pause ()
	Met l'animation en pause.
C3D_API void	stop ()
	Stoppe l'animation.
AnimationState	getState () const
float	getScale () const
void	setScale (float value)
	Définit le multiplicateur de temps de l'animation.
castor::Milliseconds	getStartingPoint () const
void	setStartingPoint (castor::Milliseconds value)
	Définit le point de départ de l'animation.
castor::Milliseconds	getStoppingPoint () const
void	setStoppingPoint (castor::Milliseconds value)
	Définit le point d'arrêt de l'animation.
bool	isLooped () const
void	setLooped (bool value)
	Définit l'état de boucle de l'animation.
InterpolatorType	getInterpolation () const
void	setInterpolation (InterpolatorType value)
	Définit le mode d'interpolation de l'animation.
Animation const &	getAnimation () const
C3D_API AnimationInstance &	operator= (AnimationInstance &&rhs) noexcept=delete
C3D_API	AnimationInstance (AnimationInstance const &rhs)=delete
C3D_API AnimationInstance &	operator= (AnimationInstance const &rhs)=delete
C3D_API	AnimationInstance (AnimationInstance &&rhs) noexcept
Fonctions membres publiques hérités de castor::OwnedBy< AnimatedObject >
AnimatedObject *	getOwner () const
	L'objet propriétaire.

Attributs protégés
SkeletonAnimationInstanceObjectPtrArray	m_toMove
SkeletonAnimationInstanceKeyFrameArray	m_keyFrames
SkeletonAnimationInstanceKeyFrameArray::iterator	m_curr
Attributs protégés hérités de castor3d::AnimationInstance
Animation const &	m_animation
float	m_scale { 1.0f }
std::atomic_bool	m_looped
castor::Milliseconds	m_startingPoint { 0 }
castor::Milliseconds	m_stoppingPoint { 0 }
castor::Milliseconds	m_currentTime { 0 }
AnimationState	m_state { AnimationState::eStopped }
InterpolatorType	m_interpolation { InterpolatorType::eLinear }

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

Documentation des constructeurs et destructeur

SkeletonAnimationInstance() [1/3]

C3D_API castor3d::SkeletonAnimationInstance::SkeletonAnimationInstance ( SkeletonAnimationInstance && rhs )

defaultnoexcept

SkeletonAnimationInstance() [2/3]

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

delete

~SkeletonAnimationInstance()

C3D_API castor3d::SkeletonAnimationInstance::~SkeletonAnimationInstance ( )

overridedefaultnoexcept

SkeletonAnimationInstance() [3/3]

C3D_API castor3d::SkeletonAnimationInstance::SkeletonAnimationInstance	(	AnimatedSkeleton &	object,
		SkeletonAnimation &	animation )

Constructeur.

Paramètres

[in]	object	L'AnimatedSkeleton parent.
[in]	animation	L'animation.

Documentation des fonctions membres

begin() [1/2]

auto castor3d::SkeletonAnimationInstance::begin ( )

inline

Renvoie

L'itérateur sur le début des objets racines.

Références m_toMove.

begin() [2/2]

auto castor3d::SkeletonAnimationInstance::begin ( ) const

inline

Renvoie

L'itérateur sur le début des objets racines.

Références m_toMove.

end() [1/2]

auto castor3d::SkeletonAnimationInstance::end ( )

inline

Renvoie

L'itérateur sur la fin des objets racines.

Références m_toMove.

end() [2/2]

auto castor3d::SkeletonAnimationInstance::end ( ) const

inline

Renvoie

L'itérateur sur la fin des objets racines.

Références m_toMove.

getObject() [1/3]

C3D_API SkeletonAnimationInstanceObjectRPtr castor3d::SkeletonAnimationInstance::getObject

(

BoneNode const &

bone

)

const

Récupère un os animé.

Paramètres

[in]

bone

L'os.

getObject() [2/3]

C3D_API SkeletonAnimationInstanceObjectRPtr castor3d::SkeletonAnimationInstance::getObject

(

SkeletonNode const &

node

)

const

Récupère un noeud animé.

Paramètres

[in]

node

Le noeud.

getObject() [3/3]

C3D_API SkeletonAnimationInstanceObjectRPtr castor3d::SkeletonAnimationInstance::getObject	(	SkeletonNodeType	type,
		castor::String const &	name ) const

Récupère un objet animé.

Paramètres

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

getObjectsCount()

auto castor3d::SkeletonAnimationInstance::getObjectsCount ( ) const

inline

Renvoie

Le nombre d'objets.

Références m_toMove.

operator=() [1/2]

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

deletenoexcept

operator=() [2/2]

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

delete

Documentation des données membres

m_curr

SkeletonAnimationInstanceKeyFrameArray::iterator castor3d::SkeletonAnimationInstance::m_curr

protected

Itérateur sur la keyframe courante (quand l'animation est jouée).

m_keyFrames

SkeletonAnimationInstanceKeyFrameArray castor3d::SkeletonAnimationInstance::m_keyFrames

protected

Les instances des keyframes.

m_toMove

SkeletonAnimationInstanceObjectPtrArray castor3d::SkeletonAnimationInstance::m_toMove

protected

Les objets mouvants.

Référencé par begin(), begin(), end(), end(), et getObjectsCount().

---

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

• Castor3D/Scene/Animation/Skeleton/SkeletonAnimationInstance.hpp