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

Représente les objets animés. Plus de détails...

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

Graphe de collaboration de castor3d::AnimatedObject:

Fonctions membres publiques
C3D_API	AnimatedObject (castor::String const &name)
	Constructeur. Plus de détails...
C3D_API	~AnimatedObject ()
	Destructeur. Plus de détails...
C3D_API void	addAnimation (castor::String const &name)
C3D_API void	startAnimation (castor::String const &name)
	Démarre l'animation identifiée par le nom donné Plus de détails...
C3D_API void	stopAnimation (castor::String const &name)
	Stoppe l'animation identifiée par le nom donné Plus de détails...
C3D_API void	pauseAnimation (castor::String const &name)
	Met en pause l'animation identifiée par le nom donné Plus de détails...
C3D_API void	startAllAnimations ()
	Démarre toutes les animations. Plus de détails...
C3D_API void	stopAllAnimations ()
	Stoppe toutes les animations. Plus de détails...
C3D_API void	pauseAllAnimations ()
	Met en pause toutes les animations. Plus de détails...
C3D_API bool	hasAnimation (castor::String const &name)
	Vérifie si l'animation avec le nom donné existe. Plus de détails...
C3D_API AnimationInstance &	getAnimation (castor::String const &name)
	Récupère une animation. Plus de détails...
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. Plus de détails...
virtual C3D_API bool	isPlayingAnimation () const =0
AnimationInstancePtrStrMap const &	getAnimations () const
C3D_API	AnimatedObject (AnimatedObject &&rhs)=default
C3D_API AnimatedObject &	operator= (AnimatedObject &&rhs)=default
C3D_API	AnimatedObject (AnimatedObject const &rhs)=delete
C3D_API AnimatedObject &	operator= (AnimatedObject const &rhs)=delete

Attributs protégés
AnimationInstancePtrStrMap	m_animations

Description détaillée

Représente les objets animés.

Auteur

Sylvain DOREMUS

Version

0.7.0

Date

10/12/2013

Documentation des constructeurs et destructeur

AnimatedObject() [1/3]

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

default

name Copie / Déplacement.

AnimatedObject() [2/3]

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

delete

AnimatedObject() [3/3]

C3D_API castor3d::AnimatedObject::AnimatedObject ( castor::String const &  name )

explicit

Constructeur.

Paramètres

[in]

name

Le nom de l'objet

~AnimatedObject()

C3D_API castor3d::AnimatedObject::~AnimatedObject

(

)

Destructeur.

Documentation des fonctions membres

addAnimation()

C3D_API void castor3d::AnimatedObject::addAnimation

(

castor::String const &

name

)

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

Référencé par hasAnimation().

Voici le graphe des appelants de cette fonction :

getAnimations()

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

inline

Renvoie

Les animations de cet objet.

Références m_animations.

hasAnimation()

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

inline

Vérifie si l'animation avec le nom donné existe.

Paramètres

[in]

name

Le nom de l'animation.

Références C3D_API, getAnimation(), isPlayingAnimation(), m_animations, et update().

Voici le graphe d'appel pour cette fonction :

isPlayingAnimation()

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

pure virtual

Renvoie

true si l'objet joue une animation.

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

Référencé par hasAnimation().

Voici le graphe des appelants de cette fonction :

operator=() [1/2]

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

default

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::AnimatedSkeleton, et castor3d::AnimatedMesh.

Référencé par hasAnimation().

Voici le graphe des appelants de cette fonction :

Documentation des données membres

m_animations

AnimationInstancePtrStrMap 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 :

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