Class TGridShelf

DescriptionHierarchyFieldsMethodsProperties

Unit

Arena

Declaration

type TGridShelf = class(TArenaObject)

Description

An arena object representing a bookshelf with an abitrary number of cells. In Table 1 below follows an example of a definition of a grid shelf and in Figure 1 the corresponding graphics is shown.

Table 1: Example definition of a grid shelf.

object MyGridShelf: TGridShelf
  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
  Depth = 0.400
  MaterialThickness = 0.030
  ShelfThickness = 0.015
  NumberOfHorizontalCells = 5
  NumberOfVerticalCells = 4
end



Figure 1: Graphical appearance of the grid shelf defined in Table 1.



Hierarchy

TGridShelf > 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 geometric representations 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.

Properties

Overview

Public property Depth: real;
Public property Length: real;
Public property MaterialThickness: real;
Public property NumberOfHorizontalCells: integer;
Public property NumberOfVerticalCells: integer;
Public property ShelfThickness: real;

Description

Public property Depth: real;

Depth of the bookshelf. Assuming that the rotation angle is zero, the depth of the bookshelf extends along the Y-axis.

Public property Length: real;

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

Public property MaterialThickness: real;

Thickness of the material surrounding the bookshelf (the outer frame).

Public property NumberOfHorizontalCells: integer;

Number of horizontal cells in the bookshelf.

Public property NumberOfVerticalCells: integer;

Number of vertical cells in the bookshelf.

Public property ShelfThickness: real;

Thickness of the shelves.


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