Class CAnimationTicker

class CAnimationTicker : public CBase;

Description

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.

Derivation

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

• CAnimationTicker - This provides timing information for animators

Members

Defined in CAnimationTicker:
Add(), CAnimationTicker_Reserved1(), CAnimationTicker_Reserved2(), Freeze(), NewL(), Remove(), TickLength(), Unfreeze(), ~CAnimationTicker()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• MAnimationTickee
• CAnimationTls

static IMPORT_C CAnimationTicker *NewL(TTimeIntervalMicroSeconds32 aTickLength=100000);

Description

Two stage constructor.

After construction, the ticker is already active.

Parameters

TTimeIntervalMicroSeconds32 aTickLength The resolution of the timer

Return value

CAnimationTicker * The new object

See also:

• MAnimationTickee

IMPORT_C ~CAnimationTicker();

Description

Destructor.

IMPORT_C TInt Add(MAnimationTickee *aTickee);

Description

Adds a new tickee to the internal list. All added tickees will be called once every tick.

Parameters

MAnimationTickee *aTickee An object derived from MAnimationTickee

Return value

TInt KErrNone or one of the other system wide error codes

IMPORT_C TInt Remove(MAnimationTickee *aTickee);

Description

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.

Parameters

MAnimationTickee *aTickee An object added using Add()

Return value

TInt KErrNone or KErrNotFound

IMPORT_C void Freeze();

Description

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

See also:

• CAnimationTicker::Unfreeze()

IMPORT_C void Unfreeze();

Description

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.

See also:

• CAnimationTicker::Freeze()

inline const TTimeIntervalMicroSeconds32 &TickLength() const;

Description

This provides the resolution of the timer.

Return value

const TTimeIntervalMicroSeconds32 & iTickLength The resolution of the timer

protected: virtual IMPORT_C void CAnimationTicker_Reserved1();

Description

Reserved for future use

protected: virtual IMPORT_C void CAnimationTicker_Reserved2();

Description

Reserved for future use