class TerrainDecal in Tinman.AddOns.Components

A terrain surface decal, to be used with DecalAdd

sealed class

TerrainDecal

implements

ICanvasTransform

Public / Attributes

Color

public property	Color { get set }
type	int64
value

Coordinates

The coordinate system of the canvas.

public property	Coordinates { get set }
type	CoordinateSystem
value		The canvas coordinate system or null if canvas space cannot be described by a CoordinateSystem object (e.g. an unfolded cubemap).
implements	ICanvasTransform.Coordinates

Georef

Returns georeferencing information.

public property	Georef { get }
type	Raster
value		The georeferencing object or null if no georeferencing is available.
implements	IGeorefInfo.Georef

Map

Returns a MapInfo value that describes the used map raster.

public property	Map { get }
type	MapInfo
value		The map info value.
implements	IMapInfo.Map

Matrix

public property	Matrix { get set }
type	Mat3D
value

Texture

public property	Texture { get set }
type	IModelTexture
value

Visible

public property	Visible { get set }
type	bool
value

Public / Constructors

TerrainDecal

public constructor

TerrainDecal ()

Public / Methods

CanvasToMapRaster

Transforms the given canvas coordinates into map raster coordinates.

public method	CanvasToMapRaster (float64 x, float64 y, bool maxSize = false)
type	Vec3D
params	x		X-component of input canvas coordinates.
	y		Y-component of input canvas coordinates.
	maxSize		Return map raster coordinates for MaxSize, instead of Size of Map? Defaults to false.
returns			The output map raster coordinates (see Georef and Map resp. maxSize), or Undefined if the transformation is not possible.
implements	ICanvasTransform.CanvasToMapRaster

MapRasterToCanvas

Transforms the given map raster coordinates into canvas coordinates.

public method	MapRasterToCanvas (float64 x, float64 y, float64 z = 0, bool maxSize = false)
type	Vec2D
params	x		X-component of input map raster coordinates.
	y		X-component of input map raster coordinates.
	z		X-component of input map raster coordinates. Defaults to 0.
	maxSize		Are input map raster coordinates specified for MaxSize, instead of Size of Map? Defaults to false.
returns			The output canvas coordinates (see Coordinates), or Undefined if the transformation is not possible.
implements	ICanvasTransform.MapRasterToCanvas

Vertex

Returns a terrain decal vertex.

public method	Vertex (int32 index)
type	Vec2D
params	index	[0..3]	The vertex index: 0: A 1: B 2: C 3: D
returns			The vertex coordinates (see Coordinates).

---

Sets a terrain decal vertex.

public method	Vertex (int32 index, Vec2D vertex)
params	index	[0..3]	The vertex index: 0: A, by default at (-1,-1) 1: B, by default at (+1,-1) 2: C, by default at (+1,+1) 3: D, by default at (-1,+1)
	vertex		The vertex coordinates (see Coordinates).