Product Home • Class Index • Download

CK_AnimatedBitmap

The CK_AnimatedBitmap class contains the frames of an animation. It cannot be drawn because it is simply a container to hold the bitmap data of the animation. A different class, CK_Animation, refers to an animated bitmap, can display it, and also contains the ability to control the animation. A CK_Animation has its own frame rate, and can stop or start the animation. This architecture allows many CK_Animation objects to exist at the same time, each of which can be independently stopped, started, or running at different frame rates, and all sharing the same bitmap data.

Factory Methods

createFromFile

Creates a CK_AnimatedBitmap from a serialized CK_AnimatedImage.

createFromImage

Creates a CK_AnimatedBitmap from a CK_AnimatedImage.

Public Methods

getHeight

Returns the height in pixels of the animated bitmap.

getNumFrames

Returns the number of frames in the animation.

getNumPalettes

Returns the number of palettes contained in the animated bitmap.Only 8 bit-per-pixel bitmaps have palettes.

getWidth

Returns the width in pixels of the animated bitmap.

isPaletteBitmap

Returns TRUE if the animated bitmap is 8 bits-per-pixel.

isTransparent

Returns TRUE if the animated bitmap has transparency.

• static CK_AnimatedBitmap *createFromFile(const char *fileName);

Creates a CK_AnimatedBitmap from a .can file containing a serialized CK_AnimatedImage. Returns a pointer to the CK_AnimatedBitmap created.

Parameters

fileName

A .can file containing a serialized CK_AnimatedImage.

• static CK_AnimatedBitmap *createFromImage(const CK_AnimatedImage *image);

Creates a CK_AnimatedBitmap from a CK_AnimatedImage. Returns a pointer to the CK_AnimatedBitmap created.

Parameters

image

The animated image used to create the CK_AnimatedBitmap. If the image has transparency, the CK_AnimatedBitmap will have the same transparency. If the image is 8 bits-per-pixels, the palettes in the image will be present in the CK_AnimatedBitmap.

• int getHeight(void) const;

Returns the height in pixels of the animation.

• int getNumFrames(void) const;

Returns the number of frames in the animation.

• int getNumPalettes(void) const;

Returns the number of palettes held by the animation. Only animations created from 8 bits-per-pixel CK_AnimatedImages will have palettes.

• int getWidth(void) const;

Returns the width in pixels of the animation.

• int isPaletteBitmap(void) const;

Returns TRUE if the animation is 8 bits-per-pixel.

• int isTransparent(void) const;

Returns TRUE if the animation has transparency.