Référence de la classe Castor3D::MovingObjectBase

Classe de représentation de choses mouvantes. Plus de détails...

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

Graphe de collaboration de Castor3D::MovingObjectBase:

Fonctions membres publiques
	MovingObjectBase (eMOVING_OBJECT_TYPE p_eType)
	Constructeur. Plus de détails...
	~MovingObjectBase ()
	Destructeur. Plus de détails...
void	AddChild (MovingObjectBaseSPtr p_pObject)
	Ajoute un objet enfant à celui-ci. Plus de détails...
void	Update (real p_rTime, bool p_bLooped, Castor::Matrix4x4r const &p_mtxTransformations)
	Met à jour les transformations appliquées à l'objet, l'index de temps donné Plus de détails...
virtual Castor::String const &	GetName () const =0
	Récupère le nom de l'objet. Plus de détails...
ScaleKeyFrameSPtr	AddScaleKeyFrame (real p_rFrom)
	Crée une key frame et l'ajoute à la liste. Plus de détails...
TranslateKeyFrameSPtr	AddTranslateKeyFrame (real p_rFrom)
	Crée une key frame et l'ajoute à la liste. Plus de détails...
RotateKeyFrameSPtr	AddRotateKeyFrame (real p_rFrom)
	Crée une key frame et l'ajoute à la liste. Plus de détails...
void	RemoveScaleKeyFrame (real p_rTime)
	Supprime la key frame à l'index de temps donné Plus de détails...
void	RemoveTranslateKeyFrame (real p_rTime)
	Supprime la key frame à l'index de temps donné Plus de détails...
void	RemoveRotateKeyFrame (real p_rTime)
	Supprime la key frame à l'index de temps donné Plus de détails...
MovingObjectBaseSPtr	Clone (MovingObjectPtrStrMap &p_map)
	Clone cet objet animable. Plus de détails...
ScaleKeyFramePtrRealMapIt	ScalesBegin ()
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
ScaleKeyFramePtrRealMapConstIt	ScalesBegin () const
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
ScaleKeyFramePtrRealMapIt	ScalesEnd ()
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
ScaleKeyFramePtrRealMapConstIt	ScalesEnd () const
	Récupère un itérateur sur la fin de la map de keyframes. Plus de détails...
TranslateKeyFramePtrRealMapIt	TranslatesBegin ()
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
TranslateKeyFramePtrRealMapConstIt	TranslatesBegin () const
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
TranslateKeyFramePtrRealMapIt	TranslatesEnd ()
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
TranslateKeyFramePtrRealMapConstIt	TranslatesEnd () const
	Récupère un itérateur sur la fin de la map de keyframes. Plus de détails...
RotateKeyFramePtrRealMapIt	RotatesBegin ()
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
RotateKeyFramePtrRealMapConstIt	RotatesBegin () const
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
RotateKeyFramePtrRealMapIt	RotatesEnd ()
	Récupère un itérateur sur le début de la map de keyframes. Plus de détails...
RotateKeyFramePtrRealMapConstIt	RotatesEnd () const
	Récupère un itérateur sur la fin de la map de keyframes. Plus de détails...
real	GetLength () const
	Récupère la durée de l'animation. Plus de détails...
void	SetLength (real p_rLength)
	Définit la durée de l'animation. Plus de détails...
Castor::Matrix4x4r const &	GetNodeTransform () const
	Récupère les animations du noeud de transformation. Plus de détails...
void	SetNodeTransform (Castor::Matrix4x4r const &p_mtxTransform)
	Définit les animations du noeud de transformation. Plus de détails...
bool	HasKeyFrames () const
	Dit si l'objet a des keyframes. Plus de détails...
eMOVING_OBJECT_TYPE	GetType () const
	Récupère le type du machin mouvant. Plus de détails...
const Castor::Matrix4x4r &	GetFinalTransformation () const
	Récupère la matrice finale de transformation du bone pour le temps courant de l'animation. Plus de détails...
void	SetFinalTransformation (const Castor::Matrix4x4r &p_mtx)
	Définit la matrice finale de transformation du bone pour le temps courant de l'animation. Plus de détails...
MovingObjectPtrArrayIt	ChildsBegin ()
	Récupère un itérateur sur le début du tableau d'enfants. Plus de détails...
MovingObjectPtrArrayConstIt	ChildsBegin () const
	Récupère un itérateur sur le début du tableau d'enfants. Plus de détails...
MovingObjectPtrArrayIt	ChildsEnd ()
	Récupère un itérateur sur le début du tableau d'enfants. Plus de détails...
MovingObjectPtrArrayConstIt	ChildsEnd () const
	Récupère un itérateur sur la fin du tableau d'enfants. Plus de détails...

Fonctions membres protégées
virtual void	DoApply ()=0
	Met à jour les transformations appliquées à l'objet. Plus de détails...
virtual MovingObjectBaseSPtr	DoClone ()=0
	Clone cet objet animable. Plus de détails...

Attributs protégés
ScaleKeyFramePtrRealMap	m_mapScales
	Les keyframes, triées par index de temps de début. Plus de détails...
TranslateKeyFramePtrRealMap	m_mapTranslates
	Les keyframes, triées par index de temps de début. Plus de détails...
RotateKeyFramePtrRealMap	m_mapRotates
	Les keyframes, triées par index de temps de début. Plus de détails...
real	m_rLength
	La durée de l'animation. Plus de détails...
MovingObjectPtrArray	m_arrayChildren
	Les objets dépendant de celui-ci. Plus de détails...
Castor::Matrix4x4r	m_mtxNodeTransform
	Transformations du noeud d'animation. Plus de détails...
Castor::Matrix4x4r	m_mtxTransformations
	Transformations actuelles. Plus de détails...
eMOVING_OBJECT_TYPE	m_eType
	Le type du machin mouvant. Plus de détails...
Castor::Matrix4x4r	m_mtxFinalTransformation
	La matrice de transformation complète au temps courant de l'animation. Plus de détails...

Description détaillée

Classe de représentation de choses mouvantes.

Auteur

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Remarques

Gère les translations, mises à l'échelle, rotations de la chose

Documentation des constructeurs et destructeur

Castor3D::MovingObjectBase::MovingObjectBase

(

eMOVING_OBJECT_TYPE

p_eType

)

Constructeur.

Paramètres

[in]

p_eType

Le type du machin mouvant

Castor3D::MovingObjectBase::~MovingObjectBase

(

)

Destructeur.

Documentation des fonctions membres

void Castor3D::MovingObjectBase::AddChild

(

MovingObjectBaseSPtr

p_pObject

)

Ajoute un objet enfant à celui-ci.

Remarques

Les transformations de l'enfant sont affectées par celles de cet objet

Paramètres

[in]

p_pObject

L'enfant

RotateKeyFrameSPtr Castor3D::MovingObjectBase::AddRotateKeyFrame

(

real

p_rFrom

)

Crée une key frame et l'ajoute à la liste.

Remarques

Si une key frame avec le même index de temps de début existe, elle est retournée sans être modifiée

Paramètres

[in]

p_rFrom

L'index de temps de début

ScaleKeyFrameSPtr Castor3D::MovingObjectBase::AddScaleKeyFrame

(

real

p_rFrom

)

Crée une key frame et l'ajoute à la liste.

Remarques

Si une key frame avec le même index de temps de début existe, elle est retournée sans être modifiée

Paramètres

[in]

p_rFrom

L'index de temps de début

TranslateKeyFrameSPtr Castor3D::MovingObjectBase::AddTranslateKeyFrame

(

real

p_rFrom

)

Crée une key frame et l'ajoute à la liste.

Remarques

Si une key frame avec le même index de temps de début existe, elle est retournée sans être modifiée

Paramètres

[in]

p_rFrom

L'index de temps de début

MovingObjectPtrArrayIt Castor3D::MovingObjectBase::ChildsBegin ( )

inline

Récupère un itérateur sur le début du tableau d'enfants.

Renvoie

Itérateur sur le début du tableau d'enfants

MovingObjectPtrArrayConstIt Castor3D::MovingObjectBase::ChildsBegin ( ) const

inline

Récupère un itérateur sur le début du tableau d'enfants.

Renvoie

Itérateur constant sur le début du tableau d'enfants

MovingObjectPtrArrayIt Castor3D::MovingObjectBase::ChildsEnd ( )

inline

Récupère un itérateur sur le début du tableau d'enfants.

Renvoie

Itérateur sur le début du tableau d'enfants

MovingObjectPtrArrayConstIt Castor3D::MovingObjectBase::ChildsEnd ( ) const

inline

Récupère un itérateur sur la fin du tableau d'enfants.

Renvoie

Itérateur constant sur la fin du tableau d'enfants

MovingObjectBaseSPtr Castor3D::MovingObjectBase::Clone

(

MovingObjectPtrStrMap &

p_map

)

Clone cet objet animable.

Paramètres

[out]

p_map

Reçoit les enfants clonés en plus de l'objet cloné

Renvoie

Le clone

virtual void Castor3D::MovingObjectBase::DoApply ( )

protectedpure virtual

Met à jour les transformations appliquées à l'objet.

virtual MovingObjectBaseSPtr Castor3D::MovingObjectBase::DoClone ( )

protectedpure virtual

Clone cet objet animable.

Renvoie

Le clone

const Castor::Matrix4x4r& Castor3D::MovingObjectBase::GetFinalTransformation ( ) const

inline

Récupère la matrice finale de transformation du bone pour le temps courant de l'animation.

Renvoie

La valeur

real Castor3D::MovingObjectBase::GetLength ( ) const

inline

Récupère la durée de l'animation.

Renvoie

La durée de l'animation

virtual Castor::String const& Castor3D::MovingObjectBase::GetName ( ) const

pure virtual

Récupère le nom de l'objet.

Renvoie

Le nom

Implémenté dans Castor3D::MovingBone, Castor3D::MovingObject, et Castor3D::MovingNode.

Castor::Matrix4x4r const& Castor3D::MovingObjectBase::GetNodeTransform ( ) const

inline

Récupère les animations du noeud de transformation.

Renvoie

La valeur

eMOVING_OBJECT_TYPE Castor3D::MovingObjectBase::GetType ( ) const

inline

Récupère le type du machin mouvant.

Renvoie

La valeur

bool Castor3D::MovingObjectBase::HasKeyFrames ( ) const

inline

Dit si l'objet a des keyframes.

Renvoie

false si pas de keyframes

void Castor3D::MovingObjectBase::RemoveRotateKeyFrame

(

real

p_rTime

)

Supprime la key frame à l'index de temps donné

Paramètres

[in]

p_rTime

L'index de temps

void Castor3D::MovingObjectBase::RemoveScaleKeyFrame

(

real

p_rTime

)

Supprime la key frame à l'index de temps donné

Paramètres

[in]

p_rTime

L'index de temps

void Castor3D::MovingObjectBase::RemoveTranslateKeyFrame

(

real

p_rTime

)

Supprime la key frame à l'index de temps donné

Paramètres

[in]

p_rTime

L'index de temps

RotateKeyFramePtrRealMapIt Castor3D::MovingObjectBase::RotatesBegin ( )

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur sur le début de la map de keyframes

RotateKeyFramePtrRealMapConstIt Castor3D::MovingObjectBase::RotatesBegin ( ) const

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur constant sur le début de la map de keyframes

RotateKeyFramePtrRealMapIt Castor3D::MovingObjectBase::RotatesEnd ( )

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur sur le début de la map de keyframes

RotateKeyFramePtrRealMapConstIt Castor3D::MovingObjectBase::RotatesEnd ( ) const

inline

Récupère un itérateur sur la fin de la map de keyframes.

Renvoie

Itérateur constant sur la fin de la map de keyframes

ScaleKeyFramePtrRealMapIt Castor3D::MovingObjectBase::ScalesBegin ( )

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur sur le début de la map de keyframes

ScaleKeyFramePtrRealMapConstIt Castor3D::MovingObjectBase::ScalesBegin ( ) const

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur constant sur le début de la map de keyframes

ScaleKeyFramePtrRealMapIt Castor3D::MovingObjectBase::ScalesEnd ( )

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur sur le début de la map de keyframes

ScaleKeyFramePtrRealMapConstIt Castor3D::MovingObjectBase::ScalesEnd ( ) const

inline

Récupère un itérateur sur la fin de la map de keyframes.

Renvoie

Itérateur constant sur la fin de la map de keyframes

void Castor3D::MovingObjectBase::SetFinalTransformation ( const Castor::Matrix4x4r &  p_mtx )

inline

Définit la matrice finale de transformation du bone pour le temps courant de l'animation.

Paramètres

[in]

p_mtx

La nouvelle valeur

void Castor3D::MovingObjectBase::SetLength ( real  p_rLength )

inline

Définit la durée de l'animation.

Paramètres

[in]

p_rLength

La nouvelle valeur

void Castor3D::MovingObjectBase::SetNodeTransform ( Castor::Matrix4x4r const &  p_mtxTransform )

inline

Définit les animations du noeud de transformation.

Paramètres

[in]

p_mtxTransform

La nouvelle valeur

TranslateKeyFramePtrRealMapIt Castor3D::MovingObjectBase::TranslatesBegin ( )

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur sur le début de la map de keyframes

TranslateKeyFramePtrRealMapConstIt Castor3D::MovingObjectBase::TranslatesBegin ( ) const

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur constant sur le début de la map de keyframes

TranslateKeyFramePtrRealMapIt Castor3D::MovingObjectBase::TranslatesEnd ( )

inline

Récupère un itérateur sur le début de la map de keyframes.

Renvoie

Itérateur sur le début de la map de keyframes

TranslateKeyFramePtrRealMapConstIt Castor3D::MovingObjectBase::TranslatesEnd ( ) const

inline

Récupère un itérateur sur la fin de la map de keyframes.

Renvoie

Itérateur constant sur la fin de la map de keyframes

void Castor3D::MovingObjectBase::Update	(	real	p_rTime,
		bool	p_bLooped,
		Castor::Matrix4x4r const &	p_mtxTransformations
	)

Met à jour les transformations appliquées à l'objet, l'index de temps donné

Paramètres

[in]	p_rTime	Index de temps courant
[in]	p_bLooped	Dit si l'animation est bouclée
	în]	p_mtxTransformations La matrice de transformation courante

Documentation des données membres

MovingObjectPtrArray Castor3D::MovingObjectBase::m_arrayChildren

protected

Les objets dépendant de celui-ci.

eMOVING_OBJECT_TYPE Castor3D::MovingObjectBase::m_eType

protected

Le type du machin mouvant.

RotateKeyFramePtrRealMap Castor3D::MovingObjectBase::m_mapRotates

protected

Les keyframes, triées par index de temps de début.

ScaleKeyFramePtrRealMap Castor3D::MovingObjectBase::m_mapScales

protected

Les keyframes, triées par index de temps de début.

TranslateKeyFramePtrRealMap Castor3D::MovingObjectBase::m_mapTranslates

protected

Les keyframes, triées par index de temps de début.

Castor::Matrix4x4r Castor3D::MovingObjectBase::m_mtxFinalTransformation

protected

La matrice de transformation complète au temps courant de l'animation.

Castor::Matrix4x4r Castor3D::MovingObjectBase::m_mtxNodeTransform

protected

Transformations du noeud d'animation.

Castor::Matrix4x4r Castor3D::MovingObjectBase::m_mtxTransformations

protected

Transformations actuelles.

real Castor3D::MovingObjectBase::m_rLength

protected

La durée de l'animation.

---

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

• Y:/projets/Castor3D/source/Core/Castor3D/Src/MovingObjectBase.hpp