HeightmapGrinder

Description

sealed class Tinman.Terrain.Heightmaps.HeightmapGrinder

Derived from

Disposable abstract

Helper class for merging IHeightmap objects.

Public / Constructors

HeightmapGrinder


public constructor HeightmapGrinder → ()

Creates a new instance of HeightmapGrinder.

Public / Methods

Add

2 overloads


public method Add1 → (1)

heightmap in : IHeightmap

The heightmap to add.

returns → HeightmapGrinder

this

Adds a heightmap to the grinder.


public method Add2 → (1)

heightmaps in : IHeightmap [ ]

The heightmaps to add.

returns → HeightmapGrinder

this

Adds heightmaps to the grinder.

Group


public method Group → ()

returns → HeightmapGrinder

this

Groups the heightmaps in the grinder by their internal size (see IHeightmap.Size) and merges the heightmaps in each group.

When this method returns, List will contain one merged heightmap per group, sorted in ascending order by internal size.

Heightmap


[OwnerReturn]
public method Heightmap → (1)

layer opt : HeightmapLayer = HeightmapLayer.All

Optional heightmap layer filter. At least one of the given layers must be present in a heightmap to be included by this method.

returns → IHeightmap

The merged heightmap or null if List is empty.

Merges the heightmaps in the grinder in the order as they appear in List.

Sort


public method Sort → ()

returns → HeightmapGrinder

this

Sorts the heightmaps in the grinder in ascending order by their internal size (see IHeightmap.Size.

Public / Attributes

List


public attribute List → (get)

value : IVectorConst<IHeightmap>

[not-null]
The heightmaps.

The heightmaps in the grinder.