ShapeLayer

Description

sealed class Tinman.Engine.Scenes.Entities.ShapeLayer

Derived from

TerrainLayerProvider abstract
ILightingProperty

A scene entity that adds a terrain layer for vector shapes.

The default value for the ILightingProperty.Lighting property is false.

Public / Constructors

Shape​Layer


public constructor ShapeLayer → (3)

sortIndex in : int32

The layer sort index. Layers with larger sort index values are rendered on top of those with smaller sort index values.

atlasId in : string

[not-empty]
ID of the texture atlas to use. Must refer to one of the IDs that have been declared via SceneOptions.TextureAtlas.

accuracy opt : float64 = 0

The shape accuracy (see IMapShapes.ShapeAccuracy).

Creates a new instance of ShapeLayer.

Public / Methods

Add


public method Add → (1)

shape in : PixelPyramidShape

[not-null]
The vector shape.

Adds a vector shape.

Prepare


[ThreadSafe]
public method Prepare → (1)

shape in : PixelPyramidShape

[not-null]
The vector shape to prepare.

returns → PixelPyramidShape

The prepared vector shape, that can be passed to Add without additional computation overhead.

Prepares the given vector shape for addition to this shape layer.

Remove


public method Remove → (1)

shape in : PixelPyramidShape

[not-null]
The vector shape to remove.

Removes a vector shape.

Logging

Logger


public static readonly attribute Logger → (ILogger)

The logger object of this class.