Product Home • Class Index • Download

CK_Animation

CK_Bitmap
   |
   +----CK_Animation

The CK_Animation class represents a displayable animation running at a specified frame rate, and it's state can be either started or stopped.

A CK_Animation is a CK_Bitmap. This allows it to be used as a property in any CK_Component that uses a bitmap property.

A CK_Animation object contains a reference to a CK_AnimatedBitmap. Many CK_Animation objects can reference the same CK_AnimatedBitmap. The CK_AnimatedBitmap is simply a storage container for the image data. The CK_Animation contains the frame rate, as well as the current state: whether the animation is stopped or running, and the index of the frame that is currently visible.

Depending on how the CK_Animation is created, it may or may not have ownership of the CK_AnimatedBitmap. The programmer can decide whether a given CK_Animation owns its CK_AnimatedBitmap. Objects that own other objects will delete the owned objects when they themselves are deleted.

Factory Methods

createFromFile

Creates a CK_Animation from a .pcx or .bmp file containing the frames of the animation.

Public Methods

CK_Animation

Constructs the animation from a CK_AnimatedBitmap.

getCurrentFrame

Returns the index of the frame that is currently shown.

getFrameRate

Gets the animation's frame rate. (number of frames per second)

getNumFrames

Returns the number of frames in the animation.

getSubject

Returns the CK_Subject contained within CK_Animation.

isStopped

Returns TRUE if the animation is not running.

manualAdvanceFrame

Advances the current frame by one.

manualBackupFrame

Backs up to the previous frame.

manualSetFrame

Sets the current frame to the specified frame.

setFrameRate

Sets the animation's frame rate (number of frames per second).

startAnimation

Causes the animation to start.

stopAnimation

Causes the animation to stop.

Inherited Methods

draw

Draws the bitmap to the Chilkat engine's render surface.

drawScaled

Draws a stretched or shrunken bitmap to the render surface.

drawTiled

Fills the render surface, or a portion of the render surface, by tiling the bitmap.

getHeight

Returns the height in pixels of the bitmap.

getNumPalettes

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

getWidth

Returns the width in pixels of the bitmap.

isPaletteBitmap

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

isTransparent

Returns TRUE if the bitmap has transparency.

• static CK_Animation *createFromFile(const char *fileName, int numColumns, int frameWidth, int frameHeight, int numFrames);

Creates a CK_Animation from a graphics file (.pcx or .bmp) where the frames of the animation are organized in rows and columns. The figure below shows one possible layout of frames for an animation with 10 frames.

Return Value

Returns a pointer to the CK_Animation object created.

Parameters

fileName

The file (.pcx or .bmp) containing a grid of frames.

nColumns

The number of columns in the grid.

frameWidth

The width in pixels of each frame.

frameHeight

The height in pixels of each frame.

numFrames

The total number of frames in the animation. This does not need to be evenly divisible by the number of columns, as demonstrated in the example above.

Remarks

This factory method internally creates a CK_AnimatedImage that is used to create the CK_Animation. The animated image is owned by the animation, and is deleted when the animation is deleted.

• CK_Animation(CK_AnimatedBitmap *anim, BOOL takeOwnership=FALSE);

This is the most common way to create a CK_Animation. The application first creates a CK_AnimatedBitmap, and then many CK_Animation objects can be created that reference the animated bitmap.

Parameters

anim

The animated bitmap that contains the image data for each frame in the animation.

takeOwnership

If TRUE, the CK_Animation owns the animated bitmap. This causes the animated bitmap to be deleted when the CK_Animation is deleted.

• int getCurrentFrame(void) const;

  Returns the index of the current frame that is visible. The first frame in the animation is at index 0.

• int getFrameRate(void) const;

  Returns the frame rate of the animation (number of frames per second).

• int getNumFrames(void) const;

  Returns the number of frames in the animation.

• CK_Subject *getSubject(void) const;

  Returns the animation as a CK_Subject. This subject can be observed by any CK_Observer. The observer will be notified whenever the animation updates its current frame, or when the animation is deleted.

• BOOL isStopped(void) const;

  Returns TRUE if the animation is not currently running.

• void manualAdvanceFrame(void);

  Advances the current frame by one. Advancing from the last frame will set the current frame to the first frame. The result of advancing the current frame will be visible (if the CK_Animation is visible on the display).

• void manualBackupFrame(void);

  Decrements the current frame index by one. Backing up from the first frame will set the current frame to the last frame. The results of this function call will be visible (if the CK_Animation is visible on the display).

• void manualSetFrame(int frameIndex);

  Sets the animation's current frame index to a specified value.

Parameters

frameIndex

The current frame will be set to this index.

• void setFrameRate(int framesPerSecond);

  Sets the animation's frame rate.

Parameters

framesPerSecond

The speed at which the animation runs.

• void startAnimation(void);

  Starts the animation. If the frame rate is zero, the animation will appear to not be started. In general, animations should only be started if they are visible on the screen. If an animation is started, the Chilkat engine will be advancing the frames of the animation even if the animation is not visible.

• void stopAnimation(void);

  Stops the animation.