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

Classe d'instance d'animation. Plus de détails...

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...
C3D_API	~AnimationInstance ()
	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
real	getScale () const
void	setScale (real value)
	Définit le multiplicateur de temps 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
real	m_scale { 1.0_r }
bool	m_looped { false }
castor::Milliseconds	m_currentTime { 0 }
AnimationState	m_state { AnimationState::eStopped }

Description détaillée

Classe d'instance d'animation.

Auteur

Sylvain DOREMUS

Version

0.9.0

Date

02/06/2016

A faire:

write and read functions.

Remarques

Utilisée pour jouer une animation sur un objet particulier.

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()

C3D_API castor3d::AnimationInstance::~AnimationInstance

(

)

Destructeur.

Documentation des fonctions membres

getAnimation()

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

inline

Renvoie

L'animation.

Références m_animation.

getScale()

real castor3d::AnimationInstance::getScale ( ) const

inline

Renvoie

Le multiplicateur de temps de l'animation.

Références m_scale.

getState()

AnimationState castor3d::AnimationInstance::getState ( ) const

inline

Renvoie

L'état de l'animation.

Références m_state.

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 ( real  value )

inline

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

Paramètres

[in]

value

La nouvelle valeur

Références m_scale.

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.

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

real castor3d::AnimationInstance::m_scale { 1.0_r }

protected

Le multiplicateur de temps.

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

m_state

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

protected

L'état actuel de l'animation.

Référencé par getState().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Scene/Animation/AnimationInstance.hpp