TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class Tinman.Heightmap.Dataset

Short Name:
  • class Heightmap.Dataset
Derived From:
Fields:

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

Fields

The following table lists all fields of this config type.

Field Type Constraint Default
required path path
# != null
 

Path to the dataset file.

optional mode Dataset.Mode  
Open

The mode to use for accessing the dataset file.

optional width number
# >= 0
0

Width of rectangular dataset.

optional height number
# >= 0
0

Height of rectangular dataset.

optional size number
# >= 0
0

Size of cubemap dataset.

optional format Heightmap.Format[]  
null

The binary storage format of the dataset.

optional coverage Coverage.Type  
PixelIsPoint

Sample coverage semantic of rectangular dataset.

optional range Vertical.Range  
null

Vertical range of dataset.

optional georef Tinman.Georef  
null

Georeferencing information to attach to dataset.

optional metadata Dataset.Info  
null

Metadata information to store in dataset.

external id Dataset.Id    

Returns a unique identifier for this dataset.

external info Heightmap.Info    

Holds detail information about this heightmap.