VisibleTileSet | harp.gl

Manages visible Tiles for MapView.

Responsible for election of rendered tiles:

quad-tree traversal
frustum culling
sorting tiles by relevance (visible area) to prioritize load
limiting number of visible tiles
caching tiles
searching cache to replace visible but yet empty tiles with already loaded siblings in nearby zoom levels

Hierarchy

VisibleTileSet

Index

Constructors

constructor

new VisibleTileSet(m_frustumIntersection: FrustumIntersection, m_tileGeometryManager: TileGeometryManager, options: VisibleTileSetOptions, m_taskQueue: TaskQueue): VisibleTileSet

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:422
Parameters
- m_frustumIntersection: FrustumIntersection
- m_tileGeometryManager: TileGeometryManager
- options: VisibleTileSetOptions
- m_taskQueue: TaskQueue
Returns VisibleTileSet

Properties

allVisibleTilesLoaded

allVisibleTilesLoaded: boolean = false

dataSourceTileList

dataSourceTileList: DataSourceTileList[] = []

options

options: VisibleTileSetOptions

Accessors

maxTilesPerFrame

get maxTilesPerFrame(): number
set maxTilesPerFrame(value: number): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:487
Gets the maximum number of tiles that can be added to the scene per frame

beta

internal

Returns number
- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:497
Gets the maximum number of tiles that can be added to the scene per frame

beta

internal

Parameters
- value: number
Returns void

resourceComputationType

get resourceComputationType(): ResourceComputationType
set resourceComputationType(computationType: ResourceComputationType): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:508
The way the cache usage is computed, either based on size in MB (mega bytes) or in number of tiles.

Cache may be either keeping number of elements stored or the memory consumed by them.

Returns ResourceComputationType
- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:520
Sets the way tile cache is managing its elements.

Cache may be either keeping number of elements stored or the memory consumed by them.

Parameters
- computationType: ResourceComputationType
  
  Type of algorith used in cache for checking full saturation, may be counting number of elements or memory consumed by them.
Returns void

Methods

clearTileCache

clearTileCache(dataSource?: DataSource, filter?: undefined | ((tile: Tile) => boolean)): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:826
Clear the tile cache.

Remove the Tile objects created by cacheable DataSource. If a DataSource name is provided, this method restricts the eviction the DataSource with the given name.

Parameters
- Optional dataSource: DataSource
- Optional filter: undefined | ((tile: Tile) => boolean)
  
  Optional tile filter
Returns void

disposePendingTiles

disposePendingTiles(): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:867
Dispose tiles that are marked for removal by {@link @here/harp-lrucache#LRUCache} algorithm.

Returns void

disposeTile

disposeTile(tile: Tile): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:898
Dispose a Tile from cache, 'dispose()' is also called on the tile to free its resources.

Parameters
- tile: Tile
Returns void

forEachCachedTile

forEachCachedTile(fun: (tile: Tile) => void, dataSource?: DataSource): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:891
Process callback function [[fun]] with each tile in the cache.

Optional dataSource parameter limits processing to the tiles that belongs to DataSource passed in.

Parameters
- fun: (tile: Tile) => void
  
  The callback function to be called.
  - - (tile: Tile): void
    - Parameters
      - tile: Tile
      Returns void
- Optional dataSource: DataSource
  
  The optional DataSource reference for tiles selection.
Returns void

forEachVisibleTile

forEachVisibleTile(fun: (tile: Tile) => void): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:876
Process callback function [[fun]] with each visible tile in set.

Parameters
- fun: (tile: Tile) => void
  
  The callback function to be called.
  - - (tile: Tile): void
    - Parameters
      - tile: Tile
      Returns void
Returns void

getCachedTile

getCachedTile(dataSource: DataSource, tileKey: TileKey, offset: number, frameNumber: number): Tile | undefined

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:691
Gets the tile corresponding to the given data source, key and offset from the cache.

Parameters
- dataSource: DataSource
  
  The data source the tile belongs to.
- tileKey: TileKey
  
  The key identifying the tile.
- offset: number
  
  Tile offset.
- frameNumber: number
  
  Frame in which the tile was requested
Returns Tile | undefined

The tile if found in cache, undefined otherwise.

getDataSourceCacheSize

getDataSourceCacheSize(): number

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:445
Returns cache size.

Returns number

getNumberOfVisibleTiles

getNumberOfVisibleTiles(): number

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:469
Retrieves maximum number of visible tiles.

Returns number

getRenderedTile

getRenderedTile(dataSource: DataSource, tileKey: TileKey, offset?: number): Tile | undefined

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:710
Gets the tile corresponding to the given data source, key and offset from the rendered tiles.

Parameters
- dataSource: DataSource
  
  The data source the tile belongs to.
- tileKey: TileKey
  
  The key identifying the tile.
- Default value offset: number = 0
  
  Tile offset.
Returns Tile | undefined

The tile if found among the rendered tiles, undefined otherwise.

getRenderedTileAtLocation

getRenderedTileAtLocation(dataSource: DataSource, geoPoint: GeoCoordinates, offset?: number): Tile | undefined

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:735
Gets the tile corresponding to the given data source and location from the rendered tiles.

Parameters
- dataSource: DataSource
  
  The data source the tile belongs to.
- geoPoint: GeoCoordinates
  
  The geolocation included within the tile.
- Default value offset: number = 0
Returns Tile | undefined

The tile if found among the rendered tiles, undefined otherwise.

getTile

getTile(dataSource: DataSource, tileKey: TileKey, offset: number, frameNumber: number): Tile | undefined

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:672
Gets the tile corresponding to the given data source, key and offset, creating it if necessary.

Parameters
- dataSource: DataSource
  
  The data source the tile belongs to.
- tileKey: TileKey
  
  The key identifying the tile.
- offset: number
  
  Tile offset.
- frameNumber: number
  
  Frame in which the tile was requested
Returns Tile | undefined

The tile if it was found or created, undefined otherwise.

markTilesDirty

markTilesDirty(dataSource?: DataSource, filter?: undefined | ((tile: Tile) => boolean)): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:850
Visit each tile in visible, rendered, and cached sets.
- Visible and temporarily rendered tiles will be marked for update and retained.
- Cached but not rendered/visible will be evicted.
Parameters
- Optional dataSource: DataSource
  
  If passed, only the tiles from this DataSource instance are processed. If undefined, tiles from all DataSources are processed.
- Optional filter: undefined | ((tile: Tile) => boolean)
  
  Optional tile filter
Returns void

removeDataSource

removeDataSource(dataSource: DataSource): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:808
Removes all internal bookkeeping entries and cache related to specified datasource.

Called by MapView when DataSource has been removed from MapView.

Parameters
- dataSource: DataSource
Returns void

setDataSourceCacheSize

setDataSourceCacheSize(size: number, computationType?: ResourceComputationType): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:457
Sets cache size.

Parameters
- size: number
  
  cache size
- Default value computationType: ResourceComputationType = ResourceComputationType.EstimationInMb
  
  Optional value specifying the way a Tiles cache usage is computed, either based on size in MB (mega bytes) or in number of tiles. Defaults to ResourceComputationType.EstimationInMb.
Returns void

setNumberOfVisibleTiles

setNumberOfVisibleTiles(size: number): void

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:478
Sets maximum number of visible tiles.

Parameters
- size: number
  
  size of visible tiles array
Returns void

updateClipPlanes

updateClipPlanes(maxElevation?: undefined | number, minElevation?: undefined | number): ViewRanges

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:528
Evaluate frustum near/far clip planes and visibility ranges.

Parameters
- Optional maxElevation: undefined | number
- Optional minElevation: undefined | number
Returns ViewRanges

updateRenderList

updateRenderList(storageLevel: number, zoomLevel: number, dataSources: DataSource[], frameNumber: number, elevationRangeSource?: ElevationRangeSource): { viewRanges: ViewRanges; viewRangesChanged: boolean }

- Defined in @here/harp-mapview/lib/VisibleTileSet.ts:552
Calculates a new set of visible tiles.

Parameters
- storageLevel: number
  
  The camera storage level, see MapView.storageLevel.
- zoomLevel: number
  
  The camera zoom level.
- dataSources: DataSource[]
  
  The data sources for which the visible tiles will be calculated.
- frameNumber: number
- Optional elevationRangeSource: ElevationRangeSource
  
  Source of elevation range data if any.
Returns { viewRanges: ViewRanges; viewRangesChanged: boolean }

view ranges and their status since last update (changed or not).
- viewRanges: ViewRanges
- viewRangesChanged: boolean

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

m_frustumIntersection: FrustumIntersection

m_tileGeometryManager: TileGeometryManager

options: VisibleTileSetOptions

m_taskQueue: TaskQueue

Returns VisibleTileSet

Properties

allVisibleTilesLoaded

dataSourceTileList

options

Accessors

maxTilesPerFrame

Returns number

Parameters

value: number

Returns void

resourceComputationType

Returns ResourceComputationType

Parameters

computationType: ResourceComputationType

Returns void

Methods

clearTileCache

Parameters

Optional dataSource: DataSource

Optional filter: undefined | ((tile: Tile) => boolean)

Returns void

disposePendingTiles

Returns void

disposeTile

Parameters

tile: Tile

Returns void

forEachCachedTile

Parameters

fun: (tile: Tile) => void

Parameters

tile: Tile

Returns void

Optional dataSource: DataSource

Returns void

forEachVisibleTile

Parameters

fun: (tile: Tile) => void

Parameters

tile: Tile

Returns void

Returns void

getCachedTile

Parameters

dataSource: DataSource

tileKey: TileKey

offset: number

frameNumber: number

Returns Tile | undefined

getDataSourceCacheSize

Returns number

getNumberOfVisibleTiles

Returns number

getRenderedTile

Parameters

dataSource: DataSource

tileKey: TileKey

Default value offset: number = 0

Returns Tile | undefined

getRenderedTileAtLocation

Parameters

dataSource: DataSource

geoPoint: GeoCoordinates

Default value offset: number = 0

Returns Tile | undefined

getTile