Class: ObjectLayer

Constructor

new ObjectLayer(properties)

Parameters:

Name Type Description

properties

Object

Properties

Name	Type	Attributes	Default	Description
`id`	String \| Number			layer id should be unique
`name`	String			the name can be anything you want and is intended for labeling
`object`	THREE.Object3D	<optional>		a three.js object to add to the scene and georeference
`longitude`	Number	<optional>	0	(optional) longitude of the model's center point in degrees.
`latitude`	Number	<optional>	0	(optional) latitude of the model's center point in degrees.
`height`	Number	<optional>	0	(optional) height in meters above sea level.
`yaw`	Number	<optional>	0	(optional) a yaw means the original z axis points north. ccw rotation about the model's local y axis.
`pitch`	Number	<optional>	0	(optional) pitch rotates the model about it's local x axis. a pitch of 0 alligns it with the horizon, negative values tilts it downwards, positive values tilts it up.
`roll`	Number	<optional>	0	(optional) roll around the model's local z axis.
`scaleX`	Number	<optional>	1	(optional) scale on X axes.
`scaleY`	Number	<optional>	1	(optional) scale on Y axes. defaults to the scaleX property if defined.
`scaleZ`	Number	<optional>	1	(optional) scale on Z axes. defaults to the scaleX property if defined.
`visible`	Boolean	<optional>	true	layer will be rendered if true (true by default)

Source: layers/ObjectLayer.js, line 22

Extends

Layer

Methods

_updateMatrices()

Updates the object's local and world matrices.

Source: layers/ObjectLayer.js, line 110

addListener(key, listener)

Adds a listener for layer events

Parameters:

Name	Type	Description
`key`	*	can be anything but should be unique
`listener`	function	a function : (layer, eventType)=>{}

Overrides: Layer#addListener
Source: layers/Layer.js, line 98

dispose()

disposes of any resources used by this layer

Overrides: Layer#dispose
Source: layers/Layer.js, line 140

getBounds() → {THREE.Box2}

Overrides: Layer#getBounds
Source: layers/Layer.js, line 77

Returns:

bounds in longitude latitude (degrees)

Type:: THREE.Box2

getCenter(sfct) → {THREE.Vector3}

Moves a given point to this layer's center in degree longitude/latitude

Parameters:

Name	Type	Description
`sfct`	THREE.Vector3	a point to move

Overrides: Layer#getCenter
Source: layers/Layer.js, line 33

Returns:

the input point

Type:: THREE.Vector3

getID()

Overrides: Layer#getID
Source: layers/Layer.js, line 43

Returns:

layer id

getName()

Overrides: Layer#getName
Source: layers/Layer.js, line 51

Returns:

layer name

getSelectableObjects()

Get all the selectable objects of this layer.

Overrides: Layer#getSelectableObjects
Source: layers/Layer.js, line 126

Returns:

an array of ray-castable objects with a property "layer" pointing to this layer.

move(longitudeopt, latitudeopt, heightopt, yawopt, pitchopt, rollopt, scaleXopt, scaleYopt, scaleZopt)

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

Parameters:

Name	Type	Attributes	Default	Description
`longitude`	number	<optional>	0	a longitude in degrees
`latitude`	number	<optional>	0	a latitude in degrees
`height`	number	<optional>	0	a height in meters above WGS 84 sea level
`yaw`	number	<optional>	0	Yaw angle in degrees. (0 points north ccw rotation)
`pitch`	number	<optional>	0	Pitch angle in degrees (-90 to 90)
`roll`	number	<optional>	0	Roll angle in degrees.
`scaleX`	number	<optional>	1	scale on X axes.
`scaleY`	number	<optional>	1	scale on Y axes. defaults to the scaleX property if defined.
`scaleZ`	number	<optional>	1	scale on Z axes. defaults to the scaleX property if defined.

Source: layers/ObjectLayer.js, line 75

removeListener(key)

Removes the listener associated to the given key

Parameters:

Name	Type	Description
`key`	*	can be anything but should be unique

Overrides: Layer#removeListener
Source: layers/Layer.js, line 89

select(objectsToSelect) → {Boolean}

selects an object from this layer

Parameters:

Name	Type	Description
`objectsToSelect`	Object

Overrides: Layer#select
Source: layers/Layer.js, line 107

Returns:

true if the object was selected, false otherwise

Type:: Boolean

setName(name)

change the layer name

Parameters:

Name	Type	Description
`name`	String

Overrides: Layer#setName
Source: layers/Layer.js, line 59

setVisible(visible)

Modifies the layer visibility

Parameters:

Name	Type	Description
`visible`	Boolean

Overrides: Layer#setVisible
Source: layers/Layer.js, line 66

unselect(objectsToUnselect) → {Boolean}

un-selects an object from this layer

Parameters:

Name	Type	Description
`objectsToUnselect`	Object

Overrides: Layer#unselect
Source: layers/Layer.js, line 117

Returns:

true if the object was un-selected, false otherwise

Type:: Boolean