#include <AnimationInstance.hpp>

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

[légende]

Graphe de collaboration de castor3d::AnimationInstance:

[légende]

Fonctions membres publiques
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
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

◆ AnimationInstance() [1/3]

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

delete

◆ AnimationInstance() [2/3]

C3D_API castor3d::AnimationInstance::AnimationInstance ( AnimationInstance && rhs )

noexcept

◆ AnimationInstance() [3/3]

C3D_API castor3d::AnimationInstance::AnimationInstance	(	AnimatedObject &	object,
		Animation const &	animation,
		bool	looped = false )

Constructeur.

Paramètres

[in]	object	L'AnimatedObject parent.
[in]	animation	L'animation.
[in]	looped	L'animation tourne-t-elle en boucle ou pas.

◆ ~AnimationInstance()

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

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

◆ getAnimation()

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

inline

Renvoie: L'animation.

Références m_animation.

◆ getInterpolation()

InterpolatorType castor3d::AnimationInstance::getInterpolation ( ) const

inline

Renvoie: Le mode d'interpolation de l'animation.

Références m_interpolation.

◆ 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.

◆ operator=() [1/2]

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

deletenoexcept

name Copie / Déplacement.

◆ operator=() [2/2]

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

delete

◆ pause()

C3D_API void castor3d::AnimationInstance::pause ( )

Met l'animation en pause.

◆ play()

C3D_API void castor3d::AnimationInstance::play ( )

Démarre l'animation.

◆ setInterpolation()

void castor3d::AnimationInstance::setInterpolation ( InterpolatorType value )

inline

Définit le mode d'interpolation de l'animation.

Paramètres

[in] value La nouvelle valeur.

Références m_interpolation.

◆ 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_interpolation

InterpolatorType castor3d::AnimationInstance::m_interpolation { InterpolatorType::eLinear }

protected

L'interplation de l'animation.

Référencé par getInterpolation(), et setInterpolation().

◆ m_looped

std::atomic_bool castor3d::AnimationInstance::m_looped

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 :

Castor3D/Scene/Animation/AnimationInstance.hpp

Fonctions membres publiques

Attributs protégés

Membres hérités additionnels

Documentation des constructeurs et destructeur

◆ AnimationInstance() [1/3]

◆ AnimationInstance() [2/3]

◆ AnimationInstance() [3/3]

◆ ~AnimationInstance()

Documentation des fonctions membres

◆ getAnimation()

◆ getInterpolation()

◆ getScale()

◆ getStartingPoint()

◆ getState()

◆ getStoppingPoint()

◆ isLooped()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pause()

◆ play()

◆ setInterpolation()

◆ setLooped()

◆ setScale()

◆ setStartingPoint()

◆ setStoppingPoint()

◆ stop()

◆ update()

Documentation des données membres

◆ m_animation

◆ m_currentTime

◆ m_interpolation

◆ m_looped

◆ m_scale

◆ m_startingPoint

◆ m_state

◆ m_stoppingPoint