Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: AnimationTls.h
Link against: animationshared.lib

Class CAnimationTls

class CAnimationTls : public CBase;

Description

This is a wrapper around the thread local storage, which simplifies its use for obtaining a CAnimationTicker object that can be shared between animations. The object is reference counted, and only one will exist per thread per DLL at any given time.

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

Derivation

Members

Defined in CAnimationTls:
CAnimationTls_Reserved1(), CAnimationTls_Reserved2(), Close(), NewL(), Ticker(), iRefCount, iTimer

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

See also:


Construction and destruction


NewL()

static IMPORT_C CAnimationTls *NewL();

Description

Two-stage constructor.

There is only ever one of these objects in existence. The object is reference counted, and is destroyed only when every call to NewL has been matched by a call to Close.

Return value

CAnimationTls *

The new object

[Top]


Member functions


Close()

IMPORT_C void Close();

Description

Decrements the reference counter for this object, and destroys it if the reference count reaches 0. This should be called once for every call to NewL.


Ticker()

IMPORT_C CAnimationTicker *Ticker();

Description

Returns the CAnimationTicker object for this thread.

Return value

CAnimationTicker *

A pointer to the shared ticker object


CAnimationTls_Reserved1()

protected: virtual IMPORT_C void CAnimationTls_Reserved1();

Description

Reserved for future use


CAnimationTls_Reserved2()

protected: virtual IMPORT_C void CAnimationTls_Reserved2();

Description

Reserved for future use

[Top]


Member data


iRefCount

protected: TInt iRefCount;

Description

A Reference count of the object


iTimer

protected: CAnimationTicker * iTimer;

Description

This provides timing information for animators