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

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

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

Fonctions membres publiques

C3D_API SkeletonAnimationInstance (AnimatedSkeleton &object, SkeletonAnimation &animation)
 Constructeur. Plus de détails...
 
C3D_API ~SkeletonAnimationInstance ()
 Destructeur. Plus de détails...
 
C3D_API SkeletonAnimationInstanceObjectSPtr getObject (Bone const &bone) const
 Récupère un os animé. Plus de détails...
 
C3D_API SkeletonAnimationInstanceObjectSPtr getObject (castor::String const &name) const
 Récupère un noeud animé. Plus de détails...
 
C3D_API SkeletonAnimationInstanceObjectSPtr getObject (SkeletonAnimationObjectType type, castor::String const &name) const
 Récupère un objet animé. Plus de détails...
 
auto getObjectsCount () const
 
auto begin ()
 
auto begin () const
 
auto end ()
 
auto end () const
 
C3D_API SkeletonAnimationInstance (SkeletonAnimationInstance &&rhs)=default
 
C3D_API SkeletonAnimationInstanceoperator= (SkeletonAnimationInstance &&rhs)=default
 
C3D_API SkeletonAnimationInstance (SkeletonAnimationInstance const &rhs)=delete
 
C3D_API SkeletonAnimationInstanceoperator= (SkeletonAnimationInstance const &rhs)=delete
 
- Fonctions membres publiques hérités de castor3d::AnimationInstance
C3D_API AnimationInstance (AnimatedObject &object, Animation &animation)
 Constructeur. Plus de détails...
 
C3D_API ~AnimationInstance ()
 Destructeur. Plus de détails...
 
C3D_API void update (castor::Milliseconds const &elapsed)
 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...
 
AnimationState getState () const
 
real getScale () const
 
void setScale (real value)
 Définit le multiplicateur de temps de l'animation. Plus de détails...
 
bool isLooped () const
 
void setLooped (bool value)
 Définit l'état de boucle de l'animation. Plus de détails...
 
Animation const & getAnimation () const
 

Attributs protégés

SkeletonAnimationInstanceObjectPtrArray m_toMove
 
SkeletonAnimationInstanceKeyFrameArray m_keyFrames
 
SkeletonAnimationInstanceKeyFrameArray::iterator m_curr
 
- Attributs protégés hérités de castor3d::AnimationInstance
Animation const & m_animation
 
real m_scale { 1.0_r }
 
bool m_looped { false }
 
castor::Milliseconds m_currentTime { 0 }
 
AnimationState m_state { AnimationState::eStopped }
 

Description détaillée

Instance d'animation de squelette.

Auteur
Sylvain DOREMUS
Version
0.9.0
Date
31/05/2016
A faire:
write and read functions.

Documentation des constructeurs et destructeur

◆ SkeletonAnimationInstance() [1/3]

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

name Copie / Déplacement.

◆ SkeletonAnimationInstance() [2/3]

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

◆ SkeletonAnimationInstance() [3/3]

C3D_API castor3d::SkeletonAnimationInstance::SkeletonAnimationInstance ( AnimatedSkeleton object,
SkeletonAnimation animation 
)

Constructeur.

Paramètres
[in]objectL'AnimatedSkeleton parent.
[in]animationL'animation.

◆ ~SkeletonAnimationInstance()

C3D_API castor3d::SkeletonAnimationInstance::~SkeletonAnimationInstance ( )

Destructeur.

Documentation des fonctions membres

◆ begin() [1/2]

auto castor3d::SkeletonAnimationInstance::begin ( )
inline
Renvoie
L'itérateur sur le début des objets racines.

Références m_toMove.

◆ begin() [2/2]

auto castor3d::SkeletonAnimationInstance::begin ( ) const
inline
Renvoie
L'itérateur sur le début des objets racines.

Références m_toMove.

◆ end() [1/2]

auto castor3d::SkeletonAnimationInstance::end ( )
inline
Renvoie
L'itérateur sur la fin des objets racines.

Références m_toMove.

◆ end() [2/2]

auto castor3d::SkeletonAnimationInstance::end ( ) const
inline
Renvoie
L'itérateur sur la fin des objets racines.

Références m_toMove.

◆ getObject() [1/3]

C3D_API SkeletonAnimationInstanceObjectSPtr castor3d::SkeletonAnimationInstance::getObject ( Bone const &  bone) const

Récupère un os animé.

Paramètres
[in]boneL'os.

◆ getObject() [2/3]

C3D_API SkeletonAnimationInstanceObjectSPtr castor3d::SkeletonAnimationInstance::getObject ( castor::String const &  name) const

Récupère un noeud animé.

Paramètres
[in]nameLe nom du noeud.

◆ getObject() [3/3]

C3D_API SkeletonAnimationInstanceObjectSPtr castor3d::SkeletonAnimationInstance::getObject ( SkeletonAnimationObjectType  type,
castor::String const &  name 
) const

Récupère un objet animé.

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

◆ getObjectsCount()

auto castor3d::SkeletonAnimationInstance::getObjectsCount ( ) const
inline
Renvoie
Le nombre d'objets.

Références m_toMove.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Documentation des données membres

◆ m_curr

SkeletonAnimationInstanceKeyFrameArray::iterator castor3d::SkeletonAnimationInstance::m_curr
protected

Itérateur sur la keyframe courante (quand l'animation est jouée).

◆ m_keyFrames

SkeletonAnimationInstanceKeyFrameArray castor3d::SkeletonAnimationInstance::m_keyFrames
protected

Les instances des keyframes.

◆ m_toMove

SkeletonAnimationInstanceObjectPtrArray castor3d::SkeletonAnimationInstance::m_toMove
protected

Les objets mouvants.

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


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