Class CAnimationGroup

class CAnimationGroup : public CAnimation;

Description

Handles groups of other animations.

When it is appropriate to have several animations starting and stopping together, add them all to an animation group and control them through that.

In addition to making the code easier to both read and write, the animation group handles synchronisation issues which can occur when issuing a sequence of asynchronous requests.

Care must be taken to remove an animation from any groups it may have been added to before deleting it.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CAnimation - Pure virtual base class for animations.

• CAnimationGroup - Handles groups of other animations.

Members

Defined in CAnimationGroup:

• Animations()Returns a reference to the array of animations being grouped.
• Animations()constReturns a reference to the array of animations being grouped.
• CAnimationGroup_Reserved1()Reserved for future use
• CAnimationGroup_Reserved2()Reserved for future use
• Freeze()Freeze all of the animations.
• Hold()Hold all of the animations.
• Pause()Pauses all of the animations.
• Resume()Resumes all of the animations.
• SetPosition(const TPoint &)Set the position of all the animations.
• Start(const TAnimationConfig &)Starts all of the animations.
• Stop()Stops all of the animations.
• Unfreeze()Unfreeze all of the animations.
• Unhold()Unhold all of the animations.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C const RPointerArray< CAnimation >& Animations() const;

Description

Returns a reference to the array of animations being grouped.

It is intended for animations to be added to and removed from this array directly.

Return value

const RPointerArray< CAnimation > & the array of animations currently held in the group.

IMPORT_C RPointerArray< CAnimation >& Animations();

Description

Returns a reference to the array of animations being grouped.

It is intended for animations to be added to and removed from this array directly.

Return value

RPointerArray< CAnimation > & the array of animations currently held in the group.

virtual void Start(const TAnimationConfig &aConfig);

Description

Starts all of the animations.

Parameters

const TAnimationConfig &aConfig Specifies run time attributes of the animation

virtual void Stop();

Description

Stops all of the animations.

virtual void Pause();

Description

Pauses all of the animations.

virtual void Resume();

Description

Resumes all of the animations.

virtual void Hold();

Description

Hold all of the animations.

virtual void Unhold();

Description

Unhold all of the animations.

virtual void Freeze();

Description

Freeze all of the animations.

virtual void Unfreeze();

Description

Unfreeze all of the animations.

virtual void SetPosition(const TPoint &aPoint);

Description

Set the position of all the animations.

Note that this will cause all the animations to be in the same place, which is unlikely to be a desired effect. It is implemented here for completeness.

Parameters

const TPoint &aPoint The new location of the top left corner of the animation, relative to the window in which it is to be drawn

protected: IMPORT_C virtual void CAnimationGroup_Reserved1();

Description

Reserved for future use

protected: IMPORT_C virtual void CAnimationGroup_Reserved2();

Description

Reserved for future use