Class CBitmapAnimClientData

class CBitmapAnimClientData : public CBase;

Description

Encapsulates one or more animation frames into an entire animation.

In addition to specifying the frames you wish to include in your animation, you can also specify:

• whether the animation will flash

• whether the animation is played once, or continuously

• the background frame that is drawn to clear each frame in the animation

You can also specify a default frame interval that is used for all frames in an animation. If the interval is already set for any of the individual frames, that takes precedence.

When you have defined your animation, use RBitmapAnim to play the animation.

Derivation

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

• CBitmapAnimClientData - Encapsulates one or more animation frames into an entire animation.

Members

Defined in CBitmapAnimClientData:

• AppendFrameL(CBitmapFrameData *)Appends a new frame to the array of frames.
• BackgroundFrame()constGets the background frame bitmap.
• DurationInMilliSeconds()constGets the time required to display the entire sequence of frames that comprise th...
• EBouncePlays the animation from the first frame to the last one then from the last fram...
• ECyclePlays the animation from the first frame to the last one continuously.
• EPlayPlays the animation once, from the first frame to the last one.
• Flash()constGets the animation's flash setting.
• FrameArray()constGets the animation frame array.
• FrameIntervalInMilliSeconds()constGets the default animation frame interval in milliseconds.
• NewL()Allocates and constructs a new CBitmapAnimClientData object.
• PlayMode()constGets the animation's play mode.
• ResetFrameArray()Resets and destroys the frame array's contents.
• SetBackgroundFrame(CBitmapFrameData *)Sets the background frame and takes ownership of it.
• SetFlash(TBool)Sets or unsets the animation's flash state.
• SetFrameInterval(TInt)Specifies for how many milliseconds each frame in the animation is displayed.
• SetPlayMode(TPlayMode)Sets the play mode so that the animation plays once or continuously.
• Size()constGets the display size required to show the entire animation.
• TPlayModeAnimation play mode flags.
• ~CBitmapAnimClientData()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...

IMPORT_C static CBitmapAnimClientData* NewL();

Description

Allocates and constructs a new CBitmapAnimClientData object.

Return value

CBitmapAnimClientData * New CBitmapAnimClientData object

IMPORT_C ~CBitmapAnimClientData();

Description

Destructor.

It deletes the background frame and destroys the contents of the frame array.

IMPORT_C void AppendFrameL(CBitmapFrameData *aFrame);

Description

Appends a new frame to the array of frames.

The array takes ownership of the new frame.

Parameters

CBitmapFrameData *aFrame A pointer to the frame to add to the array of frames

IMPORT_C void ResetFrameArray();

Description

Resets and destroys the frame array's contents.

IMPORT_C void SetBackgroundFrame(CBitmapFrameData *aBackgroundFrame);

Description

Sets the background frame and takes ownership of it.

Any previous background frame, and mask if one is included, is deleted from memory. The frame is redrawn in the animation window in order to clear the current frame before drawing the next one.

Parameters

CBitmapFrameData *aBackgroundFrame The bitmap to use as the background frame

IMPORT_C void SetFlash(TBool aFlash);

Description

Sets or unsets the animation's flash state.

Parameters

TBool aFlash ETrue for the animation to flash, otherwise EFalse

IMPORT_C void SetFrameInterval(TInt aFrameIntervalInMilliSeconds);

Description

Specifies for how many milliseconds each frame in the animation is displayed.

This is not used for any frames in the animation that specify their own interval.

Parameters

TInt aFrameIntervalInMilliSeconds The number of milliseconds for which each frame in the animation is displayed

IMPORT_C void SetPlayMode(TPlayMode aPlayMode);

Description

Sets the play mode so that the animation plays once or continuously.

Parameters

CBitmapAnimClientData::TPlayMode aPlayMode The animation play mode

IMPORT_C CBitmapFrameData* BackgroundFrame() const;

Description

Gets the background frame bitmap.

Return value

CBitmapFrameData * Background frame bitmap

IMPORT_C TBool Flash() const;

Description

Gets the animation's flash setting.

Return value

TBool ETrue if the animation is flashing, otherwise EFalse

IMPORT_C const CArrayPtrFlat< CBitmapFrameData >& FrameArray() const;

Description

Gets the animation frame array.

Return value

const CArrayPtrFlat< CBitmapFrameData > & Animation frame array

IMPORT_C TInt FrameIntervalInMilliSeconds() const;

Description

Gets the default animation frame interval in milliseconds.

Return value

TInt Default animation frame interval in milliseconds

IMPORT_C TPlayMode PlayMode() const;

Description

Gets the animation's play mode.

Return value

CBitmapAnimClientData::TPlayMode Animation's play mode

IMPORT_C TInt DurationInMilliSeconds() const;

Description

Gets the time required to display the entire sequence of frames that comprise the animation.

This time is expressed in milliseconds.

Return value

TInt Animation duration

IMPORT_C TSize Size() const;

Description

Gets the display size required to show the entire animation.

Return value

TSize Display size

TPlayMode

Description

Animation play mode flags.

The animation can be played in any of the ways described below.

EPlay Plays the animation once, from the first frame to the last one. ECycle Plays the animation from the first frame to the last one continuously. EBounce Plays the animation from the first frame to the last one then from the last frame to the first continuously.