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(MAnimationTickee *)Adds a new tickee to the internal list. All added tickees will be called once ev...
• CAnimationTicker_Reserved1()Reserved for future use
• CAnimationTicker_Reserved2()Reserved for future use
• Freeze()Freezes this ticker
• NewL(TTimeIntervalMicroSeconds32)Two stage constructor.
• Remove(MAnimationTickee *)Removes a tickee from the internal list. Attempting to remove a tickee that has ...
• TickLength()constThis provides the resolution of the timer.
• Unfreeze()Under some circumstances it may be necessary to handle unfreezing directly, inst...
• ~CAnimationTicker()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:

• MAnimationTickeeInterface used for receiving animation ticks.
• CAnimationTlsThis is a wrapper around the thread local storage, which simplifies its use for ...

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

Description

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.

Parameters

TTimeIntervalMicroSeconds32 aTickLength The resolution of the timer.

Return value

CAnimationTicker * The new object

See also:

• MAnimationTickeeInterface used for receiving animation ticks.

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 CAnimationTicker::Add(MAnimationTickee *)

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

See also:

• CAnimationTicker::Unfreeze()Under some circumstances it may be necessary to handle unfreezing directly, inst...

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()Freezes this ticker

inline const TTimeIntervalMicroSeconds32& TickLength() const;

Description

This provides the resolution of the timer.

Return value

const TTimeIntervalMicroSeconds32 & iTickLength The resolution of the timer

protected: IMPORT_C virtual void CAnimationTicker_Reserved1();

Description

Reserved for future use

protected: IMPORT_C virtual void CAnimationTicker_Reserved2();

Description

Reserved for future use