Class TerrainOptions

public shape of the accessors this class declares itself

Hierarchy (View Summary)

Accessors
BaseNative<any, TerrainOptionsOptions>
Accessors
Omit<
    Methods,
    | "getDataSource"
    | "getElevation"
    | "getElevations"
    | "getSurfaceColorParameter"
    | "getSurfaceParameter"
    | "getSurfaceShaderSource"
    | "setSurfaceColorParameter"
    | "setSurfaceParameter"
    | "setSurfaceShaderSource",
>
Omit<
    Methods,
    | "getDataSource"
    | "getElevation"
    | "getElevations"
    | "getSurfaceColorParameter"
    | "getSurfaceParameter"
    | "getSurfaceShaderSource"
    | "setSurfaceColorParameter"
    | "setSurfaceParameter"
    | "setSurfaceShaderSource",
>
- TerrainOptions

Index

Constructors

Methods

dispose getBackgroundColor getBillboardOcclusionTolerance getCameraClampDuration getCameraClearance getDataSource getDepthBias getDrapeResolution getElevation getElevationDecoder getElevations getExaggeration getMaxTileZoomCoarsening getMaxTileZoomOffset getMeshResolution getMinZoom getNative getNoDrapeLayerFilter getSurfaceColorParameter getSurfaceParameter getSurfaceShaderSource getViewDistance getViewDistanceFactor initNativeView isBackgroundBitmapEnabled isBillboardOcclusionEnabled isDrapeFillsEnabled isDrapeLinesEnabled isElevationPrefetchEnabled isEnabled isSeamlessTileEdgesEnabled isTileEdgeStitchingEnabled setBackgroundBitmapEnabled setBackgroundColor setBillboardOcclusionEnabled setBillboardOcclusionTolerance setCameraClampDuration setCameraClearance setDepthBias setDrapeFillsEnabled setDrapeLinesEnabled setDrapeResolution setElevationPrefetchEnabled setEnabled setExaggeration setMaxTileZoomCoarsening setMaxTileZoomOffset setMeshResolution setMinZoom setNoDrapeLayerFilter setSeamlessTileEdgesEnabled setSurfaceColorParameter setSurfaceParameter setSurfaceShaderSource setTileEdgeStitchingEnabled setViewDistance setViewDistanceFactor

Constructors

constructor

new TerrainOptions(options: TerrainOptionsOptions, native?: any): TerrainOptions
Parameters
- options: TerrainOptionsOptions
- Optionalnative: any
Returns TerrainOptions
Inherited from BaseNative.constructor
- Defined in packages/ui-massifmaps/components/index.d.ts:62

Properties

backgroundBitmapEnabled

backgroundBitmapEnabled: boolean

backgroundColor

backgroundColor: string | Color

billboardOcclusionEnabled

billboardOcclusionEnabled: boolean

billboardOcclusionTolerance

billboardOcclusionTolerance: number

cameraClampDuration

cameraClampDuration: number

cameraClearance

cameraClearance: number

depthBias

depthBias: number

drapeFillsEnabled

drapeFillsEnabled: boolean

drapeLinesEnabled

drapeLinesEnabled: boolean

drapeResolution

drapeResolution: number

duringInit

duringInit: boolean

elevationPrefetchEnabled

elevationPrefetchEnabled: boolean

enabled

enabled: boolean

exaggeration

exaggeration: number

maxTileZoomCoarsening

maxTileZoomCoarsening: number

maxTileZoomOffset

maxTileZoomOffset: number

meshResolution

meshResolution: number

minZoom

minZoom: number

native

native: any

noDrapeLayerFilter

noDrapeLayerFilter: string

options

options: TerrainOptionsOptions

seamlessTileEdgesEnabled

seamlessTileEdgesEnabled: boolean

surfaceShaderSource

surfaceShaderSource: string

tileEdgeStitchingEnabled

tileEdgeStitchingEnabled: boolean

viewDistance

viewDistance: number

viewDistanceFactor

viewDistanceFactor: number

Methods

dispose

dispose(): any
Returns any
Inherited from BaseNative.dispose
- Defined in packages/ui-massifmaps/index.d.ts:21

getBackgroundColor

getBackgroundColor(): Color
Returns Color
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:6

getBillboardOcclusionTolerance

getBillboardOcclusionTolerance(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:7

getCameraClampDuration

getCameraClampDuration(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:8

getCameraClearance

getCameraClearance(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:9

getDataSource

getDataSource(): any
Returns any
- Defined in packages/ui-massifmaps/components/index.d.ts:63

getDepthBias

getDepthBias(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:11

getDrapeResolution

getDrapeResolution(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:12

getElevation

getElevation<T = DefaultLatLonKeys>(pos: GenericMapPos<T>): number
metres above sea level, or 0 where no tile is loaded yet
Type Parameters
- T = DefaultLatLonKeys
Parameters
- pos: GenericMapPos<T>
Returns number
- Defined in packages/ui-massifmaps/components/index.d.ts:66

getElevationDecoder

getElevationDecoder(): any
Returns any
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:14

getElevations

getElevations<T = DefaultLatLonKeys>(
poses: MapPosVector<T> | GenericMapPos<T>[],
): number[]
Type Parameters
- T = DefaultLatLonKeys
Parameters
- poses: MapPosVector<T> | GenericMapPos<T>[]
Returns number[]
- Defined in packages/ui-massifmaps/components/index.d.ts:67

getExaggeration

getExaggeration(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:16

getMaxTileZoomCoarsening

getMaxTileZoomCoarsening(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:17

getMaxTileZoomOffset

getMaxTileZoomOffset(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:18

getMeshResolution

getMeshResolution(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:19

getMinZoom

getMinZoom(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:20

getNative

getNative(): any
Returns any
Inherited from BaseNative.getNative
- Defined in packages/ui-massifmaps/index.d.ts:20

getNoDrapeLayerFilter

getNoDrapeLayerFilter(): string
Returns string
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:21

getSurfaceColorParameter

getSurfaceColorParameter(name: string): Color
Parameters
- name: string
Returns Color
- Defined in packages/ui-massifmaps/components/index.d.ts:73

getSurfaceParameter

getSurfaceParameter(name: string): number
Parameters
- name: string
Returns number
- Defined in packages/ui-massifmaps/components/index.d.ts:71

getSurfaceShaderSource

getSurfaceShaderSource(): string
Returns string
- Defined in packages/ui-massifmaps/components/index.d.ts:75

getViewDistance

getViewDistance(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:25

getViewDistanceFactor

getViewDistanceFactor(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:26

initNativeView

initNativeView(native: any, options: TerrainOptionsOptions): void
Parameters
- native: any
- options: TerrainOptionsOptions
Returns void
Inherited from BaseNative.initNativeView
- Defined in packages/ui-massifmaps/index.d.ts:19

isBackgroundBitmapEnabled

isBackgroundBitmapEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:27

isBillboardOcclusionEnabled

isBillboardOcclusionEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:28

isDrapeFillsEnabled

isDrapeFillsEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:29

isDrapeLinesEnabled

isDrapeLinesEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:30

isElevationPrefetchEnabled

isElevationPrefetchEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:31

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:32

isSeamlessTileEdgesEnabled

isSeamlessTileEdgesEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:33

isTileEdgeStitchingEnabled

isTileEdgeStitchingEnabled(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:34

setBackgroundBitmapEnabled

setBackgroundBitmapEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:35

setBackgroundColor

setBackgroundColor(arg0: string | Color): void
Parameters
- arg0: string | Color
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:36

setBillboardOcclusionEnabled

setBillboardOcclusionEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:37

setBillboardOcclusionTolerance

setBillboardOcclusionTolerance(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:38

setCameraClampDuration

setCameraClampDuration(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:39

setCameraClearance

setCameraClearance(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:40

setDepthBias

setDepthBias(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:41

setDrapeFillsEnabled

setDrapeFillsEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:42

setDrapeLinesEnabled

setDrapeLinesEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:43

setDrapeResolution

setDrapeResolution(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:44

setElevationPrefetchEnabled

setElevationPrefetchEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:45

setEnabled

setEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:46

setExaggeration

setExaggeration(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:47

setMaxTileZoomCoarsening

setMaxTileZoomCoarsening(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:48

setMaxTileZoomOffset

setMaxTileZoomOffset(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:49

setMeshResolution

setMeshResolution(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:50

setMinZoom

setMinZoom(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:51

setNoDrapeLayerFilter

setNoDrapeLayerFilter(arg0: string): void
Parameters
- arg0: string
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:52

setSeamlessTileEdgesEnabled

setSeamlessTileEdgesEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:53

setSurfaceColorParameter

setSurfaceColorParameter(name: string, color: string | Color): void
Parameters
- name: string
- color: string | Color
Returns void
- Defined in packages/ui-massifmaps/components/index.d.ts:72

setSurfaceParameter

setSurfaceParameter(name: string, value: number): void
uniforms for a custom surface shader
Parameters
- name: string
- value: number
Returns void
- Defined in packages/ui-massifmaps/components/index.d.ts:70

setSurfaceShaderSource

setSurfaceShaderSource(source: string): void
Parameters
- source: string
Returns void
- Defined in packages/ui-massifmaps/components/index.d.ts:74

setTileEdgeStitchingEnabled

setTileEdgeStitchingEnabled(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:57

setViewDistance

setViewDistance(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:58

setViewDistanceFactor

setViewDistanceFactor(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/components/TerrainOptions.d.ts:59

Class TerrainOptions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TerrainOptions

Properties

backgroundBitmapEnabled

backgroundColor

billboardOcclusionEnabled

billboardOcclusionTolerance

cameraClampDuration

cameraClearance

depthBias

drapeFillsEnabled

drapeLinesEnabled

drapeResolution

duringInit

elevationPrefetchEnabled

enabled

exaggeration

maxTileZoomCoarsening

maxTileZoomOffset

meshResolution

minZoom

native

noDrapeLayerFilter

options

seamlessTileEdgesEnabled

surfaceShaderSource

tileEdgeStitchingEnabled

viewDistance

viewDistanceFactor

Methods

dispose

Returns any

getBackgroundColor

Returns Color

getBillboardOcclusionTolerance

Returns number

getCameraClampDuration

Returns number

getCameraClearance

Returns number

getDataSource

Returns any

getDepthBias

Returns number

getDrapeResolution

Returns number

getElevation

Type Parameters

Parameters

Returns number

getElevationDecoder

Returns any

getElevations

Type Parameters

Parameters

Returns number[]

getExaggeration

Returns number

getMaxTileZoomCoarsening

Returns number

getMaxTileZoomOffset

Returns number

getMeshResolution

Returns number

getMinZoom

Returns number

getNative

Returns any

getNoDrapeLayerFilter

Returns string

getSurfaceColorParameter

Parameters