CBitmapAnimClientData Class Reference

class CBitmapAnimClientData : public CBase

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.

Inherits from

Constructor & Destructor Documentation

CBitmapAnimClientData()

CBitmapAnimClientData ( ) [private]

~CBitmapAnimClientData()

IMPORT_C ~CBitmapAnimClientData ( )

Member Functions Documentation

AppendFrameL(CBitmapFrameData *)

IMPORT_C void AppendFrameL ( CBitmapFrameData * aFrame )

Parameters

CBitmapFrameData * aFrame

BackgroundFrame()

IMPORT_C CBitmapFrameData * BackgroundFrame ( ) const

DurationInMilliSeconds()

IMPORT_C TInt DurationInMilliSeconds ( ) const

Flash()

IMPORT_C TBool Flash ( ) const

FrameArray()

IMPORT_C const CArrayPtrFlat < CBitmapFrameData > & FrameArray ( ) const

FrameIntervalInMilliSeconds()

IMPORT_C TInt FrameIntervalInMilliSeconds ( ) const

NewL()

IMPORT_C CBitmapAnimClientData * NewL ( ) [static]

PlayMode()

IMPORT_C TPlayMode PlayMode ( ) const

ResetFrameArray()

IMPORT_C void ResetFrameArray ( )

SetBackgroundFrame(CBitmapFrameData *)

IMPORT_C void SetBackgroundFrame ( CBitmapFrameData * aBackgroundFrame )

Parameters

CBitmapFrameData * aBackgroundFrame

SetFlash(TBool)

IMPORT_C void SetFlash ( TBool aFlash )

Parameters

TBool aFlash

SetFrameInterval(TInt)

IMPORT_C void SetFrameInterval ( TInt aFrameIntervalInMilliSeconds )

Parameters

TInt aFrameIntervalInMilliSeconds

SetPlayMode(TPlayMode)

IMPORT_C void SetPlayMode ( TPlayMode aPlayMode )

Parameters

TPlayMode aPlayMode

Size()

IMPORT_C TSize Size ( ) const

Member Enumerations Documentation

Enum TPlayMode

Animation play mode flags.

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

Enumerators

EPlay = 0x00

Plays the animation once, from the first frame to the last one.

ECycle = 0x01

Plays the animation from the first frame to the last one continuously.

EBounce = 0x02

Plays the animation from the first frame to the last one then from the last frame to the first continuously.

Member Data Documentation

CBitmapFrameData * iBackgroundFrame

CBitmapFrameData * iBackgroundFrame [private]

TBool iFlash

TBool iFlash [private]

CArrayPtrFlat< CBitmapFrameData > iFrameArray

CArrayPtrFlat < CBitmapFrameData > iFrameArray [private]

TInt iFrameIntervalInMilliSeconds

TInt iFrameIntervalInMilliSeconds [private]

TPlayMode iPlayMode

TPlayMode iPlayMode [private]