Class VisibleTileSet

constructor

• new VisibleTileSet(m_frustumIntersection, m_tileGeometryManager, options, m_taskQueue): VisibleTileSet

• Parameters

  • m_frustumIntersection: FrustumIntersection

  • m_tileGeometryManager: TileGeometryManager

  • options: VisibleTileSetOptions

  • m_taskQueue: TaskQueue

  Returns VisibleTileSet

allVisibleTilesLoaded

dataSourceTileList

options

maxTilesPerFrame

• get maxTilesPerFrame(): number
• Beta Internal

  Gets the maximum number of tiles that can be added to the scene per frame

  Returns number
• set maxTilesPerFrame(value): void
• Beta Internal

  Gets the maximum number of tiles that can be added to the scene per frame

  Parameters

  • value: number

  Returns void

resourceComputationType

• get resourceComputationType(): ResourceComputationType

• The way the cache usage is computed, either based on size in MB (mega bytes) or in number of tiles.

  Returns ResourceComputationType
• set resourceComputationType(computationType): void

• 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

clearTileCache

• clearTileCache(dataSource?, filter?): void

• 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: ((tile) => boolean)

    Optional tile filter

    • • (tile): boolean

      • Parameters

        • tile: Tile

        Returns boolean

  Returns void

disposePendingTiles

• disposePendingTiles(): void

• Dispose tiles that are marked for removal by @xyzmaps/harp-lrucache#LRUCache algorithm.

  Returns void

disposeTile

• disposeTile(tile): void

• Dispose a Tile from cache, 'dispose()' is also called on the tile to free its resources.

  Parameters

  • tile: Tile

  Returns void

forEachCachedTile

• forEachCachedTile(fun, dataSource?): void

• 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) => void)

    The callback function to be called.

    • • (tile): void

      • Parameters

        • tile: Tile

        Returns void

  • Optional dataSource: DataSource

    The optional DataSource reference for tiles selection.

  Returns void

forEachVisibleTile

• forEachVisibleTile(fun): void

• Process callback function [[fun]] with each visible tile in set.

  Parameters

  • fun: ((tile) => void)

    The callback function to be called.

    • • (tile): void

      • Parameters

        • tile: Tile

        Returns void

  Returns void

getCachedTile

• getCachedTile(dataSource, tileKey, offset, frameNumber): undefined | Tile

• 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 undefined | Tile

  The tile if found in cache, undefined otherwise.

getDataSourceCacheSize

• getDataSourceCacheSize(): number

• Returns cache size.

  Returns number

getNumberOfVisibleTiles

• getNumberOfVisibleTiles(): number

• Retrieves maximum number of visible tiles.

  Returns number

getRenderedTile

• getRenderedTile(dataSource, tileKey, offset?): undefined | Tile

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

  • offset: number = 0

    Tile offset.

  Returns undefined | Tile

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

getRenderedTileAtLocation

• getRenderedTileAtLocation(dataSource, geoPoint, offset?): undefined | Tile

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

  • offset: number = 0

  Returns undefined | Tile

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

getTile

• getTile(dataSource, tileKey, offset, frameNumber): undefined | Tile

• 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 undefined | Tile

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

markTilesDirty

• markTilesDirty(dataSource?, filter?): void

• 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: ((tile) => boolean)

    Optional tile filter

    • • (tile): boolean

      • Parameters

        • tile: Tile

        Returns boolean

  Returns void

removeDataSource

• removeDataSource(dataSource): void

• 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, computationType?): void

• Sets cache size.

  Parameters

  • size: number

    cache size

  • 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): void

• Sets maximum number of visible tiles.

  Parameters

  • size: number

    size of visible tiles array

  Returns void

updateClipPlanes

• updateClipPlanes(maxElevation?, minElevation?): ViewRanges

• Evaluate frustum near/far clip planes and visibility ranges.

  Parameters

  • Optional maxElevation: number

  • Optional minElevation: number

  Returns ViewRanges

updateRenderList

• updateRenderList(storageLevel, zoomLevel, dataSources, frameNumber, elevationRangeSource?): {
      viewRanges: ViewRanges;
      viewRangesChanged: boolean;
  }

• Calculates a new set of visible tiles.

  Parameters

  • storageLevel: number

    The camera storage level, see 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