Class TBookShelf

DescriptionHierarchyFieldsMethodsProperties

Unit

Arena

Declaration

type TBookShelf = class(TArenaObject)

Description

An arena object representing a bookshelf. Below follows an example of a definition of a bookshelf and in Figure 1 the corresponding graphics is shown. Figure 2 shows the appearance of the bookshelf when the property HasBottomVerticalPlate is set to False.

Example definition of a bookshelf:

object MyBookShelf: TBookShelf
  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 =
  Width = 1.200
  Depth = 0.300
  NumberOfShelves = 5
  HasSurfaces = True
  BarThickness = 0.000
  HasBottomVerticalPlate = False
  BottomVerticalPlateIndentation = 0.050
  BottomVerticalPlateHeight = 0.080
  MaterialThickness = 0.020
end



Figure 1: Example of a bookshelf (see definition above).




Figure 2: Example of a bookshelf without the bottom vertical plate.



Hierarchy

TBookShelf > 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 BarThickness: real;
Public property BottomVerticalPlateHeight: real;
Public property BottomVerticalPlateIndentation: real;
Public property Depth: real;
Public property HasBottomVerticalPlate: Boolean;
Public property HasSurfaces: Boolean;
Public property MaterialThickness: real;
Public property NumberOfShelves: integer;
Public property Width: real;

Description

Public property BarThickness: real;

Thickness of the bars (one in each corner). This property is only considered when the property HasSurfaces is set to False.

Public property BottomVerticalPlateHeight: real;

Height of the plate located between the floor and the last shelf.

Public property BottomVerticalPlateIndentation: real;

Indentation of the bottom vertical plate.

Public property Depth: real;

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

Public property HasBottomVerticalPlate: Boolean;

Indicates whether the bookshelf has vertical plates at the bottom or if it does not. See Figure 1 (True) and Figure 2 (False) above.

Public property HasSurfaces: Boolean;

Indicates whether the bookshelf has back and side surfaces or not.

Public property MaterialThickness: real;

Thickness of the shelves.

Public property NumberOfShelves: integer;

Number of shelves.

Public property Width: real;

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


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