@jdultra/ultra-globe / Layer
Class: Layer
Defined in: layers/Layer.d.ts:4
Base class implemented by all layers.
Extended by
Constructors
Constructor
new Layer(
properties):Layer
Defined in: layers/Layer.d.ts:15
Base constructor for all layer types.
Parameters
properties
Object
Returns
Layer
Properties
attribution
attribution:
string|null
Defined in: layers/Layer.d.ts:29
bounds
bounds:
any
Defined in: layers/Layer.d.ts:26
id
id:
string|number
Defined in: layers/Layer.d.ts:24
isLayer
isLayer:
boolean
Defined in: layers/Layer.d.ts:22
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
listeners
listeners:
Object
Defined in: layers/Layer.d.ts:28
map
map:
any
Defined in: layers/Layer.d.ts:92
name
name:
string
Defined in: layers/Layer.d.ts:25
paused
paused:
boolean|undefined
Defined in: layers/Layer.d.ts:82
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
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
dispose()
dispose():
void
Defined in: layers/Layer.d.ts:87
disposes of any resources used by this layer
Returns
void
getBounds()
getBounds():
Box2
Defined in: layers/Layer.d.ts:62
Returns
Box2
bounds in longitude latitude (degrees)
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
getID()
getID():
string|number
Defined in: layers/Layer.d.ts:42
Returns
string | number
layer id
getName()
getName():
string
Defined in: layers/Layer.d.ts:47
Returns
string
layer name
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
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
setName()
setName(
name):void
Defined in: layers/Layer.d.ts:52
change the layer name
Parameters
name
string
Returns
void
setVisible()
setVisible(
visible):void
Defined in: layers/Layer.d.ts:57
Modifies the layer visibility
Parameters
visible
boolean
Returns
void