Castor3D::AnimatedObjectGroup Class Reference

Class which represents the animated object groups. More...

Inheritance diagram for Castor3D::AnimatedObjectGroup:

Collaboration diagram for Castor3D::AnimatedObjectGroup:

Classes
class	BinaryLoader
	AnimatedObjectGroup loader. More...
class	TextLoader
	AnimatedObjectGroup loader. More...

Public Member Functions
C3D_API	AnimatedObjectGroup (Castor::String const &p_name, Scene &p_scene)
	Specified constructor. More...
C3D_API	~AnimatedObjectGroup ()
	Destructor. More...
C3D_API AnimatedObjectSPtr	AddObject (GeometrySPtr p_object)
	Creates an AnimatedObject from the MovableObject given as a parameter, adds it to the list. More...
C3D_API bool	AddObject (AnimatedObjectSPtr p_object)
	Adds an AnimatedObject to this group. More...
C3D_API void	AddAnimation (Castor::String const &p_name)
	Adds the animation to the list. More...
C3D_API void	SetAnimationLooped (Castor::String const &p_name, bool p_looped)
	Sets the loop status of wanted animation. More...
C3D_API void	SetAnimationScale (Castor::String const &p_name, float p_scale)
	Sets the time scale of wanted animation. More...
C3D_API void	Update ()
	Updates all animated objects. More...
C3D_API void	StartAnimation (Castor::String const &p_name)
	Starts the animation identified by the given name. More...
C3D_API void	StopAnimation (Castor::String const &p_name)
	Stops the animation identified by the given name. More...
C3D_API void	PauseAnimation (Castor::String const &p_name)
	Pauses the animation identified by the given name. More...
C3D_API void	StartAllAnimations ()
	Starts all animations. More...
C3D_API void	StopAllAnimations ()
	Stops all animations. More...
C3D_API void	PauseAllAnimations ()
	Pauses all animations. More...
AnimationStateMap const &	GetAnimations () const
AnimatedObjectPtrStrMap const &	GetObjects () const

Detailed Description

Class which represents the animated object groups.

Author

Sylvain DOREMUS

Version

0.6.1.0

Date

19/10/2011

Remarks

Animated object groups, are a group of objects sharing a selected list of animations and needing synchronised animating

Constructor & Destructor Documentation

AnimatedObjectGroup()

C3D_API Castor3D::AnimatedObjectGroup::AnimatedObjectGroup	(	Castor::String const &	p_name,
		Scene &	p_scene
	)

Specified constructor.

Parameters

[in]	p_name	The group name
[in]	p_scene	The scene

~AnimatedObjectGroup()

C3D_API Castor3D::AnimatedObjectGroup::~AnimatedObjectGroup

(

)

Destructor.

Member Function Documentation

AddAnimation()

C3D_API void Castor3D::AnimatedObjectGroup::AddAnimation

(

Castor::String const &

p_name

)

Adds the animation to the list.

Parameters

[in]

p_name

The animation to add

Ajoute une animation à la liste

Parameters

[in]

p_name

L'animation à ajouter

AddObject() [1/2]

C3D_API AnimatedObjectSPtr Castor3D::AnimatedObjectGroup::AddObject

(

GeometrySPtr

p_object

)

Creates an AnimatedObject from the MovableObject given as a parameter, adds it to the list.

Parameters

[in]

p_object

The Geometry from which AnimatedObject is created

Returns

The created AnimatedObject

AddObject() [2/2]

C3D_API bool Castor3D::AnimatedObjectGroup::AddObject

(

AnimatedObjectSPtr

p_object

)

Adds an AnimatedObject to this group.

Remarks

This function assumes the object has already been created in order to be put in this group (with the good scene and animations map)

Parameters

[in]

p_object

The AnimatedObject to add

GetAnimations()

AnimationStateMap const& Castor3D::AnimatedObjectGroup::GetAnimations ( ) const

inline

Returns

The animations map.

GetObjects()

AnimatedObjectPtrStrMap const& Castor3D::AnimatedObjectGroup::GetObjects ( ) const

inline

Returns

The animated objects.

PauseAllAnimations()

C3D_API void Castor3D::AnimatedObjectGroup::PauseAllAnimations

(

)

Pauses all animations.

PauseAnimation()

C3D_API void Castor3D::AnimatedObjectGroup::PauseAnimation

(

Castor::String const &

p_name

)

Pauses the animation identified by the given name.

Parameters

[in]

p_name

The name of the animation

SetAnimationLooped()

C3D_API void Castor3D::AnimatedObjectGroup::SetAnimationLooped	(	Castor::String const &	p_name,
		bool	p_looped
	)

Sets the loop status of wanted animation.

Parameters

[in]	p_name	The name of the animation.
[in]	p_looped	The status.

SetAnimationScale()

C3D_API void Castor3D::AnimatedObjectGroup::SetAnimationScale	(	Castor::String const &	p_name,
		float	p_scale
	)

Sets the time scale of wanted animation.

Parameters

[in]	p_name	The name of the animation.
[in]	p_scale	The scale.

StartAllAnimations()

C3D_API void Castor3D::AnimatedObjectGroup::StartAllAnimations

(

)

Starts all animations.

StartAnimation()

C3D_API void Castor3D::AnimatedObjectGroup::StartAnimation

(

Castor::String const &

p_name

)

Starts the animation identified by the given name.

Parameters

[in]

p_name

The name of the animation

StopAllAnimations()

C3D_API void Castor3D::AnimatedObjectGroup::StopAllAnimations

(

)

Stops all animations.

StopAnimation()

C3D_API void Castor3D::AnimatedObjectGroup::StopAnimation

(

Castor::String const &

p_name

)

Stops the animation identified by the given name.

Parameters

[in]

p_name

The name of the animation

Update()

C3D_API void Castor3D::AnimatedObjectGroup::Update

(

)

Updates all animated objects.

---

The documentation for this class was generated from the following file:

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/AnimatedObjectGroup.hpp