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

#include <AnimationInstance.hpp>

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

Graphe de collaboration de castor3d::AnimationInstance:

Fonctions membres publiques
C3D_API	AnimationInstance (AnimatedObject &object, Animation &animation)
	Constructeur. Plus de détails...
virtual C3D_API	~AnimationInstance ()=default
	Destructeur. Plus de détails...
C3D_API void	update (castor::Milliseconds const &elapsed)
	Met l'animation à jour, met à jour les key frames aux bons index de temps. Plus de détails...
C3D_API void	play ()
	Démarre l'animation. Plus de détails...
C3D_API void	pause ()
	Met l'animation en pause. Plus de détails...
C3D_API void	stop ()
	Stoppe l'animation. Plus de détails...
AnimationState	getState () const
float	getScale () const
void	setScale (float value)
	Définit le multiplicateur de temps de l'animation. Plus de détails...
castor::Milliseconds	getStartingPoint () const
void	setStartingPoint (castor::Milliseconds value)
	Définit le point de départ de l'animation. Plus de détails...
castor::Milliseconds	getStoppingPoint () const
void	setStoppingPoint (castor::Milliseconds value)
	Définit le point d'arrêt de l'animation. Plus de détails...
bool	isLooped () const
void	setLooped (bool value)
	Définit l'état de boucle de l'animation. Plus de détails...
Animation const &	getAnimation () const

Attributs protégés
Animation const &	m_animation
float	m_scale { 1.0f }
bool	m_looped { false }
castor::Milliseconds	m_startingPoint { 0 }
castor::Milliseconds	m_stoppingPoint { 0 }
castor::Milliseconds	m_currentTime { 0 }
AnimationState	m_state { AnimationState::eStopped }

Documentation des constructeurs et destructeur

AnimationInstance()

C3D_API castor3d::AnimationInstance::AnimationInstance	(	AnimatedObject &	object,
		Animation &	animation
	)

Constructeur.

Paramètres

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

~AnimationInstance()

virtual C3D_API castor3d::AnimationInstance::~AnimationInstance ( )

virtualdefault

Destructeur.

Documentation des fonctions membres

getAnimation()

Animation const & castor3d::AnimationInstance::getAnimation ( ) const

inline

Renvoie

L'animation.

Références m_animation.

getScale()

float castor3d::AnimationInstance::getScale ( ) const

inline

Renvoie

Le multiplicateur de temps de l'animation.

Références m_scale.

getStartingPoint()

castor::Milliseconds castor3d::AnimationInstance::getStartingPoint ( ) const

inline

Renvoie

Le point de départ de l'animation.

Références m_startingPoint.

getState()

AnimationState castor3d::AnimationInstance::getState ( ) const

inline

Renvoie

L'état de l'animation.

Références m_state.

getStoppingPoint()

castor::Milliseconds castor3d::AnimationInstance::getStoppingPoint ( ) const

inline

Renvoie

Le point d'arrêt de l'animation.

Références m_stoppingPoint.

isLooped()

bool castor3d::AnimationInstance::isLooped ( ) const

inline

Renvoie

L'état de boucle de l'animation.

Références m_looped.

pause()

C3D_API void castor3d::AnimationInstance::pause

(

)

Met l'animation en pause.

play()

C3D_API void castor3d::AnimationInstance::play

(

)

Démarre l'animation.

setLooped()

void castor3d::AnimationInstance::setLooped ( bool  value )

inline

Définit l'état de boucle de l'animation.

Paramètres

[in]

value

La nouvelle valeur

Références m_looped.

setScale()

void castor3d::AnimationInstance::setScale ( float  value )

inline

Définit le multiplicateur de temps de l'animation.

Paramètres

[in]

value

La nouvelle valeur

Références m_scale.

setStartingPoint()

void castor3d::AnimationInstance::setStartingPoint ( castor::Milliseconds  value )

inline

Définit le point de départ de l'animation.

Paramètres

[in]

value

La nouvelle valeur.

Références m_currentTime, et m_startingPoint.

setStoppingPoint()

void castor3d::AnimationInstance::setStoppingPoint ( castor::Milliseconds  value )

inline

Définit le point d'arrêt de l'animation.

Paramètres

[in]

value

La nouvelle valeur.

Références m_currentTime, et m_stoppingPoint.

stop()

C3D_API void castor3d::AnimationInstance::stop

(

)

Stoppe l'animation.

update()

C3D_API void castor3d::AnimationInstance::update

(

castor::Milliseconds const &

elapsed

)

Met l'animation à jour, met à jour les key frames aux bons index de temps.

Paramètres

[in]

elapsed

Le temps écoulé depuis la dernière frame.

Documentation des données membres

m_animation

Animation const& castor3d::AnimationInstance::m_animation

protected

L'animation.

Référencé par getAnimation().

m_currentTime

castor::Milliseconds castor3d::AnimationInstance::m_currentTime { 0 }

protected

L'index de temps courant.

Référencé par setStartingPoint(), et setStoppingPoint().

m_looped

bool castor3d::AnimationInstance::m_looped { false }

protected

Dit si oui ou non l'animation est bouclée.

Référencé par isLooped(), et setLooped().

m_scale

float castor3d::AnimationInstance::m_scale { 1.0f }

protected

Le multiplicateur de temps.

Référencé par getScale(), et setScale().

m_startingPoint

castor::Milliseconds castor3d::AnimationInstance::m_startingPoint { 0 }

protected

Le point de départ.

Référencé par getStartingPoint(), et setStartingPoint().

m_state

AnimationState castor3d::AnimationInstance::m_state { AnimationState::eStopped }

protected

L'état actuel de l'animation.

Référencé par getState().

m_stoppingPoint

castor::Milliseconds castor3d::AnimationInstance::m_stoppingPoint { 0 }

protected

Le point d'arrêt.

Référencé par getStoppingPoint(), et setStoppingPoint().

---

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

• Scene/Animation/AnimationInstance.hpp