Class TFloor

DescriptionHierarchyFieldsMethodsProperties

Unit

Arena

Declaration

type TFloor = class(TArenaObject)

Description

An arena object representing a floor. In Table 1 below follows an example of a definition of a doorway and in Figure 1 the corresponding graphics is shown.

Table 1: Example definition of a floor.

object MyFloor: TFloor
  Position = 0.000 0.000 0.000
  Velocity = 0.000 0.000 0.000
  Angle = 0.000
  Height = 2.500
  Mass = -1.000
  RGBColor = 0 0 30
#  Texture =
  Length = 2.000
  Width = 2.000
  TileLength = 1.000
  TileWidth = 1.000
end



Figure 1: Graphical appearance of the floor defined in Table 1.



Hierarchy

TFloor > 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 visual 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 (a single plane). 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.

Properties

Overview

Public property Length: real;
Public property TileLength: real;
Public property TileWidth: real;
Public property Width: real;

Description

Public property Length: real;

Length of the floor. Assuming that the rotation angle is zero, the length of the floor extends along the X-axis.

Public property TileLength: real;

Length of each floor tile (only useful when using a texture).

Public property TileWidth: real;

Width of each floor tile (only useful when using a texture).

Public property Width: real;

Width of the floor. Assuming that the rotation angle is zero, the width of the floor extends along the Y-axis.


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