Header menu logo Nu

HeightMap Type

A height map for terrain.

Union cases

Union case Description

ImageHeightMap Image AssetTag

Full Usage: ImageHeightMap Image AssetTag

Parameters:
Item : Image AssetTag

RawHeightMap RawHeightMap

Full Usage: RawHeightMap RawHeightMap

Parameters:
Item : RawHeightMap

Instance members

Instance member Description

this.IsImageHeightMap

Full Usage: this.IsImageHeightMap

Returns: bool
Returns: bool

this.IsRawHeightMap

Full Usage: this.IsRawHeightMap

Returns: bool
Returns: bool

Static members

Static member Description

HeightMap.tryGetMetadata tryGetAssetFilePath bounds tiles heightMap

Full Usage: HeightMap.tryGetMetadata tryGetAssetFilePath bounds tiles heightMap

Parameters:
Returns: HeightMapMetadata voption

Attempt to compute height map metadata, loading assets as required. NOTE: if the heightmap pixel represents a quad in the terrain geometry in the exporting program, the geometry produced here is slightly different, with the border slightly clipped, and the terrain and quad size, slightly larger. i.e if the original map is 32m^2 and the original quad 1m^2 and the heightmap is 32x32, the quad axes below will be > 1.0.

tryGetAssetFilePath : AssetTag -> string option
bounds : Box3
tiles : Vector2
heightMap : HeightMap
Returns: HeightMapMetadata voption

Type something to start searching.