Skip to content

@jdultra/ultra-globe


@jdultra/ultra-globe / RasterLayer

Class: RasterLayer

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

Base class for layers where the data is stored in 2D rasters

Extends

Extended by

Constructors

Constructor

new RasterLayer(properties): RasterLayer

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

Base constructor for layers where the information is stored in 2D rasters

Parameters

properties

Object

Returns

RasterLayer

Overrides

Layer.constructor

Properties

attribution

attribution: string | null

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

Inherited from

Layer.attribution


bounds

bounds: any

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

Inherited from

Layer.bounds


id

id: string | number

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

Inherited from

Layer.id


isLayer

isLayer: boolean

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

Inherited from

Layer.isLayer


isRasterLayer

isRasterLayer: boolean

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


isSelectable

isSelectable: boolean

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

Inherited from

Layer.isSelectable


listeners

listeners: Object

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

Inherited from

Layer.listeners


map

map: any

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

Inherited from

Layer.map


name

name: string

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

Inherited from

Layer.name


paused

paused: boolean | undefined

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

Inherited from

Layer.paused


visible

visible: boolean

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

Inherited from

Layer.visible

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

Layer.addListener


dispose()

dispose(): void

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

disposes of any resources used by this layer

Returns

void

Inherited from

Layer.dispose


getBounds()

getBounds(): Box2

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

Returns

Box2

bounds in longitude latitude (degrees)

Inherited from

Layer.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

Layer.getCenter


getID()

getID(): string | number

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

Returns

string | number

layer id

Inherited from

Layer.getID


getName()

getName(): string

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

Returns

string

layer name

Inherited from

Layer.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

Layer.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

Layer.removeListener


setName()

setName(name): void

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

change the layer name

Parameters

name

string

Returns

void

Inherited from

Layer.setName


setVisible()

setVisible(visible): void

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

Modifies the layer visibility

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible