maplibre · jonathanlurie · Dec 18, 2024 · Dec 18, 2024 · Dec 18, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## main
 
 ### ✨ Features and improvements
+- Add the method `.coveringTiles()` to the transform objects ([#5239](https://github.com/maplibre/maplibre-gl-js/pull/5239))
 - _...Add new stuff here..._
 
 ### 🐞 Bug fixes

diff --git a/docs/index.md b/docs/index.md
@@ -94,6 +94,6 @@ Note too that if the CSS isn't available by the first render, as soon as the CSS
 MapLibre GL JS is also distributed via UNPKG. Our latest version can installed by adding below tags this in the html `<head>`. Further instructions on how to select specific versions and semver ranges can be found on at [unpkg.com](https://unpkg.com).
 
 ```html
-<script src="https://unpkg.com/maplibre-gl@^4.7.0/dist/maplibre-gl.js"></script>
-<link href="https://unpkg.com/maplibre-gl@^4.7.0/dist/maplibre-gl.css" rel="stylesheet" />
+<script src="https://unpkg.com/maplibre-gl@^5.0.0-pre.10/dist/maplibre-gl.js"></script>
+<link href="https://unpkg.com/maplibre-gl@^5.0.0-pre.10/dist/maplibre-gl.css" rel="stylesheet" />
 ```
diff --git a/src/geo/projection/covering_tiles.ts b/src/geo/projection/covering_tiles.ts
@@ -144,12 +144,7 @@ export function coveringZoomLevel(transform: IReadonlyTransform, options: Coveri
  * Returns a list of tiles that optimally covers the screen. Adapted for globe projection.
  * Correctly handles LOD when moving over the antimeridian.
  * @param transform - The transform instance.
- * @param frustum - The covering frustum.
- * @param plane - The clipping plane used by globe transform, or null.
- * @param cameraCoord - The x, y, z position of the camera in MercatorCoordinates.
- * @param centerCoord - The x, y, z position of the center point in MercatorCoordinates.
  * @param options - Additional coveringTiles options.
- * @param details - Interface to define required helper functions.
  * @returns A list of tile coordinates, ordered by ascending distance from camera.
  */
 export function coveringTiles(transform: IReadonlyTransform, options: CoveringTilesOptions): OverscaledTileID[] {

diff --git a/src/geo/projection/globe_transform.ts b/src/geo/projection/globe_transform.ts
@@ -2,7 +2,7 @@
 import {TransformHelper} from '../transform_helper';
 import {MercatorTransform} from './mercator_transform';
 import {VerticalPerspectiveTransform} from './vertical_perspective_transform';
-import {type LngLat, type LngLatLike,} from '../lng_lat';
+import type {LngLat, LngLatLike} from '../lng_lat';
 import {lerp} from '../../util/util';
 import type {OverscaledTileID, UnwrappedTileID, CanonicalTileID} from '../../source/tile_id';
 
@@ -16,6 +16,7 @@
 import type {PaddingOptions} from '../edge_insets';
 import type {ProjectionData, ProjectionDataParams} from './projection_data';
 import type {CoveringTilesDetailsProvider} from './covering_tiles_details_provider';
+import {coveringTiles, type CoveringTilesOptions} from './covering_tiles';
 
 /**
  * Globe transform is a transform that moves between vertical perspective and mercator projections.
@@ -457,4 +458,8 @@
     getFastPathSimpleProjectionMatrix(tileID: OverscaledTileID): mat4 {
         return this.currentTransform.getFastPathSimpleProjectionMatrix(tileID);
     }
+
+    coveringTiles(options: CoveringTilesOptions): OverscaledTileID[] {
+        return coveringTiles(this, options);
+    }
 }
diff --git a/src/geo/projection/mercator_transform.ts b/src/geo/projection/mercator_transform.ts
@@ -18,6 +18,7 @@
 import type {PaddingOptions} from '../edge_insets';
 import type {ProjectionData, ProjectionDataParams} from './projection_data';
 import type {CoveringTilesDetailsProvider} from './covering_tiles_details_provider';
+import {coveringTiles, type CoveringTilesOptions} from './covering_tiles';
 
 export class MercatorTransform implements ITransform {
     private _helper: TransformHelper;
@@ -831,4 +832,8 @@
     getFastPathSimpleProjectionMatrix(tileID: OverscaledTileID): mat4 {
         return this.calculatePosMatrix(tileID);
     }
+
+    coveringTiles(options: CoveringTilesOptions): OverscaledTileID[] {
+        return coveringTiles(this, options);
+    }
 }
diff --git a/src/geo/projection/vertical_perspective_transform.ts b/src/geo/projection/vertical_perspective_transform.ts
@@ -17,6 +17,7 @@
 import type {PaddingOptions} from '../edge_insets';
 import type {ProjectionData, ProjectionDataParams} from './projection_data';
 import type {CoveringTilesDetailsProvider} from './covering_tiles_details_provider';
+import {coveringTiles, type CoveringTilesOptions} from './covering_tiles';
 
 /**
  * Describes the intersection of ray and sphere.
@@ -988,4 +989,8 @@
     getFastPathSimpleProjectionMatrix(_tileID: OverscaledTileID): mat4 {
         return undefined;
     }
+
+    coveringTiles(options: CoveringTilesOptions): OverscaledTileID[] {
+        return coveringTiles(this, options);
+    }
 }
diff --git a/src/geo/transform_interface.ts b/src/geo/transform_interface.ts
@@ -10,6 +10,7 @@ import type {PointProjection} from '../symbol/projection';
 import type {ProjectionData, ProjectionDataParams} from './projection/projection_data';
 import type {CoveringTilesDetailsProvider} from './projection/covering_tiles_details_provider';
 import type {Frustum} from '../util/primitives/frustum';
+import type {CoveringTilesOptions} from './projection/covering_tiles';
 
 export interface ITransformGetters {
     get tileSize(): number;
@@ -480,6 +481,11 @@ export interface IReadonlyTransform extends ITransformGetters {
      * Returns a tile-specific projection matrix. Used for symbol placement fast-path for mercator transform.
      */
     getFastPathSimpleProjectionMatrix(tileID: OverscaledTileID): mat4 | undefined;
+
+    /**
+     * Returns a list of tiles that optimally covers the screen.
+     */
+    coveringTiles(options: CoveringTilesOptions): OverscaledTileID[];
 }
 
 /**