Class CAnimationDataProvider

class CAnimationDataProvider : public CBase;

Description

Pure virtual base class for data providers.

A data provider takes an animation specification (such as a file), converts it (if needed) into a format recognised by an animator (such as CAnimationFrame objects), and passes it to the animator, via the medium of an animation.

Most animation types take a data provider as an argument during contruction. For more detailed usage instructions, refer to the documentation of the derived classes.

Derivation

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

• CAnimationDataProvider - Pure virtual base class for data providers.

Members

Defined in CAnimationDataProvider:

• CAnimationDataProvider()Constructor
• CAnimationDataProvider_Reserved1()Reserved for future use
• CAnimationDataProvider_Reserved2()Reserved for future use
• DataType()Called from the animation to obtain the type of data to expect.
• SendEventL(TInt)Sends an event with no associated data to the observer.
• SendEventL(TInt,TAny *,TInt)Sends an event with an arbitrary size data item to the observer.
• SendEventL(TInt,TInt)Sends an event with a single integer data item to the observer.
• SetObserver(MAnimationDataProviderObserver *)Sets the destination for data from this data provider.
• StartL()Called from the animation when it is ready to begin receiving data.
• iCAnimationDataProvider_ReservedReserved for future use
• iObserverThe destination to send data to. Usually an animation class.

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:

• CAnimationPure virtual base class for animations.
• MAnimationDataProviderObserverInterface from a data provider to an animation

protected: IMPORT_C CAnimationDataProvider();

Description

Constructor

IMPORT_C void SetObserver(MAnimationDataProviderObserver *aObserver);

Description

Sets the destination for data from this data provider.

You do not need to call this function unless you are writing a new animation type.

Parameters

MAnimationDataProviderObserver *aObserver The destination to send data to. Usually an animation class.

virtual void StartL()=0;

Description

Called from the animation when it is ready to begin receiving data.

virtual TPtrC8 DataType()=0;

Description

Called from the animation to obtain the type of data to expect.

Return value

TPtrC8 An 8 bit identifier string

protected: IMPORT_C virtual void CAnimationDataProvider_Reserved1();

Description

Reserved for future use

protected: IMPORT_C virtual void CAnimationDataProvider_Reserved2();

Description

Reserved for future use

protected: IMPORT_C void SendEventL(TInt aEvent);

Description

Sends an event with no associated data to the observer.

See CAnimationDataProvider::SendEventL(TInt,TAny *,TInt) for further details.

Parameters

TInt aEvent The event to pass. This may be a member of TAnimationEvent, or a user defined value. User defined events must be greater than EAnimationReservedEvents

protected: IMPORT_C void SendEventL(TInt aEvent, TInt aData);

Description

Sends an event with a single integer data item to the observer.

See CAnimationDataProvider::SendEventL(TInt,TAny *,TInt) for further details.

Parameters

TInt aEvent The event to pass. This may be a member of TAnimationEvent, or a user defined value. User defined events must be greater than EAnimationReservedEvents TInt aData A pointer to the data to send

protected: IMPORT_C void SendEventL(TInt aEvent, TAny *aData, TInt aDataSize);

Description

Sends an event with an arbitrary size data item to the observer.

Parameters

TInt aEvent The event to pass. This may be a member of TAnimationEvent, or a user defined value. User defined events must be greater than EAnimationReservedEvents TAny *aData A pointer to the data to send TInt aDataSize The size of the data item passed in aData

See also:

• TAnimationEventGeneric events which all animation data providers can pass to animators.

protected: TInt iCAnimationDataProvider_Reserved;

Description

Reserved for future use

protected: MAnimationDataProviderObserver * iObserver;

Description

The destination to send data to. Usually an animation class.