Sample

Description

Name: struct Tinman.Heightmap.Sample
Used by: Border.sample / Brush.Uniform.sample / Heightmap.Constant.sample / Heightmap.MapShape.samples

Represents a single heightmap sample.

Fields / Optional

`coverage`

Type: number
Constraint: # >= 0 && # <= 1
Default: 1

The coverage values determines how much "valid" data is stored in the heightmap sample: A coverage of 0 means that no data is stored at all; a coverage of 1 means that the sample data if fully valid. Usually, one these two values is used. Intermediate values result from interpolation and are used for proper merging of heightmap data.

`elevation`

Type: number
Constraint: # >= -1 && # <= 1
Default: 0

The normalized elevation value of the heightmap sample. A value of 0 represents zero elevation (e.g. on the surface of the ellipsoid); a value of +/-1 represents maximum/minimum elevation along the terrain-space up vector.

`texture`

Type: Tinman.Color
Default: {Color.Name: Zero}

The texture diffuse color of the heightmap sample.

`material`

Type: Tinman.Material
Default: null

The material token of the heightmap sample.

`displacement`

Type: number
Constraint: # >= -1 && # <= 1
Default: 0

The normalized displacement value of the heightmap sample. A value of 0 represents zero displacement; a value of +/-1 represents maximum/minimum displacement along the terrain-space normal vector.