Procedural

Description

Name

class Tinman.Heightmap.Procedural

Derived from

Heightmap

A heightmap that uses scalar noise functions to generate heightmap samples at runtime.

Fields / Required

width

Type

number

Constraint

# > 0

Width of the heightmap, in samples.

Fields / Optional

height

Type

number

Constraint

# >= 0

Default

0

Height of rectangular heightmap, in samples. Set to 0 for cubemap heightmaps.


coverage

Type

Scalar

Default

null

Scalar noise function to use for the Heightmap.Layer.Coverage layer, returning values within [0..1].


elevation

Type

Scalar

Default

null

Scalar noise function to use for the Heightmap.Layer.Elevation layer, returning terrain-space elevation values.


displacement

Type

Scalar

Default

null

Scalar noise function to use for the Heightmap.Layer.Displacement layer, returning terrain-space elevation values.


texture

Type

Noise.Color

Default

null

Color noise function to use for the Heightmap.Layer.Texture layer.


material

Type

Procedural.Material[]

Default

null

Scalar noise functions per material ID to use for the Heightmap.Layer.Material layer, returning values within [0..1].


scale

Type

number

Default

1

Scale factor from terrain-space to noise-space.


seed

Type

Vec3

Default

{Vec3: 0, 0, 0}

Pseudo random seed value.


range

Type

Vertical.Range

Default

null

The vertical range of the heightmap.


georef

Type

Tinman.Georef

Default

null

The georeference of the heightmap.

Fields / External

id

Type

Dataset.Id

Returns a unique identifier for this dataset.


metadata

Returns dataset metadata information.


info

Holds detail information about this heightmap.