Class TDoorWay

DescriptionHierarchyFieldsMethodsProperties

Unit

Arena

Declaration

type TDoorWay = class(TArenaObject)

Description

An arena object representing a doorway (with or without a door). 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 doorway.

object MyDoorWay: TDoorWay
  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 0
#  Texture =
  Width = 0.900
  Thickness = 0.100
  OpeningHeight = 2.120
  OuterEdgeWidth = 0.050
  OuterEdgeThickness = 0.010
  HasWallPaperFront = False
#  WallPaperFront =
  HasWallPaperBack = False
#  WallPaperBack =
  TextureTileLength = 1.000
  TextureTileHeight = 1.000
  HasDoor = True
  DoorThickness = 0.050
end



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



Hierarchy

TDoorWay > 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 DoorThickness: real;
Public property HasDoor: Boolean;
Public property HasWallPaperBack: Boolean;
Public property HasWallPaperFront: Boolean;
Public property OpeningHeight: real;
Public property OuterEdgeThickness: real;
Public property OuterEdgeWidth: real;
Public property TextureTileHeight: real;
Public property TextureTileLength: real;
Public property Thickness: real;
Public property WallPaperBack: string;
Public property WallPaperFront: string;
Public property Width: real;

Description

Public property DoorThickness: real;

Thickness of the door.

Public property HasDoor: Boolean;

Indicates whether the doorway has a door or not.

Public property HasWallPaperBack: Boolean;

Indicates whether the doorway should use a texture on its back side or not. See also WallPaperBack.

Public property HasWallPaperFront: Boolean;

Indicates whether the doorway should use a texture on its front side or not. See also WallPaperFront.

Public property OpeningHeight: real;

Height of the opening in the doorway (height of the door).

Public property OuterEdgeThickness: real;

Thickness of the frame around the doorway opening.

Public property OuterEdgeWidth: real;

Width of the frame around the doorway opening.

Public property TextureTileHeight: real;

Height of the texture tiling (along the Z-axis). This property is meaningful only when HasWallPaperBack and/or HasWallPaperFront is set to True.

Public property TextureTileLength: real;

Length of the texture tiling (along X- and Y-axis). This property is meaningful only when HasWallPaperBack and/or HasWallPaperFront is set to True.

Public property Thickness: real;

Thickness of the doorway (should match with the thickness of any adjacent walls).

Public property WallPaperBack: string;

Texture (a file name) to be used on the back of the doorway. This texture image is only used if HasWallPaperBack is set to True.

Public property WallPaperFront: string;

Texture (a file name) to be used on the front of the doorway. This texture image is only used if HasWallPaperFront is set to True.

Public property Width: real;

Width of the doorway. The width of the opening (the door) is equal to Width-OuterEdgeWidth.


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