#include <AnimatedObjectGroup.hpp>

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

Graphe de collaboration de castor3d::AnimatedObjectGroup:

Types publics
using	AnimatedObjectMap = std::map< castor::String, AnimatedObjectUPtr >

Fonctions membres publiques
C3D_API	AnimatedObjectGroup (castor::String const &name, Scene &scene)
	Constructeur spécifié

C3D_API	~AnimatedObjectGroup ()
	Destructeur.

C3D_API AnimatedObjectRPtr	addObject (SceneNode &node, castor::String const &name)
	Crée un AnimatedObject à partir du SceneNode donné, l'ajoute à la liste.

C3D_API AnimatedObjectRPtr	addObject (Mesh &mesh, Geometry &geometry, castor::String const &name)
	Crée un AnimatedObject à partir du Mesh donné, l'ajoute à la liste.

C3D_API AnimatedObjectRPtr	addObject (Skeleton &skeleton, Mesh &mesh, Geometry &geometry, castor::String const &name)
	Crée un AnimatedObject à partir du Skeleton donné, l'ajoute à la liste.

C3D_API AnimatedObjectRPtr	addObject (TextureSourceInfo const &sourceInfo, TextureConfiguration const &config, Pass &pass)
	Crée un AnimatedObject pour une texture, l'ajoute à la liste.

C3D_API bool	addObject (AnimatedObjectUPtr object)
	Ajoute un AnimatedObject à ce groupe.

C3D_API AnimatedObject *	findObject (castor::String const &name) const
	Recherche un AnimatedObject en fonction de son nom.

C3D_API bool	addAnimation (castor::String const &name)
	Ajoute une animation à la liste.

C3D_API void	setAnimationLooped (castor::String const &name, bool looped)
	Définit le statut de bouclage de l'animation voulue.

C3D_API void	setAnimationScale (castor::String const &name, float scale)
	Définit le multiplicateur de temps de l'animation voulue.

C3D_API void	setAnimationStartingPoint (castor::String const &name, castor::Milliseconds value)
	Définit le point de départ de l'animation voulue.

C3D_API void	setAnimationStoppingPoint (castor::String const &name, castor::Milliseconds value)
	Définit le point d'arrêt de l'animation voulue.

C3D_API void	setAnimationInterpolation (castor::String const &name, InterpolatorType mode)
	Définit le mode d'interpolation de l'animation voulue.

C3D_API void	update (CpuUpdater &updater)
	Mise à jour CPU.

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.

GroupAnimationMap const &	getAnimations () const

AnimatedObjectMap const &	getObjects () const

Attributs publics
OnAnimatedSkeletonChange	onSkeletonAdded

OnAnimatedSkeletonChange	onSkeletonRemoved

OnAnimatedMeshChange	onMeshAdded

OnAnimatedMeshChange	onMeshRemoved

OnAnimatedTextureChange	onTextureAdded

OnAnimatedTextureChange	onTextureRemoved

OnAnimatedSceneNodeChange	onSceneNodeAdded

OnAnimatedSceneNodeChange	onSceneNodeRemoved

Documentation des définitions de type membres

◆ AnimatedObjectMap

using castor3d::AnimatedObjectGroup::AnimatedObjectMap = std::map< castor::String, AnimatedObjectUPtr >

Documentation des constructeurs et destructeur

◆ AnimatedObjectGroup()

C3D_API castor3d::AnimatedObjectGroup::AnimatedObjectGroup	(	castor::String const &	name,
		Scene &	scene
	)

Constructeur spécifié

Paramètres

[in]	scene	La scène
[in]	name	Le nom du groupe

◆ ~AnimatedObjectGroup()

C3D_API castor3d::AnimatedObjectGroup::~AnimatedObjectGroup ( )

Destructeur.

Documentation des fonctions membres

◆ addAnimation()

C3D_API bool castor3d::AnimatedObjectGroup::addAnimation ( castor::String const & name )

Ajoute une animation à la liste.

Paramètres

[in] name L'animation à ajouter.

Renvoie: true si l'animation n'existait pas encore.

◆ addObject() [1/5]

C3D_API bool castor3d::AnimatedObjectGroup::addObject ( AnimatedObjectUPtr object )

Ajoute un AnimatedObject à ce groupe.

Remarques: Cette fonction considère que l'objet a préalablement été créé afin d'être intégré à ce groupe (avec donc les bonnes scène et map d'animations)

Paramètres

[in] object Le AnimatedObject à ajouter

◆ addObject() [2/5]

C3D_API AnimatedObjectRPtr castor3d::AnimatedObjectGroup::addObject	(	Mesh &	mesh,
		Geometry &	geometry,
		castor::String const &	name
	)

Crée un AnimatedObject à partir du Mesh donné, l'ajoute à la liste.

Paramètres

[in]	mesh	Le Mesh à partir duquel l'AnimatedObject est créé.
[in]	geometry	La géométrie instanciant le maillage.
[in]	name	Le nom de l'instance du Mesh.

◆ addObject() [3/5]

C3D_API AnimatedObjectRPtr castor3d::AnimatedObjectGroup::addObject	(	SceneNode &	node,
		castor::String const &	name
	)

Crée un AnimatedObject à partir du SceneNode donné, l'ajoute à la liste.

Paramètres

[in]	node	Le SceneNode à partir duquel l'AnimatedObject est créé.
[in]	name	Le nom de l'instance du SceneNode.

◆ addObject() [4/5]

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

Crée un AnimatedObject à partir du Skeleton donné, l'ajoute à la liste.

Paramètres

[in]	skeleton	Le Skeleton à partir duquel l'AnimatedObject est créé.
[in]	mesh	Le maillage auquel le squelette est lié.
[in]	geometry	La géométrie instanciant le maillage.
[in]	name	Le nom de l'instance du Skeleton.

◆ addObject() [5/5]

C3D_API AnimatedObjectRPtr castor3d::AnimatedObjectGroup::addObject	(	TextureSourceInfo const &	sourceInfo,
		TextureConfiguration const &	config,
		Pass &	pass
	)

Crée un AnimatedObject pour une texture, l'ajoute à la liste.

Paramètres

[in]	sourceInfo	Les informations de source de la texture.
[in]	config	La configuration de texture
[in]	pass	La passe instanciant la texture.

◆ findObject()

C3D_API AnimatedObject * castor3d::AnimatedObjectGroup::findObject ( castor::String const & name ) const

Recherche un AnimatedObject en fonction de son nom.

Paramètres

[in] name Le nom de l'AnimatedObject.

◆ getAnimations()

GroupAnimationMap const & castor3d::AnimatedObjectGroup::getAnimations ( ) const

inline

Renvoie: La map d'animations.

◆ getObjects()

AnimatedObjectMap const & castor3d::AnimatedObjectGroup::getObjects ( ) const

inline

Renvoie: Les objets animés.

◆ pauseAllAnimations()

C3D_API void castor3d::AnimatedObjectGroup::pauseAllAnimations ( )

Met en pause toutes les animations.

◆ pauseAnimation()

C3D_API void castor3d::AnimatedObjectGroup::pauseAnimation ( castor::String const & name )

Met en pause l'animation identifiée par le nom donné

Paramètres

[in] name Le nom de l'animation

◆ setAnimationInterpolation()

C3D_API void castor3d::AnimatedObjectGroup::setAnimationInterpolation	(	castor::String const &	name,
		InterpolatorType	mode
	)

Définit le mode d'interpolation de l'animation voulue.

Paramètres

[in]	name	Le nom de l'animation.
[in]	mode	Le mode d'interpolation.

◆ setAnimationLooped()

C3D_API void castor3d::AnimatedObjectGroup::setAnimationLooped	(	castor::String const &	name,
		bool	looped
	)

Définit le statut de bouclage de l'animation voulue.

Paramètres

[in]	name	Le nom de l'animation.
[in]	looped	Le statut.

◆ setAnimationScale()

C3D_API void castor3d::AnimatedObjectGroup::setAnimationScale	(	castor::String const &	name,
		float	scale
	)

Définit le multiplicateur de temps de l'animation voulue.

Paramètres

[in]	name	Le nom de l'animation.
[in]	scale	Le multiplicateur.

◆ setAnimationStartingPoint()

C3D_API void castor3d::AnimatedObjectGroup::setAnimationStartingPoint	(	castor::String const &	name,
		castor::Milliseconds	value
	)

Définit le point de départ de l'animation voulue.

Paramètres

[in]	name	Le nom de l'animation.
[in]	value	Le point de départ.

◆ setAnimationStoppingPoint()

C3D_API void castor3d::AnimatedObjectGroup::setAnimationStoppingPoint	(	castor::String const &	name,
		castor::Milliseconds	value
	)

Définit le point d'arrêt de l'animation voulue.

Paramètres

[in]	name	Le nom de l'animation.
[in]	value	Le point d'arrêt.

◆ startAllAnimations()

C3D_API void castor3d::AnimatedObjectGroup::startAllAnimations ( )

Démarre toutes les animations.

◆ startAnimation()

C3D_API void castor3d::AnimatedObjectGroup::startAnimation ( castor::String const & name )

Démarre l'animation identifiée par le nom donné

Paramètres

[in] name Le nom de l'animation

◆ stopAllAnimations()

C3D_API void castor3d::AnimatedObjectGroup::stopAllAnimations ( )

Stoppe toutes les animations.

◆ stopAnimation()

C3D_API void castor3d::AnimatedObjectGroup::stopAnimation ( castor::String const & name )

Stoppe l'animation identifiée par le nom donné

Paramètres

[in] name Le nom de l'animation

◆ update()

C3D_API void castor3d::AnimatedObjectGroup::update ( CpuUpdater & updater )

Mise à jour CPU.

Paramètres

[in,out] updater Les données d'update.

Documentation des données membres

◆ onMeshAdded

OnAnimatedMeshChange castor3d::AnimatedObjectGroup::onMeshAdded

◆ onMeshRemoved

OnAnimatedMeshChange castor3d::AnimatedObjectGroup::onMeshRemoved

◆ onSceneNodeAdded

OnAnimatedSceneNodeChange castor3d::AnimatedObjectGroup::onSceneNodeAdded

◆ onSceneNodeRemoved

OnAnimatedSceneNodeChange castor3d::AnimatedObjectGroup::onSceneNodeRemoved

◆ onSkeletonAdded

OnAnimatedSkeletonChange castor3d::AnimatedObjectGroup::onSkeletonAdded

◆ onSkeletonRemoved

OnAnimatedSkeletonChange castor3d::AnimatedObjectGroup::onSkeletonRemoved

◆ onTextureAdded

OnAnimatedTextureChange castor3d::AnimatedObjectGroup::onTextureAdded

◆ onTextureRemoved

OnAnimatedTextureChange castor3d::AnimatedObjectGroup::onTextureRemoved

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

Scene/Animation/AnimatedObjectGroup.hpp

Types publics

Fonctions membres publiques

Attributs publics

Documentation des définitions de type membres

◆ AnimatedObjectMap

Documentation des constructeurs et destructeur

◆ AnimatedObjectGroup()

◆ ~AnimatedObjectGroup()

Documentation des fonctions membres

◆ addAnimation()

◆ addObject() [1/5]

◆ addObject() [2/5]

◆ addObject() [3/5]

◆ addObject() [4/5]

◆ addObject() [5/5]

◆ findObject()

◆ getAnimations()

◆ getObjects()

◆ pauseAllAnimations()

◆ pauseAnimation()

◆ setAnimationInterpolation()

◆ setAnimationLooped()

◆ setAnimationScale()

◆ setAnimationStartingPoint()

◆ setAnimationStoppingPoint()

◆ startAllAnimations()

◆ startAnimation()

◆ stopAllAnimations()

◆ stopAnimation()

◆ update()

Documentation des données membres

◆ onMeshAdded

◆ onMeshRemoved

◆ onSceneNodeAdded

◆ onSceneNodeRemoved

◆ onSkeletonAdded

◆ onSkeletonRemoved

◆ onTextureAdded

◆ onTextureRemoved