Class: GlobusTerrain

new GlobusTerrain(nameopt, optionsopt, gridSizeByZoomopt, heightFactoropt)

Parameters:

Name Type Attributes Default Description

name

string

Terrain provider name.

options

IGlobusTerrainParams

Provider options:

Properties

Name	Type	Attributes	Default	Description
`minZoom`	number	<optional>	3	Minimal visible zoom index when terrain handler works.
`minZoom`	number	<optional>	14	Maximal visible zoom index when terrain handler works.
`minNativeZoom`	number	<optional>	14	Maximal available terrain zoom level.
`url`	string	<optional>	"//openglobus.org/heights/srtm3/{z}/{y}/{x}.ddm"	Terrain source path url template. Default is openglobus ddm elevation file.
`gridSizeByZoom`	Array.<number>	<optional>		Array of segment triangulation grid sizes where array index agreed to the segment zoom index.
`plainGridSize`	number	<optional>	32	Elevation grid size. Default is 32x32. Must be power of two.
`responseType`	string	<optional>	"arraybuffer"	Response type.
`MAX_LOADING_TILES`	number	<optional>		Maximum at one time loading tiles.

gridSizeByZoom

Array.<number>

Array of values, where each value corresponds to the size of a tile(or segment) on the globe. Each value must be power of two.

heightFactor

number

Elevation height multiplier.

Deprecated: Use GlobusRgbTerrain Class that loads segment elevation data, converts it to the array and passes it to the planet segment.
Source: terrain/GlobusTerrain.ts, line 30

Fires:

GlobusTerrainEvents#event:load
GlobusTerrainEvents#event:loadend

Extends

GlobusTerrain

Methods

(protected) _applyElevationsData()

Overrides: GlobusTerrain#_applyElevationsData
Source: terrain/GlobusTerrain.ts, line 466

_createHeights() → {Array.<number>}

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

Overrides: GlobusTerrain#_createHeights
Source: terrain/GlobusTerrain.ts, line 450

Returns:

Type:: Array.<number>

(protected) _createUrl(segment) → {string}

Creates default query url string.

Parameters:

Name	Type	Description
`segment`	Segment

Overrides: GlobusTerrain#_createUrl
Source: terrain/GlobusTerrain.ts, line 417

Returns:

Type:: string

(protected) _getHTTPRequestString(segment) → {string}

Returns actual url query string.

Parameters:

Name	Type	Description
`segment`	Segment	Segment that loads image data.

Overrides: GlobusTerrain#_getHTTPRequestString
Source: terrain/GlobusTerrain.ts, line 427

Returns:

Url string.

Type:: string

abortLoading()

Stop loading.

Overrides: GlobusTerrain#abortLoading
Source: terrain/GlobusTerrain.ts, line 305

loadTerrain(segment, forceLoadingopt)

Starts to load segment elevation data.

Parameters:

Name	Type	Attributes	Default	Description
`segment`	Segment			Segment that wants a terrain data.
`forceLoading`	boolean	<optional>	false

Overrides: GlobusTerrain#loadTerrain
Source: terrain/GlobusTerrain.ts, line 337

setName(name)

Sets provider name.

Parameters:

Name	Type	Description
`name`	string	Name.

Overrides: GlobusTerrain#setName
Source: terrain/GlobusTerrain.ts, line 324

setUrl(url)

Sets terrain data url template.

Parameters:

Name	Type	Description
`url`	string	Url template.

Overrides: GlobusTerrain#setUrl
Source: terrain/GlobusTerrain.ts, line 313

Example

<caption>Default openglobus url template:</caption>:
"http://earth3.openglobus.org/{z}/{y}/{x}.ddm"

setUrlRewriteCallback(ur)

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

Parameters:

Name	Type	Description
`ur`	UrlRewriteFunc	The callback that returns tile custom created url.

Overrides: GlobusTerrain#setUrlRewriteCallback
Source: terrain/GlobusTerrain.ts, line 441