CAnimationTicker Class Reference

class CAnimationTicker : public CBase

This provides timing information for animators.

You do not need to instantiate an object of this type unless you are writing a new animation type.

MAnimationTickee

CAnimationTls

Inherits from

Constructor & Destructor Documentation

CAnimationTicker()

CAnimationTicker()[private]

~CAnimationTicker()

IMPORT_C~CAnimationTicker()

Destructor.

Member Functions Documentation

Add(MAnimationTickee *)

IMPORT_C TIntAdd(MAnimationTickee *aTickee)

Adds a new tickee to the internal list. All added tickees will be called once every tick. KErrNone or one of the other system wide error codes

Parameters

MAnimationTickee * aTickeeAn object derived from MAnimationTickee

CAnimationTicker_Reserved1()

IMPORT_C voidCAnimationTicker_Reserved1()[protected, virtual]

Reserved for future use

CAnimationTicker_Reserved2()

IMPORT_C voidCAnimationTicker_Reserved2()[protected, virtual]

Reserved for future use

ConstructL(TTimeIntervalMicroSeconds32)

voidConstructL(TTimeIntervalMicroSeconds32aTickLength)[private]

Parameters

TTimeIntervalMicroSeconds32 aTickLength

Freeze()

IMPORT_C voidFreeze()

Freezes this ticker

This allows asynchronous actions to be taken for more than one animation without the animations getting out of synch with each other.

It is possible to freeze multiple times. Doing so will increment a reference counter and the ticker will not be unfrozen until every freeze has been matched by a call to unfreeze.

You should not need to call this function unless you are writing a new animation type. CAnimationTicker::Unfreeze()

NewL(TTimeIntervalMicroSeconds32)

IMPORT_C CAnimationTicker *NewL(TTimeIntervalMicroSeconds32aTickLength = 100000)[static]

Two stage constructor.

After construction, the ticker is already active.

Creates a new CAnimationTicker with the specified time period in microseconds. The time period aTickLength must be greater than 0 otherwise the caller will be panicked. See CPeriodic for the panic code raised.

MAnimationTickee

CPeriodic

The new object

Parameters

TTimeIntervalMicroSeconds32 aTickLength = 100000The resolution of the timer.

OnTick()

voidOnTick()

Remove(MAnimationTickee *)

IMPORT_C TIntRemove(MAnimationTickee *aTickee)

Removes a tickee from the internal list. Attempting to remove a tickee that has not been added is not an error, and has no effect. KErrNone or KErrNotFound

Parameters

MAnimationTickee * aTickeeAn object added using Add()

StartTickingL()

voidStartTickingL()[private]

StopTicking()

voidStopTicking()[private]

TickLength()

const TTimeIntervalMicroSeconds32 &TickLength()const [inline]

This provides the resolution of the timer. iTickLength The resolution of the timer

Unfreeze()

IMPORT_C voidUnfreeze()

Under some circumstances it may be necessary to handle unfreezing directly, instead of through the item on the cleanupstack. In this case the cleanup item should be popped and then Unfreeze called when appropriate.

You should not need to call this function unless you are writing a new animation type. CAnimationTicker::Freeze()

Member Data Documentation

TInt iCAnimationTicker_Reserved

TInt iCAnimationTicker_Reserved[private]

TInt iFreeze

TInt iFreeze[private]

CPeriodic * iPeriodic

CPeriodic *iPeriodic[private]

TTimeIntervalMicroSeconds32 iTickLength

TTimeIntervalMicroSeconds32 iTickLength[private]

RPointerArray< MAnimationTickee > iTickees

RPointerArray< MAnimationTickee >iTickees[private]