SAnimatorGroup Class Reference

Manages a group of animations. More...

#include <SValueAnimator.h>

Inheritance diagram for SAnimatorGroup:

Public Types
enum	AniState { idle , started , running }
	Enumeration of animation states. More...

Public Member Functions
	SAnimatorGroup ()
	Constructor.
	~SAnimatorGroup ()
	Destructor.
BOOL	AddAnimator (IValueAnimator *ani) OVERRIDE
	Adds an animator to the group.
BOOL	RemoveAnimator (IValueAnimator *ani) OVERRIDE
	Removes an animator from the group.
void	SetListener (IAnimatorGroupListerer *listener) OVERRIDE
	Sets the listener for the animator group.
Public Member Functions inherited from TObjRefImpl< IAnimatorGroup >
	TObjRefImpl ()
	Constructor that initializes the reference count to 1.
virtual	~TObjRefImpl ()
	Virtual destructor.
long	AddRef () override
	Increments the reference count.
long	Release () override
	Decrements the reference count and deletes the object if the count reaches zero.
void	OnFinalRelease () override
	Deletes the object.

Protected Types
typedef SMap< IValueAnimator *, AniState >	AnimatorStateMap
	Map of animators and their states.

Protected Member Functions
void	onAnimationStart (IValueAnimator *pAnimator)
	Called when an animation starts.
void	onAnimationRepeat (IValueAnimator *pAnimator)
	Called when an animation repeats.
void	onAnimationEnd (IValueAnimator *pAnimator)
	Called when an animation ends.

Protected Attributes
AnimatorStateMap	m_lstAnimator
	Map of animators and their states.
IAnimatorGroupListerer *	m_listener
	Listener for the animator group.
Protected Attributes inherited from TObjRefImpl< IAnimatorGroup >
LONG	m_cRef
	Reference count.

Detailed Description

Manages a group of animations.

Definition at line 767 of file SValueAnimator.h.

Member Typedef Documentation

AnimatorStateMap

typedef SMap<IValueAnimator *, AniState> SAnimatorGroup::AnimatorStateMap

protected

Map of animators and their states.

Definition at line 837 of file SValueAnimator.h.

Member Enumeration Documentation

AniState

enum SAnimatorGroup::AniState

Enumeration of animation states.

Definition at line 775 of file SValueAnimator.h.

Constructor & Destructor Documentation

SAnimatorGroup()

SAnimatorGroup::SAnimatorGroup

(

)

Constructor.

Definition at line 658 of file SValueAnimator.cpp.

~SAnimatorGroup()

SAnimatorGroup::~SAnimatorGroup

(

)

Destructor.

Definition at line 663 of file SValueAnimator.cpp.

Member Function Documentation

AddAnimator()

BOOL SAnimatorGroup::AddAnimator

(

IValueAnimator *

ani

)

Adds an animator to the group.

Parameters

ani	Pointer to the animator to add.

Returns

TRUE if the animator was added successfully, FALSE otherwise.

Definition at line 675 of file SValueAnimator.cpp.

onAnimationEnd()

void SAnimatorGroup::onAnimationEnd ( IValueAnimator * pAnimator )

protected

Called when an animation ends.

Parameters

pAnimator

Pointer to the animator that ended.

Definition at line 714 of file SValueAnimator.cpp.

onAnimationRepeat()

void SAnimatorGroup::onAnimationRepeat ( IValueAnimator * pAnimator )

inlineprotected

Called when an animation repeats.

Parameters

pAnimator

Pointer to the animator that repeated.

Definition at line 823 of file SValueAnimator.h.

onAnimationStart()

void SAnimatorGroup::onAnimationStart ( IValueAnimator * pAnimator )

protected

Called when an animation starts.

Parameters

pAnimator

Pointer to the animator that started.

Definition at line 703 of file SValueAnimator.cpp.

RemoveAnimator()

BOOL SAnimatorGroup::RemoveAnimator

(

IValueAnimator *

ani

)

Removes an animator from the group.

Parameters

ani	Pointer to the animator to remove.

Returns

TRUE if the animator was removed successfully, FALSE otherwise.

Definition at line 694 of file SValueAnimator.cpp.

SetListener()

void SAnimatorGroup::SetListener

(

IAnimatorGroupListerer *

listener

)

Sets the listener for the animator group.

Parameters

listener

Pointer to the listener.

Definition at line 741 of file SValueAnimator.cpp.

Member Data Documentation

m_listener

IAnimatorGroupListerer* SAnimatorGroup::m_listener

protected

Listener for the animator group.

Definition at line 847 of file SValueAnimator.h.

m_lstAnimator

AnimatorStateMap SAnimatorGroup::m_lstAnimator

protected

Map of animators and their states.

Definition at line 842 of file SValueAnimator.h.

---

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

• SOUI/include/valueAnimator/SValueAnimator.h
• SOUI/src/valueAnimator/SValueAnimator.cpp