Class TerrainTileManager
Hierarchy (View Summary)
- Evented
- TerrainTileManager
Index
Constructors
constructor
Parameters
- tileManager: TileManager
Returns TerrainTileManager
Properties
deltaZoom
raster-dem tiles will load for performance the actualZoom - deltaZoom zoom-level.
maxzoom
maximum zoomlevel to render the terrain.
minzoom
minimum zoomlevel to render the terrain.
tileManager
tile manager for the raster-dem source.
tileSize
render-to-texture tileSize in scene.
Methods
anyTilesAfterTime
gets whether any tiles were loaded after a specific time. This is used to update depth & coords framebuffers.
Parameters
Optionaltime: numberthe time
Returns boolean
true if any tiles came into view at or after the specified time
destruct
Returns void
findTileInCaches
Parameters
- key: string
Returns Tile | undefined
fire
Parameters
- event: string | Event
Optionalproperties: any
Returns this
freeRtt
Free render to texture cache
Parameters
OptionaltileID: OverscaledTileIDoptional, free only corresponding to tileID.
Returns void
getRenderableTiles
get a list of tiles, which are loaded and should be rendered in the current scene
Returns Tile[]
the renderable tiles
getSource
Returns Source
getSourceTile
find the covering raster-dem tile
Parameters
- tileID: OverscaledTileID
the tile to look for
OptionalsearchForDEM: booleanOptional parameter to search for (parent) source tiles with loaded dem.
Returns Tile | undefined
the tile
- tileID: OverscaledTileID
getTerrainCoords
- getTerrainCoords(
tileID: OverscaledTileID,
terrainTileRanges?: { [zoom: string]: CanonicalTileRange },
): Record<string, OverscaledTileID>Searches for the corresponding current renderable terrain-tiles
Parameters
- tileID: OverscaledTileID
the tile to look for
OptionalterrainTileRanges: { [zoom: string]: CanonicalTileRange }
Returns Record<string, OverscaledTileID>
the tiles that were found
- tileID: OverscaledTileID
getTileByID
listens
Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
- type: string
The event type
Returns boolean
trueif there is at least one registered listener for specified event type,falseotherwise- type: string
off
Removes a previously registered event listener.
Parameters
- type: string
The event type to remove listeners for.
- listener: Listener
The listener function to remove.
Returns this
- type: string
on
Adds a listener to a specified event type.
Parameters
- type: string
The event type to add a listen for.
- listener: Listener
The function to be called when the event is fired. The listener function is called with the data object passed to
fire, extended withtargetandtypeproperties.
Returns Subscription
- type: string
once
Adds a listener that will be called only once to a specified event type.
The listener will be called first time the event fires after the listener is registered.
Parameters
- type: string
The event type to listen for.
Optionallistener: ListenerThe function to be called when the event is fired the first time.
Returns Promise<any> | TerrainTileManager
thisor a promise if a listener is not provided- type: string
setEventedParent
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
Optionalparent: Evented | nullOptionaldata: any
Returns this
update
Load Terrain Tiles, create internal render-to-texture tiles, free GPU memory.
Parameters
- transform: ITransform
the operation to do
- terrain: Terrain
the terrain
Returns void
- transform: ITransform
Methods mixed in to other classes for event capabilities.