Class TCellElementSegment

DescriptionHierarchyFieldsMethodsProperties

Unit

ScreenObjectUnit

Declaration

type TCellElementSegment = class(TObject)

Description

TCellElementSegment represents the 2D intersection of one segment of a TScreenObject with a cell or element in the grid.

Hierarchy

Overview

Fields

Private FSegment: TSegment2D;
Private FCol: integer;
Private FEndPosition: TEdgePosition;
Private FLayer: integer;
Private FVertexIndex: integer;
Private FRow: integer;
Private FStartPosition: TEdgePosition;
Private FSectionIndex: integer;
Private FSubSegments: TSegment2DArray;
Private FLgrEdge: boolean;
Private FScreenObject: TScreenObject;

Methods

Private procedure Store(Stream: TStream);
Private procedure Restore(Stream: TDecompressionStream);
Public function SegmentLength: double;
Public function FirstPointRealCoord(ViewDirection: TViewDirection): TPoint2D;
Public function SecondPointRealCoord(ViewDirection: TViewDirection): TPoint2D;
Public constructor Create(ScreenObject: TScreenObject);

Properties

Public property Col: integer read FCol write FCol;
Public property EndPosition: TEdgePosition read FEndPosition write FEndPosition;
Public property Layer: integer read FLayer write FLayer;
Public property VertexIndex: integer read FVertexIndex write FVertexIndex;
Public property Row: integer read FRow write FRow;
Public property StartPosition: TEdgePosition read FStartPosition write FStartPosition;
Public property X1: double read FSegment[1].x write FSegment[1].x;
Public property X2: double read FSegment[2].x write FSegment[2].x;
Public property Y1: double read FSegment[1].y write FSegment[1].y;
Public property Y2: double read FSegment[2].y write FSegment[2].y;
Public property StartPoint: TPoint2D read FSegment[1];
Public property EndPoint: TPoint2D read FSegment[2];
Public property SectionIndex: integer read FSectionIndex write FSectionIndex;
Public property LgrEdge: boolean read FLgrEdge write FLgrEdge;

Description

Fields

Private FSegment: TSegment2D;

See X1, X2, Y1, and Y2.

Private FCol: integer;

See Col.

Private FEndPosition: TEdgePosition;

See EndPosition.

Private FLayer: integer;

See Layer.

Private FVertexIndex: integer;

See VertexIndex.

Private FRow: integer;

See Row.

Private FStartPosition: TEdgePosition;

See StartPosition.

Private FSectionIndex: integer;
 
Private FSubSegments: TSegment2DArray;
 
Private FLgrEdge: boolean;
 
Private FScreenObject: TScreenObject;
 

Methods

Private procedure Store(Stream: TStream);
 
Private procedure Restore(Stream: TDecompressionStream);
 
Public function SegmentLength: double;

SegmentLength returns the length of this TCellElementSegment.

Public function FirstPointRealCoord(ViewDirection: TViewDirection): TPoint2D;
 
Public function SecondPointRealCoord(ViewDirection: TViewDirection): TPoint2D;
 
Public constructor Create(ScreenObject: TScreenObject);
 

Properties

Public property Col: integer read FCol write FCol;

Col is the column of the grid which this TCellElementSegment intersects. In this context, column can represent a column of elements or a column of cells depending on which this TCellElementSegment is intersecting.

Public property EndPosition: TEdgePosition read FEndPosition write FEndPosition;

If the end of this TCellElementSegment is at the edge of the cell or element, EndPosition is epLast. If it is a vertex on the TScreenObject so that the point is in the interior of the cell or element, it is epMiddle. EndPosition is used in exporting rivers in PHAST.

Public property Layer: integer read FLayer write FLayer;

Layer is the layer of the grid which this TCellElementSegment intersects. In this context, layer can represent a layer of elements or a layer of cells depending on which this TCellElementSegment is intersecting.

Public property VertexIndex: integer read FVertexIndex write FVertexIndex;

VertexIndex is the index of the point in Points that comes before this TCellElementSegment.

Public property Row: integer read FRow write FRow;

Row is the row of the grid which this TCellElementSegment intersects. In this context, row can represent a row of elements or a row of cells depending on which this TCellElementSegment is intersecting.

Public property StartPosition: TEdgePosition read FStartPosition write FStartPosition;

If the start of this TCellElementSegment is at the edge of the cell or element, StartPosition is epFirst. If it is a vertex on the TScreenObject so that the point is in the interior of the cell or element, it is epMiddle. StartPosition is used in exporting rivers in PHAST.

Public property X1: double read FSegment[1].x write FSegment[1].x;

X1 is the X-coordinate of the start of this TCellElementSegment. X1 is in the coordinate system of the grid rather than global coordinate system.

Public property X2: double read FSegment[2].x write FSegment[2].x;

X2 is the X-coordinate of the end of this TCellElementSegment. X2 is in the coordinate system of the grid rather than global coordinate system.

Public property Y1: double read FSegment[1].y write FSegment[1].y;

Y1 is the Y-coordinate of the start of this TCellElementSegment. Y1 is in the coordinate system of the grid rather than global coordinate system.

Public property Y2: double read FSegment[2].y write FSegment[2].y;

Y2 is the Y-coordinate of the end of this TCellElementSegment. Y2 is in the coordinate system of the grid rather than global coordinate system.

Public property StartPoint: TPoint2D read FSegment[1];
 
Public property EndPoint: TPoint2D read FSegment[2];
 
Public property SectionIndex: integer read FSectionIndex write FSectionIndex;
 
Public property LgrEdge: boolean read FLgrEdge write FLgrEdge;
 
Generated by PasDoc 0.12.1 on 2013-05-13 15:42:00