Référence du modèle de la classe castor3d::AnimableT< AnimableHandlerT >

interface publique d'animable Plus de détails...

#include <Animable.hpp>

Graphe d'héritage de castor3d::AnimableT< AnimableHandlerT >:

Graphe de collaboration de castor3d::AnimableT< AnimableHandlerT >:

Fonctions membres publiques
virtual C3D_API	~AnimableT ()=default
void	cleanupAnimations ()
	Vid ela map d'animations.
bool	hasAnimation () const
bool	hasAnimation (castor::String const &name) const
Animation const &	getAnimation (castor::String const &name) const
	Récupère une animation.
Animation &	getAnimation (castor::String const &name)
	Récupère une animation.
void	addAnimation (AnimationPtr animation)
	Ajoute une animation.
AnimationsMap const &	getAnimations () const

Types protégés
using	Animation = AnimationT< AnimableHandlerT >
using	AnimationPtr = castor::UniquePtr< Animation >
using	AnimationsMap = std::map< castor::String, AnimationPtr >

Fonctions membres protégées
void	doRemoveAnimation (castor::String const &name)
	Enlève une animation.
template<typename AnimationType >
AnimationType &	doGetAnimation (castor::String const &name)
	Récupère une animation.
template<typename AnimationType >
AnimationType const &	doGetAnimation (castor::String const &name) const
	Récupère une animation.
Construction / Destruction.
	AnimableT (AnimableHandlerT &owner)
C3D_API	AnimableT (AnimableT &&rhs)=default
C3D_API AnimableT &	operator= (AnimableT &&rhs)=delete
C3D_API	AnimableT (AnimableT const &rhs)=delete
C3D_API AnimableT &	operator= (AnimableT const &rhs)=delete

Attributs protégés
AnimationsMap	m_animations

Description détaillée

template<typename AnimableHandlerT>
class castor3d::AnimableT< AnimableHandlerT >

interface publique d'animable

Documentation des définitions de type membres

Animation

template<typename AnimableHandlerT >

using castor3d::AnimableT< AnimableHandlerT >::Animation = AnimationT< AnimableHandlerT >

protected

AnimationPtr

template<typename AnimableHandlerT >

using castor3d::AnimableT< AnimableHandlerT >::AnimationPtr = castor::UniquePtr< Animation >

protected

AnimationsMap

template<typename AnimableHandlerT >

using castor3d::AnimableT< AnimableHandlerT >::AnimationsMap = std::map< castor::String, AnimationPtr >

protected

Documentation des constructeurs et destructeur

AnimableT() [1/3]

template<typename AnimableHandlerT >

castor3d::AnimableT< AnimableHandlerT >::AnimableT ( AnimableHandlerT &  owner )

inlineexplicitprotected

AnimableT() [2/3]

template<typename AnimableHandlerT >

C3D_API castor3d::AnimableT< AnimableHandlerT >::AnimableT ( AnimableT< AnimableHandlerT > &&  rhs )

protecteddefault

AnimableT() [3/3]

template<typename AnimableHandlerT >

C3D_API castor3d::AnimableT< AnimableHandlerT >::AnimableT ( AnimableT< AnimableHandlerT > const &  rhs )

protecteddelete

~AnimableT()

template<typename AnimableHandlerT >

virtual C3D_API castor3d::AnimableT< AnimableHandlerT >::~AnimableT ( )

virtualdefault

Documentation des fonctions membres

addAnimation()

template<typename AnimableHandlerT >

void castor3d::AnimableT< AnimableHandlerT >::addAnimation

(

AnimationPtr

animation

)

Ajoute une animation.

Paramètres

[in]

animation

L'animation.

cleanupAnimations()

template<typename AnimableHandlerT >

void castor3d::AnimableT< AnimableHandlerT >::cleanupAnimations ( )

inline

Vid ela map d'animations.

doGetAnimation() [1/2]

template<typename AnimableHandlerT >

template<typename AnimationType >

AnimationType & castor3d::AnimableT< AnimableHandlerT >::doGetAnimation ( castor::String const &  name )

inlineprotected

Récupère une animation.

Paramètres

[in]

name

Le nom de l'animation

Renvoie

L'animation

doGetAnimation() [2/2]

template<typename AnimableHandlerT >

template<typename AnimationType >

AnimationType const & castor3d::AnimableT< AnimableHandlerT >::doGetAnimation ( castor::String const &  name ) const

inlineprotected

Récupère une animation.

Paramètres

[in]

name

Le nom de l'animation

Renvoie

L'animation

doRemoveAnimation()

template<typename AnimableHandlerT >

void castor3d::AnimableT< AnimableHandlerT >::doRemoveAnimation ( castor::String const &  name )

inlineprotected

Enlève une animation.

Paramètres

[in]

name

Le nom de l'animation

getAnimation() [1/2]

template<typename AnimableHandlerT >

Animation & castor3d::AnimableT< AnimableHandlerT >::getAnimation ( castor::String const &  name )

inline

Récupère une animation.

Paramètres

[in]

name

Le nom de l'animation

Renvoie

L'animation

getAnimation() [2/2]

template<typename AnimableHandlerT >

Animation const & castor3d::AnimableT< AnimableHandlerT >::getAnimation ( castor::String const &  name ) const

inline

Récupère une animation.

Paramètres

[in]

name

Le nom de l'animation

Renvoie

L'animation

getAnimations()

template<typename AnimableHandlerT >

AnimationsMap const & castor3d::AnimableT< AnimableHandlerT >::getAnimations ( ) const

inline

Renvoie

Les animations.

Références castor3d::AnimableT< AnimableHandlerT >::m_animations.

hasAnimation() [1/2]

template<typename AnimableHandlerT >

bool castor3d::AnimableT< AnimableHandlerT >::hasAnimation ( ) const

inline

Renvoie

true si l'objet a une animation.

hasAnimation() [2/2]

template<typename AnimableHandlerT >

bool castor3d::AnimableT< AnimableHandlerT >::hasAnimation ( castor::String const &  name ) const

inline

Paramètres

[in]

name

Le nom de l'animation

Renvoie

true si l'objet a une animation ayant le nom donné.

operator=() [1/2]

template<typename AnimableHandlerT >

C3D_API AnimableT & castor3d::AnimableT< AnimableHandlerT >::operator= ( AnimableT< AnimableHandlerT > &&  rhs )

protecteddelete

operator=() [2/2]

template<typename AnimableHandlerT >

C3D_API AnimableT & castor3d::AnimableT< AnimableHandlerT >::operator= ( AnimableT< AnimableHandlerT > const &  rhs )

protecteddelete

Documentation des données membres

m_animations

template<typename AnimableHandlerT >

AnimationsMap castor3d::AnimableT< AnimableHandlerT >::m_animations

protected

Toutes les animations.

Référencé par castor3d::AnimableT< AnimableHandlerT >::getAnimations().

---

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

• Animation/Animable.hpp