@jdultra/ultra-globe / ClipMapImageryLayer
Class: ClipMapImageryLayer
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:22
Base layer for Clipmap imagery (WebGPU version). Clipmap imagery layers cache rasters in concentric rings around the camera at different LODs.
Param
Param
layer id should be unique
Param
the name can be anything you want and is intended for labeling
Param
the layer's transparency (0 to 1)
Param
layer will be rendered if true (true by default)
Param
imagery crs (only 4326 and 3857)
Param
texture size per side in pixels
Param
meters per pixel at the equator target for the finest LOD
Param
child-to-parent LOD footprint scale factor r in (0,1). For r=0.5 each child covers half the parent's width.
Param
drapes on mesh (and point-cloud) if true.
Param
drapes on splats if true.
Param
drapes on terrain if true.
Param
min longitude, min latitude, max longitude, max latitude in degrees. If undefined, computed from properties.localBounds and defaults to entire globe if localBounds is undefined
Param
min x, min y, max x, max y in local CRS (properties.epsg). If undefined, computed from properties.bounds and defaults to entire globe if localBounds is undefined
Extends
Extended by
Constructors
Constructor
new ClipMapImageryLayer(
properties?):ClipMapImageryLayer
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:23
Parameters
properties?
Object
Returns
ClipMapImageryLayer
Overrides
ProjectedImageryLayer.constructor
Properties
arrayRenderTarget
arrayRenderTarget:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:31
attribution
attribution:
string|null
Defined in: layers/Layer.d.ts:29
Inherited from
ProjectedImageryLayer.attribution
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
ProjectedImageryLayer.drapeOnMesh
drapeOnSplats
drapeOnSplats:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:12
Inherited from
ProjectedImageryLayer.drapeOnSplats
drapeOnTerrain
drapeOnTerrain:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:13
Inherited from
ProjectedImageryLayer.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
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
ProjectedImageryLayer.isProjectedImageryLayer
isProjectedLayer
isProjectedLayer:
boolean
Defined in: layers/ProjectedLayer.d.ts:15
Inherited from
ProjectedImageryLayer.isProjectedLayer
isRasterLayer
isRasterLayer:
boolean
Defined in: layers/RasterLayer.d.ts:21
Inherited from
ProjectedImageryLayer.isRasterLayer
isSelectable
isSelectable:
boolean
Defined in: layers/Layer.d.ts:23
Inherited from
ProjectedImageryLayer.isSelectable
levels
levels:
number|undefined
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:45
listeners
listeners:
Object
Defined in: layers/Layer.d.ts:28
Inherited from
ProjectedImageryLayer.listeners
localBounds
localBounds:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:9
Inherited from
ProjectedImageryLayer.localBounds
lodBounds
lodBounds:
any[]
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:28
lodRefs
lodRefs:
any[]
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:30
lodScale
lodScale:
number
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:27
map
map:
any
Defined in: layers/Layer.d.ts:92
Inherited from
material
material:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:43
maxResolution
maxResolution:
number
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:26
name
name:
string
Defined in: layers/Layer.d.ts:25
Inherited from
origin
origin:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:71
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
ProjectedImageryLayer.reference
tentativeLODBounds
tentativeLODBounds:
any[]
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:29
textureSize
textureSize:
number
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:25
transform
transform:
Converter|undefined
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:8
Inherited from
ProjectedImageryLayer.transform
transparency
transparency:
any
Defined in: layers/imagery/ProjectedImageryLayer.d.ts:14
Inherited from
ProjectedImageryLayer.transparency
uCameraPos
uCameraPos:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:50
uCameraThreshold
uCameraThreshold:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:51
uDrapeOnMesh
uDrapeOnMesh:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:54
uDrapeOnSplats
uDrapeOnSplats:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:56
uDrapeOnTerrain
uDrapeOnTerrain:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:55
uLodBoundsArray
uLodBoundsArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:57
uNumLevels
uNumLevels:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:52
uOffset
uOffset:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:49
uOpacity
uOpacity:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:47
uRefEArray
uRefEArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:62
uReference
uReference:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:48
uRefKxArray
uRefKxArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:60
uRefKyArray
uRefKyArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:61
uRefLocalUvMaxArray
uRefLocalUvMaxArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:67
uRefLocalUvMinArray
uRefLocalUvMinArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:66
uRefMinLocalArray
uRefMinLocalArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:64
uRefNArray
uRefNArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:63
uRefOriginDeg
uRefOriginDeg:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:53
uRefSLatArray
uRefSLatArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:59
uRefSLonArray
uRefSLonArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:58
uRefSpanLocalArray
uRefSpanLocalArray:
any
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:65
visible
visible:
boolean
Defined in: layers/Layer.d.ts:27
Inherited from
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
ProjectedImageryLayer.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
ProjectedImageryLayer.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
ProjectedImageryLayer.getCenter
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
invalidate()
invalidate():
void
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:83
Returns
void
loadLODTexture()
loadLODTexture(
lodIndex,bounds):Promise<any>
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:82
Parameters
lodIndex
any
bounds
any
Returns
Promise<any>
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
ProjectedImageryLayer.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
Overrides
setLODBounds()
setLODBounds(
lodIndex,bounds):void
Defined in: layers/imagery/ClipMapImageryLayer.d.ts:85
Parameters
lodIndex
any
bounds
any
Returns
void
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