UltraGlobe

Appearance

@jdultra/ultra-globe

@jdultra/ultra-globe / ShadowsLayer

Class: ShadowsLayer ​

Defined in: layers/shadows/ShadowsLayer.d.ts:1

Base class implemented by all layers.

Extends ​

Constructors ​

Constructor ​

new ShadowsLayer(properties?): ShadowsLayer

Defined in: layers/shadows/ShadowsLayer.d.ts:2

Parameters ​

properties? ​

Object

Returns ​

ShadowsLayer

Overrides ​

Layer.constructor

Properties ​

altitude ​

altitude: number

Defined in: layers/shadows/ShadowsLayer.d.ts:6

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

csm ​

csm: CSM | undefined

Defined in: layers/shadows/ShadowsLayer.d.ts:10

debug ​

debug: any

Defined in: layers/shadows/ShadowsLayer.d.ts:4

helper ​

helper: CSMHelper | null | undefined

Defined in: layers/shadows/ShadowsLayer.d.ts:8

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

isSelectable ​

isSelectable: boolean

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

Inherited from ​

Layer.isSelectable

isShadowLayer ​

isShadowLayer: boolean

Defined in: layers/shadows/ShadowsLayer.d.ts:3

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

properties ​

properties: Object

Defined in: layers/shadows/ShadowsLayer.d.ts:5

shadowRT ​

shadowRT: any

Defined in: layers/shadows/ShadowsLayer.d.ts:11

shadowUniforms ​

shadowUniforms: { shadowMap: any; shadowMapUniform: any; cascadeMatrices: any[]; cascadeSplits: any[]; cascadeCount: any; shadowFar: any; shadowMapSize: any; lightDirection: any; } | null | undefined

Defined in: layers/shadows/ShadowsLayer.d.ts:12

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

getRenderTarget() ​

getRenderTarget(): any

Defined in: layers/shadows/ShadowsLayer.d.ts:22

Returns ​

any

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

renderShadows() ​

renderShadows(renderer, scene, clear?): void

Defined in: layers/shadows/ShadowsLayer.d.ts:23

Parameters ​

renderer ​

any

scene ​

any

clear? ​

boolean

Returns ​

void

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