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

#include <AnimatedObject.hpp>

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

Graphe de collaboration de castor3d::AnimatedObject:

Types publics
using	AnimationInstancesMap = castor::StringMap< AnimationInstanceUPtr >

Fonctions membres publiques
C3D_API	AnimatedObject (AnimationType kind, castor::String const &name)
	Constructeur.
virtual C3D_API	~AnimatedObject () noexcept=default
	Destructeur.
C3D_API void	addAnimation (castor::String const &name)
	Ajoute une animation à la liste.
C3D_API void	startAnimation (castor::String const &name)
	Démarre l'animation identifiée par le nom donné
C3D_API void	stopAnimation (castor::String const &name)
	Stoppe l'animation identifiée par le nom donné
C3D_API void	pauseAnimation (castor::String const &name)
	Met en pause l'animation identifiée par le nom donné
C3D_API void	startAllAnimations ()
	Démarre toutes les animations.
C3D_API void	stopAllAnimations ()
	Stoppe toutes les animations.
C3D_API void	pauseAllAnimations ()
	Met en pause toutes les animations.
C3D_API AnimationInstance &	getAnimation (castor::String const &name)
	Récupère une animation.
virtual C3D_API void	update (castor::Milliseconds const &elapsed)=0
	Met à jour les animations de l'objet, selon le temps écoulé depuis la dernière frame.
virtual C3D_API bool	isPlayingAnimation () const =0
C3D_API	AnimatedObject (AnimatedObject &&rhs) noexcept=default
C3D_API AnimatedObject &	operator= (AnimatedObject &&rhs) noexcept=default
C3D_API	AnimatedObject (AnimatedObject const &rhs)=delete
C3D_API AnimatedObject &	operator= (AnimatedObject const &rhs)=delete
bool	hasAnimation (castor::String const &name)
AnimationInstancesMap const &	getAnimations () const
AnimationType	getKind () const
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept

Attributs protégés
AnimationInstancesMap	m_animations
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des définitions de type membres

AnimationInstancesMap

using castor3d::AnimatedObject::AnimationInstancesMap = castor::StringMap< AnimationInstanceUPtr >

Documentation des constructeurs et destructeur

AnimatedObject() [1/3]

C3D_API castor3d::AnimatedObject::AnimatedObject ( AnimatedObject && rhs )

defaultnoexcept

name Copie / Déplacement.

AnimatedObject() [2/3]

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

delete

AnimatedObject() [3/3]

C3D_API castor3d::AnimatedObject::AnimatedObject ( AnimationType kind, castor::String const & name )

explicit

Constructeur.

Paramètres

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

~AnimatedObject()

virtual C3D_API castor3d::AnimatedObject::~AnimatedObject ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

addAnimation()

C3D_API void castor3d::AnimatedObject::addAnimation

(

castor::String const &

name

)

Ajoute une animation à la liste.

Paramètres

[in]

name

L'animation à ajouter

getAnimation()

C3D_API AnimationInstance & castor3d::AnimatedObject::getAnimation

(

castor::String const &

name

)

Récupère une animation.

Paramètres

[in]

name

Le nom de l'animation

Renvoie

L'animation

getAnimations()

AnimationInstancesMap const & castor3d::AnimatedObject::getAnimations ( ) const

inline

Références m_animations.

getKind()

AnimationType castor3d::AnimatedObject::getKind ( ) const

inline

hasAnimation()

bool castor3d::AnimatedObject::hasAnimation ( castor::String const & name )

inline

name Accesseurs.

Références m_animations.

isPlayingAnimation()

virtual C3D_API bool castor3d::AnimatedObject::isPlayingAnimation ( ) const

pure virtual

Renvoie

true si l'objet joue une animation.

Implémenté dans castor3d::AnimatedMesh, castor3d::AnimatedSceneNode, castor3d::AnimatedSkeleton, et castor3d::AnimatedTexture.

operator=() [1/2]

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

defaultnoexcept

operator=() [2/2]

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

delete

pauseAllAnimations()

C3D_API void castor3d::AnimatedObject::pauseAllAnimations

(

)

Met en pause toutes les animations.

pauseAnimation()

C3D_API void castor3d::AnimatedObject::pauseAnimation

(

castor::String const &

name

)

Met en pause l'animation identifiée par le nom donné

Paramètres

[in]

name

Le nom de l'animation

startAllAnimations()

C3D_API void castor3d::AnimatedObject::startAllAnimations

(

)

Démarre toutes les animations.

startAnimation()

C3D_API void castor3d::AnimatedObject::startAnimation

(

castor::String const &

name

)

Démarre l'animation identifiée par le nom donné

Paramètres

[in]

name

Le nom de l'animation

stopAllAnimations()

C3D_API void castor3d::AnimatedObject::stopAllAnimations

(

)

Stoppe toutes les animations.

stopAnimation()

C3D_API void castor3d::AnimatedObject::stopAnimation

(

castor::String const &

name

)

Stoppe l'animation identifiée par le nom donné

Paramètres

[in]

name

Le nom de l'animation

update()

virtual C3D_API void castor3d::AnimatedObject::update ( castor::Milliseconds const & elapsed )

pure virtual

Met à jour les animations de l'objet, selon le temps écoulé depuis la dernière frame.

Paramètres

[in]

elapsed

Le temps écoulé depuis la dernière frame

Implémenté dans castor3d::AnimatedMesh, castor3d::AnimatedSceneNode, castor3d::AnimatedSkeleton, et castor3d::AnimatedTexture.

Documentation des données membres

m_animations

AnimationInstancesMap castor3d::AnimatedObject::m_animations

protected

Toutes les animations.

Référencé par getAnimations(), et hasAnimation().

---

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

• Castor3D/Scene/Animation/AnimatedObject.hpp