Heightmap.Dataset

Description

Name

class Tinman.Heightmap.Dataset

Derived from

Heightmap

A heightmap that uses an existing persistent file-based dataset for storing its heightmap samples.

Fields / Required

path

Type

path

Constraint

# != null

Path to the dataset file.

Fields / Optional

mode

Type

Dataset.Mode

Default

Dataset.Mode.Open

The mode to use for accessing the dataset file.


width

Type

number

Constraint

# >= 0

Default

0

Width of rectangular dataset.


height

Type

number

Constraint

# >= 0

Default

0

Height of rectangular dataset.


size

Type

number

Constraint

# >= 0

Default

0

Size of cubemap dataset.


format

Type

Heightmap.Format[]

Default

null

The binary storage format of the dataset.


coverage

Type

Coverage.Type

Default

Coverage.Type.PixelIsPoint

Sample coverage semantic of rectangular dataset.


range

Type

Vertical.Range

Default

null

Vertical range of dataset.


georef

Type

Tinman.Georef

Default

null

geo-referencing information to attach to dataset.


metadata

Type

Dataset.Info

Default

null

Metadata information to store in dataset.


guid

Type

string

Default

null

The dataset identifier to use. If empty, a random identifier will be generated.

Fields / External

id

Type

Dataset.Id

Returns a unique identifier for this dataset.


info

Holds detail information about this heightmap.