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

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

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

Graphe de collaboration de castor3d::Animation:

Fonctions membres publiques
C3D_API	Animation (AnimationType type, Animable &animable, castor::String const &name=castor::cuEmptyString)
	Constructeur. Plus de détails...
C3D_API	~Animation ()
	Destructeur. Plus de détails...
C3D_API void	addKeyFrame (AnimationKeyFrameUPtr &&keyFrame)
	Ajoute une keyframe à l'animation. Plus de détails...
C3D_API AnimationKeyFrameArray::iterator	find (castor::Milliseconds const &time)
	Trouve une keyframe à l'index de temps donné. Plus de détails...
C3D_API 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...
C3D_API void	updateLength ()
	Initialise la longueur de l'animation. Plus de détails...
bool	isEmpty () 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
C3D_API	Animation (Animation &&rhs)=default
C3D_API Animation &	operator= (Animation &&rhs)=default
C3D_API	Animation (Animation const &rhs)=delete
C3D_API Animation &	operator= (Animation const &rhs)=delete

Attributs protégés
AnimationType	m_type { AnimationType::eCount }
castor::Milliseconds	m_length { 0 }
AnimationKeyFrameArray	m_keyframes

Amis
class	BinaryWriter< Animation >
class	BinaryParser< Animation >
class	AnimationInstance

Description détaillée

Classe de base des animations.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

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

Documentation des constructeurs et destructeur

Animation() [1/3]

C3D_API castor3d::Animation::Animation ( Animation &&  rhs )

default

name Copie / Déplacement.

Animation() [2/3]

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

delete

Animation() [3/3]

C3D_API castor3d::Animation::Animation	(	AnimationType	type,
		Animable &	animable,
		castor::String const &	name = castor::cuEmptyString
	)

Constructeur.

Paramètres

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

~Animation()

C3D_API castor3d::Animation::~Animation

(

)

Destructeur.

Documentation des fonctions membres

addKeyFrame()

C3D_API void castor3d::Animation::addKeyFrame

(

AnimationKeyFrameUPtr &&

keyFrame

)

Ajoute une keyframe à l'animation.

Paramètres

[in]

keyFrame

La keyframe.

begin() [1/2]

AnimationKeyFrameArray::const_iterator castor3d::Animation::begin ( ) const

inline

Renvoie

Le début des key frames.

Références m_keyframes.

begin() [2/2]

AnimationKeyFrameArray::iterator castor3d::Animation::begin ( )

inline

Renvoie

Le début des key frames.

Références m_keyframes.

end() [1/2]

AnimationKeyFrameArray::const_iterator castor3d::Animation::end ( ) const

inline

Renvoie

La fin des key frames.

Références m_keyframes.

end() [2/2]

AnimationKeyFrameArray::iterator castor3d::Animation::end ( )

inline

Renvoie

La fin des key frames.

Références m_keyframes.

find()

C3D_API AnimationKeyFrameArray::iterator castor3d::Animation::find

(

castor::Milliseconds const &

time

)

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

Paramètres

[in]

time

L'index de temps.

findKeyFrame()

C3D_API void castor3d::Animation::findKeyFrame	(	castor::Milliseconds const &	time,
		AnimationKeyFrameArray::iterator &	prv,
		AnimationKeyFrameArray::iterator &	cur
	)		const

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.

getLength()

castor::Milliseconds const& castor3d::Animation::getLength ( ) const

inline

Renvoie

La longueur de l'animation.

Références m_length.

getType()

AnimationType castor3d::Animation::getType ( ) const

inline

Renvoie

Le type de l'animation.

Références m_type.

isEmpty()

bool castor3d::Animation::isEmpty ( ) const

inline

Renvoie

true si la liste de key frames est vide.

Références m_keyframes.

operator=() [1/2]

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

default

operator=() [2/2]

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

delete

updateLength()

C3D_API void castor3d::Animation::updateLength

(

)

Initialise la longueur de l'animation.

Documentation des fonctions amies et associées

AnimationInstance

friend class AnimationInstance

friend

BinaryParser< Animation >

friend class BinaryParser< Animation >

friend

BinaryWriter< Animation >

friend class BinaryWriter< Animation >

friend

Documentation des données membres

m_keyframes

AnimationKeyFrameArray castor3d::Animation::m_keyframes

protected

Les keyframes.

Référencé par begin(), end(), et isEmpty().

m_length

castor::Milliseconds castor3d::Animation::m_length { 0 }

protected

La durée de l'animation.

Référencé par getLength().

m_type

AnimationType castor3d::Animation::m_type { AnimationType::eCount }

protected

Le type d'animation.

Référencé par getType().

---

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

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