@jdultra/ultra-globe

---

@jdultra/ultra-globe / ObjectLayer

Class: ObjectLayer

Defined in: layers/object/ObjectLayer.d.ts:6

A layer for loading and geolocating a three.js Object3D.

Extends

• Layer

Extended by

• OGC3DTileLayer

Constructors

Constructor

new ObjectLayer(properties): ObjectLayer

Defined in: layers/object/ObjectLayer.d.ts:11

Parameters

properties

Object

(params same as original...)

Returns

ObjectLayer

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

---

floatingRoot

floatingRoot: any

Defined in: layers/object/ObjectLayer.d.ts:18

---

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

---

isObjectLayer

isObjectLayer: boolean

Defined in: layers/object/ObjectLayer.d.ts:14

---

isOverlay

isOverlay: any

Defined in: layers/object/ObjectLayer.d.ts:13

---

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

---

object

object: any

Defined in: layers/object/ObjectLayer.d.ts:16

---

object3D

object3D: any

Defined in: layers/object/ObjectLayer.d.ts:17

---

objectType

objectType: any

Defined in: layers/object/ObjectLayer.d.ts:15

---

paused

paused: boolean | undefined

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

Inherited from

Layer.paused

---

physics

physics: { sim: any; rigidBodyID: any; colliderIDs: never[]; } | undefined

Defined in: layers/object/ObjectLayer.d.ts:21

---

physicsProps

physicsProps: any

Defined in: layers/object/ObjectLayer.d.ts:20

---

planet

planet: any

Defined in: layers/object/ObjectLayer.d.ts:40

---

properties

properties: Object

Defined in: layers/object/ObjectLayer.d.ts:19

---

rotation

rotation: any

Defined in: layers/object/ObjectLayer.d.ts:12

---

scene

scene: any

Defined in: layers/object/ObjectLayer.d.ts:41

---

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

---

move()

move(longitude?, latitude?, height?, yaw?, pitch?, roll?, scaleX?, scaleY?, scaleZ?): void

Defined in: layers/object/ObjectLayer.d.ts:35

Sets the object position and orientation based on Longitude, Latitude, Height, Yaw, Pitch, Roll

Parameters

longitude?

number

latitude?

number

height?

number

yaw?

number

pitch?

number

roll?

number

scaleX?

number

scaleY?

number

scaleZ?

number

Returns

void

---

move2()

move2(longitude?, latitude?, height?, targetLongitude?, targetLatitude?, targetHeight?, scaleX?, scaleY?, scaleZ?): void

Defined in: layers/object/ObjectLayer.d.ts:36

Parameters

longitude?

number

latitude?

number

height?

number

targetLongitude?

number

targetLatitude?

number

targetHeight?

number

scaleX?

number

scaleY?

number

scaleZ?

number

Returns

void

---

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

---

setPose()

setPose(position, rotation, scale): void

Defined in: layers/object/ObjectLayer.d.ts:37

Parameters

position

any

rotation

any

scale

any

Returns

void

---

setVisible()

setVisible(visible): void

Defined in: layers/object/ObjectLayer.d.ts:42

Modifies the layer visibility

Parameters

visible

any

Returns

void

Overrides

Layer.setVisible