Class TIRBeacon

DescriptionHierarchyFieldsMethodsProperties

Unit

Arena

Declaration

type TIRBeacon = class(TArenaObject)

Description

An arena object representing an IR beacon.

Hierarchy

TIRBeacon > TArenaObject > TObject

Methods

Overview

Public constructor Create(Owner: TArena);
Public destructor Destroy; override;
Public procedure AddAsStrings(Strings: TStringList); override;
Public function Edit(Dlg: TArenaObjectEditor = nil): Boolean; override;
Public procedure GenerateShapes; override;

Description

Public constructor Create(Owner: TArena);

Constructor

parameters
Owner
is the TArena that owns this object.
Public destructor Destroy; override;

Destructor

Public procedure AddAsStrings(Strings: TStringList); override;

Adds all properties as strings to a list of strings. Used internally by TArena.SaveToFile.

Public function Edit(Dlg: TArenaObjectEditor = nil): Boolean; override;

Displays an edit dialog (for graphical editing of the object's properties).

parameters
Dlg
should always be Nil. (Only used internally.)
returns

True if the user clicks the OK button, False otherwise.

Public procedure GenerateShapes; override;

Generates a geometric representation of the object. The result of this procedure can be retrieved through the property Shapes.
This procedure is automatically called when needed and should never be called explicitly by a user.

Currently, this object does not have any geometric representation and will not generate any geometric representation. Hence, it will not show up on e.g. a slice of an arena.

Properties

Overview

Public property Active: Boolean;
Public property ID: Integer;
Public property MaximumSignal: real;
Public property MinimumSignal: real;
Public property Range: real;

Description

Public property Active: Boolean;

On/off toggle.

Public property ID: Integer;

The identification number.

Public property MaximumSignal: real;

The maximum signal value.

Public property MinimumSignal: real;

The minimum signal value.

Public property Range: real;

The range of the beacon (spherical range).


Generated by PasDoc 0.8.8.3 on 2005-05-28 08:13:49