Classe de représentation d'objets d'animations de squelette. Plus de détails...

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

Graphe de collaboration de Castor3D::SkeletonAnimationObject:

Fonctions membres publiques
virtual C3D_API	~SkeletonAnimationObject ()
	Destructeur. Plus de détails...

C3D_API void	AddChild (SkeletonAnimationObjectSPtr p_object)
	Ajoute un objet enfant à celui-ci. Plus de détails...

virtual C3D_API Castor::String const &	GetName () const =0
	Récupère le nom de l'objet. Plus de détails...

C3D_API KeyFrame &	AddKeyFrame (std::chrono::milliseconds const &p_from, Castor::Point3r const &p_translate=Castor::Point3r{}, Castor::Quaternion const &p_rotate=Castor::Quaternion{}, Castor::Point3r const &p_scale=Castor::Point3r{ 1.0_r, 1.0_r, 1.0_r })
	Crée une key frame de mise à l'échelle et l'ajoute à la liste. Plus de détails...

C3D_API void	RemoveKeyFrame (std::chrono::milliseconds const &p_time)
	Supprime la key frame de mise à l'échelle à l'index de temps donné. Plus de détails...

InterpolatorType	GetInterpolationMode () const

KeyFrameArray const &	GetKeyFrames () const

std::chrono::milliseconds const &	GetLength () const

SkeletonAnimationObjectType	GetType () const

void	SetLength (std::chrono::milliseconds const &p_length)
	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_transform)
	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...

SkeletonAnimationObjectPtrArray const &	GetChildren () const

SkeletonAnimationObjectSPtr	GetParent () const

Fonctions membres protégées
C3D_API	SkeletonAnimationObject (SkeletonAnimation &p_animation, SkeletonAnimationObjectType p_type)
	Constructeur. Plus de détails...

C3D_API	SkeletonAnimationObject (SkeletonAnimationObject const &p_rhs)=delete
	Constructeur par copie. Plus de détails...

Attributs protégés
InterpolatorType	m_mode { InterpolatorType::eCount }

std::chrono::milliseconds	m_length { 0 }

SkeletonAnimationObjectType	m_type

KeyFrameArray	m_keyframes

Castor::Matrix4x4r	m_nodeTransform

SkeletonAnimationObjectPtrArray	m_children

SkeletonAnimationObjectWPtr	m_parent

Amis
class	BinaryWriter< SkeletonAnimationObject >

class	BinaryParser< SkeletonAnimationObject >

class	SkeletonAnimationInstanceObject

Description détaillée

Classe de représentation d'objets d'animations de squelette.

Auteur: Sylvain DOREMUS

Version: 0.1

Date: 09/02/2010

Remarques: Gère les translations, mises à l'échelle, rotations de l'objet.

Documentation des constructeurs et destructeur

◆ SkeletonAnimationObject() [1/2]

C3D_API Castor3D::SkeletonAnimationObject::SkeletonAnimationObject	(	SkeletonAnimation &	p_animation,
		SkeletonAnimationObjectType	p_type
	)

protected

Constructeur.

Paramètres

[in]	p_animation	L'animation parente.
[in]	p_type	Le type d'objet d'animation de squelette.

◆ SkeletonAnimationObject() [2/2]

C3D_API Castor3D::SkeletonAnimationObject::SkeletonAnimationObject ( SkeletonAnimationObject const & p_rhs )

protecteddelete

Constructeur par copie.

◆ ~SkeletonAnimationObject()

virtual C3D_API Castor3D::SkeletonAnimationObject::~SkeletonAnimationObject ( )

virtual

Destructeur.

Documentation des fonctions membres

◆ AddChild()

C3D_API void Castor3D::SkeletonAnimationObject::AddChild ( SkeletonAnimationObjectSPtr p_object )

Ajoute un objet enfant à celui-ci.

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

Paramètres

[in] p_object L'enfant.

◆ AddKeyFrame()

C3D_API KeyFrame& Castor3D::SkeletonAnimationObject::AddKeyFrame	(	std::chrono::milliseconds const &	p_from,
		Castor::Point3r const &	p_translate = `Castor::Point3r{}`,
		Castor::Quaternion const &	p_rotate = `Castor::Quaternion{}`,
		Castor::Point3r const &	p_scale = `Castor::Point3r{ 1.0_r, 1.0_r, 1.0_r }`
	)

Crée une key frame de mise à l'échelle 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_from	L'index de temps de début.
[in]	p_translate	La translation au temps de début.
[in]	p_rotate	La rotation au temps de début.
[in]	p_scale	L'échelle au temps de début.

◆ GetChildren()

SkeletonAnimationObjectPtrArray const& Castor3D::SkeletonAnimationObject::GetChildren ( ) const

inline

Renvoie: Le tableau d'enfants.

Références m_children.

◆ GetInterpolationMode()

InterpolatorType Castor3D::SkeletonAnimationObject::GetInterpolationMode ( ) const

inline

Renvoie: Le mode d'interpolation des key frames de mise à l'échelle.

Références m_mode.

◆ GetKeyFrames()

KeyFrameArray const& Castor3D::SkeletonAnimationObject::GetKeyFrames ( ) const

inline

Renvoie: Les key frames.

Références m_keyframes.

◆ GetLength()

std::chrono::milliseconds const& Castor3D::SkeletonAnimationObject::GetLength ( ) const

inline

Renvoie: La durée de l'animation.

Références m_length.

◆ GetName()

virtual C3D_API Castor::String const& Castor3D::SkeletonAnimationObject::GetName ( ) const

pure virtual

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

Renvoie: Le nom.

Implémenté dans Castor3D::SkeletonAnimationNode, et Castor3D::SkeletonAnimationBone.

◆ GetNodeTransform()

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

inline

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

Renvoie: La valeur.

Références m_nodeTransform.

◆ GetParent()

SkeletonAnimationObjectSPtr Castor3D::SkeletonAnimationObject::GetParent ( ) const

inline

Renvoie: L'objet parent.

Références m_parent.

◆ GetType()

SkeletonAnimationObjectType Castor3D::SkeletonAnimationObject::GetType ( ) const

inline

Renvoie: Le type d'objet mouvant.

Références m_type.

◆ HasKeyFrames()

bool Castor3D::SkeletonAnimationObject::HasKeyFrames ( ) const

inline

Dit si l'objet a des keyframes.

Renvoie: false si pas de keyframes.

Références m_keyframes.

◆ RemoveKeyFrame()

C3D_API void Castor3D::SkeletonAnimationObject::RemoveKeyFrame ( std::chrono::milliseconds const & p_time )

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

Paramètres

[in] p_time L'index de temps.

◆ SetLength()

void Castor3D::SkeletonAnimationObject::SetLength ( std::chrono::milliseconds const & p_length )

inline

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

Paramètres

[in] p_length La nouvelle valeur.

Références m_length.

◆ SetNodeTransform()

void Castor3D::SkeletonAnimationObject::SetNodeTransform ( Castor::Matrix4x4r const & p_transform )

inline

Définit les animations du noeud de transformation.

Paramètres

[in] p_transform La nouvelle valeur.

Références m_nodeTransform.

Documentation des fonctions amies et associées

◆ BinaryParser< SkeletonAnimationObject >

friend class BinaryParser< SkeletonAnimationObject >

friend

◆ BinaryWriter< SkeletonAnimationObject >

friend class BinaryWriter< SkeletonAnimationObject >

friend

◆ SkeletonAnimationInstanceObject

friend class SkeletonAnimationInstanceObject

friend

Documentation des données membres

◆ m_children

SkeletonAnimationObjectPtrArray Castor3D::SkeletonAnimationObject::m_children

protected

Les objets dépendant de celui-ci.

Référencé par GetChildren().

◆ m_keyframes

KeyFrameArray Castor3D::SkeletonAnimationObject::m_keyframes

protected

Les keyframes.

Référencé par GetKeyFrames(), et HasKeyFrames().

◆ m_length

std::chrono::milliseconds Castor3D::SkeletonAnimationObject::m_length { 0 }

protected

La durée de l'animation.

Référencé par GetLength(), et SetLength().

◆ m_mode

InterpolatorType Castor3D::SkeletonAnimationObject::m_mode { InterpolatorType::eCount }

protected

Le mode d'interpolation.

Référencé par GetInterpolationMode().

◆ m_nodeTransform

Castor::Matrix4x4r Castor3D::SkeletonAnimationObject::m_nodeTransform

protected

Transformations du noeud d'animation.

Référencé par GetNodeTransform(), et SetNodeTransform().

◆ m_parent

SkeletonAnimationObjectWPtr Castor3D::SkeletonAnimationObject::m_parent

protected

L'objet parent.

Référencé par GetParent().

◆ m_type

SkeletonAnimationObjectType Castor3D::SkeletonAnimationObject::m_type

protected

Le type du machin mouvant.

Référencé par GetType().

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Animation/Skeleton/SkeletonAnimationObject.hpp

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Amis

Description détaillée

Documentation des constructeurs et destructeur

◆ SkeletonAnimationObject() [1/2]

◆ SkeletonAnimationObject() [2/2]

◆ ~SkeletonAnimationObject()

Documentation des fonctions membres

◆ AddChild()

◆ AddKeyFrame()

◆ GetChildren()

◆ GetInterpolationMode()

◆ GetKeyFrames()

◆ GetLength()

◆ GetName()

◆ GetNodeTransform()

◆ GetParent()

◆ GetType()

◆ HasKeyFrames()

◆ RemoveKeyFrame()

◆ SetLength()

◆ SetNodeTransform()

Documentation des fonctions amies et associées

◆ BinaryParser< SkeletonAnimationObject >

◆ BinaryWriter< SkeletonAnimationObject >

◆ SkeletonAnimationInstanceObject

Documentation des données membres

◆ m_children

◆ m_keyframes

◆ m_length

◆ m_mode

◆ m_nodeTransform

◆ m_parent

◆ m_type