Castor3D  ..
Fonctions membres publiques | Attributs protégés | Amis | Liste de tous les membres
Référence de la classe castor3d::SkeletonAnimation

Classe d'animation de squelette. Plus de détails...

+ Graphe d'héritage de castor3d::SkeletonAnimation:
+ Graphe de collaboration de castor3d::SkeletonAnimation:

Fonctions membres publiques

C3D_API SkeletonAnimation (Animable &animable, castor::String const &name=castor::cuEmptyString)
 Constructeur. Plus de détails...
 
C3D_API ~SkeletonAnimation ()
 Destructeur. Plus de détails...
 
C3D_API SkeletonAnimation (SkeletonAnimation &&rhs)=default
 Constructeur par déplacement. Plus de détails...
 
C3D_API SkeletonAnimationoperator= (SkeletonAnimation &&rhs)=default
 Opérateur d'affectation par déplacement. Plus de détails...
 
C3D_API SkeletonAnimation (SkeletonAnimation const &rhs)=delete
 Constructeur par copie. Plus de détails...
 
C3D_API SkeletonAnimationoperator= (SkeletonAnimation const &rhs)=delete
 Opérateur d'affectation par copie. Plus de détails...
 
C3D_API SkeletonAnimationObjectSPtr addObject (castor::String const &name, SkeletonAnimationObjectSPtr parent)
 Crée et ajoute un noeud mouvant. Plus de détails...
 
C3D_API SkeletonAnimationObjectSPtr addObject (BoneSPtr bone, SkeletonAnimationObjectSPtr parent)
 Crée et ajoute un os mouvant. Plus de détails...
 
C3D_API SkeletonAnimationObjectSPtr addObject (SkeletonAnimationObjectSPtr object, SkeletonAnimationObjectSPtr parent)
 Ajoute un objet animé. Plus de détails...
 
C3D_API bool hasObject (SkeletonAnimationObjectType type, castor::String const &name) const
 Dit si l'animation a l'objet animé. Plus de détails...
 
C3D_API SkeletonAnimationObjectSPtr getObject (Bone const &bone) const
 Récupère un os animé. Plus de détails...
 
C3D_API SkeletonAnimationObjectSPtr getObject (castor::String const &name) const
 Récupère un objet animé. Plus de détails...
 
C3D_API SkeletonAnimationObjectSPtr getObject (SkeletonAnimationObjectType type, castor::String const &name) const
 Récupère un objet animé. Plus de détails...
 
SkeletonAnimationObjectPtrStrMap const & getObjects () const
 
SkeletonAnimationObjectPtrArray const & getRootObjects () const
 Récupère le nombre d'objets mouvants. Plus de détails...
 
- Fonctions membres publiques hérités de castor3d::Animation
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 Animationoperator= (Animation &&rhs)=default
 
C3D_API Animation (Animation const &rhs)=delete
 
C3D_API Animationoperator= (Animation const &rhs)=delete
 

Attributs protégés

SkeletonAnimationObjectPtrArray m_arrayMoving
 
SkeletonAnimationObjectPtrStrMap m_toMove
 
- Attributs protégés hérités de castor3d::Animation
AnimationType m_type { AnimationType::eCount }
 
castor::Milliseconds m_length { 0 }
 
AnimationKeyFrameArray m_keyframes
 

Amis

class BinaryWriter< SkeletonAnimation >
 
class BinaryParser< SkeletonAnimation >
 
class SkeletonAnimationInstance
 

Description détaillée

Classe d'animation de squelette.

Auteur
Sylvain DOREMUS
Version
0.9.0
Date
31/05/2016

Documentation des constructeurs et destructeur

◆ SkeletonAnimation() [1/3]

C3D_API castor3d::SkeletonAnimation::SkeletonAnimation ( Animable animable,
castor::String const &  name = castor::cuEmptyString 
)

Constructeur.

Paramètres
[in]animableL'objet animable parent.
[in]nameLe nom de l'animation.

◆ ~SkeletonAnimation()

C3D_API castor3d::SkeletonAnimation::~SkeletonAnimation ( )

Destructeur.

◆ SkeletonAnimation() [2/3]

C3D_API castor3d::SkeletonAnimation::SkeletonAnimation ( SkeletonAnimation &&  rhs)
default

Constructeur par déplacement.

◆ SkeletonAnimation() [3/3]

C3D_API castor3d::SkeletonAnimation::SkeletonAnimation ( SkeletonAnimation const &  rhs)
delete

Constructeur par copie.

Documentation des fonctions membres

◆ addObject() [1/3]

C3D_API SkeletonAnimationObjectSPtr castor3d::SkeletonAnimation::addObject ( castor::String const &  name,
SkeletonAnimationObjectSPtr  parent 
)

Crée et ajoute un noeud mouvant.

Paramètres
[in]nameLe nom du noeud.
[in]parentLe parent de l'objet déplaçable.

◆ addObject() [2/3]

C3D_API SkeletonAnimationObjectSPtr castor3d::SkeletonAnimation::addObject ( BoneSPtr  bone,
SkeletonAnimationObjectSPtr  parent 
)

Crée et ajoute un os mouvant.

Paramètres
[in]boneL'os.
[in]parentLe parent de l'objet déplaçable.

◆ addObject() [3/3]

C3D_API SkeletonAnimationObjectSPtr castor3d::SkeletonAnimation::addObject ( SkeletonAnimationObjectSPtr  object,
SkeletonAnimationObjectSPtr  parent 
)

Ajoute un objet animé.

Paramètres
[in]objectL'objet animé.
[in]parentLe parent de l'objet déplaçable.

◆ getObject() [1/3]

C3D_API SkeletonAnimationObjectSPtr castor3d::SkeletonAnimation::getObject ( Bone const &  bone) const

Récupère un os animé.

Paramètres
[in]boneL'os.

◆ getObject() [2/3]

C3D_API SkeletonAnimationObjectSPtr castor3d::SkeletonAnimation::getObject ( castor::String const &  name) const

Récupère un objet animé.

Paramètres
[in]nameLe nom de l'objet.

◆ getObject() [3/3]

C3D_API SkeletonAnimationObjectSPtr castor3d::SkeletonAnimation::getObject ( SkeletonAnimationObjectType  type,
castor::String const &  name 
) const

Récupère un objet animé.

Paramètres
[in]typeLe type d'objet.
[in]nameLe nom de l'objet.

◆ getObjects()

SkeletonAnimationObjectPtrStrMap const& castor3d::SkeletonAnimation::getObjects ( ) const
inline
Renvoie
Les objets mouvants.

Références m_toMove.

◆ getRootObjects()

SkeletonAnimationObjectPtrArray const& castor3d::SkeletonAnimation::getRootObjects ( ) const
inline

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

Renvoie
Les objets mouvants racines.

Références m_arrayMoving.

◆ hasObject()

C3D_API bool castor3d::SkeletonAnimation::hasObject ( SkeletonAnimationObjectType  type,
castor::String const &  name 
) const

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

Paramètres
[in]typeLe type de l'objet.
[in]nameLe nom de l'objet.

◆ operator=() [1/2]

C3D_API SkeletonAnimation& castor3d::SkeletonAnimation::operator= ( SkeletonAnimation &&  rhs)
default

Opérateur d'affectation par déplacement.

◆ operator=() [2/2]

C3D_API SkeletonAnimation& castor3d::SkeletonAnimation::operator= ( SkeletonAnimation const &  rhs)
delete

Opérateur d'affectation par copie.

Documentation des fonctions amies et associées

◆ BinaryParser< SkeletonAnimation >

friend class BinaryParser< SkeletonAnimation >
friend

◆ BinaryWriter< SkeletonAnimation >

friend class BinaryWriter< SkeletonAnimation >
friend

◆ SkeletonAnimationInstance

friend class SkeletonAnimationInstance
friend

Documentation des données membres

◆ m_arrayMoving

SkeletonAnimationObjectPtrArray castor3d::SkeletonAnimation::m_arrayMoving
protected

Les objets mouvants racine.

Référencé par getRootObjects().

◆ m_toMove

SkeletonAnimationObjectPtrStrMap castor3d::SkeletonAnimation::m_toMove
protected

Les objets mouvants.

Référencé par getObjects().


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