On this page

Interface CoveringTilesDetailsProvider

interface CoveringTilesDetailsProvider {
    allowVariableZoom: (
        transform: IReadonlyTransform,
        options: CoveringTilesOptionsInternal,
    ) => boolean;
    allowWorldCopies: () => boolean;
    distanceToTile2d: (
        pointX: number,
        pointY: number,
        tileID: { x: number; y: number; z: number },
        boundingVolume: IBoundingVolume,
    ) => number;
    getTileBoundingVolume: (
        tileID: { x: number; y: number; z: number },
        wrap: number,
        elevation: number,
        options: CoveringTilesOptionsInternal,
    ) => IBoundingVolume;
    getWrap: (
        centerCoord: MercatorCoordinate,
        tileID: { x: number; y: number; z: number },
        parentWrap: number,
    ) => number;
    prepareNextFrame(): void;
}
Index

Properties

allowVariableZoom: (
    transform: IReadonlyTransform,
    options: CoveringTilesOptionsInternal,
) => boolean

Whether to allow variable zoom, which is used at high pitch angle to avoid loading an excessive amount of tiles.

allowWorldCopies: () => boolean

Whether to allow world copies to be rendered.

distanceToTile2d: (
    pointX: number,
    pointY: number,
    tileID: { x: number; y: number; z: number },
    boundingVolume: IBoundingVolume,
) => number

Returns the distance from the point to the tile

Type Declaration

    • (
          pointX: number,
          pointY: number,
          tileID: { x: number; y: number; z: number },
          boundingVolume: IBoundingVolume,
      ): number
    • Parameters

      • pointX: number

        point x.

      • pointY: number

        point y.

      • tileID: { x: number; y: number; z: number }

        Tile x, y and z for zoom.

      • boundingVolume: IBoundingVolume

        tile bounding volume

      Returns number

getTileBoundingVolume: (
    tileID: { x: number; y: number; z: number },
    wrap: number,
    elevation: number,
    options: CoveringTilesOptionsInternal,
) => IBoundingVolume

Returns the bounding volume of the specified tile.

Type Declaration

getWrap: (
    centerCoord: MercatorCoordinate,
    tileID: { x: number; y: number; z: number },
    parentWrap: number,
) => number

Returns the wrap value for a given tile.

Methods

  • Prepare cache for the next frame.

    Returns void

Was this helpful?
SDK JS
Reference
CoveringTilesDetailsProvider