@jdultra/ultra-globe / ElevationLayer
Class: ElevationLayer
Defined in: layers/elevation/ElevationLayer.d.ts:16
Base constructor for all terrain elevation layers.
Extends
Extended by
Constructors
Constructor
new ElevationLayer(
properties):ElevationLayer
Defined in: layers/elevation/ElevationLayer.d.ts:27
Base constructor for elevation layers.
Parameters
properties
Object
Returns
ElevationLayer
Overrides
Properties
attribution
attribution:
string|null
Defined in: layers/Layer.d.ts:29
Inherited from
bounds
bounds:
any
Defined in: layers/Layer.d.ts:26
Inherited from
id
id:
string|number
Defined in: layers/Layer.d.ts:24
Inherited from
isElevationLayer
isElevationLayer:
boolean
Defined in: layers/elevation/ElevationLayer.d.ts:35
isLayer
isLayer:
boolean
Defined in: layers/Layer.d.ts:22
Inherited from
isRasterLayer
isRasterLayer:
boolean
Defined in: layers/RasterLayer.d.ts:21
Inherited from
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
Inherited from
listeners
listeners:
Object
Defined in: layers/Layer.d.ts:28
Inherited from
map
map:
any
Defined in: layers/Layer.d.ts:92
Inherited from
maxResolution
maxResolution:
number
Defined in: layers/elevation/ElevationLayer.d.ts:36
name
name:
string
Defined in: layers/Layer.d.ts:25
Inherited from
paused
paused:
boolean|undefined
Defined in: layers/Layer.d.ts:82
Inherited from
useEgm96
useEgm96:
boolean
Defined in: layers/elevation/ElevationLayer.d.ts:37
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
Inherited from
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
dispose()
dispose():
void
Defined in: layers/Layer.d.ts:87
disposes of any resources used by this layer
Returns
void
Inherited from
getBounds()
getBounds():
Box2
Defined in: layers/Layer.d.ts:62
Returns
Box2
bounds in longitude latitude (degrees)
Inherited from
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
getElevation()
getElevation(
bounds,width,height,geometry,skirtGeometry):Promise<any>
Defined in: layers/elevation/ElevationLayer.d.ts:49
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
Box2
width
number
width resolution for the elevation
height
number
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
getID()
getID():
string|number
Defined in: layers/Layer.d.ts:42
Returns
string | number
layer id
Inherited from
getName()
getName():
string
Defined in: layers/Layer.d.ts:47
Returns
string
layer name
Inherited from
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
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
setName()
setName(
name):void
Defined in: layers/Layer.d.ts:52
change the layer name
Parameters
name
string
Returns
void
Inherited from
setVisible()
setVisible(
visible):void
Defined in: layers/Layer.d.ts:57
Modifies the layer visibility
Parameters
visible
boolean
Returns
void