Class: PerlinElevationLayer

Constructor

new PerlinElevationLayer(properties)

Base constructor for elevation layers.

Parameters:

Name Type Description

properties

Object

Properties

Name	Type	Attributes	Default	Description
`id`	String \| Number			layer id should be unique
`name`	String			the name can be anything you want and is intended for labeling
`minHeight`	Number			min terrain height relative to sea level
`maxHeight`	Number			max terrain height relative to sea level
`bounds`	Array.<Number>	<optional>	[-180, -90, 180, 90]	min longitude, min latitude, max longitude, max latitude in degrees
`visible`	Boolean	<optional>	true	layer will be rendered if true (true by default)

Source: layers/PerlinElevationLayer.js, line 65

Extends

ElevationLayer

Methods

_simpleMeshFromElevation(bounds, width, height, extendedElevation, geometry, skirtGeometry) → {Promise(THREE.Vector3)}

A default mesh generation function given some elevation.

Parameters:

Name	Type	Description
`bounds`	THREE.Box2
`width`	Number
`height`	Number
`extendedElevation`	Array.<Number>	elevation array extended by 1 in all directions (for correct normals on the edges)
`geometry`	THREE.BufferGeometry
`skirtGeometry`	THREE.BufferGeometry

Overrides: ElevationLayer#_simpleMeshFromElevation
Source: layers/ElevationLayer.js, line 99

Returns:

the shift to apply to the tile (for numerical stability)

Type:: Promise(THREE.Vector3)

_simpleMeshFromElevationAsync(bounds, width, height, extendedElevation, geometry, skirtGeometry) → {Promise(THREE.Vector3)}

A default mesh generation function given some elevation using web workers.

Parameters:

Name	Type	Description
`bounds`	THREE.Box2
`width`	Number
`height`	Number
`extendedElevation`	Array.<Number>	elevation array extended by 1 in all directions (for correct normals on the edges)
`geometry`	THREE.BufferGeometry
`skirtGeometry`	THREE.BufferGeometry

Overrides: ElevationLayer#_simpleMeshFromElevationAsync
Source: layers/ElevationLayer.js, line 123

Returns:

the shift to apply to the tile (for numerical stability)

Type:: Promise(THREE.Vector3)

_trimEdges(arr, width, height)

Trims the edges of an elevation array by 1 on all sides

Parameters:

Name	Type	Description
`arr`	*	elevation array width+2 height+2
`width`	*	the desired width
`height`	*	the desired height

Overrides: ElevationLayer#_trimEdges
Source: layers/ElevationLayer.js, line 157

Returns:

the trimmed array

addListener(key, listener)

Adds a listener for layer events

Parameters:

Name	Type	Description
`key`	*	can be anything but should be unique
`listener`	function	a function : (layer, eventType)=>{}

Overrides: ElevationLayer#addListener
Source: layers/Layer.js, line 98

dispose()

disposes of any resources used by this layer

Overrides: ElevationLayer#dispose
Source: layers/Layer.js, line 140

getBounds() → {THREE.Box2}

Overrides: ElevationLayer#getBounds
Source: layers/Layer.js, line 77

Returns:

bounds in longitude latitude (degrees)

Type:: THREE.Box2

getCenter(sfct) → {THREE.Vector3}

Moves a given point to this layer's center in degree longitude/latitude

Parameters:

Name	Type	Description
`sfct`	THREE.Vector3	a point to move

Overrides: ElevationLayer#getCenter
Source: layers/Layer.js, line 33

Returns:

the input point

Type:: THREE.Vector3

getElevation(bounds, width, height, geometry, skirtGeometry) → {Promise}

Returns a 2D elevation array and populates a tile's geometry and skirtGeometry. The generated geometry does not have to match the elevation array exactly. It can represent overhanging features for example but the elevation array is expected to correspond at least roughly to the geometry's highest points.

Parameters:

Name	Type	Description
`bounds`	THREE.Box2
`width`	Number	width resolution for the elevation
`height`	Number	height resolution for the elevation
`geometry`	THREE.BufferGeometry \| undefined	a tile's buffer geometry to be filled with actual geometry
`skirtGeometry`	THREE.BufferGeometry \| undefined	a skirt geometry to be filled with actual skirts