| 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.
| Public Member Functions | |
|---|---|
| ~CBitmapAnimClientData() | |
| IMPORT_C void | AppendFrameL(CBitmapFrameData *) |
| IMPORT_C CBitmapFrameData * | BackgroundFrame() |
| IMPORT_C TInt | DurationInMilliSeconds() |
| IMPORT_C TBool | Flash() |
| IMPORT_C const CArrayPtrFlat< CBitmapFrameData > & | FrameArray() |
| IMPORT_C TInt | FrameIntervalInMilliSeconds() |
| IMPORT_C CBitmapAnimClientData * | NewL() |
| IMPORT_C TPlayMode | PlayMode() |
| IMPORT_C void | ResetFrameArray() |
| IMPORT_C void | SetBackgroundFrame(CBitmapFrameData *) |
| IMPORT_C void | SetFlash(TBool) |
| IMPORT_C void | SetFrameInterval(TInt) |
| IMPORT_C void | SetPlayMode(TPlayMode) |
| IMPORT_C TSize | Size() |
| Private Member Functions | |
|---|---|
| CBitmapAnimClientData() | |
| Public Member Enumerations | |
|---|---|
| enum | TPlayMode { EPlay = 0x00, ECycle = 0x01, EBounce = 0x02 } |
| Private Attributes | |
|---|---|
| CBitmapFrameData * | iBackgroundFrame |
| TBool | iFlash |
| CArrayPtrFlat< CBitmapFrameData > | iFrameArray |
| TInt | iFrameIntervalInMilliSeconds |
| TPlayMode | iPlayMode |
| IMPORT_C void | AppendFrameL | ( | CBitmapFrameData * | aFrame | ) |
| CBitmapFrameData * aFrame |
| IMPORT_C void | SetBackgroundFrame | ( | CBitmapFrameData * | aBackgroundFrame | ) |
| CBitmapFrameData * aBackgroundFrame |
| IMPORT_C void | SetFrameInterval | ( | TInt | aFrameIntervalInMilliSeconds | ) |
| TInt aFrameIntervalInMilliSeconds |
Animation play mode flags.
The animation can be played in any of the ways described below.
| 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. |