@jdultra/ultra-globe

---

@jdultra/ultra-globe / XYZElevationLayer

Class: XYZElevationLayer

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:1

Base constructor for all terrain elevation layers.

Extends

• ElevationLayer

Constructors

Constructor

new XYZElevationLayer(properties?): XYZElevationLayer

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:2

Parameters

properties?

Object

Returns

XYZElevationLayer

Overrides

ElevationLayer.constructor

Properties

attribution

attribution: string | null

Defined in: layers/Layer.d.ts:29

Inherited from

ElevationLayer.attribution

---

bounds

bounds: any

Defined in: layers/Layer.d.ts:26

Inherited from

ElevationLayer.bounds

---

cacheSize

cacheSize: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:9

---

centerSampling

centerSampling: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:8

---

decode

decode: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:7

---

id

id: string | number

Defined in: layers/Layer.d.ts:24

Inherited from

ElevationLayer.id

---

isElevationLayer

isElevationLayer: boolean

Defined in: layers/elevation/ElevationLayer.d.ts:35

Inherited from

ElevationLayer.isElevationLayer

---

isLayer

isLayer: boolean

Defined in: layers/Layer.d.ts:22

Inherited from

ElevationLayer.isLayer

---

isRasterLayer

isRasterLayer: boolean

Defined in: layers/RasterLayer.d.ts:21

Inherited from

ElevationLayer.isRasterLayer

---

isSelectable

isSelectable: boolean

Defined in: layers/Layer.d.ts:23

Inherited from

ElevationLayer.isSelectable

---

listeners

listeners: Object

Defined in: layers/Layer.d.ts:28

Inherited from

ElevationLayer.listeners

---

map

map: any

Defined in: layers/Layer.d.ts:92

Inherited from

ElevationLayer.map

---

maxResolution

maxResolution: number

Defined in: layers/elevation/ElevationLayer.d.ts:36

Inherited from

ElevationLayer.maxResolution

---

maxZoom

maxZoom: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:6

---

minZoom

minZoom: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:5

---

name

name: string

Defined in: layers/Layer.d.ts:25

Inherited from

ElevationLayer.name

---

paused

paused: boolean | undefined

Defined in: layers/Layer.d.ts:82

Inherited from

ElevationLayer.paused

---

tileSize

tileSize: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:4

---

urlTemplate

urlTemplate: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:3

---

useEgm96

useEgm96: boolean

Defined in: layers/elevation/ElevationLayer.d.ts:37

Inherited from

ElevationLayer.useEgm96

---

visible

visible: boolean

Defined in: layers/Layer.d.ts:27

Inherited from

ElevationLayer.visible

---

worker

worker: any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:11

Methods

addListener()

addListener(key, listener): void

Defined in: layers/Layer.d.ts:74

Adds a listener for layer events

Parameters

key

any

can be anything but should be unique

listener

Function

a function : (layer, eventType)=>{}

Returns

void

Inherited from

ElevationLayer.addListener

---

dispose()

dispose(): void

Defined in: layers/Layer.d.ts:87

disposes of any resources used by this layer

Returns

void

Inherited from

ElevationLayer.dispose

---

getBounds()

getBounds(): Box2

Defined in: layers/Layer.d.ts:62

Returns

Box2

bounds in longitude latitude (degrees)

Inherited from

ElevationLayer.getBounds

---

getCenter()

getCenter(sfct): Vector3

Defined in: layers/Layer.d.ts:37

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

Parameters

sfct

Vector3

a point to move

Returns

Vector3

the input point

Inherited from

ElevationLayer.getCenter

---

getElevation()

getElevation(bounds, width, height, geometry, skirtGeometry): Promise<any>

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:33

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

bounds

any

width

any

width resolution for the elevation

height

any

height resolution for the elevation

geometry

any

a tile's buffer geometry to be filled with actual geometry

skirtGeometry

any

a skirt geometry to be filled with actual skirts

Returns

Promise<any>

a promise for an elevation array

Overrides

ElevationLayer.getElevation

---

getID()

getID(): string | number

Defined in: layers/Layer.d.ts:42

Returns

string | number

layer id

Inherited from

ElevationLayer.getID

---

getName()

getName(): string

Defined in: layers/Layer.d.ts:47

Returns

string

layer name

Inherited from

ElevationLayer.getName

---

raycast()

raycast(raycaster): any[]

Defined in: layers/Layer.d.ts:80

raycasts through objects from this layer if the layer is selectable and if the objects are raycastable

Parameters

raycaster

Object

a three.js Raycaster

Returns

any[]

an array of selected objects

Inherited from

ElevationLayer.raycast

---

removeListener()

removeListener(key): void

Defined in: layers/Layer.d.ts:68

Removes the listener associated to the given key

Parameters

key

any

can be anything but should be unique

Returns

void

Inherited from

ElevationLayer.removeListener

---

setName()

setName(name): void

Defined in: layers/Layer.d.ts:52

change the layer name

Parameters

name

string

Returns

void

Inherited from

ElevationLayer.setName

---

setVisible()

setVisible(visible): void

Defined in: layers/Layer.d.ts:57

Modifies the layer visibility

Parameters

visible

boolean

Returns

void

Inherited from

ElevationLayer.setVisible

---

urlFor()

urlFor(z, x, y): any

Defined in: layers/elevation/xyz/XYZElevationLayer.d.ts:14

Parameters

z

any

x

any

y

any

Returns

any