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

class Tinman.Heightmap.Import

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

Imports pixel data into a dataset.

This method ignores georeferencing information present in image and/or this dataset. The pixels of image will be imported and written to a dataset region denoted by topLeft and transform. Pixel data will not be resampled or reprojected. Only pixel values will be scaled and/or translated if necessary (e.g. see Image.Range, Vertical.Range for heightmaps).

A-------B
|       |    input image: W x H pixels
D-------C

First, the given transform is applied to the input image, using the center of its map raster as the center of transformation. This figure shows the transformed image for Tinman.Transform.Diagonal:

A----D
|    |
|    |      transformed input image: W' x H' pixels
|    |
B----C

Then, the top-left pixel of the transformed input image (here A) is tied to the given cubemap face coordinates (see topLeft) and the pixels of the transformed image are imported into the cubemap face, where to X-axis resp. Y-axis of the transformed input image correspond to the cubemap face X-axis resp. Y-axis.

Fields

The following table lists all fields of this config type.

Field Type Constraint Default
required image Image
# != null
 

The pixel data to import.

required dataset Heightmap
# != null
 

The target dataset.

optional validate bool  
true

Validate image data before processing?

optional topLeft Coords  
{0, 0, None}

Cubemap face coordinates of top-left pixel of transformed input image.

optional transform Tinman.Transform  
None

Transform to apply to input image.

optional materials Vec4  
{0, 1, 2, 3}

The material IDs to associate with the red-, green-, blue- and alpha channels of the imported image pixels. This is only relevant when importing pixel data into the Heightmap.Layer.Material layer.