Class: OGC3DTilesLayer

Constructor

new OGC3DTilesLayer(properties, scaleXopt, scaleYopt, scaleZopt, yawopt, pitchopt, rollopt)

Parameters:

Name Type Attributes Default 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
`url`	String			url of the root tileset.json
`displayCopyright`	Boolean	<optional>	false	(optional) display copyright information when present in tiles by concatenating all copyright info for all displayed tiles
`displayErrors`	Boolean	<optional>	false	(optional) display loading errors
`proxy`	Boolean	<optional>		(optional) the url to a proxy service. Instead of fetching tiles via a GET request, a POST will be sent to the proxy url with the real tile address in the body of the request.
`queryParams`	Boolean	<optional>		(optional) path params to add to individual tile urls (starts with "?").

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.

yaw number <optional> 0 Yaw angle in degrees. (0 means local z axis points north ccw rotation)

pitch number <optional> 0 Pitch angle in degrees (0 means the x-z plane alligns with the horizon )

roll number <optional> 0 Roll angle in degrees. (ccw rotation about the local z axis)

properties.geometricErrorMultiplier Number <optional> 1 (optional) between 0 and infinity, defaults to 1. controls the level of detail.

properties.longitude Number <optional> 0 (optional) longitude of the model's center point in degrees.

properties.latitude Number <optional> 0 (optional) latitude of the model's center point in degrees.

properties.height Number <optional> 0 (optional) height in meters above sea level.

properties.loadOutsideView Boolean <optional> false (optional) if true, will load tiles outside the view at the lowest possible LOD.

properties.selectable Boolean <optional> false (optional) if true, the tileset can be selected.

properties.bounds Array.<Number> <optional> [-180, -90, 180, 90] min longitude, min latitude, max longitude, max latitude in degrees

properties.visible Boolean <optional> true layer will be rendered if true (true by default)

properties.loadingStrategy String <optional> "INCREMENTAL" loading strategy, "INCREMENTAL" (default) or "IMMEDIATE". "IMMEDIATE" mode loads only the ideal LOD while "INCREMENTAL" loads intermediate LODs.

properties.updateCallback function <optional> A callback called on every tileset update with a stats object indicating number of tiles loaded/visualized, max loaded LOD, and percentage of the tileset loaded

Source: layers/OGC3DTilesLayer.js, line 26

Extends

Layer

Methods

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/OGC3DTilesLayer.js, line 338

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