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

Classe de base des animations. Plus de détails...

#include <Animation.hpp>

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

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

Fonctions membres publiques
	AnimationT (AnimableHandlerT &handler, AnimationType type, AnimableT< AnimableHandlerT > &animable, castor::String const &name=castor::cuEmptyString)
	Constructeur. Plus de détails...
	AnimationT (AnimableHandlerT &handler, AnimationType type, castor::String const &name=castor::cuEmptyString)
	Constructeur. Plus de détails...
void	addKeyFrame (AnimationKeyFrameUPtr keyFrame)
	Ajoute une keyframe à l'animation. Plus de détails...
AnimationKeyFrameArray::iterator	find (castor::Milliseconds const &time)
	Trouve une keyframe à l'index de temps donné. Plus de détails...
void	findKeyFrame (castor::Milliseconds const &time, AnimationKeyFrameArray::iterator &prv, AnimationKeyFrameArray::iterator &cur) const
	Trouve une keyframe à l'index de temps donné. Plus de détails...
void	updateLength ()
	Initialise la longueur de l'animation. Plus de détails...
bool	isEmpty () const
size_t	size () const
AnimationKeyFrameArray::const_iterator	begin () const
AnimationKeyFrameArray::iterator	begin ()
AnimationKeyFrameArray::const_iterator	end () const
AnimationKeyFrameArray::iterator	end ()
AnimationType	getType () const
castor::Milliseconds const &	getLength () const
AnimableT< AnimableHandlerT > *	getAnimable () const
C3D_API	AnimationT (AnimationT &&rhs)=default
C3D_API AnimationT &	operator= (AnimationT &&rhs)=delete
C3D_API	AnimationT (AnimationT const &rhs)=delete
C3D_API AnimationT &	operator= (AnimationT const &rhs)=delete
virtual C3D_API	~AnimationT ()=default

Attributs protégés
AnimableT< AnimableHandlerT > *	m_animable {}
AnimationType	m_type { AnimationType::eCount }
castor::Milliseconds	m_length { 0 }
AnimationKeyFrameArray	m_keyframes

Amis
class	BinaryWriter< AnimationT >
class	BinaryParser< AnimationT >

Description détaillée

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

Classe de base des animations.

Remarques

Une animation est jouée au travers d'une AnimationInstance.

Documentation des constructeurs et destructeur

AnimationT() [1/4]

template<typename AnimableHandlerT >

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

default

name Copie / Déplacement.

AnimationT() [2/4]

template<typename AnimableHandlerT >

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

delete

~AnimationT()

template<typename AnimableHandlerT >

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

virtualdefault

AnimationT() [3/4]

template<typename AnimableHandlerT >

castor3d::AnimationT< AnimableHandlerT >::AnimationT ( AnimableHandlerT &  handler, AnimationType  type, AnimableT< AnimableHandlerT > &  animable, castor::String const &  name = castor::cuEmptyString  )

inline

Constructeur.

Paramètres

[in]	handler	Le handler parent.
[in]	type	Le type d'animation.
[in]	animable	L'objet animable parent.
[in]	name	Le nom de l'animation.

AnimationT() [4/4]

template<typename AnimableHandlerT >

castor3d::AnimationT< AnimableHandlerT >::AnimationT ( AnimableHandlerT &  handler, AnimationType  type, castor::String const &  name = castor::cuEmptyString  )

inline

Constructeur.

Paramètres

[in]	handler	Le handler parent.
[in]	type	Le type d'animation.
[in]	name	Le nom de l'animation.

Documentation des fonctions membres

addKeyFrame()

template<typename AnimableHandlerT >

void castor3d::AnimationT< AnimableHandlerT >::addKeyFrame ( AnimationKeyFrameUPtr  keyFrame )

inline

Ajoute une keyframe à l'animation.

Paramètres

[in]

keyFrame

La keyframe.

begin() [1/2]

template<typename AnimableHandlerT >

AnimationKeyFrameArray::iterator castor3d::AnimationT< AnimableHandlerT >::begin ( )

inline

Renvoie

Le début des key frames.

Références castor3d::AnimationT< AnimableHandlerT >::m_keyframes.

begin() [2/2]

template<typename AnimableHandlerT >

AnimationKeyFrameArray::const_iterator castor3d::AnimationT< AnimableHandlerT >::begin ( ) const

inline

Renvoie

Le début des key frames.

Références castor3d::AnimationT< AnimableHandlerT >::m_keyframes.

end() [1/2]

template<typename AnimableHandlerT >

AnimationKeyFrameArray::iterator castor3d::AnimationT< AnimableHandlerT >::end ( )

inline

Renvoie

La fin des key frames.

Références castor3d::AnimationT< AnimableHandlerT >::m_keyframes.

end() [2/2]

template<typename AnimableHandlerT >

AnimationKeyFrameArray::const_iterator castor3d::AnimationT< AnimableHandlerT >::end ( ) const

inline

Renvoie

La fin des key frames.

Références castor3d::AnimationT< AnimableHandlerT >::m_keyframes.

find()

template<typename AnimableHandlerT >

AnimationKeyFrameArray::iterator castor3d::AnimationT< AnimableHandlerT >::find ( castor::Milliseconds const &  time )

inline

Trouve une keyframe à l'index de temps donné.

Paramètres

[in]

time

L'index de temps.

findKeyFrame()

template<typename AnimableHandlerT >

void castor3d::AnimationT< AnimableHandlerT >::findKeyFrame ( castor::Milliseconds const &  time, AnimationKeyFrameArray::iterator &  prv, AnimationKeyFrameArray::iterator &  cur  ) const

inline

Trouve une keyframe à l'index de temps donné.

Paramètres

[in]	time	L'index de temps.
[in,out]	prv	La keyframe précédente, reçoit la nouvelle s'il y a eu un changement.
[in,out]	cur	La keyframe courante, reçoit la nouvelle s'il y a eu un changement.

getAnimable()

template<typename AnimableHandlerT >

AnimableT< AnimableHandlerT > * castor3d::AnimationT< AnimableHandlerT >::getAnimable ( ) const

inline

Références castor3d::AnimationT< AnimableHandlerT >::m_animable.

getLength()

template<typename AnimableHandlerT >

castor::Milliseconds const & castor3d::AnimationT< AnimableHandlerT >::getLength ( ) const

inline

Renvoie

La longueur de l'animation.

Références castor3d::AnimationT< AnimableHandlerT >::m_length.

getType()

template<typename AnimableHandlerT >

AnimationType castor3d::AnimationT< AnimableHandlerT >::getType ( ) const

inline

Renvoie

Le type de l'animation.

Références castor3d::AnimationT< AnimableHandlerT >::m_type.

isEmpty()

template<typename AnimableHandlerT >

bool castor3d::AnimationT< AnimableHandlerT >::isEmpty ( ) const

inline

Renvoie

true si la liste de key frames est vide.

Références castor3d::AnimationT< AnimableHandlerT >::m_keyframes.

operator=() [1/2]

template<typename AnimableHandlerT >

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

delete

operator=() [2/2]

template<typename AnimableHandlerT >

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

delete

size()

template<typename AnimableHandlerT >

size_t castor3d::AnimationT< AnimableHandlerT >::size ( ) const

inline

Renvoie

Le nombre de key frames.

Références castor3d::AnimationT< AnimableHandlerT >::m_keyframes.

updateLength()

template<typename AnimableHandlerT >

void castor3d::AnimationT< AnimableHandlerT >::updateLength ( )

inline

Initialise la longueur de l'animation.

Documentation des fonctions amies et associées

BinaryParser< AnimationT >

template<typename AnimableHandlerT >

friend class BinaryParser< AnimationT >

friend

BinaryWriter< AnimationT >

template<typename AnimableHandlerT >

friend class BinaryWriter< AnimationT >

friend

Documentation des données membres

m_animable

template<typename AnimableHandlerT >

AnimableT< AnimableHandlerT >* castor3d::AnimationT< AnimableHandlerT >::m_animable {}

protected

Référencé par castor3d::AnimationT< AnimableHandlerT >::getAnimable().

m_keyframes

template<typename AnimableHandlerT >

AnimationKeyFrameArray castor3d::AnimationT< AnimableHandlerT >::m_keyframes

protected

Les keyframes.

Référencé par castor3d::AnimationT< AnimableHandlerT >::begin(), castor3d::AnimationT< AnimableHandlerT >::end(), castor3d::AnimationT< AnimableHandlerT >::isEmpty(), et castor3d::AnimationT< AnimableHandlerT >::size().

m_length

template<typename AnimableHandlerT >

castor::Milliseconds castor3d::AnimationT< AnimableHandlerT >::m_length { 0 }

protected

La durée de l'animation.

Référencé par castor3d::AnimationT< AnimableHandlerT >::getLength().

m_type

template<typename AnimableHandlerT >

AnimationType castor3d::AnimationT< AnimableHandlerT >::m_type { AnimationType::eCount }

protected

Le type d'animation.

Référencé par castor3d::AnimationT< AnimableHandlerT >::getType().

---

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

• Animation/Animation.hpp