Class Documentation

Name:Blur
Version:1.0
ID:ID_BLUR
Status:In Development
Category:Effect
Date:January 2003
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2001-2003. All rights reserved.
Short:  Blurs out graphics.



Description

This class is under development. Use at your own risk.

Structure

The Blur object consists of the following public fields:

Drawable  Defines the drawable area for the Blur graphics.
Frame  Determines the rendering frame that a blur will be applied to.
Height  The height of a blur graphic.
Width  The width of a blur's graphic.
XCoord  The horizontal position of a blur region.
XOffset  The horizontal offset of a blur.
YCoord  The vertical coordinate of a blur region.
YOffset  The vertical offset of a blur region.
Field:Drawable
Short:Defines the drawable area for the Blur graphics.
Type:OBJECTID
Status:Read/Write

In most cases, when you create a new blur object it should be contained by a drawable area, such as a Render object. If you do this correctly then the blur object will detect the drawable area and set the Drawable field to the correct object. However, there may be occasions where you want to initialise a blur object to a non-graphical container. If this is the case then you must set the Drawable field to point to a valid drawable area, such as a Render object.


Field:Frame
Short:Determines the rendering frame that a blur will be applied to.
Type:LONG
Status:Read/Write

Setting the Frame field to any value other than zero will force a blur object to be drawn only when the drawable frame matches the specified value. For instance, if the drawable container has a Frame setting of 2, and the blur object has a Frame of 1, then no graphics will be drawn to represent the blur region, as the numbers do not match.


Field:Height
Short:The height of a blur graphic.
Type:DOUBLE/PERCENTAGE
Status:Write

A blur region can be given a fixed height by setting this field to the desired value. A percentage may be specified if the FD_PERCENT flag is used when setting the field.


Field:Width
Short:The width of a blur's graphic.
Type:DOUBLE/PERCENTAGE
Status:Write

If the Blur is to be drawn with a fixed width, set this field to the desired value. A percentage may be specified if the FD_PERCENT flag is used when setting the field.


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

The horizontal position of a blur region can be fixed to an absolute coordinate by writing a value to the XCoord field. If you use the FD_PERCENT flag then you may write a relative/percentage based value to the field. Negative values are permitted.


Field:XOffset
Short:The horizontal offset of a blur.
Type:DOUBLE/PERCENTAGE
Status: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 blur 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 blur 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 blur region will be drawn at an X coordinate calculated from the formula "XCoord = ContainerWidth - BlurWidth - XOffset".


Field:YCoord
Short:The vertical coordinate of a blur region.
Type:DOUBLE/PERCENTAGE
Status:Read/Write

The vertical position of a blur region can be fixed to an absolute coordinate by writing a value to the YCoord field. If you use the FD_PERCENT flag then you may write a relative/percentage based value to the field. Negative values are permitted.


Field:YOffset
Short:The vertical offset of a blur region.
Type:DOUBLE/PERCENTAGE
Status: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 blur 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 blur 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 blur region will be drawn at a Y coordinate calculated from the formula "YCoord = ContainerHeight - BlurHeight - YOffset".