Heightmap

Description

abstract class Tinman.Terrain.Heightmaps.Heightmap

Derived from: Disposable ^abstract
IHeightmap
Extended by: CompositeHeightmapOne ^abstract
CompositeHeightmapTwo ^abstract
MandelbrotHeightmap ^sealed
RandomHeightmap ^sealed
TestPatternHeightmap ^sealed

Abstract base class for IHeightmap implementations.

Public / Constructors

Builder

_4 overloads

public static method Builder¹ → (1)

size ⁱⁿ : int32: [pow2+1]
The cubemap size.
returns → HeightmapBuilder: The heightmap builder object.

Builds a heightmap of type MapType.Cube with PixelCoverage.PixelIsPoint.

public static method Builder² → (3)

width ⁱⁿ : int32: [>0]
The map width, in heightmap samples.
height ⁱⁿ : int32: [>0]
The map height, in heightmap samples.
coverage ^opt : PixelCoverage = PixelCoverage.PixelIsPoint: The sample coverage of the rectangular heightmap.
returns → HeightmapBuilder: The heightmap builder object.

Builds a heightmap of type MapType.Rect.

public static method Builder³ → (1)

map ⁱⁿ : MapInfo: The map raster.
returns → HeightmapBuilder: The heightmap builder object.

Builds a heightmap for the given map raster.

public static method Builder⁴ → (1)

heightmap ⁱⁿ : IHeightmap: The other heightmap to use as template.
returns → HeightmapBuilder: The heightmap builder object.

Builds a heightmap similar to heightmap ⁱⁿ.

See also: Heightmap.Builder³
HeightmapBuilder.Georef
HeightmapBuilder.Range

Public / Methods

Merge

[OwnerReturn]
public static method Merge → (2)

first ⁱⁿ : IHeightmap ^own: The first heightmap or null.
second ⁱⁿ : IHeightmap ^own: The second heightmap or null.
returns → IHeightmap: The resulting heightmap or null if both input heightmaps are null.

Merges the given heightmaps.

See also: IHeightmapOps.Merge

Public / Attributes

Datasets

public static attribute Datasets → (get)

value : HeightmapCollection: [not-null]
The dataset collection.

The shared collection of heightmap datasets.

Protected / Constructors

Heightmap

protected constructor Heightmap → ()

Creates a new instance of Heightmap.

Protected / Methods

AssertSameSize

protected method AssertSameSize → (2)

source ⁱⁿ : string: The error source tag.
other ⁱⁿ : Heightmap: The other heightmap.

Asserts that the given heightmap has the same size as this one.

BlockCoords

[Pure]
protected method BlockCoords → (3)

faceX ⁱⁿ : int32: The cubemap face X-coordinate.
faceY ⁱⁿ : int32: The cubemap face Y-coordinate.
face ⁱⁿ : CubemapFace: The cubemap face.
returns → Vec3I: The cubemap coordinates.

Computes cubemap coordinate for the given face coordinates, wrapping resp. clamping them as required.

DoGetRegion

protected virtual method DoGetRegion → (9)

region ⁱⁿ : CubemapFaceRect: The rectangular region to fetch (already aligned to step ⁱⁿ).
step ⁱⁿ : int32: The step value between samples. This is always a power of two (including 1).
buffer ⁱⁿ : HeightmapRegion: The output heightmap buffer.
bufferX ⁱⁿ : int32: X-coordinate of top-left pixel in buffer ⁱⁿ to set.
bufferY ⁱⁿ : int32: Y-coordinate of top-left pixel in buffer ⁱⁿ to set.
bufferWidth ⁱⁿ : int32: Width of buffer region to fetch.
bufferHeight ⁱⁿ : int32: Height of buffer region to fetch.
layers ⁱⁿ : HeightmapLayer: The heightmap layers to fetch. Will contain one or more layers of this heightmaps IHeightmapLayers.LayerMask.
smooth ⁱⁿ : bool: Use smooth interpolation?

Fetches a rectangular region of heightmap samples.

The default implementation fetches each sample individually, which is slow. Subclasses are encouraged to provide an optimized implementation for this method.

The heightmap coordinate range given by region ⁱⁿ will always be fully inside of the valid coordinate range of this heightmap.

The given buffer ⁱⁿ is guaranteed to contain at least all layers of the intersection of the specified layers ⁱⁿ and the IHeightmapLayers.LayerMask of this heightmap.

IOException: If an I/O error has occurred.

DoGetSample

protected abstract method DoGetSample → (3)

x ⁱⁿ : int32: X-coordinate of heightmap sample.
y ⁱⁿ : int32: Y-coordinate of heightmap sample.
z ⁱⁿ : int32: Z-coordinate of heightmap sample (for MapType.Cube).
returns → HeightmapSample: The heightmap sample.

Returns a single heightmap sample.

The default implementations of DoGetSamples and DoGetRegion use of this method. This is convenient but will most likely be very slow. It is better to also provide optimized implementations for DoGetSamples and DoGetRegion.

The x ⁱⁿ, and y ⁱⁿ and z ⁱⁿ coordinates will always be within the valid bounds of this heightmap.

IOException: If an I/O error has occurred.

See also: Heightmap.DoGetSamples
Heightmap.DoGetRegion

DoGetSamples

protected virtual method DoGetSamples → (5)

xyz ⁱⁿ : Vec3I [ ]: The heightmap sample coordinates (given for a heightmap of size HeightmapsUtil.MaxSize).
count ⁱⁿ : int32: Number of samples to fetch, always greater than or equal to 1.
buffer ⁱⁿ : HeightmapSamples: The output heightmap buffer.
layers ⁱⁿ : HeightmapLayer: The heightmap layers to get.
helpers ⁱⁿ : HeightmapSamplesCache: The helper cache to use.

Fetches a series of heightmap samples.

The default implementation fetches each sample individually, which is slow. Subclasses are encouraged to provide an optimized implementation for this method.

The given buffer ⁱⁿ is guaranteed to contain at least all layers of the intersection of the specified layers ⁱⁿ and the IHeightmapLayers.LayerMask of this heightmap.

IOException: If an I/O error has occurred.

DoHasRegion

protected abstract method DoHasRegion → (2)

region ⁱⁿ : CubemapFaceRect: The step-aligned cubemap face region.
flags ⁱⁿ : CoverageFlags: The coverage flags that need to be determined.
returns → CoverageFlags: The result of the check.

Checks if this heightmap contains samples in the given region.

The given region ⁱⁿ will never be empty (see CubemapFaceRect.IsEmpty) and its bounds will always be inside of its cubemap face (see CubemapFaceRect.Face).

IOException: If an I/O error has occurred.

DoSetRegion

[EmptyBody]
protected virtual method DoSetRegion → (5)

region ⁱⁿ : CubemapFaceRect: The rectangular region to fetch.
buffer ⁱⁿ : HeightmapRegion: The output heightmap buffer.
bufferX ⁱⁿ : int32: X-coordinate of top-left pixel in buffer ⁱⁿ to set.
bufferY ⁱⁿ : int32: Y-coordinate of top-left pixel in buffer ⁱⁿ to set.
layers ⁱⁿ : HeightmapLayer: The heightmap layers to fetch. Will contain one or more layers of this heightmaps IHeightmapLayers.LayerMask.

Stores a rectangular region of heightmap samples.

The heightmap coordinate range given by region ⁱⁿ will always be fully inside of the valid coordinate range of this heightmap.

The given buffer ⁱⁿ is guaranteed to contain at least all layers of the intersection of the specified layers ⁱⁿ and the IHeightmapLayers.LayerMask of this heightmap.

IOException: If an I/O error has occurred.

DoSplit

[OwnerReturn] [OwnerThis]
protected virtual method DoSplit → (1)

layers ⁱⁿ : HeightmapLayer: The heightmap layers to retain.
returns → IHeightmap: The resulting heightmap.

Filters this heightmap by retaining only the given heightmap layers.

The given layers ⁱⁿ will never be HeightmapLayer.None and will always be a subset of this heightmaps IHeightmapLayers.LayerMask.

Initialize

_2 overloads

protected method Initialize¹ → (1)

map ⁱⁿ : IHeightmap: [not-null]
The IHeightmap object.

Initializes the map to the size and type of the given IHeightmap object.

protected method Initialize² → (4)

type ⁱⁿ : MapType: The heightmap type.
size ⁱⁿ : int32: [>=0]
The internal size, in samples.
width ^opt : int32 = 0: [>=0]
The heightmap width, in samples. If 0, the internal size will be used.
height ^opt : int32 = 0: [>=0]
The heightmap height, in samples. If 0, the internal size will be used.

Initializes the heightmap to the given type and size.

The internal size of this heightmap will be set to the maximum of size ⁱⁿ, width ^opt and height ^opt, clamped to the next power of two plus one between HeightmapsUtil.MinSize and HeightmapsUtil.MaxSize.

UpdateRegion_Lock

[EmptyBody]
protected virtual method UpdateRegion_Lock → (1)

region ⁱⁿ : Box3I: The region to lock.

Locks the given region for subsequent updates.

See also: Heightmap.UpdateRegion_Unlock

UpdateRegion_Unlock

[EmptyBody]
protected virtual method UpdateRegion_Unlock → (1)

region ⁱⁿ : Box3I: The region to unlock.

Unlocks the given region.

See also: Heightmap.UpdateRegion_Lock

ValidCoords

_2 overloads

[Pure]
protected method ValidCoords¹ → (2)

v ⁱⁿ : Vec3I: The heightmap coordinates.
maxSize ^opt : bool = false: Are the coordinate specified for a heightmap of HeightmapsUtil.MaxSize?
returns → bool: true if the coordinates are valid, false if not.

Checks if the given heightmap coordinates are valid for this heightmap.

[Pure]
protected method ValidCoords² → (4)

x ⁱⁿ : int32: The heightmap X-coordinate.
y ⁱⁿ : int32: The heightmap Y-coordinate.
z ^opt : int32 = 0: The heightmap Z-coordinate.
maxSize ^opt : bool = false: Are the coordinate specified for a heightmap of HeightmapsUtil.MaxSize?
returns → bool: true if the coordinates are valid, false if not.

Checks if the given heightmap coordinates are valid for this heightmap.

Protected / Attributes

height

protected attribute height → (int32)

The height of the heightmap.

This value is set by Initialize².

isCube

protected attribute isCube → (bool)

Is this map of type MapType.Cube?

This value is set by Initialize².

mapType

protected attribute mapType → (MapType)

The type of the heightmap (rectangular or cube).

This value is set by Initialize².

maxSizeMask

protected attribute maxSizeMask → (int32)

Bitmask for aligning coordinates to the size of this heightmap.

This value is set by Initialize².

A binary and with this bitmask has the same effect as doing a right-shift of maxSizeShift bits followed by a left-shift of the same bit count.

maxSizeScale

protected attribute maxSizeScale → (int32)

Scale factor to apply to coordinates of this map in order to translate them to HeightmapsUtil.MaxSize.

This value is set by Initialize².

maxSizeShift

protected attribute maxSizeShift → (int32)

Shift amount to apply to coordinates of this map in order to translate them to HeightmapsUtil.MaxSize.

This value is set by Initialize².

According to HeightmapsUtil.MinSize and HeightmapsUtil.MaxSize, this value will always be in the range [0..22].

maxSizeX

protected attribute maxSizeX → (int32)

Maximum cubemap face X-coordinate of this heightmap, given for HeightmapsUtil.MaxSize.

maxSizeY

protected attribute maxSizeY → (int32)

Maximum cubemap face Y-coordinate of this heightmap, given for HeightmapsUtil.MaxSize.

onUpdated

[Owner]
protected attribute onUpdated → (EventGeneric<HeightmapEventArgs>)

The event object of IHeightmap.OnUpdated.

size

protected attribute size → (int32)

The internal size of the heightmap.

This value is set by Initialize².

sizeMinusOne

protected attribute sizeMinusOne → (int32)

The internal size of the heightmap, minus one.

This value is set by Initialize².

width

protected attribute width → (int32)

The width of the heightmap.

This value is set by Initialize².

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<IHeightmap>: [not-null]
The configurator object.

The configurator object for this type.

Heightmap

Description

Public / Constructors

Builder

Public / Methods

Merge

Public / Attributes

Datasets

Protected / Constructors

Heightmap

Protected / Methods

Assert​Same​Size

Block​Coords

Do​Get​Region

Do​Get​Sample

Do​Get​Samples

Do​Has​Region

Do​Set​Region

Do​Split

Initialize

Update​Region_​Lock

Update​Region_​Unlock

Valid​Coords

Protected / Attributes

height

is​Cube

map​Type

max​Size​Mask

max​Size​Scale

max​Size​Shift

max​Size​X

max​Size​Y

on​Updated

size

size​Minus​One

width

Configuration

Config

AssertSameSize

BlockCoords

DoGetRegion

DoGetSample

DoGetSamples

DoHasRegion

DoSetRegion

DoSplit

UpdateRegion_Lock

UpdateRegion_Unlock

ValidCoords

isCube

mapType

maxSizeMask

maxSizeScale

maxSizeShift

maxSizeX

maxSizeY

onUpdated

sizeMinusOne