maplibre-gl 2.3.0 → 2.4.0

package/src/ui/map.test.ts

@@ -13,6 +13,9 @@ import {LngLatBoundsLike} from '../geo/lng_lat_bounds';
 import {IControl} from './control/control';
 import EvaluationParameters from '../style/evaluation_parameters';
 import {fakeServer, FakeServer} from 'nise';
+import {CameraOptions} from './camera';
+import Terrain, {} from '../render/terrain';
+import {mercatorZfromAltitude} from '../geo/mercator_coordinate';
 
 function createStyleSource() {
     return {
@@ -2132,6 +2135,108 @@ describe('Map', () => {
         map.fire(new Event('dataabort'));
     });
 
+    describe('#calculateCameraOptionsFromTo', () => {
+        // Choose initial zoom to avoid center being constrained by mercator latitude limits.
+        test('pitch 90 with terrain', () => {
+            const map = createMap();
+
+            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 111200);
+
+            const terrainStub = {} as Terrain;
+            terrainStub.getElevation = mockedGetElevation;
+            map.style.terrain = terrainStub;
+
+            // distance between lng x and lng x+1 is 111.2km at same lat
+            // altitude same as center elevation => 90° pitch
+            const cameraOptions: CameraOptions = map.calculateCameraOptionsFromTo(new LngLat(1, 0), 111200, new LngLat(0, 0));
+            expect(cameraOptions).toBeDefined();
+            expect(cameraOptions.pitch).toBeCloseTo(90);
+            expect(mockedGetElevation.mock.calls).toHaveLength(1);
+        });
+
+        test('pitch 153.435 with terrain', () => {
+            const map = createMap();
+
+            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 111200 * 3);
+
+            const terrainStub = {} as Terrain;
+            terrainStub.getElevation = mockedGetElevation;
+            map.style.terrain = terrainStub;
+            // distance between lng x and lng x+1 is 111.2km at same lat
+            // (elevation difference of cam and center) / 2 = grounddistance =>
+            // acos(111.2 / sqrt(111.2² + (111.2 * 2)²)) = acos(1/sqrt(5)) => 63.435 + 90 = 153.435
+            const cameraOptions: CameraOptions = map.calculateCameraOptionsFromTo(new LngLat(1, 0), 111200, new LngLat(0, 0));
+            expect(cameraOptions).toBeDefined();
+            expect(cameraOptions.pitch).toBeCloseTo(153.435);
+            expect(mockedGetElevation.mock.calls).toHaveLength(1);
+        });
+
+        test('pitch 63 with terrain', () => {
+            const map = createMap();
+
+            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 111200 / 2);
+
+            const terrainStub = {} as Terrain;
+            terrainStub.getElevation = mockedGetElevation;
+            map.style.terrain = terrainStub;
+
+            // distance between lng x and lng x+1 is 111.2km at same lat
+            // (elevation difference of cam and center) * 2 = grounddistance =>
+            // acos(111.2 / sqrt(111.2² + (111.2 * 0.5)²)) = acos(1/sqrt(1.25)) => 90 (looking down) - 26.565 = 63.435
+            const cameraOptions: CameraOptions = map.calculateCameraOptionsFromTo(new LngLat(0, 0), 111200, new LngLat(1, 0));
+            expect(cameraOptions).toBeDefined();
+            expect(cameraOptions.pitch).toBeCloseTo(63.435);
+            expect(mockedGetElevation.mock.calls).toHaveLength(1);
+        });
+
+        test('zoom distance 1000', () => {
+            const map = createMap();
+
+            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 1000);
+
+            const terrainStub = {} as Terrain;
+            terrainStub.getElevation = mockedGetElevation;
+            map.style.terrain = terrainStub;
+
+            const expectedZoom = Math.log2(map.transform.cameraToCenterDistance / mercatorZfromAltitude(1000, 0) / map.transform.tileSize);
+            const cameraOptions = map.calculateCameraOptionsFromTo(new LngLat(0, 0), 0, new LngLat(0, 0));
+
+            expect(cameraOptions).toBeDefined();
+            expect(cameraOptions.zoom).toBeCloseTo(expectedZoom);
+            expect(mockedGetElevation.mock.calls).toHaveLength(1);
+        });
+
+        test('don\'t call getElevation when altitude supplied', () => {
+            const map = createMap();
+
+            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 0);
+
+            const terrainStub = {} as Terrain;
+            terrainStub.getElevation = mockedGetElevation;
+            map.style.terrain = terrainStub;
+
+            const cameraOptions = map.calculateCameraOptionsFromTo(new LngLat(0, 0), 0, new LngLat(0, 0), 1000);
+
+            expect(cameraOptions).toBeDefined();
+            expect(mockedGetElevation.mock.calls).toHaveLength(0);
+        });
+
+        test('don\'t call getElevation when altitude 0 supplied', () => {
+            const map = createMap();
+
+            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 0);
+
+            const terrainStub = {} as Terrain;
+            terrainStub.getElevation = mockedGetElevation;
+            map.style.terrain = terrainStub;
+
+            const cameraOptions = map.calculateCameraOptionsFromTo(new LngLat(0, 0), 0, new LngLat(1, 0), 0);
+
+            expect(cameraOptions).toBeDefined();
+            expect(mockedGetElevation.mock.calls).toHaveLength(0);
+        });
+    });
+
 });
 
 function createStyle() {

package/src/ui/map.ts

@@ -10,7 +10,7 @@ import Painter from '../render/painter';
 import Transform from '../geo/transform';
 import Hash from './hash';
 import HandlerManager from './handler_manager';
-import Camera from './camera';
+import Camera, {CameraOptions} from './camera';
 import LngLat from '../geo/lng_lat';
 import LngLatBounds from '../geo/lng_lat_bounds';
 import Point from '@mapbox/point-geometry';
@@ -603,6 +603,13 @@ class Map extends Camera {
         return this._controls.indexOf(control) > -1;
     }
 
+    calculateCameraOptionsFromTo(from: LngLat, altitudeFrom: number, to: LngLat, altitudeTo?: number) : CameraOptions {
+        if (altitudeTo == null && this.style.terrain) {
+            altitudeTo = this.transform.getElevation(to, this.style.terrain);
+        }
+        return super.calculateCameraOptionsFromTo(from, altitudeFrom, to, altitudeTo);
+    }
+
     /**
      * Resizes the map according to the dimensions of its
      * `container` element.

package/src/util/ajax.ts

@@ -1,6 +1,5 @@
 import {extend, warnOnce, isWorker} from './util';
 import config from './config';
-import assert from 'assert';
 import {cacheGet, cachePut} from './tile_request_cache';
 import webpSupported from './webp_supported';
 
@@ -390,7 +389,7 @@ export const getImage = function(
         if (advanced) return;
         advanced = true;
         numImageRequests--;
-        assert(numImageRequests >= 0);
+
         while (imageQueue.length && numImageRequests < config.MAX_PARALLEL_IMAGE_REQUESTS) { // eslint-disable-line
             const request = imageQueue.shift();
             const {requestParameters, callback, cancelled} = request;

package/src/util/color_ramp.ts

@@ -1,6 +1,5 @@
 import {RGBAImage} from './image';
 import {isPowerOfTwo} from './util';
-import assert from 'assert';
 
 import type {StylePropertyExpression} from '../style-spec/expression/index';
 
@@ -24,7 +23,7 @@ export function renderColorRamp(params: ColorRampParams): RGBAImage {
     const height = params.clips ? params.clips.length : 1;
     const image = params.image || new RGBAImage({width, height});
 
-    assert(isPowerOfTwo(width));
+    if (!isPowerOfTwo(width)) throw new Error(`width is not a power of 2 - ${width}`);
 
     const renderPixel = (stride, index, progress) => {
         evaluationGlobals[params.evaluationKey] = progress;

package/src/util/dictionary_coder.ts

@@ -1,4 +1,3 @@
-import assert from 'assert';
 
 class DictionaryCoder {
     _stringToNumber: {[_: string]: number};
@@ -15,12 +14,11 @@ class DictionaryCoder {
     }
 
     encode(string: string) {
-        assert(string in this._stringToNumber);
         return this._stringToNumber[string];
     }
 
     decode(n: number) {
-        assert(n < this._numberToString.length);
+        if (n >= this._numberToString.length) throw new Error(`Out of bounds. Index requested n=${n} can't be >= this._numberToString.length ${this._numberToString.length}`);
         return this._numberToString[n];
     }
 }

package/src/util/dispatcher.ts

@@ -1,6 +1,5 @@
 import {uniqueId, asyncAll} from './util';
 import Actor from './actor';
-import assert from 'assert';
 
 import type WorkerPool from './worker_pool';
 
@@ -33,7 +32,7 @@ class Dispatcher {
             actor.name = `Worker ${i}`;
             this.actors.push(actor);
         }
-        assert(this.actors.length);
+        if (!this.actors.length) throw new Error('No actors found');
     }
 
     /**
@@ -41,7 +40,6 @@ class Dispatcher {
      * @private
      */
     broadcast(type: string, data: unknown, cb?: (...args: any[]) => any) {
-        assert(this.actors.length);
         cb = cb || function () {};
         asyncAll(this.actors, (actor, done) => {
             actor.send(type, data, done);
@@ -53,7 +51,6 @@ class Dispatcher {
      * @returns An actor object backed by a web worker for processing messages.
      */
     getActor(): Actor {
-        assert(this.actors.length);
         this.currentActor = (this.currentActor + 1) % this.actors.length;
         return this.actors[this.currentActor];
     }

package/src/util/dom.ts

@@ -1,7 +1,5 @@
 import Point from '@mapbox/point-geometry';
 
-import assert from 'assert';
-
 export default class DOM {
     private static readonly docStyle = typeof window !== 'undefined' && window.document && window.document.documentElement.style;
 
@@ -107,7 +105,6 @@ export default class DOM {
     }
 
     public static mouseButton(e: MouseEvent) {
-        assert(e.type === 'mousedown' || e.type === 'mouseup');
         return e.button;
     }
 

package/src/util/image.ts

@@ -1,5 +1,3 @@
-import assert from 'assert';
-
 import {register} from './web_worker_transfer';
 
 export type Size = {
@@ -71,7 +69,7 @@ function copyImage(srcImg: any, dstImg: any, srcPt: Point2D, dstPt: Point2D, siz
     const srcData = srcImg.data;
     const dstData = dstImg.data;
 
-    assert(srcData !== dstData);
+    if (srcData === dstData) throw new Error('srcData equals dstData, so image is already copied');
 
     for (let y = 0; y < size.height; y++) {
         const srcOffset = ((srcPt.y + y) * srcImg.width + srcPt.x) * channels;

package/src/util/struct_array.ts

@@ -1,7 +1,5 @@
 // Note: all "sizes" are measured in bytes
 
-import assert from 'assert';
-
 import type {Transferable} from '../types/transferable';
 
 const viewTypes = {
@@ -111,7 +109,6 @@ abstract class StructArray {
      * @private
      */
     static serialize(array: StructArray, transferables?: Array<Transferable>): SerializedStructArray {
-        assert(!array.isTransferred);
 
         array._trim();
 
@@ -160,7 +157,6 @@ abstract class StructArray {
      * @param {number} n The new size of the array.
      */
     resize(n: number) {
-        assert(!this.isTransferred);
         this.reserve(n);
         this.length = n;
     }
@@ -209,7 +205,6 @@ function createLayout(
     let offset = 0;
     let maxSize = 0;
     const layoutMembers = members.map((member) => {
-        assert(member.name.length);
         const typeSize = sizeOf(member.type);
         const memberOffset = offset = align(offset, Math.max(alignment, typeSize));
         const components = member.components || 1;

package/src/util/task_queue.ts

@@ -1,5 +1,3 @@
-import assert from 'assert';
-
 export type TaskID = number; // can't mark opaque due to https://github.com/flowtype/flow-remove-types/pull/61
 
 type Task = {
@@ -40,7 +38,7 @@ class TaskQueue {
     }
 
     run(timeStamp: number = 0) {
-        assert(!this._currentlyRunning);
+        if (this._currentlyRunning) throw new Error('Attempting to run(), but is already running.');
         const queue = this._currentlyRunning = this._queue;
 
         // Tasks queued by callbacks in the current queue should be executed

package/src/util/web_worker_transfer.ts

@@ -1,5 +1,3 @@
-import assert from 'assert';
-
 import TransferableGridIndex from './transferable_grid_index';
 import Color from '../style-spec/util/color';
 import {StylePropertyFunction, StyleExpression, ZoomDependentExpression, ZoomConstantExpression} from '../style-spec/expression';
@@ -51,7 +49,7 @@ export function register<T extends any>(
     },
     options: RegisterOptions<T> = {}
 ) {
-    assert(!registry[name], `${name} is already registered.`);
+    if (registry[name]) throw new Error(`${name} is already registered.`);
     ((Object.defineProperty as any))(klass, '_classRegistryKey', {
         value: name,
         writeable: false
@@ -159,7 +157,7 @@ export function serialize(input: unknown, transferables?: Array<Transferable> |
         if (!name) {
             throw new Error('can\'t serialize object of unregistered class');
         }
-        assert(registry[name]);
+        if (!registry[name]) throw new Error(`${name} is not registered.`);
 
         const properties: SerializedObject = klass.serialize ?
             // (Temporary workaround) allow a class to provide static
@@ -185,8 +183,9 @@ export function serialize(input: unknown, transferables?: Array<Transferable> |
                 properties.message = input.message;
             }
         } else {
-            // make sure statically serialized object survives transfer of $name property
-            assert(!transferables || properties as any !== transferables[transferables.length - 1]);
+            if (transferables && properties as any === transferables[transferables.length - 1]) {
+                throw new Error('statically serialized object won\'t survive transfer of $name property');
+            }
         }
 
         if (properties.$name) {