OpenGlobus v1.0.0-rc27

RgbTerrain

Extends: GlobusTerrain

Source: RgbTerrain.ts:71

Constructor

new RgbTerrain( name?: string, options?: IRgbTerrainParams, ): RgbTerrain

Parameters

  • name (string, optional, default: "\"RgbTerrain\"") — Terrain provider name.
  • options (IRgbTerrainParams, optional) — Provider options:
    • options.equalizeNormals (boolean, optional, default: true) — Enables normal equalization on tile edges.
    • options.key (string, optional, default: "\"\"") — API key.
    • options.imageSize (number, optional, default: 256) — Source image size.
    • options.minHeight (number, optional, default: -10000) — Minimal height for RGB-to-height conversion.
    • options.resolution (number, optional, default: 0.1) — RGB-to-height conversion resolution.
    • options.encoding (RgbTerrainEncoding, optional, default: "\"rgb\"") — RGB elevation encoding: "rgb" (default) or "terrarium". Ignored when options.rgbToHeightFunc is set.
    • options.rgbToHeightFunc (RgbToHeightFunc, optional) — Custom RGB-to-height decoder with signature (r, g, b, minHeight, resolution) => number. Defaults to rgbToHeightByEncoding[options.encoding].

Instance Methods

abortLoading()

GlobusTerrain.ts:326

Inherited from GlobusTerrain#abortLoading

Overrides: GlobusTerrain#abortLoading

Stop loading.

setUrl(url: string)

GlobusTerrain.ts:337

Inherited from GlobusTerrain#setUrl

Overrides: GlobusTerrain#setUrl

Sets terrain data url template.

Parameters

  • url (string) — Url template.

Example

Default openglobus url template:

CODE
:
"https://{s}.srtm3.openglobus.org/{z}/{y}/{x}.ddm"

setName(name: string)

GlobusTerrain.ts:346

Inherited from GlobusTerrain#setName

Overrides: GlobusTerrain#setName

Sets provider name.

Parameters

  • name (string) — Name.

loadTerrain(segment: Segment, forceLoading?: boolean)

GlobusTerrain.ts:360

Inherited from GlobusTerrain#loadTerrain

Overrides: GlobusTerrain#loadTerrain

Starts to load segment elevation data.

Parameters

  • segment (Segment) — Segment that requests terrain data.
  • forceLoading (boolean, optional, default: false) — Forces loading even if default filter would skip it.

_createUrl(segment: Segment): string

protected
GlobusTerrain.ts:444

Inherited from GlobusTerrain#_createUrl

Overrides: GlobusTerrain#_createUrl

Creates default query url string.

Parameters

  • segment (Segment) — Segment to create URL for.

Returns

  • string — URL string.

_getHTTPRequestString(segment: Segment): string

protected
GlobusTerrain.ts:454

Inherited from GlobusTerrain#_getHTTPRequestString

Overrides: GlobusTerrain#_getHTTPRequestString

Returns actual url query string.

Parameters

  • segment (Segment) — Segment that loads terrain data.

Returns

  • string — URL string.

setUrlRewriteCallback(ur: UrlRewriteFunc)

GlobusTerrain.ts:470

Inherited from GlobusTerrain#setUrlRewriteCallback

Overrides: GlobusTerrain#setUrlRewriteCallback

Sets url rewrite callback, used for custom url rewriting for every tile loading.

Parameters

  • ur (UrlRewriteFunc) — The callback that returns tile custom created url.

_createHeights(): Array.<number> | TypedArray

GlobusTerrain.ts:479

Inherited from GlobusTerrain#_createHeights

Overrides: GlobusTerrain#_createHeights

Converts loaded data to segment elevation data type(column major elevation data array in meters)

Returns

  • Array.<number> | TypedArray — Column-major elevation data array in meters.

_applyElevationsData()

protected
GlobusTerrain.ts:502

Inherited from GlobusTerrain#_applyElevationsData

Overrides: GlobusTerrain#_applyElevationsData

setAttribution(html: string)

EmptyTerrain.ts:217

Inherited from EmptyTerrain#setAttribution

Overrides: GlobusTerrain#setAttribution

Sets terrain provider attribution text.

Parameters

  • html (string) — HTML string that represents terrain provider attribution.

getAttribution(): string

EmptyTerrain.ts:229

Inherited from EmptyTerrain#getAttribution

Overrides: GlobusTerrain#getAttribution

Gets terrain provider attribution.

Returns

  • string — Terrain provider attribution.

handleSegmentTerrain(segment: Segment)

EmptyTerrain.ts:287

Inherited from EmptyTerrain#handleSegmentTerrain

Overrides: GlobusTerrain#handleSegmentTerrain

Loads or creates segment elevation data.

Parameters

  • segment (Segment) — Segment to create elevation data.

Instance Fields

iconSrc

EmptyTerrain.ts:238

Inherited from EmptyTerrain#iconSrc

Overrides: GlobusTerrain#iconSrc

Gets terrain provider icon.

Returns

  • string | null — Icon source.