@jdultra/ultra-globe

---

@jdultra/ultra-globe / OSMImageryLayer

Class: OSMImageryLayer

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:6

OSMImageryLayer2

• Adapter for OpenStreetMap-compatible XYZ tile services.
• Supports {z}/{x}/{y} templates and optional {s} subdomains.

Extends

• XYZImageryLayer

Constructors

Constructor

new OSMImageryLayer(properties?): OSMImageryLayer

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:23

Parameters

properties?

Object

Returns

OSMImageryLayer

Inherited from

XYZImageryLayer.constructor

Properties

apiKey

apiKey: any

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:9

---

apiKeyParamName

apiKeyParamName: any

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:10

---

arrayRenderTarget

arrayRenderTarget: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:31

Inherited from

XYZImageryLayer.arrayRenderTarget

---

attribution

attribution: any

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:11

Overrides

XYZImageryLayer.attribution

---

blitCallbacks

blitCallbacks: any[]

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:40

Inherited from

XYZImageryLayer.blitCallbacks

---

bounds

bounds: any

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

Inherited from

XYZImageryLayer.bounds

---

drapeOnMesh

drapeOnMesh: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:11

Inherited from

XYZImageryLayer.drapeOnMesh

---

drapeOnSplats

drapeOnSplats: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:12

Inherited from

XYZImageryLayer.drapeOnSplats

---

drapeOnTerrain

drapeOnTerrain: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:13

Inherited from

XYZImageryLayer.drapeOnTerrain

---

id

id: string | number

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

Inherited from

XYZImageryLayer.id

---

isClipMapImageryLayer

isClipMapImageryLayer: boolean

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:24

Inherited from

XYZImageryLayer.isClipMapImageryLayer

---

isLayer

isLayer: boolean

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

Inherited from

XYZImageryLayer.isLayer

---

isProjectedImageryLayer

isProjectedImageryLayer: boolean

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:10

Inherited from

XYZImageryLayer.isProjectedImageryLayer

---

isProjectedLayer

isProjectedLayer: boolean

Defined in: layers/ProjectedLayer.d.ts:15

Inherited from

XYZImageryLayer.isProjectedLayer

---

isRasterLayer

isRasterLayer: boolean

Defined in: layers/RasterLayer.d.ts:21

Inherited from

XYZImageryLayer.isRasterLayer

---

isSelectable

isSelectable: boolean

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

Inherited from

XYZImageryLayer.isSelectable

---

levels

levels: number | undefined

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:45

Inherited from

XYZImageryLayer.levels

---

listeners

listeners: Object

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

Inherited from

XYZImageryLayer.listeners

---

localBounds

localBounds: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:9

Inherited from

XYZImageryLayer.localBounds

---

lodBounds

lodBounds: any[]

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:28

Inherited from

XYZImageryLayer.lodBounds

---

lodRefs

lodRefs: any[]

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:30

Inherited from

XYZImageryLayer.lodRefs

---

lodScale

lodScale: number

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:27

Inherited from

XYZImageryLayer.lodScale

---

map

map: any

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

Inherited from

XYZImageryLayer.map

---

material

material: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:43

Inherited from

XYZImageryLayer.material

---

maxResolution

maxResolution: number

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:26

Inherited from

XYZImageryLayer.maxResolution

---

maxZoom

maxZoom: any

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:44

Inherited from

XYZImageryLayer.maxZoom

---

minZoom

minZoom: any

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:43

Inherited from

XYZImageryLayer.minZoom

---

name

name: string

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

Inherited from

XYZImageryLayer.name

---

origin

origin: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:71

Inherited from

XYZImageryLayer.origin

---

paused

paused: boolean | undefined

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

Inherited from

XYZImageryLayer.paused

---

providerTemplate

providerTemplate: any

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:7

---

reference

reference: number

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:15

Inherited from

XYZImageryLayer.reference

---

subdomains

subdomains: any

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:8

---

tentativeLODBounds

tentativeLODBounds: any[]

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:29

Inherited from

XYZImageryLayer.tentativeLODBounds

---

textureLoader

textureLoader: Object

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:24

Inherited from

XYZImageryLayer.textureLoader

---

textureSize

textureSize: number

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:25

Inherited from

XYZImageryLayer.textureSize

---

tileSize

tileSize: any

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:23

Inherited from

XYZImageryLayer.tileSize

---

transform

transform: Converter | undefined

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:8

Inherited from

XYZImageryLayer.transform

---

transparency

transparency: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:14

Inherited from

XYZImageryLayer.transparency

---

uCameraPos

uCameraPos: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:50

Inherited from

XYZImageryLayer.uCameraPos

---

uCameraThreshold

uCameraThreshold: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:51

Inherited from

XYZImageryLayer.uCameraThreshold

---

uDrapeOnMesh

uDrapeOnMesh: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:54

Inherited from

XYZImageryLayer.uDrapeOnMesh

---

uDrapeOnSplats

uDrapeOnSplats: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:56

Inherited from

XYZImageryLayer.uDrapeOnSplats

---

uDrapeOnTerrain

uDrapeOnTerrain: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:55

Inherited from

XYZImageryLayer.uDrapeOnTerrain

---

uLodBoundsArray

uLodBoundsArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:57

Inherited from

XYZImageryLayer.uLodBoundsArray

---

uNumLevels

uNumLevels: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:52

Inherited from

XYZImageryLayer.uNumLevels

---

uOffset

uOffset: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:49

Inherited from

XYZImageryLayer.uOffset

---

uOpacity

uOpacity: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:47

Inherited from

XYZImageryLayer.uOpacity

---

uRefEArray

uRefEArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:62

Inherited from

XYZImageryLayer.uRefEArray

---

uReference

uReference: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:48

Inherited from

XYZImageryLayer.uReference

---

uRefKxArray

uRefKxArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:60

Inherited from

XYZImageryLayer.uRefKxArray

---

uRefKyArray

uRefKyArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:61

Inherited from

XYZImageryLayer.uRefKyArray

---

uRefLocalUvMaxArray

uRefLocalUvMaxArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:67

Inherited from

XYZImageryLayer.uRefLocalUvMaxArray

---

uRefLocalUvMinArray

uRefLocalUvMinArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:66

Inherited from

XYZImageryLayer.uRefLocalUvMinArray

---

uRefMinLocalArray

uRefMinLocalArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:64

Inherited from

XYZImageryLayer.uRefMinLocalArray

---

uRefNArray

uRefNArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:63

Inherited from

XYZImageryLayer.uRefNArray

---

uRefOriginDeg

uRefOriginDeg: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:53

Inherited from

XYZImageryLayer.uRefOriginDeg

---

uRefSLatArray

uRefSLatArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:59

Inherited from

XYZImageryLayer.uRefSLatArray

---

uRefSLonArray

uRefSLonArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:58

Inherited from

XYZImageryLayer.uRefSLonArray

---

uRefSpanLocalArray

uRefSpanLocalArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:65

Inherited from

XYZImageryLayer.uRefSpanLocalArray

---

urlTemplate

urlTemplate: any

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:22

Inherited from

XYZImageryLayer.urlTemplate

---

visible

visible: boolean

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

Inherited from

XYZImageryLayer.visible

---

zoomExageration

zoomExageration: any

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:45

Inherited from

XYZImageryLayer.zoomExageration

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

XYZImageryLayer.addListener

---

dispose()

dispose(): void

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

disposes of any resources used by this layer

Returns

void

Inherited from

XYZImageryLayer.dispose

---

getBounds()

getBounds(): Box2

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

Returns

Box2

bounds in longitude latitude (degrees)

Inherited from

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

XYZImageryLayer.getCenter

---

getID()

getID(): string | number

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

Returns

string | number

layer id

Inherited from

XYZImageryLayer.getID

---

getName()

getName(): string

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

Returns

string

layer name

Inherited from

XYZImageryLayer.getName

---

getTarget()

getTarget(needsDepthBuffer?): any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:84

Parameters

needsDepthBuffer?

boolean

Returns

any

Inherited from

XYZImageryLayer.getTarget

---

getTextureBoundsAndReference()

getTextureBoundsAndReference(): Object

Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:60

Returns

Object

Inherited from

XYZImageryLayer.getTextureBoundsAndReference

---

invalidate()

invalidate(): void

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:83

Returns

void

Inherited from

XYZImageryLayer.invalidate

---

loadLODTexture()

loadLODTexture(lodIndex, bounds): Promise<any>

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:82

Parameters

lodIndex

any

bounds

any

Returns

Promise<any>

Inherited from

XYZImageryLayer.loadLODTexture

---

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

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

XYZImageryLayer.removeListener

---

render()

render(colorTexture, normalTexture, emissiveTexture, metalnessRoughnessTexture, positionTexture, renderTarget): boolean

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:100

Render imagery into a render target using the provided position texture. Subclasses must implement this method.

Parameters

colorTexture

any

normalTexture

any

emissiveTexture

any

metalnessRoughnessTexture

any

positionTexture

any

renderTarget

any

Returns

boolean

Inherited from

XYZImageryLayer.render

---

setLODBounds()

setLODBounds(lodIndex, bounds): void

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:85

Parameters

lodIndex

any

bounds

any

Returns

void

Inherited from

XYZImageryLayer.setLODBounds

---

setName()

setName(name): void

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

change the layer name

Parameters

name

string

Returns

void

Inherited from

XYZImageryLayer.setName

---

setVisible()

setVisible(visible): void

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

Modifies the layer visibility

Parameters

visible

boolean

Returns

void

Inherited from

XYZImageryLayer.setVisible

---

urlFor()

urlFor(z, x, y): any

Defined in: layers/imagery/xyz/OSMImageryLayer.d.ts:12

Subclasses MUST provide urlFor(z,x,y) returning a tile URL string.

Parameters

z

any

x

any

y

any

Returns

any

Overrides

XYZImageryLayer.urlFor