IHeightmapProvider

Description

interface Tinman.Engine.Scenes.IHeightmapProvider

Extended by

Example_HeightmapProvider sealed
IScene
SceneOptions sealed

Base interface for classes that provide IHeightmap objects for a given Path value.

Public / Methods

Open​Heightmap​Dataset


[OwnerReturn]
public method OpenHeightmapDataset → (2)

path in : Path

[not-null]
Path to the heightmap dataset file.

readOnly opt : bool = true

Open the heightmap dataset in read-only mode?

returns → IHeightmapDataset

The heightmap dataset.

Opens a heightmap dataset, using the configured dataset file cache.

Usually, an implementation will use Heightmap.Datasets to call DatasetCollection.Open1 (which opens an HGT dataset file), passing some DatasetFileCacheDelegate to apply caching.

IOException

If an I/O error has occurred.