CAnimator Class Reference

class CAnimator : public CBase

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.

CAnimation

Inherits from

Constructor & Destructor Documentation

~CAnimator()

IMPORT_C~CAnimator()[virtual]

Destructor.

Member Functions Documentation

DataEventL(TInt, TAny *, TInt)

voidDataEventL(TIntaEvent,
TAny *aData,
TIntaDataSize
)[pure virtual]

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

MAnimationDataProviderObserver

Parameters

TInt aEventThe event identifier
TAny * aDataA pointer to any data for the event
TInt aDataSizeThe length of the data in aData

Draw(CBitmapContext &)

voidDraw(CBitmapContext &aBitmapContext)const [pure virtual]

Called from the renderer and draws the animation.

Parameters

CBitmapContext & aBitmapContextThe context on which the animation will be drawn

DrawMask(CBitmapContext &)

voidDrawMask(CBitmapContext &aBitmapContext)const [pure virtual]

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

Parameters

CBitmapContext & aBitmapContextThe context on which the mask will be drawn

Hold()

voidHold()[pure virtual]

Puts an animation on hold.

NewL(MAnimationDrawer *)

IMPORT_C CAnimator *NewL(MAnimationDrawer *aRenderer)[static]

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.

The new animator.

Parameters

MAnimationDrawer * aRendererThe MAnimationDrawer implementation for the animator to use.

Pause()

voidPause()[pure virtual]

Pauses the animation.

Resume()

voidResume()[pure virtual]

Resumes a paused animation.

Start(const TAnimationConfig &)

voidStart(const TAnimationConfig &aConfig)[pure virtual]

Starts the animation running. TAnimationConfig

Parameters

const TAnimationConfig & aConfigRuntime settings

Stop()

voidStop()[pure virtual]

Stops the animation and rewinds it.

Unhold()

voidUnhold()[pure virtual]

Restores a held animation and brings it back into synch.

Member Data Documentation

TUid iDtor_ID_Key

TUid iDtor_ID_Key[protected]

Animator ECOM Plugin identifier

TInt iLoop

TInt iLoop[protected]

Data