Class Documentation

Name:Boing
Version:1.0
ID:ID_BOING
Status:Stable
Category:Effect
Date:July 2001
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2000-2001. All rights reserved.
Short:  Real-time animated bouncing circles.



Description

The Boing class draws a number of multi-coloured circles that bounce around the sides and bottom of the graphical container. The class draws to the foreground only, so you will need to use a graphical object to define the background underneath the Boing effect. Here is an example:

  <render width="300" height="200"/>
    <box colour="#000000"/>
    <boing/>
  </render>

Once initialised, the effect will run automatically until the Boing object is freed from the system. The amount of processor cycles used by the Boing object is directly proportional to the amount of bouncing elements, as specified by the MaxElements field. Generally, 50 to 100 elements are sufficient for an adequate effect and minimal processor usage.

Structure

The Boing object consists of the following public fields:

MaxElements  The total number of bouncing elements is defined by this field.
Field:MaxElements
Short:The total number of bouncing elements is defined by this field.
Type:LONG
Status:Read/Init

You may specify the exact amount of elements to be used in the Boing effect by setting the MaxElements field. For a reasonable effect, a minimum amount of 50 elements is recommended. The value should be no higher than 300.

If you do not set this field, the default number of elements will be used.