Référence de la classe castor3d::AnimatedSkeleton

#include <AnimatedSkeleton.hpp>

Graphe d'héritage de castor3d::AnimatedSkeleton:

Graphe de collaboration de castor3d::AnimatedSkeleton:

Fonctions membres publiques
C3D_API	AnimatedSkeleton (castor::String const &name, Skeleton &skeleton, Mesh &mesh, Geometry &geometry)
	Constructeur.
C3D_API uint32_t	fillBuffer (SkinningTransformsConfiguration *buffer) const
	Remplit un buffer avec les transformations du squelette de cet objet.
C3D_API void	update (castor::Milliseconds const &elapsed) override
	Met à jour les animations de l'objet, selon le temps écoulé depuis la dernière frame.
bool	isPlayingAnimation () const override
Skeleton &	getSkeleton () const
Mesh &	getMesh () const
Geometry &	getGeometry () const
uint32_t	getId () const
void	setId (uint32_t id)
C3D_API	AnimatedSkeleton (AnimatedSkeleton &&rhs) noexcept=default
C3D_API AnimatedSkeleton &	operator= (AnimatedSkeleton &&rhs) noexcept=delete
C3D_API	AnimatedSkeleton (AnimatedSkeleton const &rhs)=delete
C3D_API AnimatedSkeleton &	operator= (AnimatedSkeleton const &rhs)=delete
C3D_API	~AnimatedSkeleton () noexcept override=default
Fonctions membres publiques hérités de castor3d::AnimatedObject
C3D_API	AnimatedObject (AnimationType kind, castor::String const &name)
	Constructeur.
virtual C3D_API	~AnimatedObject () noexcept=default
	Destructeur.
C3D_API void	addAnimation (castor::String const &name)
	Ajoute une animation à la liste.
C3D_API void	startAnimation (castor::String const &name)
	Démarre l'animation identifiée par le nom donné
C3D_API void	stopAnimation (castor::String const &name)
	Stoppe l'animation identifiée par le nom donné
C3D_API void	pauseAnimation (castor::String const &name)
	Met en pause l'animation identifiée par le nom donné
C3D_API void	startAllAnimations ()
	Démarre toutes les animations.
C3D_API void	stopAllAnimations ()
	Stoppe toutes les animations.
C3D_API void	pauseAllAnimations ()
	Met en pause toutes les animations.
C3D_API AnimationInstance &	getAnimation (castor::String const &name)
	Récupère une animation.
C3D_API	AnimatedObject (AnimatedObject &&rhs) noexcept=default
C3D_API AnimatedObject &	operator= (AnimatedObject &&rhs) noexcept=default
C3D_API	AnimatedObject (AnimatedObject const &rhs)=delete
C3D_API AnimatedObject &	operator= (AnimatedObject const &rhs)=delete
bool	hasAnimation (castor::String const &name)
AnimationInstancesMap const &	getAnimations () const
AnimationType	getKind () const
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept

Types protégés
using	InstanceArray = castor::Vector< SkeletonAnimationInstance * >

Attributs protégés
Skeleton &	m_skeleton
Mesh &	m_mesh
Geometry &	m_geometry
InstanceArray	m_playingAnimations
uint32_t	m_id {}
bool	m_reinit = true
Attributs protégés hérités de castor3d::AnimatedObject
AnimationInstancesMap	m_animations
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Membres hérités additionnels
Types publics hérités de castor3d::AnimatedObject
using	AnimationInstancesMap = castor::StringMap< AnimationInstanceUPtr >

Documentation des définitions de type membres

InstanceArray

using castor3d::AnimatedSkeleton::InstanceArray = castor::Vector< SkeletonAnimationInstance * >

protected

Documentation des constructeurs et destructeur

AnimatedSkeleton() [1/3]

C3D_API castor3d::AnimatedSkeleton::AnimatedSkeleton ( AnimatedSkeleton && rhs )

defaultnoexcept

name Copie / Déplacement.

AnimatedSkeleton() [2/3]

C3D_API castor3d::AnimatedSkeleton::AnimatedSkeleton ( AnimatedSkeleton const & rhs )

delete

~AnimatedSkeleton()

C3D_API castor3d::AnimatedSkeleton::~AnimatedSkeleton ( )

overridedefaultnoexcept

AnimatedSkeleton() [3/3]

C3D_API castor3d::AnimatedSkeleton::AnimatedSkeleton	(	castor::String const &	name,
		Skeleton &	skeleton,
		Mesh &	mesh,
		Geometry &	geometry )

Constructeur.

Paramètres

[in]	name	Le nom de l'objet.
[in]	skeleton	Le squelette.
[in]	mesh	Le maillage auquel le squelette est lié.
[in]	geometry	La géométrie instanciant le maillage.

Documentation des fonctions membres

fillBuffer()

C3D_API uint32_t castor3d::AnimatedSkeleton::fillBuffer

(

SkinningTransformsConfiguration *

buffer

)

const

Remplit un buffer avec les transformations du squelette de cet objet.

Paramètres

[out]

buffer

Reçoit les transformations.

getGeometry()

Geometry & castor3d::AnimatedSkeleton::getGeometry ( ) const

inline

Références m_geometry.

getId()

uint32_t castor3d::AnimatedSkeleton::getId ( ) const

inline

Références m_id.

getMesh()

Mesh & castor3d::AnimatedSkeleton::getMesh ( ) const

inline

Références m_mesh.

getSkeleton()

Skeleton & castor3d::AnimatedSkeleton::getSkeleton ( ) const

inline

Références m_skeleton.

isPlayingAnimation()

bool castor3d::AnimatedSkeleton::isPlayingAnimation ( ) const

inlineoverridevirtual

Renvoie

true si l'objet joue une animation.

Implémente castor3d::AnimatedObject.

Références m_playingAnimations.

operator=() [1/2]

C3D_API AnimatedSkeleton & castor3d::AnimatedSkeleton::operator= ( AnimatedSkeleton && rhs )

deletenoexcept

operator=() [2/2]

C3D_API AnimatedSkeleton & castor3d::AnimatedSkeleton::operator= ( AnimatedSkeleton const & rhs )

delete

setId()

void castor3d::AnimatedSkeleton::setId ( uint32_t id )

inline

Références m_id.

update()

C3D_API void castor3d::AnimatedSkeleton::update ( castor::Milliseconds const & elapsed )

overridevirtual

Met à jour les animations de l'objet, selon le temps écoulé depuis la dernière frame.

Paramètres

[in]

elapsed

Le temps écoulé depuis la dernière frame

Implémente castor3d::AnimatedObject.

Documentation des données membres

m_geometry

Geometry& castor3d::AnimatedSkeleton::m_geometry

protected

Référencé par getGeometry().

m_id

uint32_t castor3d::AnimatedSkeleton::m_id {}

protected

Référencé par getId(), et setId().

m_mesh

Mesh& castor3d::AnimatedSkeleton::m_mesh

protected

Référencé par getMesh().

m_playingAnimations

InstanceArray castor3d::AnimatedSkeleton::m_playingAnimations

protected

Référencé par isPlayingAnimation().

m_reinit

bool castor3d::AnimatedSkeleton::m_reinit = true

mutableprotected

m_skeleton

Skeleton& castor3d::AnimatedSkeleton::m_skeleton

protected

Référencé par getSkeleton().

---

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

• Castor3D/Scene/Animation/AnimatedSkeleton.hpp