Class Documentation

Name:Flame
Version:1.0
ID:ID_FLAME
Status:Stable
Category:Effect
Date:August 2002
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2000-2002. All rights reserved.
Short:  Creates a flame effect.



Description

The Flame class draws an animated effect that looks like a fire burning within a graphical area. The effect uses a large amount of CPU time, and this increases according to the size of the area that the graphics are being drawn to. The flame looks best when applied to 24 bit colour displays, as 16 bit colours or less produces high levels of colour banding.

Once initialised, the effect will run automatically until the object is freed from the system.

Structure

The Flame object consists of the following public fields:

CanvasHeight  Defines the internal height of the flame graphic.
CanvasWidth  Defines the internal width of the flame graphic.
Field:CanvasHeight
Short:Defines the internal height of the flame graphic.
Type:LONG
Status:Read/Write

Once it is initialised, the flame object allocates its own graphical workspace for generating the effect. The CanvasWidth and CanvasHeight fields have default values, but you may want to set the dimensions of the area as it has a direct effect on the speed and quality of the flame.

If the value is high, the quality will increase but the effect will take longer to generate. If the value is low then the quality will decrease but the effect will be generated more quickly. It is recommended that the value you specify is between the range of 50 and 400.


Field:CanvasWidth
Short:Defines the internal width of the flame graphic.
Type:LONG
Status:Read/Write

Once it is initialised, the flame object allocates its own graphical workspace for generating the effect. The CanvasWidth and CanvasHeight fields have default values, but you may want to set the dimensions of the area as it has a direct effect on the speed and quality of the flame.

If the value is high, the quality will increase but the effect will take longer to generate. If the value is low then the quality will decrease but the effect will be generated more quickly. It is recommended that the value you specify is between the range of 50 and 400.