@jdultra/ultra-globe / XYZImageryLayer
Class: XYZImageryLayer
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:14
XYZImageryLayer
- Extends ClipMapImageryLayer to fill the clipmap array render target by requesting XYZ tiles.
- Subclasses should implement urlFor(z,x,y) returning a tile URL (standard {z}/{x}/{y} scheme).
- Tiles are NOT cached. For each requested LOD slice we:
- compute the appropriate z (zoom) to request,
- request all xyz tiles that cover the requested bounds,
- assemble them into a temporary canvas at native tile pixels,
- crop+resample to this.textureSize and upload / blit to the arrayRenderTarget slice,
- dispose all intermediate resources and set this.lodBounds[lodIndex] = bounds.
Note: This implementation intentionally avoids persistent caching per your instructions.
Extends
Extended by
Constructors
Constructor
new XYZImageryLayer(
properties?):XYZImageryLayer
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:23
Parameters
properties?
Object
Returns
XYZImageryLayer
Inherited from
ClipMapImageryLayer.constructor
Properties
arrayRenderTarget
arrayRenderTarget:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:31
Inherited from
ClipMapImageryLayer.arrayRenderTarget
attribution
attribution:
string|null
Defined in: layers/Layer.d.ts:29
Inherited from
ClipMapImageryLayer.attribution
blitCallbacks
blitCallbacks:
any[]
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:40
bounds
bounds:
any
Defined in: layers/Layer.d.ts:26
Inherited from
drapeOnMesh
drapeOnMesh:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:11
Inherited from
ClipMapImageryLayer.drapeOnMesh
drapeOnSplats
drapeOnSplats:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:12
Inherited from
ClipMapImageryLayer.drapeOnSplats
drapeOnTerrain
drapeOnTerrain:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:13
Inherited from
ClipMapImageryLayer.drapeOnTerrain
id
id:
string|number
Defined in: layers/Layer.d.ts:24
Inherited from
isClipMapImageryLayer
isClipMapImageryLayer:
boolean
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:24
Inherited from
ClipMapImageryLayer.isClipMapImageryLayer
isLayer
isLayer:
boolean
Defined in: layers/Layer.d.ts:22
Inherited from
isProjectedImageryLayer
isProjectedImageryLayer:
boolean
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:10
Inherited from
ClipMapImageryLayer.isProjectedImageryLayer
isProjectedLayer
isProjectedLayer:
boolean
Defined in: layers/ProjectedLayer.d.ts:15
Inherited from
ClipMapImageryLayer.isProjectedLayer
isRasterLayer
isRasterLayer:
boolean
Defined in: layers/RasterLayer.d.ts:21
Inherited from
ClipMapImageryLayer.isRasterLayer
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
Inherited from
ClipMapImageryLayer.isSelectable
levels
levels:
number|undefined
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:45
Inherited from
listeners
listeners:
Object
Defined in: layers/Layer.d.ts:28
Inherited from
localBounds
localBounds:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:9
Inherited from
ClipMapImageryLayer.localBounds
lodBounds
lodBounds:
any[]
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:28
Inherited from
lodRefs
lodRefs:
any[]
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:30
Inherited from
lodScale
lodScale:
number
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:27
Inherited from
map
map:
any
Defined in: layers/Layer.d.ts:92
Inherited from
material
material:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:43
Inherited from
maxResolution
maxResolution:
number
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:26
Inherited from
ClipMapImageryLayer.maxResolution
maxZoom
maxZoom:
any
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:44
minZoom
minZoom:
any
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:43
name
name:
string
Defined in: layers/Layer.d.ts:25
Inherited from
origin
origin:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:71
Inherited from
paused
paused:
boolean|undefined
Defined in: layers/Layer.d.ts:82
Inherited from
reference
reference:
number
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:15
Inherited from
tentativeLODBounds
tentativeLODBounds:
any[]
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:29
Inherited from
ClipMapImageryLayer.tentativeLODBounds
textureLoader
textureLoader:
Object
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:24
textureSize
textureSize:
number
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:25
Inherited from
ClipMapImageryLayer.textureSize
tileSize
tileSize:
any
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:23
transform
transform:
Converter|undefined
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:8
Inherited from
transparency
transparency:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:14
Inherited from
ClipMapImageryLayer.transparency
uCameraPos
uCameraPos:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:50
Inherited from
ClipMapImageryLayer.uCameraPos
uCameraThreshold
uCameraThreshold:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:51
Inherited from
ClipMapImageryLayer.uCameraThreshold
uDrapeOnMesh
uDrapeOnMesh:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:54
Inherited from
ClipMapImageryLayer.uDrapeOnMesh
uDrapeOnSplats
uDrapeOnSplats:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:56
Inherited from
ClipMapImageryLayer.uDrapeOnSplats
uDrapeOnTerrain
uDrapeOnTerrain:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:55
Inherited from
ClipMapImageryLayer.uDrapeOnTerrain
uLodBoundsArray
uLodBoundsArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:57
Inherited from
ClipMapImageryLayer.uLodBoundsArray
uNumLevels
uNumLevels:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:52
Inherited from
ClipMapImageryLayer.uNumLevels
uOffset
uOffset:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:49
Inherited from
uOpacity
uOpacity:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:47
Inherited from
uRefEArray
uRefEArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:62
Inherited from
ClipMapImageryLayer.uRefEArray
uReference
uReference:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:48
Inherited from
ClipMapImageryLayer.uReference
uRefKxArray
uRefKxArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:60
Inherited from
ClipMapImageryLayer.uRefKxArray
uRefKyArray
uRefKyArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:61
Inherited from
ClipMapImageryLayer.uRefKyArray
uRefLocalUvMaxArray
uRefLocalUvMaxArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:67
Inherited from
ClipMapImageryLayer.uRefLocalUvMaxArray
uRefLocalUvMinArray
uRefLocalUvMinArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:66
Inherited from
ClipMapImageryLayer.uRefLocalUvMinArray
uRefMinLocalArray
uRefMinLocalArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:64
Inherited from
ClipMapImageryLayer.uRefMinLocalArray
uRefNArray
uRefNArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:63
Inherited from
ClipMapImageryLayer.uRefNArray
uRefOriginDeg
uRefOriginDeg:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:53
Inherited from
ClipMapImageryLayer.uRefOriginDeg
uRefSLatArray
uRefSLatArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:59
Inherited from
ClipMapImageryLayer.uRefSLatArray
uRefSLonArray
uRefSLonArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:58
Inherited from
ClipMapImageryLayer.uRefSLonArray
uRefSpanLocalArray
uRefSpanLocalArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:65
Inherited from
ClipMapImageryLayer.uRefSpanLocalArray
urlTemplate
urlTemplate:
any
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:22
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
Inherited from
zoomExageration
zoomExageration:
any
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:45
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
ClipMapImageryLayer.addListener
dispose()
dispose():
void
Defined in: layers/Layer.d.ts:87
disposes of any resources used by this layer
Returns
void
Inherited from
getBounds()
getBounds():
Box2
Defined in: layers/Layer.d.ts:62
Returns
Box2
bounds in longitude latitude (degrees)
Inherited from
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
getID()
getID():
string|number
Defined in: layers/Layer.d.ts:42
Returns
string | number
layer id
Inherited from
getName()
getName():
string
Defined in: layers/Layer.d.ts:47
Returns
string
layer name
Inherited from
getTarget()
getTarget(
needsDepthBuffer?):any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:84
Parameters
needsDepthBuffer?
boolean
Returns
any
Inherited from
getTextureBoundsAndReference()
getTextureBoundsAndReference():
Object
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:60
Returns
Object
invalidate()
invalidate():
void
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:83
Returns
void
Inherited from
ClipMapImageryLayer.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
ClipMapImageryLayer.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
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
ClipMapImageryLayer.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
setLODBounds()
setLODBounds(
lodIndex,bounds):void
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:85
Parameters
lodIndex
any
bounds
any
Returns
void
Inherited from
ClipMapImageryLayer.setLODBounds
setName()
setName(
name):void
Defined in: layers/Layer.d.ts:52
change the layer name
Parameters
name
string
Returns
void
Inherited from
setVisible()
setVisible(
visible):void
Defined in: layers/Layer.d.ts:57
Modifies the layer visibility
Parameters
visible
boolean
Returns
void
Inherited from
ClipMapImageryLayer.setVisible
urlFor()
urlFor(
z,x,y):void
Defined in: layers/imagery/xyz/XYZImageryLayer.d.ts:54
Subclasses MUST provide urlFor(z,x,y) returning a tile URL string.
Parameters
z
any
x
any
y
any
Returns
void