class GridLineBuilder in Tinman.Terrain.Tools

The GridLineBuilder is a tool for building grid lines (e.g. meridians and parallels) on a projected map (see IMapProjection).

sealed class

GridLineBuilder

Public / Attributes

Error

The maximum geometric error to allow for grid lines on a cubemap face.

public property	Error { get set }
type	float64
value	[>0]	The maximum geometric error, measured in the target map units (see Target) of the map projection (see Projection).

Remarks:

The default value is 1.

From

First corner of source map rectangle which defines the area where gridlines will be computed.

public property	From { get set }
type	Vec2D
value		The source map coordinates.

Remarks:

The coordinates refer to the source map (see Source) of the configured map projection (see Projection).

GridLines

Returns the resulting grid lines.

public property	GridLines { get }
type	IVectorConst<GridLine>
value	[not-null]	The grid lines.

Remarks:

The grid lines in the returned list are sorted by orientation (horizontal / vertical) and cubemap face. Use the GridLinesFor method to obtain the respective list index ranges.

Origin

The map origin to use for computing grid lines.

public property	Origin { get set }
type	Vec2D
value		The map origin.

Remarks:

The values for origin and step determine the coordinates of horizontal and vertical grid lines (see Coordinate):

• Horizontal (e.g. meridian):
  c := origin.Y + n * step.Y
• Vertical (e.g. parallel):
  c := origin.X + n * step.X

The coordinates refer to the source map (see Source) of the configured map projection (see Projection).

The default value is (0,0).

Projection

The used map projection.

public property	Projection { get }
type	IMapProjection
value	[not-null]	The map projection.

Step

The step distance to use for computing grid lines.

public property	Step { get set }
type	Vec2D
value		The step distance.

Remarks:

The values for origin and step determine the coordinates of horizontal and vertical grid lines:

• Horizontal (e.g. meridian):
  c := origin.Y + n * step.Y
• Vertical (e.g. parallel):
  c := origin.X + n * step.X

The step values refer to the source map (see Source) of the configured map projection (see Projection).

The default value is (1,1).

To

Second corner of source map rectangle which defines the area where gridlines will be computed.

public property	To { get set }
type	Vec2D
value		The source map coordinates.

Remarks:

The coordinates refer to the source map (see Source) of the configured map projection (see Projection).

Public / Constructors

GridLineBuilder

Creates a new instance of GridLineBuilder.

public constructor	GridLineBuilder (IMapProjection projection, Mat3D transform)
params	projection	[not-null]	The map projection to use.
	transform		Homogeneous 2D transformation matrix to apply to map coordinates of grid lines before storing them in Coordinate.

Remarks:

In the source map (see Source) of the given projection, all gridlines are parallel to the X-axis resp. Y-axis. Use From and To to define the area in which gridlines will be computed. Use Origin and Step to control placement and number of gridlines. Use Error to control tessellation quality.

Public / Methods

GridLinesFor

Returns the list index range in GridLines for the given cubemap face and orientation.

public method	GridLinesFor (CubemapFace face, int32 orientation = 0)
type	RangeI
params	face		The cubemap face.
	orientation		Return horizontal grid lines (>0), vertical grid lines (<0) or both ( =0)? Defaults to 0.
returns			The list index range, which can be empty (see IsEmpty).