Shape

Description

abstract class Tinman.Terrain.Shapes.Shape

Derived from: ShapeBase ^abstract
Extended by: ShapeGeometry ^abstract

Abstract base class for IShape implementations.

The following default method implementations provide standard functionality and may be overridden by subclasses in order to provide custom / optimized behaviour:

Public / Constructors

ArcInner

[Pure]
public static method ArcInner → (6)

center ⁱⁿ : Vec2D: The center of the oval from which to create the arc.
a ⁱⁿ : Vec2D: Vector pointing from center ⁱⁿ to start of arc.
b ⁱⁿ : Vec2D: Vector pointing from center ⁱⁿ to end of arc.
n ⁱⁿ : int32: [>=1]
The number of segments between a ⁱⁿ and b ⁱⁿ.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates an arc shape that runs from a ⁱⁿ to b ⁱⁿ over the inner path (i.e. the shorter one).

See also: ShapeType.Polygon

ArcOuter

[Pure]
public static method ArcOuter → (6)

center ⁱⁿ : Vec2D: The center of the oval from which to create the arc.
a ⁱⁿ : Vec2D: Vector pointing from center ⁱⁿ to start of arc.
b ⁱⁿ : Vec2D: Vector pointing from center ⁱⁿ to end of arc.
n ⁱⁿ : int32: [>=1]
The number of segments between a ⁱⁿ and b ⁱⁿ.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates an arc shape that runs from a ⁱⁿ to b ⁱⁿ over the outer path (i.e. the longer one).

See also: ShapeType.Polygon

Arrow

[Pure]
public static method Arrow → (8)

from ⁱⁿ : Vec2D: Base point of arrow.
to ⁱⁿ : Vec2D: Tip point of arrow.
width ^opt : float64 = 0.7: Scale factor from length to width.
widthShaft ^opt : float64 = 0.25: Scale factor from width to widthShaft.
lengthShaft ^opt : float64 = 0.5: Scale factor length to lengthShaft.
lengthHead ^opt : float64 = 0.6: Scale factor length to lengthHead.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates an arrow shape.

The arrow shape vertices a are determined by the these dimensions:

       /         /\             \
       |        /  \            |
       |       /    \           |
       |      /      \          | lengthHead
       |     /        \         |
length |    /  _    _  \        |
       |   /.-´ |  | `-.\   \   /
       |        |  |        |
       |        |  |        | lengthShaft
       \        `--´        /

                \__/
             widthShaft

           \____________/
               width

The length is the distance between from ⁱⁿ and to ⁱⁿ. The other dimensions are defined by the ratios given as parameters.

See also: ShapeType.Polygon

Box

[Pure]
public static method Box → (5)

bounds ⁱⁿ : Box2D: The bounds of the box.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
value ^opt : float64 = 0: The custom value to use for all box vertices.
type ^opt : ShapeValue = ShapeValue.None: The type of value ^opt.
returns → IShape: The shape.

Creates a new box shape.

See also: ShapeType.Polygon

CheckerBoard

[Pure]
public static method CheckerBoard → (4)

size ^opt : float64 = 1: [>0]
Edge length of checkerboard tiles.
offset ^opt : Vec2D = default(Vec2D): Tile corner offset.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a new checkerboard shape.

See also: ShapeType.Implicit

Circle

_2 overloads

[Pure]
public static method Circle¹ → (5)

center ⁱⁿ : Vec2D: The circle center.
radius ⁱⁿ : float64: [>=0]
The circle radius.
n ⁱⁿ : int32: [>=1]
The number of segments per circle quadrant.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: this

Creates a new circle shape by defining an approximating polygon.

See also: ShapeType.Polygon

[Pure]
public static method Circle² → (4)

center ⁱⁿ : Vec2D: Coordinates of center of circle.
radius ^opt : float64 = 0: [>=0]
Radius of circle. Set to 0 to create a point shape.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a new circle shape by defining a signed distance field.

See also: ShapeType.Points

Curve

[Pure]
public static method Curve → (7)

curve ⁱⁿ : ICurve: [not-null]
The curve to follow.
accuracy ⁱⁿ : float64: [>=0]
The sub-division accuracy to achieve, given as the maximum allowed error in the shape coordinate system (treating control point position and tangent values as 2D vectors). Set to 0 to disable.
range ⁱⁿ : RangeD: The control point index range of the shape. If RangeD.Inv, the curve range will be used (see ICurve.Range).
y1b ^opt : float64 = 0: Coefficient for Y-coordinate, in curve-space (see remarks).
y2b ^opt : float64 = 0: Coefficient for Y-coordinate, in curve-space (see remarks).
y1m ^opt : float64 = 0: Coefficient for Y-coordinate, in curve-space (see remarks).
y2m ^opt : float64 = 0: Coefficient for Y-coordinate, in curve-space (see remarks).
returns → IShape: The shape.

Creates a new shape that follows the given curve, using ShapeBuilder.Curve

This method is a helper that uses Geometry and calls ShapeBuilder.Build to build the shape, using an edge parity of 0 if any of the following holds true and -1 otherwise:

The given range ⁱⁿ has zero length.
y1b ^opt is equal to y2b ^opt and both y1m ^opt and y2m ^opt are zero.

See also: ShapeType.Polygon
ShapeType.Points
ShapeType.Graph

File

_2 overloads

[Pure]
public static method File¹ → (5)

file ⁱⁿ : Path: [not-null]
The file path.
flags ^opt : ReadShapeFlags = ReadShapeFlags.Geo: The reader flags to use.
format ^opt : ShapeFormat = null: The file format or null if not known.
modifier ^opt : IShapeReaderModifier = null: The shape data modifier to use.
filter ^opt : IShapeReaderFilter = null: The shape data filter to use.
returns → IShape: The shape.

Reads the given shape file.

[Pure]
public static method File² → (5)

file ⁱⁿ : IFileData: [not-null]
The file data.
flags ^opt : ReadShapeFlags = ReadShapeFlags.Geo: The reader flags to use.
format ^opt : ShapeFormat = null: The file format or null if not known.
modifier ^opt : IShapeReaderModifier = null: The shape data modifier to use.
filter ^opt : IShapeReaderFilter = null: The shape data filter to use.
returns → IShape: The shape.

Reads the given shape file.

GeographicPolygon

_2 overloads

[Pure]
public static method GeographicPolygon¹ → (3)

vertices ⁱⁿ : LatLon [ ]: [not-null]
The polygon vertices, given as a non-closed polyline that represents a weakly simple polygon.
datum ^opt : GeodeticDatum = null: The geographic datum. If null, GeodeticDatum.WGS84 will be used.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The resulting shape.

Creates a polygon shape in a geographic coordinate system.

The winding the shape vertices is not relevant.

See also: ShapeType.Polygon

[Pure]
public static method GeographicPolygon² → (3)

vertices ⁱⁿ : IVectorConst<LatLon>: [not-null]
The polygon vertices, given as a non-closed polyline that represents a weakly simple polygon.
datum ^opt : GeodeticDatum = null: The geographic datum. If null, GeodeticDatum.WGS84 will be used.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The resulting shape.

Creates a polygon shape in a geographic coordinate system.

The winding the shape vertices is not relevant.

See also: ShapeType.Polygon

Geometry

public static method Geometry → (3)

vertices ^opt : int32 = 0: [>=0]
Initial vertex capacity.
edges ^opt : int32 = 0: [>=0]
Initial edge capacity.
triangles ^opt : int32 = 0: [>=0]
Initial triangle capacity.
returns → ShapeBuilder: The shape builder object.

Returns a ShapeBuilder object for creating geometry based shapes (i.e. vertices, edges and/or triangles).

See also: IShape.IsGeometry

Grid

[Pure]
public static method Grid → (8)

a ⁱⁿ : Vec2D: First grid corner point.
b ⁱⁿ : Vec2D: Second grid corner point.
c ⁱⁿ : Vec2D: Third grid corner point.
d ⁱⁿ : Vec2D: Fourth grid corner point.
x ⁱⁿ : int32: [>=1]
Number of segment lines between a ⁱⁿ and b ⁱⁿ (inclusive).
y ⁱⁿ : int32: [>=1]
Number of segment lines between a ⁱⁿ and d ⁱⁿ (inclusive).
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a grid shape.

The grid is specified by the four given control points:

(a)----- + ----- + ----- + -----(b)
 |       |       |       |       |
 + ----- + ----- + ----- + ----- +
 |       |       |       |       |
 + ----- + ----- + ----- + ----- +
 |       |       |       |       |
(d)----- + ----- + ----- + -----(c)

See also: ShapeType.Graph

Group

public static method Group → (3)

georef ^opt : CoordinateSystem = null: The geo-reference of the shape group or null for CoordinateSystem.Local.
metadata ^opt : IJsonValue = null: The metadata of the shape group or null for JsonValue.Null.
accuracy ^opt : float64 = 0: [>=0]
Optional accuracy to use for subdivision of edges. Given as a maximum error in the target coordinate system (see georef ^opt). Set to 0 to disable edge subdivision.
returns → IShape: The shape group.

Creates an empty shape group (see ShapeType.Group).

Oval

[Pure]
public static method Oval → (6)

center ⁱⁿ : Vec2D: The center of the oval.
a ⁱⁿ : Vec2D: First vector pointing from center ⁱⁿ to oval edge.
b ⁱⁿ : Vec2D: Second vector pointing from center ⁱⁿ to oval edge.
n ⁱⁿ : int32: [>=1]
The number of segments between a ⁱⁿ and b ⁱⁿ.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates an oval shape.

See also: ShapeType.Polygon

Polygon

_2 overloads

[Pure]
public static method Polygon¹ → (3)

vertices ⁱⁿ : Vec2D [ ]: [not-null]
The polygon vertices, given as a non-closed polyline that represents a weakly simple polygon.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a polygon shape.

The winding the shape vertices is not relevant.

See also: ShapeType.Polygon

[Pure]
public static method Polygon² → (3)

vertices ⁱⁿ : IVectorConst<Vec2D>: [not-null]
The polygon vertices, given as a non-closed polyline that represents a weakly simple polygon.
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a polygon shape.

The winding the shape vertices is not relevant.

See also: ShapeType.Polygon

Polyline

_2 overloads

[Pure]
public static method Polyline¹ → (4)

vertices ⁱⁿ : Vec2D [ ]: [not-null]
The polyline vertices.
closed ⁱⁿ : bool: Attach last vertex to first one?
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a polyline shape.

See also: ShapeType.Graph

[Pure]
public static method Polyline² → (4)

vertices ⁱⁿ : IVectorConst<Vec2D>: [not-null]
The polyline vertices.
closed ⁱⁿ : bool: Attach last vertex to first one?
georef ^opt : CoordinateSystem = null: The geo-reference or null.
metadata ^opt : IJsonValue = null: The metadata or null.
returns → IShape: The shape.

Creates a polyline shape.

See also: ShapeType.Graph

ReadCSH

_2 overloads

public static method ReadCSH¹ → (1)

path ⁱⁿ : Path: [not-null]
The file path.
returns → IShape: The resulting shape.

Reads a shape from a CSH file.

IOException: If an I/O error has occurred.

public static method ReadCSH² → (1)

stream ⁱⁿ : IDataStream ^own: [not-null]
The input data stream.
returns → IShape: The resulting shape.

Reads a shape from a CSH file.

IOException: If an I/O error has occurred.

Public / Methods

RasterizerFactory

_5 overloads

public static method RasterizerFactory¹ → (2)

sample ⁱⁿ : HeightmapSample: The uniform heightmap sample data to use.
falloff ⁱⁿ : float64: [>=0]
Distance falloff value (see remarks).
returns → IShapeRasterizerFactory<HeightmapRegion>: The shape rasterizer.

Returns a IShapeRasterizerFactory object that rasterizes distance values into the given sample buffer.

Distance values are converted into heightmap samples by computing weighted vertex sums. Distance values of zero or less will produce heightmap samples that have full coverage; values greater than or equal to falloff ⁱⁿ will produce void heightmap samples (i.e. zero coverage). Values in-between create have a smooth transition.

public static method RasterizerFactory² → (2)

samples ⁱⁿ : HeightmapSamples: [not-null]
Heightmap sample data for each vertex of the input shape (see IShape.VertexAt).
falloff ⁱⁿ : float64: [>=0]
Distance falloff value (see remarks).
returns → IShapeRasterizerFactory<HeightmapRegion>: The shape rasterizer.

Returns a IShapeRasterizerFactory object that rasterizes distance values into the given sample buffer.

Per-vertex heightmap sample values can only be used for explicit shapes that have an edge parity of zero. See IShape for details.

public static method RasterizerFactory³ → ()

returns → IShapeRasterizerFactory<DistanceBuffer>: The shape rasterizer.

Returns a IShapeRasterizerFactory object that rasterizes distance values into a sample buffer.

The distance value range (see ISampleBuffer.ScanlineRange) of the target sample buffer is used to optimize the rasterization process.

See also: DistanceBuffer

public static method RasterizerFactory⁴ → (1)

colorRamp ⁱⁿ : IColorRamp: [not-null]
The color ramp to use.
returns → IShapeRasterizerFactory<ColorBuffer>: The shape rasterizer.

Returns a IShapeRasterizerFactory object that rasterizes distance values into the given sample buffer.

Distance values are converted into color values by performing a color ramp lookup.

See also: IColorRamp
ColorBuffer

public static method RasterizerFactory⁵ → (2)

colorRamp ⁱⁿ : IColorRamp: [not-null]
The color ramp to use.
lineStipple ⁱⁿ : LineStipple: The line stipple pattern to use.
returns → IShapeRasterizerFactory<ColorBuffer>: The shape rasterizer.

Returns a IShapeRasterizerFactory object that rasterizes distance values into the given sample buffer.

Distance values are converted into color values by performing a color ramp lookup.

See also: IColorRamp
ColorBuffer

Protected / Constructors

Shape

protected constructor Shape → (3)

serialId ⁱⁿ : ISerialTypeInfo: [not-null]
The serial type ID.
georef ^opt : CoordinateSystem = null: Geo-reference object or null.
metadata ^opt : IJsonValue = null: Metadata object or null.

Creates a new instance of Shape.

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<IShape>: [not-null]
The configurator object.

The configurator object for this type.

Shape

Description

Public / Constructors

Arc​Inner

Arc​Outer

Arrow

Box

Checker​Board

Circle

Curve

File

Geographic​Polygon

Geometry

Grid

Group

Oval

Polygon

Polyline

Read​CSH

Public / Methods

Rasterizer​Factory

Protected / Constructors

Shape

Configuration

Config

ArcInner

ArcOuter

CheckerBoard

GeographicPolygon

ReadCSH

RasterizerFactory