Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: bmpancli.h
Link against: bmpanim.lib

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:

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

Members

Defined in CBitmapAnimClientData:
AppendFrameL(), BackgroundFrame(), DurationInMilliSeconds(), EBounce, ECycle, EPlay, Flash(), FrameArray(), FrameIntervalInMilliSeconds(), NewL(), PlayMode(), ResetFrameArray(), SetBackgroundFrame(), SetFlash(), SetFrameInterval(), SetPlayMode(), Size(), TPlayMode, ~CBitmapAnimClientData()

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


Construction and destruction


NewL()

static IMPORT_C CBitmapAnimClientData *NewL();

Description

Allocates and constructs a new CBitmapAnimClientData object.

Return value

CBitmapAnimClientData *

New CBitmapAnimClientData object


~CBitmapAnimClientData()

IMPORT_C ~CBitmapAnimClientData();

Description

Destructor.

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

[Top]


Member functions


AppendFrameL()

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


ResetFrameArray()

IMPORT_C void ResetFrameArray();

Description

Resets and destroys the frame array's contents.


SetBackgroundFrame()

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


SetFlash()

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


SetFrameInterval()

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


SetPlayMode()

IMPORT_C void SetPlayMode(TPlayMode aPlayMode);

Description

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

Parameters

TPlayMode aPlayMode

The animation play mode


BackgroundFrame()

IMPORT_C CBitmapFrameData *BackgroundFrame() const;

Description

Gets the background frame bitmap.

Return value

CBitmapFrameData *

Background frame bitmap


Flash()

IMPORT_C TBool Flash() const;

Description

Gets the animation's flash setting.

Return value

TBool

ETrue if the animation is flashing, otherwise EFalse


FrameArray()

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

Description

Gets the animation frame array.

Return value

const CArrayPtrFlat< CBitmapFrameData > &

Animation frame array


FrameIntervalInMilliSeconds()

IMPORT_C TInt FrameIntervalInMilliSeconds() const;

Description

Gets the default animation frame interval in milliseconds.

Return value

TInt

Default animation frame interval in milliseconds


PlayMode()

IMPORT_C TPlayMode PlayMode() const;

Description

Gets the animation's play mode.

Return value

TPlayMode

Animation's play mode


DurationInMilliSeconds()

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


Size()

IMPORT_C TSize Size() const;

Description

Gets the display size required to show the entire animation.

Return value

TSize

Display size

[Top]


Member enumerations


Enum TPlayMode

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.