Class CAnimator

class CAnimator : public CBase;

Description

Pure virtual base class for animators.

Each data type supported by the animation framework is represented by an animator, which handles the data interpretation, timing and control. Each animator is provided in the form of an ECOM plugin.

You do not need to instatiate animators in a client application. This is handled by the animation classes.

Derivation

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

• CAnimator - Pure virtual base class for animators.

Members

Defined in CAnimator:

• DataEventL(TInt,TAny *,TInt)Receives data from a data provider. The mechanism by which data is actually pass...
• Draw(CBitmapContext &)constCalled from the renderer and draws the animation.
• DrawMask(CBitmapContext &)constCalled from the renderer and draws the mask for the animation.
• Hold()Puts an animation on hold.
• NewL(MAnimationDrawer *)Locates and constructs an animator.
• Pause()Pauses the animation.
• Resume()Resumes a paused animation.
• Start(const TAnimationConfig &)Starts the animation running.
• Stop()Stops the animation and rewinds it.
• Unhold()Restores a held animation and brings it back into synch.
• iDtor_ID_KeyAnimator ECOM Plugin identifier
• iLoopData
• ~CAnimator()Destructor.

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...

See also:

• CAnimationPure virtual base class for animations.

IMPORT_C static CAnimator* NewL(MAnimationDrawer *aRenderer);

Description

Locates and constructs an animator.

The MAnimationDrawer passed as an argument returns a string through the function AnimatorDataType. If a matching animator plugin can be found then it will be loaded and constructed.

Parameters

MAnimationDrawer *aRenderer The MAnimationDrawer implementation for the animator to use.

Return value

CAnimator * The new animator.

IMPORT_C virtual ~CAnimator();

Description

Destructor.

virtual void Start(const TAnimationConfig &aConfig)=0;

Description

Starts the animation running.

Parameters

const TAnimationConfig &aConfig Runtime settings

See also:

• TAnimationConfigThese are passed to animator objects when an animation is started and provide so...

virtual void Stop()=0;

Description

Stops the animation and rewinds it.

virtual void Pause()=0;

Description

Pauses the animation.

virtual void Resume()=0;

Description

Resumes a paused animation.

virtual void Hold()=0;

Description

Puts an animation on hold.

virtual void Unhold()=0;

Description

Restores a held animation and brings it back into synch.

virtual void DataEventL(TInt aEvent, TAny *aData, TInt aDataSize)=0;

Description

Receives data from a data provider. The mechanism by which data is actually passed depends on the animation type.

Parameters

TInt aEvent The event identifier TAny *aData A pointer to any data for the event TInt aDataSize The length of the data in aData

See also:

• MAnimationDataProviderObserverInterface from a data provider to an animation

virtual void Draw(CBitmapContext &aBitmapContext) const=0;

Description

Called from the renderer and draws the animation.

Parameters

CBitmapContext &aBitmapContext The context on which the animation will be drawn

virtual void DrawMask(CBitmapContext &aBitmapContext) const=0;

Description

Called from the renderer and draws the mask for the animation.

Parameters

CBitmapContext &aBitmapContext The context on which the mask will be drawn

protected: TUid iDtor_ID_Key;

Description

Animator ECOM Plugin identifier

protected: TInt iLoop;

Description

Data