@jdultra/ultra-globe

---

@jdultra/ultra-globe / GoogleMap3DTileLayer

Class: GoogleMap3DTileLayer

Defined in: layers/object/GoogleMap3DTileLayer.d.ts:9

Google Maps 3D Tiles layer.

Thin adapter over OGC3DTileLayer that applies the Google-specific endpoint, authentication, and recommended defaults.

Extends

• OGC3DTileLayer

Constructors

Constructor

new GoogleMap3DTileLayer(properties?): GoogleMap3DTileLayer

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

Parameters

properties?

Object

Returns

GoogleMap3DTileLayer

Overrides

OGC3DTileLayer.constructor

Properties

apiKey

apiKey: string

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

---

attribution

attribution: string | null

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

Inherited from

OGC3DTileLayer.attribution

---

bounds

bounds: any

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

Inherited from

OGC3DTileLayer.bounds

---

cacheGroup

cacheGroup: number

Defined in: layers/object/OGC3DTileLayer.d.ts:96

Inherited from

OGC3DTileLayer.cacheGroup

---

floatingRoot

floatingRoot: any

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

Inherited from

OGC3DTileLayer.floatingRoot

---

id

id: string | number

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

Inherited from

OGC3DTileLayer.id

---

isGoogleMap3DTileLayer

isGoogleMap3DTileLayer: boolean

Defined in: layers/object/GoogleMap3DTileLayer.d.ts:22

---

isGoogleMaps3DTileLayer

isGoogleMaps3DTileLayer: boolean

Defined in: layers/object/GoogleMap3DTileLayer.d.ts:23

---

isGoogleMaps3DTilesLayer

isGoogleMaps3DTilesLayer: boolean

Defined in: layers/object/GoogleMap3DTileLayer.d.ts:24

---

isLayer

isLayer: boolean

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

Inherited from

OGC3DTileLayer.isLayer

---

isObjectLayer

isObjectLayer: boolean

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

Inherited from

OGC3DTileLayer.isObjectLayer

---

isOGC3DTileLayer

isOGC3DTileLayer: boolean

Defined in: layers/object/OGC3DTileLayer.d.ts:94

Inherited from

OGC3DTileLayer.isOGC3DTileLayer

---

isOverlay

isOverlay: any

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

Inherited from

OGC3DTileLayer.isOverlay

---

isSelectable

isSelectable: boolean

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

Inherited from

OGC3DTileLayer.isSelectable

---

isSplats

isSplats: boolean

Defined in: layers/object/OGC3DTileLayer.d.ts:117

If true, this layer is rendered in the map's splats scene.

Inherited from

OGC3DTileLayer.isSplats

---

listeners

listeners: Object

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

Inherited from

OGC3DTileLayer.listeners

---

map

map: any

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

Inherited from

OGC3DTileLayer.map

---

name

name: string

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

Inherited from

OGC3DTileLayer.name

---

object

object: any

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

Inherited from

OGC3DTileLayer.object

---

object3D

object3D: any

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

Inherited from

OGC3DTileLayer.object3D

---

objectType

objectType: any

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

Inherited from

OGC3DTileLayer.objectType

---

paused

paused: boolean | undefined

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

Inherited from

OGC3DTileLayer.paused

---

physics

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

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

Inherited from

OGC3DTileLayer.physics

---

physicsProps

physicsProps: any

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

Inherited from

OGC3DTileLayer.physicsProps

---

planet

planet: any

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

Inherited from

OGC3DTileLayer.planet

---

pointType

pointType: number

Defined in: layers/object/OGC3DTileLayer.d.ts:98

Inherited from

OGC3DTileLayer.pointType

---

properties

properties: Object

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

Inherited from

OGC3DTileLayer.properties

---

rotation

rotation: any

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

Inherited from

OGC3DTileLayer.rotation

---

scene

scene: any

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

Inherited from

OGC3DTileLayer.scene

---

tileLoader

tileLoader: TileLoader | undefined

Defined in: layers/object/OGC3DTileLayer.d.ts:104

Inherited from

OGC3DTileLayer.tileLoader

---

tileset

tileset: OGC3DTile | undefined

Defined in: layers/object/OGC3DTileLayer.d.ts:102

Inherited from

OGC3DTileLayer.tileset

---

visible

visible: boolean

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

Inherited from

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

OGC3DTileLayer.addListener

---

clear()

clear(): void

Defined in: layers/object/OGC3DTileLayer.d.ts:301

Clears unused cached tile contents for this layer's shared cacheGroup. Equivalent to TileLoader.clear.

Note: this affects all layers using the same cacheGroup.

Returns

void

Inherited from

OGC3DTileLayer.clear

---

dispose()

dispose(): void

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

disposes of any resources used by this layer

Returns

void

Inherited from

OGC3DTileLayer.dispose

---

getBounds()

getBounds(): Box2

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

Returns

Box2

bounds in longitude latitude (degrees)

Inherited from

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

OGC3DTileLayer.getCenter

---

getID()

getID(): string | number

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

Returns

string | number

layer id

Inherited from

OGC3DTileLayer.getID

---

getName()

getName(): string

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

Returns

string

layer name

Inherited from

OGC3DTileLayer.getName

---

getPointSize()

getPointSize(): number

Defined in: layers/object/OGC3DTileLayer.d.ts:368

Returns the multiplier applied to the automatically computed point size. The base point size is estimated from point density / geometric error, so this value is unitless and does not represent a size in meters.

Returns

number

Inherited from

OGC3DTileLayer.getPointSize

---

getTileLoader()

getTileLoader(): TileLoader | undefined

Defined in: layers/object/OGC3DTileLayer.d.ts:145

Returns the shared TileLoader for this layer's cacheGroup, if already initialized.

Important: the TileLoader is shared by all layers using the same cacheGroup. Modifying it (e.g. maxCachedItems) affects all layers in that group.

Returns

TileLoader | undefined

Inherited from

OGC3DTileLayer.getTileLoader

---

getTileset()

getTileset(): OGC3DTile | undefined

Defined in: layers/object/OGC3DTileLayer.d.ts:136

Returns the underlying OGC3DTile instance, if already initialized.

Prefer OGC3DTileLayer.whenReady if you need to ensure the tileset exists.

Returns

OGC3DTile | undefined

Inherited from

OGC3DTileLayer.getTileset

---

hideCopyright()

hideCopyright(): void

Defined in: layers/object/OGC3DTileLayer.d.ts:215

Returns

void

Inherited from

OGC3DTileLayer.hideCopyright

---

invalidate()

invalidate(path, tileIdentifier): void

Defined in: layers/object/OGC3DTileLayer.d.ts:312

Invalidates a cached tile content URL after a delay (timeout ms). Equivalent to TileLoader.invalidate.

Note: this affects all layers using the same cacheGroup.

Parameters

path

string

Content URL/path.

tileIdentifier

Tile identifier (usually a UUID).

string | number

Returns

void

Inherited from

OGC3DTileLayer.invalidate

---

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

Inherited from

OGC3DTileLayer.move

---

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

Inherited from

OGC3DTileLayer.move2

---

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

OGC3DTileLayer.raycast

---

raycastTileset()

raycastTileset(raycaster, intersects): void

Defined in: layers/object/OGC3DTileLayer.d.ts:227

Raycasts against the tileset contents (three.js style).

This is not the map selection API; this is the low-level three.js Object3D.raycast hook.

Parameters

raycaster

Raycaster

intersects

Intersection[]

Returns

void

Inherited from

OGC3DTileLayer.raycastTileset

---

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

OGC3DTileLayer.removeListener

---

setCanvasSize()

setCanvasSize(width, height): void

Defined in: layers/object/OGC3DTileLayer.d.ts:173

Sets the canvas width/height used to compute geometric error refinement.

Note: if a renderer is available, the tileset can infer the drawing buffer size automatically.

Parameters

width

number

height

number

Returns

void

Inherited from

OGC3DTileLayer.setCanvasSize

---

setClipShape()

setClipShape(clipShape?): void

Defined in: layers/object/OGC3DTileLayer.d.ts:156

Specifies a clip shape object in world space; tiles outside of the shape are not loaded.

Parameters

clipShape?

any

Clip volume.

Returns

void

Inherited from

OGC3DTileLayer.setClipShape

---

setDistanceBias()

setDistanceBias(distanceBias): void

Defined in: layers/object/OGC3DTileLayer.d.ts:213

Sets the distance bias exponent used by refinement.

Parameters

distanceBias

number

Returns

void

Inherited from

OGC3DTileLayer.setDistanceBias

---

setDownloadParallelism()

setDownloadParallelism(downloadParallelism): void

Defined in: layers/object/OGC3DTileLayer.d.ts:330

Sets the max number of concurrent downloads for the shared TileLoader.

Note: this affects all layers using the same cacheGroup.

Parameters

downloadParallelism

number

Returns

void

Inherited from

OGC3DTileLayer.setDownloadParallelism

---

setGeometricErrorMultiplier()

setGeometricErrorMultiplier(geometricErrorMultiplier): void

Defined in: layers/object/OGC3DTileLayer.d.ts:206

Sets the geometric error multiplier for the tileset.

Parameters

geometricErrorMultiplier

number

Returns

void

Inherited from

OGC3DTileLayer.setGeometricErrorMultiplier

---

setMaxCachedItems()

setMaxCachedItems(maxCachedItems): void

Defined in: layers/object/OGC3DTileLayer.d.ts:321

Sets the maximum number of cached items for the shared TileLoader.

Note: this affects all layers using the same cacheGroup.

Parameters

maxCachedItems

number

Returns

void

Inherited from

OGC3DTileLayer.setMaxCachedItems

---

setName()

setName(name): void

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

change the layer name

Parameters

name

string

Returns

void

Inherited from

OGC3DTileLayer.setName

---

setPointSize()

setPointSize(pointSize?): void

Defined in: layers/object/OGC3DTileLayer.d.ts:376

Sets the multiplier applied to the automatically computed point size. The base point size is estimated from point density / geometric error, so this value is unitless and does not represent a size in meters.

Parameters

pointSize?

number

Returns

void

Inherited from

OGC3DTileLayer.setPointSize

---

setPointType()

setPointType(pointType): void

Defined in: layers/object/OGC3DTileLayer.d.ts:292

Sets the point representation mode for this tileset at runtime.

This only affects this layer/tileset instance and does not mutate the shared TileLoader for the cacheGroup.

Parameters

pointType

number

Returns

void

Inherited from

OGC3DTileLayer.setPointType

---

setPose()

setPose(position, rotation, scale): void

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

Parameters

position

any

rotation

any

scale

any

Returns

void

Inherited from

OGC3DTileLayer.setPose

---

setSplatsContrast()

setSplatsContrast(splatsContrast): void

Defined in: layers/object/OGC3DTileLayer.d.ts:275

Sets contrast multiplier for splats.

Parameters

splatsContrast

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsContrast

---

setSplatsCPUCulling()

setSplatsCPUCulling(splatsCPUCulling): void

Defined in: layers/object/OGC3DTileLayer.d.ts:251

Enables/disables CPU culling for splats.

Parameters

splatsCPUCulling

boolean

Returns

void

Inherited from

OGC3DTileLayer.setSplatsCPUCulling

---

setSplatsCropRadius()

setSplatsCropRadius(cropRadius): void

Defined in: layers/object/OGC3DTileLayer.d.ts:239

Specifies a crop radius for splats.

Parameters

cropRadius

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsCropRadius

---

setSplatsDepthBias()

setSplatsDepthBias(depthBias): void

Defined in: layers/object/OGC3DTileLayer.d.ts:245

Sets depth bias for splats rendering (helps avoid overlap issues when overlaying splats on meshes).

Parameters

depthBias

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsDepthBias

---

setSplatsExposureEV()

setSplatsExposureEV(splatsExposureEV): void

Defined in: layers/object/OGC3DTileLayer.d.ts:263

Sets exposure compensation (EV stops) for splats.

Parameters

splatsExposureEV

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsExposureEV

---

setSplatsQuality()

setSplatsQuality(splatsQuality): void

Defined in: layers/object/OGC3DTileLayer.d.ts:257

Sets splats quality.

Parameters

splatsQuality

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsQuality

---

setSplatsSaturation()

setSplatsSaturation(splatsSaturation): void

Defined in: layers/object/OGC3DTileLayer.d.ts:269

Sets saturation multiplier for splats.

Parameters

splatsSaturation

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsSaturation

---

setSplatsSizeMultiplier()

setSplatsSizeMultiplier(sizeMultiplier): void

Defined in: layers/object/OGC3DTileLayer.d.ts:233

Specifies a size multiplier for splats.

Parameters

sizeMultiplier

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsSizeMultiplier

---

setSplatsTempTint()

setSplatsTempTint(splatsTemperature, splatsTint): void

Defined in: layers/object/OGC3DTileLayer.d.ts:282

Sets temperature and tint for splats.

Parameters

splatsTemperature

number

splatsTint

number

Returns

void

Inherited from

OGC3DTileLayer.setSplatsTempTint

---

setTileLoaderTimeout()

setTileLoaderTimeout(timeout): void

Defined in: layers/object/OGC3DTileLayer.d.ts:339

Sets the invalidate timeout (ms) for the shared TileLoader.

Note: this affects all layers using the same cacheGroup.

Parameters

timeout

number

Returns

void

Inherited from

OGC3DTileLayer.setTileLoaderTimeout

---

setTilesetPose()

setTilesetPose(position, rotation, scale): void

Defined in: layers/object/OGC3DTileLayer.d.ts:199

Sets the world-space pose of the tileset.

Note: for georeferenced positioning, prefer ObjectLayer.move / ObjectLayer.setPose. This method is exposed for API parity with OGC3DTile.

Parameters

position

Vector3

rotation

any

scale

Vector3

Returns

void

Inherited from

OGC3DTileLayer.setTilesetPose

---

setVisible()

setVisible(visible): void

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

Modifies the layer visibility

Parameters

visible

any

Returns

void

Inherited from

OGC3DTileLayer.setVisible

---

showCopyright()

showCopyright(): void

Defined in: layers/object/OGC3DTileLayer.d.ts:217

Returns

void

Inherited from

OGC3DTileLayer.showCopyright

---

update()

update(camera): { numTilesLoaded: number; numTilesRendered: number; maxLOD: number; percentageLoaded: number; } | undefined

Defined in: layers/object/OGC3DTileLayer.d.ts:182

Updates the tileset refinement state.

This is normally called automatically by the map render loop.

Parameters

camera

Camera

Returns

{ numTilesLoaded: number; numTilesRendered: number; maxLOD: number; percentageLoaded: number; } | undefined

Inherited from

OGC3DTileLayer.update

---

updateMatrices()

updateMatrices(): void

Defined in: layers/object/OGC3DTileLayer.d.ts:163

Manually updates all matrices of the tileset. Use this after transforming a tileset created with the static option.

Returns

void

Inherited from

OGC3DTileLayer.updateMatrices

---

whenReady()

whenReady(): Promise<OGC3DTile | undefined>

Defined in: layers/object/OGC3DTileLayer.d.ts:128

Ensures the layer is initialized (tileset + shared TileLoader).

This is useful when you want to call tileset/loader APIs immediately after adding the layer.

Returns

Promise<OGC3DTile | undefined>

Resolves once initialized. Resolves to undefined if the layer has no map/renderer yet.

Inherited from

OGC3DTileLayer.whenReady