class ShapeInfo in Tinman.Terrain.Shapes

Provides information about a IShape object.

sealed class

ShapeInfo

implements

IShapeInfo

Remarks

This class is intended to be used from the Scripting API.

Configuration

Config

The configurator object for this type.

public static property	Config { get }
type	IConfigurator<ShapeInfo>
value	[not-null]	The configurator object.

ToConfig

Returns the configuration value that describes this object.

public method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Public / Attributes

EdgeCount

Returns the number of shape edges.

public property	EdgeCount { get }
type	int32
value	[>=0]	The number of shape edges.
implements	IShapeInfo.EdgeCount

See also:

IShape.EdgeAt

EdgeParity

Defines how the vertex winding of polygon contours is interpreted (outer rings vs. holes).

public property	EdgeParity { get }
type	int32
value		The parity value: +/- 1 for polygons, 0 for non-polygon shapes.
implements	IShapeInfo.EdgeParity

Remarks:

A polygon contour is classified as an outer ring or a hole according to the sign of its signed area:

outer := sign(Area(contour)) == Parity
hole  := sign(Area(contour)) != Parity

The default value is -1 (i.e. clockwise orientation in a standard Cartesian coordinate system).

Georef

The coordinate system of the shape.

public property	Georef { get }
type	CoordinateSystem
value	[not-null]	The coordinate system.
implements	IShapeInfo.Georef

Remarks:

The default coordinate system is a local one (see IsLocal) in metres (see Metre).

IsCubemap

Is this a cubemap shape?

public property	IsCubemap { get }
type	bool
value		true if this is a cubemap shape, false if not.
implements	IShapeInfo.IsCubemap

Remarks:

Cubemap shapes have a geographic coordinate system (see IsGeographic) and six separate sub-shapes, one for each cubemap face (see Cubemap)).

See also:

IShape.TransformCubemap
IShape.Face

TriangleCount

Returns the number of shape triangles.

public property	TriangleCount { get }
type	int32
value	[>=0]	The number of shape triangles.
implements	IShapeInfo.TriangleCount

Type

The shape type.

public property	Type { get }
type	ShapeType
value		The shape type.
implements	IShapeInfo.Type

VertexCount

Returns the number of shape vertices.

public property	VertexCount { get }
type	int32
value	[>=0]	The number of shape vertices.
implements	IShapeInfo.VertexCount

Remarks:

When the vertex count is zero, the shape is defined implicitly. If the vertex count is greater than zero, the shape is explicitly defined by its vertices.

See also:

IShape.VertexAt

Public / Constructors

ShapeInfo

Creates a new instance of ShapeInfo.

public constructor	ShapeInfo (IShape shape)
params	shape	[not-null]	The shape for which to obtain infos.