Collapse all Symbian^3 Application Developer Library

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.

Inherits from

CAnimationTicker
- CBase

Public Member Functions
	~CAnimationTicker ()
IMPORT_C TInt	Add ( MAnimationTickee *)
IMPORT_C void	Freeze ()
IMPORT_C CAnimationTicker *	NewL ( TTimeIntervalMicroSeconds32 )
void	OnTick ()
IMPORT_C TInt	Remove ( MAnimationTickee *)
const TTimeIntervalMicroSeconds32 &	TickLength ()
IMPORT_C void	Unfreeze ()

Protected Member Functions
IMPORT_C void	CAnimationTicker_Reserved1 ()
IMPORT_C void	CAnimationTicker_Reserved2 ()

Private Member Functions
	CAnimationTicker ()
void	ConstructL ( TTimeIntervalMicroSeconds32 )
void	StartTickingL ()
void	StopTicking ()

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()

Private Attributes
TInt	iCAnimationTicker_Reserved
TInt	iFreeze
CPeriodic *	iPeriodic
TTimeIntervalMicroSeconds32	iTickLength
RPointerArray < MAnimationTickee >	iTickees

Constructor & Destructor Documentation

CAnimationTicker()

CAnimationTicker

(

)

[private]

~CAnimationTicker()

IMPORT_C

~CAnimationTicker

(

)

Destructor.

Member Functions Documentation

Add(MAnimationTickee *)

IMPORT_C TInt

Add

(

MAnimationTickee *

aTickee

)

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

CAnimationTicker_Reserved1()

IMPORT_C void

CAnimationTicker_Reserved1

(

)

[protected, virtual]

Reserved for future use

CAnimationTicker_Reserved2()

IMPORT_C void

CAnimationTicker_Reserved2

(

)

[protected, virtual]

Reserved for future use

ConstructL(TTimeIntervalMicroSeconds32)

void

ConstructL

(

TTimeIntervalMicroSeconds32

aTickLength

)

[private]

Parameters

TTimeIntervalMicroSeconds32 aTickLength

Freeze()

IMPORT_C void

Freeze

(

)

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

(

TTimeIntervalMicroSeconds32

aTickLength = 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

Parameters

TTimeIntervalMicroSeconds32 aTickLength = 100000

The resolution of the timer.

OnTick()

void

OnTick

(

)

Remove(MAnimationTickee *)

IMPORT_C TInt

Remove

(

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.

Parameters

MAnimationTickee * aTickee

An object added using Add()

StartTickingL()

void

StartTickingL

(

)

[private]

StopTicking()

void

StopTicking

(

)

[private]

TickLength()

const TTimeIntervalMicroSeconds32 &

TickLength

(

)

const [inline]

This provides the resolution of the timer.

Unfreeze()

IMPORT_C void

Unfreeze

(

)

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()