Class CAnimationFrame

class CAnimationFrame : public CBase;

Description

Data format for individual bitmap format animation frames.

Animators and data providers which use the "bitmap" data type use objects of this type to transfer data.

You do not need to instantiate an object of this type unless you are writing a new data provider.

Derivation

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

• CAnimationFrame - Data format for individual bitmap format animation frames.

Members

Defined in CAnimationFrame:

• Bitmap()Returns the bitmap image for the changed area for this frame
• Bitmap()constReturns the bitmap image for the changed area for this frame
• CAnimationFrame_Reserved1()Reserved for future use
• CAnimationFrame_Reserved2()Reserved for future use
• CreateL(const TFrameInfo &)Initialises the internal bitmaps to the correct sizes for the frame.
• FrameInfo()Returns information about the frame.
• FrameInfo()constReturns information about the frame.
• GetHandles(THandles &)constObtains an alternative representation of the frame suitable for transferring ove...
• Mask()Returns the bitmap mask for the changed area for this frame
• Mask()constReturns the bitmap mask for the changed area for this frame
• NewL()Two stage constructor.
• NewL(const THandles &)Two stage constructor.
• SetHandlesL(const THandles &)Sets the contents of the internal bitmaps to those represented by the handles.
• THandlesStructure used for passing a CAnimationFrame safely over a client/server connect...
• ~CAnimationFrame()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...

See also:

• CICLAnimationDataProviderData provider for frame based animations.

virtual ~CAnimationFrame();

Description

Destructor.

IMPORT_C static CAnimationFrame* NewL();

Description

Two stage constructor.

After construction, the frame contains empty bitmaps.

Return value

CAnimationFrame * The new object

IMPORT_C static CAnimationFrame* NewL(const THandles &aHandles);

Description

Two stage constructor.

After construction, the frame contains the bitmaps specified in the handles argument.

Parameters

const CAnimationFrame::THandles &aHandles An internal data type used for transferring the contents

Return value

CAnimationFrame * The new object

See also:

• CAnimationFrame::GetHandles(THandles &)constObtains an alternative representation of the frame suitable for transferring ove...

IMPORT_C void GetHandles(THandles &aHandles) const;

Description

Obtains an alternative representation of the frame suitable for transferring over most interfaces (a THandle uses handles instead of pointers).

Parameters

CAnimationFrame::THandles &aHandles A handles object to populate

See also:

• CAnimationFrame::SetHandlesL(const THandles &)Sets the contents of the internal bitmaps to those represented by the handles.

IMPORT_C void SetHandlesL(const THandles &aHandles);

Description

Sets the contents of the internal bitmaps to those represented by the handles.

Parameters

const CAnimationFrame::THandles &aHandles A handles object obtained from a call to GetHandles

See also:

• CAnimationFrame::GetHandles(THandles &)constObtains an alternative representation of the frame suitable for transferring ove...

IMPORT_C void CreateL(const TFrameInfo &aFrameInfo);

Description

Initialises the internal bitmaps to the correct sizes for the frame.

Parameters

const TFrameInfo &aFrameInfo A TFrameInfo object indicating the required size of the bitmaps.

inline CFbsBitmap* Bitmap();

Description

Returns the bitmap image for the changed area for this frame

Return value

CFbsBitmap * A pointer to a CFbsBitmap

inline const CFbsBitmap* Bitmap() const;

Description

Returns the bitmap image for the changed area for this frame

Return value

const CFbsBitmap * A pointer to a const CFbsBitmap

inline CFbsBitmap* Mask();

Description

Returns the bitmap mask for the changed area for this frame

Return value

CFbsBitmap * A pointer to a CFbsBitmap

inline const CFbsBitmap* Mask() const;

Description

Returns the bitmap mask for the changed area for this frame

Return value

const CFbsBitmap * A pointer to a const CFbsBitmap

inline TFrameInfo& FrameInfo();

Description

Returns information about the frame.

Return value

TFrameInfo & A TFrameInfo

inline const TFrameInfo& FrameInfo() const;

Description

Returns information about the frame.

Return value

const TFrameInfo & A const TFrameInfo

protected: IMPORT_C virtual void CAnimationFrame_Reserved1();

Description

Reserved for future use

protected: IMPORT_C virtual void CAnimationFrame_Reserved2();

Description

Reserved for future use

struct THandles;

Description

Structure used for passing a CAnimationFrame safely over a client/server connection.

Members

Defined in CAnimationFrame::THandles:

• iBitmapHandleA handle to the bitmap into which the decoded frame(s) are put
• iFrameInfoGeneral frame info provided by all plugins
• iMaskHandleThe bitmap mask for the changed area for this frame

Member data

---

iBitmapHandle

TInt iBitmapHandle;

Description

A handle to the bitmap into which the decoded frame(s) are put

---

iMaskHandle

TInt iMaskHandle;

Description

The bitmap mask for the changed area for this frame

---

iFrameInfo

TFrameInfo iFrameInfo;

Description

General frame info provided by all plugins