TerrainViewWidget

Description

sealed class Tinman.AddOns.Widgets.TerrainViewWidget

Derived from

DefaultControlsWidget abstract
ICameraSpeed

Full source code is included in the Tinman 3D SDK download.

A GUI widget that runs a TerrainView.

Public / Constructors

Terrain​View​Widget

public constructor TerrainViewWidget → ()

Creates a new instance of TerrainViewWidget.

Public / Methods

Terrain​Clear

public method TerrainClear → ()

Clears the current terrain view, if any.

Terrain​Create

public method TerrainCreate → (5)

meshOptions in : MeshOptions own

[not-null]
Options to use for creating the TerrainMesh object.

cache opt : PyramidFileCache own = null

The pyramid file cache to use or null for none.

gravity opt : IHeightmap own = null

Optional heightmap that stores gravity-related offsets from the ellipsoid surface (see VerticalType.Gravity).

flags opt : TerrainBufferFlags = TerrainBufferFlags.Default

The terrain buffer flags to use.

stage opt : IRenderStage own = null

The render stage to use. If null, RenderStage.Default will be used. A full frame will be rendered when IRenderable.Render is called.

returns → TerrainMesh

The TerrainMesh object, owned by this widget.

Discards the current terrain view (see Terrain) and creates own TerrainBuffer, TerrainMesh and TerrainView objects, based on the given options.

Elevation values of the given mesh heightmap (see MeshOptions.Heightmap) are interpreted as relative offsets to the ellipsoid surface.

ValidatingException

If the given meshOptions in are invalid.

GeorefException

If MeshOptions.Geometry is null and the given geo-reference is not suitable.

RenderException

If a graphics subsystem error has occurred.

Terrain​Set

public method TerrainSet → (1)

terrain in : TerrainView own

The terrain view to use or null to clear.

Sets the current terrain view (see Terrain).

RenderException

If a graphics subsystem error has occurred.

Public / Attributes

Camera​Azerty

public attribute CameraAzerty → (get,set)

value : bool

true to use the alternative binding, false to use the default one.

Use the alternative key binding for free camera control?

The default value is false.

See also

CameraControlFree

Terrain

[OwnerValue]
public attribute Terrain → (get)

value : TerrainView

The terrain view object or null.

The current terrain view.

See also

TerrainViewWidget.TerrainCreate
TerrainViewWidget.TerrainSet

Configuration

Config

public static attribute Config → (get)

value : IConfigurator<IWidget>

[not-null]
The configurator object.

The configurator object for this type.