fix: ProjectionDataParams no longer requires OverscaledTileID instance

Author: kubapelc

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### 🐞 Bug fixes
 - Fix `Popup` not updating its position when switching between terrain/globe projections ([#7468](https://github.com/maplibre/maplibre-gl-js/pull/7468)) (by [@CommanderStorm](https://github.com/CommanderStorm))
+- Fix `ProjectionDataParams` requiring an `OverscaledTileID` instance, even though the class is only exported as a type ([#7471](https://github.com/maplibre/maplibre-gl-js/pull/7471))
 
 ## 5.23.0
 

src/geo/projection/globe_transform.test.ts

@@ -54,6 +54,17 @@ describe('GlobeTransform', () => {
             const projectionData = globeTransform.getProjectionData({overscaledTileID: new OverscaledTileID(1, 0, 1, 1, 0), applyGlobeMatrix: true});
             expect(projectionData.projectionTransition).not.toBe(0);
         });
+
+        test('OverscaledTileID instance is not required', () => {
+            const projectionData = globeTransform.getProjectionData({overscaledTileID: {
+                canonical: {
+                    x: 1,
+                    y: 0,
+                    z: 1,
+                },
+            }});
+            expectToBeCloseToArray(projectionData.tileMercatorCoords, [0.5, 0, 0.5 / EXTENT, 0.5 / EXTENT]);
+        });
     });
 
     describe('clipping plane', () => {

src/geo/projection/mercator_transform.test.ts

@@ -1,14 +1,15 @@
 import {describe, test, expect} from 'vitest';
 import Point from '@mapbox/point-geometry';
 import {LngLat} from '../lng_lat';
-import {CanonicalTileID, UnwrappedTileID} from '../../tile/tile_id';
+import {CanonicalTileID, OverscaledTileID, UnwrappedTileID} from '../../tile/tile_id';
 import {fixedLngLat, fixedCoord} from '../../../test/unit/lib/fixed';
 import type {Terrain} from '../../render/terrain';
 import {MercatorTransform} from './mercator_transform';
 import {LngLatBounds} from '../lng_lat_bounds';
 import {getMercatorHorizon} from './mercator_utils';
 import {mat4} from 'gl-matrix';
 import {expectToBeCloseToArray} from '../../util/test/util';
+import {EXTENT} from '../../data/extent';
 
 describe('transform', () => {
     test('creates a transform', () => {
@@ -616,4 +617,49 @@ describe('transform', () => {
         expect(transform.getCameraLngLat().lng).toBeCloseTo(camLngLat.lng, 10);
         expect(transform.getCameraLngLat().lat).toBeCloseTo(camLngLat.lat, 10);
     });
+
+    describe('getProjectionData', () => {
+        const transform = new MercatorTransform({minZoom: 0, maxZoom: 22, minPitch: 0, maxPitch: 180, renderWorldCopies: true});
+        transform.resize(512, 512);
+        test('parses a custom object', () => {
+            const projectionData = transform.getProjectionData({overscaledTileID: {
+                canonical: {
+                    x: 1,
+                    y: 0,
+                    z: 1,
+                },
+            }});
+            expectToBeCloseToArray(projectionData.tileMercatorCoords, [0.5, 0, 0.5 / EXTENT, 0.5 / EXTENT]);
+            expectToBeCloseToArray([...projectionData.mainMatrix], [
+                0.09375,
+                0,
+                0,
+                0,
+                0,
+                -0.09375,
+                0,
+                0,
+                0,
+                0,
+                -0.000013132550520822406,
+                -0.000012790334039891604,
+                0,
+                768,
+                767.7944946289062,
+                768
+            ]);
+        });
+        test('parses OverscaledTileID', () => {
+            const transform = new MercatorTransform({minZoom: 0, maxZoom: 22, minPitch: 0, maxPitch: 180, renderWorldCopies: true});
+            transform.resize(512, 512);
+            const projectionData = transform.getProjectionData({overscaledTileID: new OverscaledTileID(1, 0, 1, 1, 0)});
+            expectToBeCloseToArray(projectionData.tileMercatorCoords, [0.5, 0, 0.5 / EXTENT, 0.5 / EXTENT]);
+        });
+        test('parses null', () => {
+            const transform = new MercatorTransform({minZoom: 0, maxZoom: 22, minPitch: 0, maxPitch: 180, renderWorldCopies: true});
+            transform.resize(512, 512);
+            const projectionData = transform.getProjectionData({overscaledTileID: null});
+            expectToBeCloseToArray(projectionData.tileMercatorCoords, [0, 0, 1, 1]);
+        });
+    });
 });

src/geo/projection/mercator_transform.ts

@@ -728,12 +728,26 @@ export class MercatorTransform implements ITransform {
 
     getProjectionData(params: ProjectionDataParams): ProjectionData {
         const {overscaledTileID, aligned, applyTerrainMatrix} = params;
-        const mercatorTileCoordinates = this._helper.getMercatorTileCoordinates(overscaledTileID);
-        const tilePosMatrix = overscaledTileID ? this.calculatePosMatrix(overscaledTileID, aligned, true) : null;
+        let tile: OverscaledTileID;
+        if (!overscaledTileID) {
+            tile = null;
+        } else if (overscaledTileID instanceof OverscaledTileID) {
+            tile = overscaledTileID;
+        } else {
+            tile = new OverscaledTileID(
+                overscaledTileID.overscaledZ ?? overscaledTileID.canonical.z,
+                overscaledTileID.wrap ?? 0,
+                overscaledTileID.canonical.z,
+                overscaledTileID.canonical.x,
+                overscaledTileID.canonical.y
+            );
+        }
+        const mercatorTileCoordinates = this._helper.getMercatorTileCoordinates(tile);
+        const tilePosMatrix = overscaledTileID ? this.calculatePosMatrix(tile, aligned, true) : null;
 
         let mainMatrix: mat4;
-        if (overscaledTileID?.terrainRttPosMatrix32f && applyTerrainMatrix) {
-            mainMatrix = overscaledTileID.terrainRttPosMatrix32f;
+        if (tile?.terrainRttPosMatrix32f && applyTerrainMatrix) {
+            mainMatrix = tile.terrainRttPosMatrix32f;
         } else if (tilePosMatrix) {
             mainMatrix = tilePosMatrix; // This matrix should be float32
         } else {

src/geo/projection/projection_data.ts

@@ -54,7 +54,15 @@ export type ProjectionDataParams = {
     /**
      * The ID of the current tile
      */
-    overscaledTileID: OverscaledTileID | null;
+    overscaledTileID: OverscaledTileID | null | {
+        overscaledZ?: number;
+        wrap?: number;
+        canonical: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
     /**
      * Set to true if a pixel-aligned matrix should be used, if possible (mostly used for raster tiles under mercator projection)
      */

src/geo/transform_helper.ts

@@ -10,7 +10,6 @@ import {EXTENT} from '../data/extent';
 
 import type {PaddingOptions} from './edge_insets';
 import type {IReadonlyTransform, ITransformGetters, TransformConstrainFunction} from './transform_interface';
-import type {OverscaledTileID} from '../tile/tile_id';
 import {Bounds} from './bounds';
 /**
  * If a path crossing the antimeridian would be shorter, extend the final coordinate so that
@@ -681,7 +680,7 @@ export class TransformHelper implements ITransformGetters {
         return camMercator.toLngLat();
     }
 
-    getMercatorTileCoordinates(overscaledTileID: OverscaledTileID): [number, number, number, number] {
+    getMercatorTileCoordinates(overscaledTileID?: { canonical: {x: number; y: number; z: number}} | null): [number, number, number, number] {
         if (!overscaledTileID) {
             return [0, 0, 1, 1];
         }

test/build/bundle_size.json

@@ -1 +1 @@
-1053826
+1055028