TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

interface IShapeInfo in Tinman.Terrain.Shapes

interface IShapeInfo extends IConfigurable
  base of IShape
  ShapeInfo

Attributes

EdgeCount

Returns the number of shape edges.

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

See also:

IShape.EdgeAt

EdgeParity

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

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

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.

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

Remarks:

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

IsCubemap

Is this a cubemap shape?

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

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.

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

Type

The shape type.

property Type { get }
type ShapeType
value The shape type.

VertexCount

Returns the number of shape vertices.

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

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

Methods

ToConfig

Returns the configuration value that describes this object.

method ToConfig ()
type ConfigValue
returns [not-null] The configuration value.
inherited 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.