HeightmapSampleGui

Description

sealed class Tinman.AddOns.Components.HeightmapSampleGui

Full source code is included in the Tinman 3D SDK download.

A GUI component that displays the values of a HeightmapSample.

The following default Layout settings are defined for LightingGui objects:

Public / Constants

Label​Coverage


[Localized]
public constant LabelCoverage → ("Coverage":string)

Label for coverage layer.

Label​Displacement


[Localized]
public constant LabelDisplacement → ("Displace":string)

Label for displacement layer.

Label​Elevation


[Localized]
public constant LabelElevation → ("Elevation":string)

Label for elevation layer.

Label​Material


[Localized]
public constant LabelMaterial → ("Material":string)

Label for material layer.

Label​Texture


[Localized]
public constant LabelTexture → ("Texture":string)

Label for texture layer.

Public / Constructors

Heightmap​Sample​Gui


public constructor HeightmapSampleGui → ()

Creates a new instance of HeightmapSampleGui.

Public / Attributes

Layer​Mask


public attribute LayerMask → (get,set)

value : HeightmapLayer

Bitwise combination of HeightmapLayer values.

The mask of heightmap layers this object uses.

These heightmap layers store actual terrain data:

Missing data is represented with the HeightmapLayer.Coverage layer. It describes how much information is present in a stored heightmap sample. The semantics of coverage with heightmap samples is the same as premultiplied alpha with texture samples. A LayerMask without HeightmapLayer.Coverage means that all samples are fully solid. If a LayerMask contains the HeightmapLayer.Coverage layer but no others, the coverage values are used to represent 'holes' in the terrain (e.g. creating holes for caves, tunnels, etc.).

Range


public attribute Range → (get,set)

value : VerticalRange

The vertical range, in metres.

Sample


public attribute Sample → (get,set)

value : HeightmapSample

The heightmap sample.

The heightmap sample to display.