Class Documentation

Name:Colour
Version:1.0
ID:ID_COLOUR
Status:Stable
Category:Effect
Date:July 2001
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2001. All rights reserved.
Short:  This class is used to adjust the colour of rendered graphics.



Description

This is a new class that is currently under development. Use with caution.

Structure

The Colour object consists of the following public fields:

Height  Defines the height of a Colour's region.
Width  Defines the width of a Colour's region.
XCoord  The horizontal position of a Colour region.
XOffset  The horizontal offset of a Colour region.
YCoord  The vertical position of a Colour region.
YOffset  The vertical offset of a Colour region.
Field:Height
Short:Defines the height of a Colour's region.
Type:FLOAT/PERCENTAGE
Status:Read/Write

A Colour region can be given a fixed or relative height by setting this field to the desired value. To set a relative height, use the FD_PERCENT flag when setting the field.

 

Field:Width
Short:Defines the width of a Colour's region.
Type:FLOAT/PERCENTAGE
Status:Read/Write

A Colour region can be given a fixed or relative width by setting this field to the desired value. To set a relative width, use the FD_PERCENT flag when setting the field.

 

Field:XCoord
Short:The horizontal position of a Colour region.
Type:FLOAT/PERCENTAGE
Status:Read/Write

The horizontal position of a Colour's region can be set to an absolute or relative coordinate by writing a value to the XCoord field. To set a relative/percentage based value, you must use the FD_PERCENT flag or the value will be interpreted as fixed. Negative values are permitted.

 

Field:XOffset
Short:The horizontal offset of a Colour region.
Type:FLOAT/PERCENTAGE
Status:Read/Write

The XOffset has a dual purpose depending on whether or not it is set in conjunction with an X coordinate or a Width based field.

If set in conjunction with an X coordinate then the affected region will be drawn from that X coordinate up to the width of the container, minus the value given in the XOffset. This means that the width of the affected region is dynamically calculated in relation to the width of the container.

If the XOffset field is set in conjunction with a fixed or relative width then the region will be drawn from an X coordinate calculated from the formula "XCoord = ContainerWidth - Width - XOffset".

 

Field:YCoord
Short:The vertical position of a Colour region.
Type:FLOAT/PERCENTAGE
Status:Read/Write

The vertical position of a Colour region can be set to an absolute or relative coordinate by writing a value to the YCoord field. To set a relative/percentage based value, you must use the FD_PERCENT flag or the value will be interpreted as fixed. Negative values are permitted.

 

Field:YOffset
Short:The vertical offset of a Colour region.
Type:FLOAT
Status:Read/Write

The YOffset has a dual purpose depending on whether or not it is set in conjunction with a Y coordinate or a Height based field.

If set in conjunction with a Y coordinate then the affected region will be drawn from that Y coordinate up to the height of the container, minus the value given in the YOffset. This means that the height of the region is dynamically calculated in relation to the height of the container.

If the YOffset field is set in conjunction with a fixed or relative height then the region will be drawn from a vertical coordinate calculated from the formula "YCoord = ContainerHeight - ColourHeight - YOffset".