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

Graphe de collaboration de Castor3D::Animation:

Classes
class	BinaryParser

Fonctions membres publiques
C3D_API	Animation (Castor::String const &p_name=Castor::cuEmptyString)
	Constructeur. Plus de détails...

C3D_API	~Animation ()
	Destructeur. Plus de détails...

C3D_API void	Update (real p_tslf)
	Met l'animation à jour, met à jour les key frames aux bons index de temps. Plus de détails...

C3D_API void	Play ()
	Démarre l'animation. Plus de détails...

C3D_API void	Pause ()
	Met l'animation en pause. Plus de détails...

C3D_API void	Stop ()
	Stoppe l'animation. Plus de détails...

C3D_API AnimationObjectSPtr	AddObject (Castor::String const &p_name, AnimationObjectSPtr p_parent)
	Crée et ajoute un noeud mouvant. Plus de détails...

C3D_API AnimationObjectSPtr	AddObject (GeometrySPtr p_object, AnimationObjectSPtr p_parent)
	Crée et ajoute un objet mouvant. Plus de détails...

C3D_API AnimationObjectSPtr	AddObject (BoneSPtr p_bone, AnimationObjectSPtr p_parent)
	Crée et ajoute un os mouvant. Plus de détails...

C3D_API void	AddObject (AnimationObjectSPtr p_object, AnimationObjectSPtr p_parent)
	Ajoute un objet animé. Plus de détails...

C3D_API bool	HasObject (eANIMATION_OBJECT_TYPE p_type, Castor::String const &p_name) const
	Dit si l'animation a l'objet animé. Plus de détails...

C3D_API AnimationObjectSPtr	GetObject (MovableObjectSPtr p_object) const
	Récupère un objet animé. Plus de détails...

C3D_API AnimationObjectSPtr	GetObject (BoneSPtr p_bone) const
	Récupère un os animé. Plus de détails...

C3D_API void	SetInterpolationMode (eINTERPOLATOR_MODE p_mode)

C3D_API AnimationSPtr	Clone () const
	Clone cette animation. Plus de détails...

eANIMATION_STATE	GetState () const
	Récupère l'état de l'animation. Plus de détails...

real	GetScale () const
	Récupère le multiplicateur de temps de l'animation. Plus de détails...

bool	IsLooped () const
	Récupère l'état de boucle de l'animation. Plus de détails...

void	SetScale (real p_scale)
	Définit le multiplicateur de temps de l'animation. Plus de détails...

void	SetLooped (bool p_looped)
	Définit l'état de boucle de l'animation. Plus de détails...

AnimationObjectPtrStrMap const &	GetObjects () const
	Récupère le nombre d'objets mouvants. Plus de détails...

Attributs protégés
real	m_currentTime
	L'index de temps courant. Plus de détails...

eANIMATION_STATE	m_state
	L'état actuel de l'animation. Plus de détails...

real	m_scale
	Le multiplicateur de temps. Plus de détails...

real	m_length
	La durée de l'animation. Plus de détails...

bool	m_looped
	Dit si oui ou non l'animation est bouclée. Plus de détails...

AnimationObjectPtrArray	m_arrayMoving
	The parent moving objects. Plus de détails...

AnimationObjectPtrStrMap	m_toMove
	The moving objects. Plus de détails...

Description détaillée

Classe d'animation.

Auteur: Sylvain DOREMUS

Version: 0.1

Date: 09/02/2010

A faire:: Write and Read functions.

Remarques: Classe gérant une Animation, sa durée, les key frames ...

Documentation des constructeurs et destructeur

C3D_API Castor3D::Animation::Animation ( Castor::String const & p_name = Castor::cuEmptyString )

Constructeur.

Paramètres

[in] p_name Le nom de l'animation.

C3D_API Castor3D::Animation::~Animation ( )

Destructeur.

Documentation des fonctions membres

C3D_API AnimationObjectSPtr Castor3D::Animation::AddObject	(	Castor::String const &	p_name,
		AnimationObjectSPtr	p_parent
	)

Crée et ajoute un noeud mouvant.

Paramètres

[in]	p_name	Le nom du noeud.
[in]	p_parent	Le parent de l'objet déplaçable.

C3D_API AnimationObjectSPtr Castor3D::Animation::AddObject	(	GeometrySPtr	p_object,
		AnimationObjectSPtr	p_parent
	)

Crée et ajoute un objet mouvant.

Paramètres

[in]	p_object	L'objet déplaçable.
[in]	p_parent	Le parent de l'objet déplaçable.

C3D_API AnimationObjectSPtr Castor3D::Animation::AddObject	(	BoneSPtr	p_bone,
		AnimationObjectSPtr	p_parent
	)

Crée et ajoute un os mouvant.

Paramètres

[in]	p_bone	L'os.
[in]	p_parent	Le parent de l'objet déplaçable.

C3D_API void Castor3D::Animation::AddObject	(	AnimationObjectSPtr	p_object,
		AnimationObjectSPtr	p_parent
	)

Ajoute un objet animé.

Paramètres

[in]	p_object	L'objet animé.
[in]	p_parent	Le parent de l'objet déplaçable.

C3D_API AnimationSPtr Castor3D::Animation::Clone ( ) const

Clone cette animation.

Renvoie: Le clone.

C3D_API AnimationObjectSPtr Castor3D::Animation::GetObject ( MovableObjectSPtr p_object ) const

Récupère un objet animé.

Paramètres

[in] p_object L'objet déplaçable.

C3D_API AnimationObjectSPtr Castor3D::Animation::GetObject ( BoneSPtr p_bone ) const

Récupère un os animé.

Paramètres

[in] p_bone L'os.

AnimationObjectPtrStrMap const& Castor3D::Animation::GetObjects ( ) const

inline

Récupère le nombre d'objets mouvants.

Renvoie: Le nombre

Références m_toMove.

real Castor3D::Animation::GetScale ( ) const

inline

Récupère le multiplicateur de temps de l'animation.

Renvoie: Le multiplicateur de temps de l'animation

Références m_scale.

eANIMATION_STATE Castor3D::Animation::GetState ( ) const

inline

Récupère l'état de l'animation.

Renvoie: L'état de l'animation

Références m_state.

C3D_API bool Castor3D::Animation::HasObject	(	eANIMATION_OBJECT_TYPE	p_type,
		Castor::String const &	p_name
	)		const

Dit si l'animation a l'objet animé.

Paramètres

[in]	p_type	Le type de l'objet.
[in]	p_name	Le nom de l'objet.

bool Castor3D::Animation::IsLooped ( ) const

inline

Récupère l'état de boucle de l'animation.

Renvoie: L'état de boucle de l'animation

Références m_looped.

C3D_API void Castor3D::Animation::Pause ( )

Met l'animation en pause.

C3D_API void Castor3D::Animation::Play ( )

Démarre l'animation.

C3D_API void Castor3D::Animation::SetInterpolationMode ( eINTERPOLATOR_MODE p_mode )

Renvoie: Le mode d'interpolation des key frames.

void Castor3D::Animation::SetLooped ( bool p_looped )

inline

Définit l'état de boucle de l'animation.

Paramètres

[in] p_looped La nouvelle valeur

Références m_looped.

void Castor3D::Animation::SetScale ( real p_scale )

inline

Définit le multiplicateur de temps de l'animation.

Paramètres

[in] p_scale La nouvelle valeur

Références m_scale.

C3D_API void Castor3D::Animation::Stop ( )

Stoppe l'animation.

C3D_API void Castor3D::Animation::Update ( real p_tslf )

Met l'animation à jour, met à jour les key frames aux bons index de temps.

Paramètres

[in] p_tslf Le temps écoulé depuis la dernière frame.

Documentation des données membres

AnimationObjectPtrArray Castor3D::Animation::m_arrayMoving

protected

The parent moving objects.

real Castor3D::Animation::m_currentTime

protected

L'index de temps courant.

real Castor3D::Animation::m_length

protected

La durée de l'animation.

bool Castor3D::Animation::m_looped

protected

Dit si oui ou non l'animation est bouclée.

Référencé par IsLooped(), et SetLooped().

real Castor3D::Animation::m_scale

protected

Le multiplicateur de temps.

Référencé par GetScale(), et SetScale().

eANIMATION_STATE Castor3D::Animation::m_state

protected

L'état actuel de l'animation.

Référencé par GetState().

AnimationObjectPtrStrMap Castor3D::Animation::m_toMove

protected

The moving objects.

Référencé par GetObjects().

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

Y:/software/Castor3D/source/Core/Castor3D/Src/Animation.hpp

Classes

Fonctions membres publiques

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres