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 &p_object, Animation const &p_animation)
	Constructeur. Plus de détails...
C3D_API	~AnimationInstance ()
	Destructeur. Plus de détails...
C3D_API void	Update (std::chrono::milliseconds const &p_tslf)
	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 p_scale)
	Définit le multiplicateur de temps de l'animation. Plus de détails...
bool	IsLooped () const
void	SetLooped (bool p_looped)
	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 }
std::chrono::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 &	p_object,
		Animation const &	p_animation
	)

Constructeur.

Paramètres

[in]	p_object	L'AnimatedObject parent.
[in]	p_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  p_looped )

inline

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

Paramètres

[in]

p_looped

La nouvelle valeur

Références m_looped.

SetScale()

void Castor3D::AnimationInstance::SetScale ( real  p_scale )

inline

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

Paramètres

[in]

p_scale

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

(

std::chrono::milliseconds const &

p_tslf

)

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

Paramètres

[in]

p_tslf

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

std::chrono::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 :

• Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Scene/Animation/AnimationInstance.hpp