![Symbian Developer Library](../../../../a_stock/images/mainheading.gif)
![]() |
![]() |
|
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.
CBase
-
Base class for all classes to be instantiated on the heap.
CBitmapAnimClientData
- Encapsulates one or more animation frames into an entire animation.
Defined in CBitmapAnimClientData
:
AppendFrameL(CBitmapFrameData *)
Appends a new frame to the array of frames.BackgroundFrame()const
Gets the background frame bitmap.DurationInMilliSeconds()const
Gets the time required to display the entire sequence of frames that comprise th...EBounce
Plays the animation from the first frame to the last one then from the last fram...ECycle
Plays the animation from the first frame to the last one continuously. EPlay
Plays the animation once, from the first frame to the last one. Flash()const
Gets the animation's flash setting.FrameArray()const
Gets the animation frame array.FrameIntervalInMilliSeconds()const
Gets the default animation frame interval in milliseconds.NewL()
Allocates and constructs a new CBitmapAnimClientData object.PlayMode()const
Gets 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()const
Gets the display size required to show the entire animation.TPlayMode
Animation 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();
Allocates and constructs a new CBitmapAnimClientData object.
|
IMPORT_C ~CBitmapAnimClientData();
Destructor.
It deletes the background frame and destroys the contents of the frame array.
IMPORT_C void AppendFrameL(CBitmapFrameData *aFrame);
Appends a new frame to the array of frames.
The array takes ownership of the new frame.
|
IMPORT_C void SetBackgroundFrame(CBitmapFrameData *aBackgroundFrame);
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.
|
IMPORT_C void SetFlash(TBool aFlash);
Sets or unsets the animation's flash state.
|
IMPORT_C void SetFrameInterval(TInt aFrameIntervalInMilliSeconds);
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.
|
IMPORT_C void SetPlayMode(TPlayMode aPlayMode);
Sets the play mode so that the animation plays once or continuously.
|
IMPORT_C CBitmapFrameData* BackgroundFrame() const;
Gets the background frame bitmap.
|
IMPORT_C TBool Flash() const;
Gets the animation's flash setting.
|
IMPORT_C const CArrayPtrFlat< CBitmapFrameData >& FrameArray() const;
Gets the animation frame array.
|
IMPORT_C TInt FrameIntervalInMilliSeconds() const;
Gets the default animation frame interval in milliseconds.
|
IMPORT_C TPlayMode PlayMode() const;
Gets the animation's play mode.
|
IMPORT_C TInt DurationInMilliSeconds() const;
Gets the time required to display the entire sequence of frames that comprise the animation.
This time is expressed in milliseconds.
|
IMPORT_C TSize Size() const;
Gets the display size required to show the entire animation.
|
TPlayMode
Animation play mode flags.
The animation can be played in any of the ways described below.
|