Collapse all Symbian^3 Application Developer Library

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

CAnimator
- CBase

Public Member Functions
	~CAnimator ()
void	DataEventL ( TInt , TAny *, TInt )
void	Draw ( CBitmapContext &)
void	DrawMask ( CBitmapContext &)
void	Hold ()
IMPORT_C CAnimator *	NewL ( MAnimationDrawer *)
void	Pause ()
void	Resume ()
void	Start (const TAnimationConfig &)
void	Stop ()
void	Unhold ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
TUid	iDtor_ID_Key
TInt	iLoop

Constructor & Destructor Documentation

~CAnimator()

IMPORT_C

~CAnimator

(

)

[virtual]

Destructor.

Member Functions Documentation

DataEventL(TInt, TAny *, TInt)

void	DataEventL	(	TInt	aEvent,
			TAny *	aData,
			TInt	aDataSize
		)	[pure virtual]

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

MAnimationDataProviderObserver

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

Draw(CBitmapContext &)

void

Draw

(

CBitmapContext &

aBitmapContext

)

const [pure virtual]

Called from the renderer and draws the animation.

Parameters

CBitmapContext & aBitmapContext

The context on which the animation will be drawn

DrawMask(CBitmapContext &)

void

DrawMask

(

CBitmapContext &

aBitmapContext

)

const [pure virtual]

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

Parameters

CBitmapContext & aBitmapContext

The context on which the mask will be drawn

Hold()

void

Hold

(

)

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

Parameters

MAnimationDrawer * aRenderer

The MAnimationDrawer implementation for the animator to use.

Pause()

void

Pause

(

)

[pure virtual]

Pauses the animation.

Resume()

void

Resume

(

)

[pure virtual]

Resumes a paused animation.

Start(const TAnimationConfig &)

void

Start

(

const TAnimationConfig &

aConfig

)

[pure virtual]

Starts the animation running. TAnimationConfig

Parameters

const TAnimationConfig & aConfig

Runtime settings

Stop()

void

Stop

(

)

[pure virtual]

Stops the animation and rewinds it.

Unhold()

void

Unhold

(

)

[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