maplibre-gl

import {describe, beforeEach, test, expect, vi} from 'vitest'; import {Camera, type CameraOptions, type PointLike} from '../ui/camera'; import {TaskQueue, type TaskID} from '../util/task_queue'; import {browser} from '../util/browser'; import {fixedLngLat, fixedNum} from '../../test/unit/lib/fixed'; import {setMatchMedia} from '../util/test/util'; import {mercatorZfromAltitude} from '../geo/mercator_coordinate'; import {LngLat, type LngLatLike} from '../geo/lng_lat'; import {LngLatBounds} from '../geo/lng_lat_bounds'; import {MercatorTransform} from '../geo/projection/mercator_transform'; import {GlobeTransform} from '../geo/projection/globe_transform'; import {getZoomAdjustment} from '../geo/projection/globe_utils'; import {GlobeCameraHelper} from '../geo/projection/globe_camera_helper'; import {MercatorCameraHelper} from '../geo/projection/mercator_camera_helper'; import type {GlobeProjection} from '../geo/projection/globe_projection'; import type {Terrain} from '../render/terrain'; beforeEach(() => { setMatchMedia(); Object.defineProperty(browser, 'prefersReducedMotion', {value: false}); }); class CameraMock extends Camera { // eslint-disable-next-line _requestRenderFrame(a: () => void): TaskID { return undefined; } _cancelRenderFrame(_: TaskID): void { return undefined; } } function attachSimulateFrame(camera) { const queue = new TaskQueue(); camera._requestRenderFrame = (cb) => queue.add(cb); camera._cancelRenderFrame = (id) => queue.remove(id); camera.simulateFrame = () => queue.run(); return camera; } function createCamera(options?): Camera & { simulateFrame: () => void } { options = options || {}; const transform = options.globe ? new GlobeTransform() : new MercatorTransform(); transform.setMinZoom(0); transform.setMaxZoom(20); transform.setMinPitch(0); transform.setMaxPitch(60); transform.setRenderWorldCopies(options.renderWorldCopies); transform.resize(512, 512); const camera = attachSimulateFrame(new CameraMock(transform, new MercatorCameraHelper(), {} as any)); if (options.globe) { camera.cameraHelper = new GlobeCameraHelper({useGlobeRendering: true} as GlobeProjection); } camera.jumpTo(options); camera._update = () => {}; camera._elevateCameraIfInsideTerrain = (_tr : any) => ({}); return camera; } function createCameraGlobe(options?) { options = options || {}; options.globe = true; return createCamera(options); } function createCameraGlobeZoomed() { return createCameraGlobe({ zoom: 3 }); } describe('calculateCameraOptionsFromTo', () => { // Choose initial zoom to avoid center being constrained by mercator latitude limits. const camera = createCamera({zoom: 1}); test('look at north', () => { const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromTo({lng: 1, lat: 0}, 0, {lng: 1, lat: 1}); expect(cameraOptions).toBeDefined(); expect(cameraOptions.center).toBeDefined(); expect(cameraOptions.bearing).toBeCloseTo(0); expect(cameraOptions.roll).toBeUndefined(); }); test('look at west', () => { const cameraOptions = camera.calculateCameraOptionsFromTo({lng: 1, lat: 0} as LngLat, 0, {lng: 0, lat: 0} as LngLat); expect(cameraOptions).toBeDefined(); expect(cameraOptions.bearing).toBeCloseTo(-90); expect(cameraOptions.roll).toBeUndefined(); }); test('pitch 45', () => { // altitude same as grounddistance => 45° // distance between lng x and lng x+1 is 111.2km at same lat const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromTo({lng: 1, lat: 0}, 111200, {lng: 0, lat: 0}); expect(cameraOptions).toBeDefined(); expect(cameraOptions.pitch).toBeCloseTo(45); expect(cameraOptions.roll).toBeUndefined(); }); test('pitch 90', () => { const cameraOptions = camera.calculateCameraOptionsFromTo({lng: 1, lat: 0}, 0, {lng: 0, lat: 0}); expect(cameraOptions).toBeDefined(); expect(cameraOptions.pitch).toBeCloseTo(90); expect(cameraOptions.roll).toBeUndefined(); }); test('pitch 153.435', () => { // 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 (looking up) = 153.435 const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromTo({lng: 1, lat: 0}, 111200, {lng: 0, lat: 0}, 111200 * 3); expect(cameraOptions).toBeDefined(); expect(cameraOptions.pitch).toBeCloseTo(153.435); expect(cameraOptions.roll).toBeUndefined(); }); test('zoom distance 1000', () => { const expectedZoom = Math.log2(camera.transform.cameraToCenterDistance / mercatorZfromAltitude(1000, 0) / camera.transform.tileSize); const cameraOptions = camera.calculateCameraOptionsFromTo({lng: 0, lat: 0}, 0, {lng: 0, lat: 0}, 1000); expect(cameraOptions).toBeDefined(); expect(cameraOptions.zoom).toBeCloseTo(expectedZoom); expect(cameraOptions.roll).toBeUndefined(); }); test('zoom distance 1 lng (111.2km), 111.2km altitude away', () => { const expectedZoom = Math.log2(camera.transform.cameraToCenterDistance / mercatorZfromAltitude(Math.hypot(111200, 111200), 0) / camera.transform.tileSize); const cameraOptions = camera.calculateCameraOptionsFromTo({lng: 0, lat: 0}, 0, {lng: 1, lat: 0}, 111200); expect(cameraOptions).toBeDefined(); expect(cameraOptions.zoom).toBeCloseTo(expectedZoom); expect(cameraOptions.roll).toBeUndefined(); }); test('same To as From error', () => { expect(() => { camera.calculateCameraOptionsFromTo({lng: 0, lat: 0}, 0, {lng: 0, lat: 0}, 0); }).toThrow(); }); }); describe('calculateCameraOptionsFromCameraLngLatAltRotation', () => { // Choose initial zoom to avoid center being constrained by mercator latitude limits. const camera = createCamera({zoom: 1, maxPitch: 180}); test('look straight down', () => { const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromCameraLngLatAltRotation({lng: 1, lat: 0}, 0, 0, 0); expect(cameraOptions).toBeDefined(); expect(cameraOptions.center).toBeDefined(); const center = cameraOptions.center as LngLat; expect(center.lng).toBeCloseTo(1); expect(center.lat).toBeCloseTo(0); expect(cameraOptions.elevation).toBeDefined(); expect(cameraOptions.elevation).toBeLessThan(0); expect(cameraOptions.zoom).toBeGreaterThan(0); expect(cameraOptions.bearing).toBeCloseTo(0); expect(cameraOptions.pitch).toBeCloseTo(0); expect(cameraOptions.roll).toBeUndefined(); }); test('look straight up', () => { const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromCameraLngLatAltRotation({lng: 1, lat: 0}, 0, 0, 180); expect(cameraOptions).toBeDefined(); expect(cameraOptions.center).toBeDefined(); const center = cameraOptions.center as LngLat; expect(center.lng).toBeCloseTo(1); expect(center.lat).toBeCloseTo(0); expect(cameraOptions.elevation).toBeDefined(); expect(cameraOptions.elevation).toBeGreaterThan(0); expect(cameraOptions.zoom).toBeGreaterThan(0); expect(cameraOptions.bearing).toBeCloseTo(0); expect(cameraOptions.pitch).toBeCloseTo(180); expect(cameraOptions.roll).toBeUndefined(); }); test('look level', () => { const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromCameraLngLatAltRotation({lng: 1, lat: 0}, 0, 0, 90); expect(cameraOptions).toBeDefined(); expect(cameraOptions.center).toBeDefined(); expect(cameraOptions.elevation).toBeDefined(); expect(cameraOptions.elevation).toBeCloseTo(0); expect(cameraOptions.zoom).toBeGreaterThan(0); expect(cameraOptions.bearing).toBeCloseTo(0); expect(cameraOptions.pitch).toBeCloseTo(90); expect(cameraOptions.roll).toBeUndefined(); }); test('roll passthru', () => { const cameraOptions: CameraOptions = camera.calculateCameraOptionsFromCameraLngLatAltRotation({lng: 1, lat: 55}, 0, 34, 45, 123.4); expect(cameraOptions).toBeDefined(); expect(cameraOptions.center).toBeDefined(); expect(cameraOptions.elevation).toBeDefined(); expect(cameraOptions.elevation).toBeLessThan(0); expect(cameraOptions.zoom).toBeGreaterThan(0); expect(cameraOptions.bearing).toBeCloseTo(34); expect(cameraOptions.pitch).toBeCloseTo(45); expect(cameraOptions.roll).toBeCloseTo(123.4); }); }); describe('jumpTo', () => { // Choose initial zoom to avoid center being constrained by mercator latitude limits. const camera = createCamera({zoom: 1}); test('sets center', () => { camera.jumpTo({center: [1, 2]}); expect(camera.getCenter()).toEqual({lng: 1, lat: 2}); }); test('throws on invalid center argument', () => { expect(() => { camera.jumpTo({center: 1 as any}); }).toThrow(Error); }); test('keeps current center if not specified', () => { camera.jumpTo({}); expect(camera.getCenter()).toEqual({lng: 1, lat: 2}); }); test('sets zoom', () => { camera.jumpTo({zoom: 3}); expect(camera.getZoom()).toBe(3); }); test('keeps current zoom if not specified', () => { camera.jumpTo({}); expect(camera.getZoom()).toBe(3); }); test('sets bearing', () => { camera.jumpTo({bearing: 4}); expect(camera.getBearing()).toBe(4); }); test('keeps current bearing if not specified', () => { camera.jumpTo({}); expect(camera.getBearing()).toBe(4); }); test('sets pitch', () => { camera.jumpTo({pitch: 45}); expect(camera.getPitch()).toBe(45); }); test('keeps current pitch if not specified', () => { camera.jumpTo({}); expect(camera.getPitch()).toBe(45); }); test('sets roll', () => { camera.jumpTo({pitch: 0, roll: 45}); expect(camera.getRoll()).toBe(45); expect(camera.getPitch()).toBe(0); }); test('keeps current roll if not specified', () => { camera.jumpTo({}); expect(camera.getRoll()).toBe(45); }); test('sets field of view', () => { camera.setVerticalFieldOfView(29); expect(camera.getVerticalFieldOfView()).toBeCloseTo(29, 10); }); test('sets multiple properties', () => { camera.jumpTo({ center: [10, 20], zoom: 10, bearing: 180, pitch: 60 }); expect(camera.getCenter()).toEqual({lng: 10, lat: 20}); expect(camera.getZoom()).toBe(10); expect(camera.getBearing()).toBe(180); expect(camera.getPitch()).toBe(60); }); test('sets more properties', () => { camera.jumpTo({ center: [1, 2], zoom: 9, bearing: 120, pitch: 40, roll: 20 }); expect(camera.getCenter()).toEqual({lng: 1, lat: 2}); expect(camera.getZoom()).toBe(9); expect(camera.getBearing()).toBe(120); expect(camera.getPitch()).toBe(40); expect(camera.getRoll()).toBe(20); }); test('emits move events, preserving eventData', () => { let started, moved, ended; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { started = d.data; }); camera.on('move', (d) => { moved = d.data; }); camera.on('moveend', (d) => { ended = d.data; }); camera.jumpTo({center: [1, 2]}, eventData); expect(started).toBe('ok'); expect(moved).toBe('ok'); expect(ended).toBe('ok'); }); test('emits move events when FOV changes, preserving eventData', () => { let started, moved, ended; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { started = d.data; }); camera.on('move', (d) => { moved = d.data; }); camera.on('moveend', (d) => { ended = d.data; }); camera.setVerticalFieldOfView(44, eventData); expect(started).toBe('ok'); expect(moved).toBe('ok'); expect(ended).toBe('ok'); }); test('emits zoom events, preserving eventData', () => { let started, zoomed, ended; const eventData = {data: 'ok'}; camera.on('zoomstart', (d) => { started = d.data; }); camera.on('zoom', (d) => { zoomed = d.data; }); camera.on('zoomend', (d) => { ended = d.data; }); camera.jumpTo({zoom: 3}, eventData); expect(started).toBe('ok'); expect(zoomed).toBe('ok'); expect(ended).toBe('ok'); }); test('emits rotate events, preserving eventData', () => { let started, rotated, ended; const eventData = {data: 'ok'}; camera.on('rotatestart', (d) => { started = d.data; }); camera.on('rotate', (d) => { rotated = d.data; }); camera.on('rotateend', (d) => { ended = d.data; }); camera.jumpTo({bearing: 90}, eventData); expect(started).toBe('ok'); expect(rotated).toBe('ok'); expect(ended).toBe('ok'); }); test('emits pitch events, preserving eventData', () => { let started, pitched, ended; const eventData = {data: 'ok'}; camera.on('pitchstart', (d) => { started = d.data; }); camera.on('pitch', (d) => { pitched = d.data; }); camera.on('pitchend', (d) => { ended = d.data; }); camera.jumpTo({pitch: 10}, eventData); expect(started).toBe('ok'); expect(pitched).toBe('ok'); expect(ended).toBe('ok'); }); test('emits roll events, preserving eventData', () => { let started, rolled, ended; const eventData = {data: 'ok'}; camera.on('rollstart', (d) => { started = d.data; }); camera.on('roll', (d) => { rolled = d.data; }); camera.on('rollend', (d) => { ended = d.data; }); camera.jumpTo({roll: 10}, eventData); expect(started).toBe('ok'); expect(rolled).toBe('ok'); expect(ended).toBe('ok'); }); test('cancels in-progress easing', () => { camera.panTo([3, 4]); expect(camera.isEasing()).toBeTruthy(); camera.jumpTo({center: [1, 2]}); expect(!camera.isEasing()).toBeTruthy(); }); }); describe('setCenter', () => { // Choose initial zoom to avoid center being constrained by mercator latitude limits. const camera = createCamera({zoom: 1}); test('sets center', () => { camera.setCenter([1, 2]); expect(camera.getCenter()).toEqual({lng: 1, lat: 2}); }); test('throws on invalid center argument', () => { expect(() => { camera.jumpTo({center: 1 as any}); }).toThrow(Error); }); test('emits move events, preserving eventData', () => { let started, moved, ended; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { started = d.data; }); camera.on('move', (d) => { moved = d.data; }); camera.on('moveend', (d) => { ended = d.data; }); camera.setCenter([10, 20], eventData); expect(started).toBe('ok'); expect(moved).toBe('ok'); expect(ended).toBe('ok'); }); test('cancels in-progress easing', () => { camera.panTo([3, 4]); expect(camera.isEasing()).toBeTruthy(); camera.setCenter([1, 2]); expect(!camera.isEasing()).toBeTruthy(); }); }); describe('setZoom', () => { const camera = createCamera(); test('sets zoom', () => { camera.setZoom(3); expect(camera.getZoom()).toBe(3); }); test('emits move and zoom events, preserving eventData', () => { let movestarted, moved, moveended, zoomstarted, zoomed, zoomended; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { movestarted = d.data; }); camera.on('move', (d) => { moved = d.data; }); camera.on('moveend', (d) => { moveended = d.data; }); camera.on('zoomstart', (d) => { zoomstarted = d.data; }); camera.on('zoom', (d) => { zoomed = d.data; }); camera.on('zoomend', (d) => { zoomended = d.data; }); camera.setZoom(4, eventData); expect(movestarted).toBe('ok'); expect(moved).toBe('ok'); expect(moveended).toBe('ok'); expect(zoomstarted).toBe('ok'); expect(zoomed).toBe('ok'); expect(zoomended).toBe('ok'); }); test('cancels in-progress easing', () => { camera.panTo([3, 4]); expect(camera.isEasing()).toBeTruthy(); camera.setZoom(5); expect(!camera.isEasing()).toBeTruthy(); }); }); describe('setBearing', () => { const camera = createCamera(); test('sets bearing', () => { camera.setBearing(4); expect(camera.getBearing()).toBe(4); }); test('emits move and rotate events, preserving eventData', () => { let movestarted, moved, moveended, rotatestarted, rotated, rotateended; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { movestarted = d.data; }); camera.on('move', (d) => { moved = d.data; }); camera.on('moveend', (d) => { moveended = d.data; }); camera.on('rotatestart', (d) => { rotatestarted = d.data; }); camera.on('rotate', (d) => { rotated = d.data; }); camera.on('rotateend', (d) => { rotateended = d.data; }); camera.setBearing(5, eventData); expect(movestarted).toBe('ok'); expect(moved).toBe('ok'); expect(moveended).toBe('ok'); expect(rotatestarted).toBe('ok'); expect(rotated).toBe('ok'); expect(rotateended).toBe('ok'); }); test('cancels in-progress easing', () => { camera.panTo([4, 3]); expect(camera.isEasing()).toBeTruthy(); camera.setBearing(6); expect(!camera.isEasing()).toBeTruthy(); }); }); describe('setRoll', () => { const camera = createCamera(); test('sets roll', () => { camera.setRoll(4); expect(camera.getRoll()).toBe(4); }); test('emits move and roll events, preserving eventData', () => { let movestarted, moved, moveended, rollstarted, rolled, rollended; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { movestarted = d.data; }); camera.on('move', (d) => { moved = d.data; }); camera.on('moveend', (d) => { moveended = d.data; }); camera.on('rollstart', (d) => { rollstarted = d.data; }); camera.on('roll', (d) => { rolled = d.data; }); camera.on('rollend', (d) => { rollended = d.data; }); camera.setRoll(5, eventData); expect(movestarted).toBe('ok'); expect(moved).toBe('ok'); expect(moveended).toBe('ok'); expect(rollstarted).toBe('ok'); expect(rolled).toBe('ok'); expect(rollended).toBe('ok'); }); test('cancels in-progress easing', () => { camera.panTo([3, 4]); expect(camera.isEasing()).toBeTruthy(); camera.setRoll(6); expect(!camera.isEasing()).toBeTruthy(); }); }); describe('setPadding', () => { test('sets padding', () => { const camera = createCamera(); const padding = {left: 300, top: 100, right: 50, bottom: 10}; camera.setPadding(padding); expect(camera.getPadding()).toEqual(padding); }); test('existing padding is retained if no new values are passed in', () => { const camera = createCamera(); const padding = {left: 300, top: 100, right: 50, bottom: 10}; camera.setPadding(padding); camera.setPadding({} as any); const currentPadding = camera.getPadding(); expect(currentPadding).toEqual(padding); }); test('doesn\'t change padding thats already present if new value isn\'t passed in', () => { const camera = createCamera(); const padding = {left: 300, top: 100, right: 50, bottom: 10}; camera.setPadding(padding); const padding1 = {right: 100}; camera.setPadding(padding1); const currentPadding = camera.getPadding(); expect(currentPadding.left).toBe(padding.left); expect(currentPadding.top).toBe(padding.top); // padding1 here expect(currentPadding.right).toBe(padding1.right); expect(currentPadding.bottom).toBe(padding.bottom); }); }); describe('panBy', () => { test('pans by specified amount', () => { const camera = createCamera(); camera.panBy([100, 0], {duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 70.3125, lat: 0}); }); test('pans relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180}); camera.panBy([100, 0], {duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: -70.3125, lat: 0}); }); test('emits move events, preserving eventData', async () => { const camera = createCamera(); let started, moved; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { started = d.data; }); camera.on('move', (d) => { moved = d.data; }); const promise = camera.once('moveend'); camera.panBy([100, 0], {duration: 0}, eventData); const d = await promise; expect(started).toBe('ok'); expect(moved).toBe('ok'); expect(d.data).toBe('ok'); }); test('suppresses movestart if noMoveStart option is true', async () => { const camera = createCamera(); let started; // fire once in advance to satisfy assertions that moveend only comes after movestart camera.fire('movestart'); camera.on('movestart', () => { started = true; }); const promise = camera.once('moveend'); camera.panBy([100, 0], {duration: 0, noMoveStart: true}); await promise; expect(started).toBeFalsy(); }); }); describe('panTo', () => { test('pans to specified location', () => { const camera = createCamera(); camera.panTo([100, 0], {duration: 0}); expect(camera.getCenter()).toEqual({lng: 100, lat: 0}); }); test('throws on invalid center argument', () => { const camera = createCamera(); expect(() => { camera.panTo({center: 1} as any); }).toThrow(Error); }); test('pans with specified offset', () => { const camera = createCamera(); camera.panTo([100, 0], {offset: [100, 0], duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 29.6875, lat: 0}); }); test('pans with specified offset relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180}); camera.panTo([100, 0], {offset: [100, 0], duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 170.3125, lat: 0}); }); test('emits move events, preserving eventData', async () => { const camera = createCamera(); let started, moved; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { started = d.data; }); camera.on('move', (d) => { moved = d.data; }); const promise = camera.once('moveend'); camera.panTo([100, 0], {duration: 0}, eventData); const d = await promise; expect(started).toBe('ok'); expect(moved).toBe('ok'); expect(d.data).toBe('ok'); }); test('suppresses movestart if noMoveStart option is true', async () => { const camera = createCamera(); let started; // fire once in advance to satisfy assertions that moveend only comes after movestart camera.fire('movestart'); camera.on('movestart', () => { started = true; }); const promise = camera.once('moveend'); camera.panTo([100, 0], {duration: 0, noMoveStart: true}); await promise; expect(started).toBeFalsy(); }); }); describe('zoomTo', () => { test('zooms to specified level', () => { const camera = createCamera(); camera.zoomTo(3.2, {duration: 0}); expect(camera.getZoom()).toBe(3.2); }); test('zooms around specified location', () => { const camera = createCamera(); camera.zoomTo(3.2, {around: [5, 0], duration: 0}); expect(camera.getZoom()).toBe(3.2); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 4.455905897939886, lat: 0})); }); test('zooms with specified offset', () => { const camera = createCamera(); camera.zoomTo(3.2, {offset: [100, 0], duration: 0}); expect(camera.getZoom()).toBe(3.2); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 62.66117668978015, lat: 0})); }); test('zooms with specified offset relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180}); camera.zoomTo(3.2, {offset: [100, 0], duration: 0}); expect(camera.getZoom()).toBe(3.2); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: -62.66117668978012, lat: 0})); }); test('emits move and zoom events, preserving eventData', async () => { const camera = createCamera(); let movestarted, moved, zoomstarted, zoomed; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { movestarted = d.data; }); camera.on('move', (d) => { moved = d.data; }); const movePromise = camera.once('moveend'); camera.on('zoomstart', (d) => { zoomstarted = d.data; }); camera.on('zoom', (d) => { zoomed = d.data; }); const zoomPromise = camera.once('zoomend'); camera.zoomTo(5, {duration: 0}, eventData); const moveResult = await movePromise; const zoomResult = await zoomPromise; expect(movestarted).toBe('ok'); expect(moved).toBe('ok'); expect(moveResult.data).toBe('ok'); expect(zoomstarted).toBe('ok'); expect(zoomed).toBe('ok'); expect(zoomResult.data).toBe('ok'); }); }); describe('rotateTo', () => { test('rotates to specified bearing', () => { const camera = createCamera(); camera.rotateTo(90, {duration: 0}); expect(camera.getBearing()).toBe(90); }); test('rotates around specified location', () => { const camera = createCamera({zoom: 3}); camera.rotateTo(90, {around: [5, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 4.999999999999972, lat: 4.993665859353271})); }); test('rotates around specified location, constrained to fit the view', () => { const camera = createCamera({zoom: 0}); camera.rotateTo(90, {around: [5, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 4.999999999999972, lat: 0.000002552471840999715})); }); test('rotates with specified offset', () => { const camera = createCamera({zoom: 1}); camera.rotateTo(90, {offset: [200, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 70.3125, lat: 57.3265212252})); }); test('rotates with specified offset, constrained to fit the view', () => { const camera = createCamera({zoom: 0}); camera.rotateTo(90, {offset: [100, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 70.3125, lat: 0.000002552471840999715})); }); test('rotates with specified offset relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180, zoom: 1}); camera.rotateTo(90, {offset: [200, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: -70.3125, lat: 57.3265212252})); }); test('emits move and rotate events, preserving eventData', async () => { const camera = createCamera(); let movestarted, moved, rotatestarted, rotated; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { movestarted = d.data; }); camera.on('move', (d) => { moved = d.data; }); const movePromise = camera.once('moveend'); camera.on('rotatestart', (d) => { rotatestarted = d.data; }); camera.on('rotate', (d) => { rotated = d.data; }); const rotatePRomise = camera.once('rotateend'); camera.rotateTo(90, {duration: 0}, eventData); const moveResults = await movePromise; const rotateReults = await rotatePRomise; expect(movestarted).toBe('ok'); expect(moved).toBe('ok'); expect(moveResults.data).toBe('ok'); expect(rotatestarted).toBe('ok'); expect(rotated).toBe('ok'); expect(rotateReults.data).toBe('ok'); }); }); describe('easeTo', () => { test('pans to specified location', () => { const camera = createCamera(); camera.easeTo({center: [100, 0], duration: 0}); expect(camera.getCenter()).toEqual({lng: 100, lat: 0}); }); test('zooms to specified level', () => { const camera = createCamera(); camera.easeTo({zoom: 3.2, duration: 0}); expect(camera.getZoom()).toBe(3.2); }); test('rotates to specified bearing', () => { const camera = createCamera(); camera.easeTo({bearing: 90, duration: 0}); expect(camera.getBearing()).toBe(90); }); test('pitches to specified pitch', () => { const camera = createCamera(); camera.easeTo({pitch: 45, duration: 0}); expect(camera.getPitch()).toBeCloseTo(45, 6); }); test('rolls to specified roll', () => { const camera = createCamera(); camera.easeTo({pitch: 1, roll: 45, duration: 0}); expect(camera.getRoll()).toBeCloseTo(45, 6); }); test('roll behavior at Euler angle singularity', () => { const camera = createCamera(); camera.easeTo({bearing: 0, pitch: 0, roll: 45, duration: 0}); expect(camera.getRoll()).toBeCloseTo(45, 6); expect(camera.getPitch()).toBeCloseTo(0, 6); expect(camera.getBearing()).toBeCloseTo(0, 6); }); test('bearing behavior at Euler angle singularity', () => { const camera = createCamera(); camera.easeTo({bearing: 45, pitch: 0, roll: 0, duration: 0}); expect(camera.getRoll()).toBeCloseTo(0, 6); expect(camera.getPitch()).toBeCloseTo(0, 6); expect(camera.getBearing()).toBeCloseTo(45, 6); }); test('pans and zooms', () => { const camera = createCamera(); camera.easeTo({center: [100, 0], zoom: 3.2, duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 100, lat: 0})); expect(camera.getZoom()).toBe(3.2); }); test('zooms around a point', () => { const camera = createCamera(); camera.easeTo({around: [100, 0], zoom: 3, duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 87.5, lat: 0})); expect(camera.getZoom()).toBe(3); }); test('pans and rotates', () => { const camera = createCamera(); camera.easeTo({center: [100, 0], bearing: 90, duration: 0}); expect(camera.getCenter()).toEqual({lng: 100, lat: 0}); expect(camera.getBearing()).toBe(90); }); test('zooms and rotates', () => { const camera = createCamera(); camera.easeTo({zoom: 3.2, bearing: 90, duration: 0}); expect(camera.getZoom()).toBe(3.2); expect(camera.getBearing()).toBe(90); }); test('pans, zooms, and rotates', () => { const camera = createCamera({bearing: -90}); camera.easeTo({center: [100, 0], zoom: 3.2, bearing: 90, duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 100, lat: 0})); expect(camera.getZoom()).toBe(3.2); expect(camera.getBearing()).toBe(90); }); test('noop', () => { const camera = createCamera(); camera.easeTo({duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 0, lat: 0}); expect(camera.getZoom()).toBe(0); expect(camera.getBearing()).toBeCloseTo(0); }); test('noop with offset', () => { const camera = createCamera(); camera.easeTo({offset: [100, 0], duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 0, lat: 0}); expect(camera.getZoom()).toBe(0); expect(camera.getBearing()).toBeCloseTo(0); }); test('pans with specified offset', () => { const camera = createCamera(); camera.easeTo({center: [100, 0], offset: [100, 0], duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 29.6875, lat: 0}); }); test('pans with specified offset relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180}); camera.easeTo({center: [100, 0], offset: [100, 0], duration: 0}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 170.3125, lat: 0}); }); test('zooms with specified offset', () => { const camera = createCamera(); camera.easeTo({zoom: 3.2, offset: [100, 0], duration: 0}); expect(camera.getZoom()).toBe(3.2); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 62.66117668978015, lat: 0})); }); test('zooms with specified offset relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180}); camera.easeTo({zoom: 3.2, offset: [100, 0], duration: 0}); expect(camera.getZoom()).toBe(3.2); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: -62.66117668978012, lat: 0})); }); test('rotates with specified offset', () => { const camera = createCamera(); camera.easeTo({bearing: 90, offset: [100, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: 70.3125, lat: 0.000002552471840999715})); }); test('rotates with specified offset relative to viewport on a rotated camera', () => { const camera = createCamera({bearing: 180}); camera.easeTo({bearing: 90, offset: [100, 0], duration: 0}); expect(camera.getBearing()).toBe(90); expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat({lng: -70.3125, lat: 0.000002552471840999715})); }); test('emits move, zoom, rotate, pitch, and roll events, preserving eventData', async () => { const camera = createCamera(); let movestarted, moved, zoomstarted, zoomed, rotatestarted, rotated, pitchstarted, pitched, rollstarted, rolled; const eventData = {data: 'ok'}; camera.on('movestart', (d) => { movestarted = d.data; }); camera.on('move', (d) => { moved = d.data; }); const movePromise = camera.once('moveend'); camera.on('zoomstart', (d) => { zoomstarted = d.data; }); camera.on('zoom', (d) => { zoomed = d.data; }); const zoomPromise = camera.once('zoomend'); camera.on('rotatestart', (d) => { rotatestarted = d.data; }); camera.on('rotate', (d) => { rotated = d.data; }); const rotatePromise = camera.once('rotateend'); camera.on('pitchstart', (d) => { pitchstarted = d.data; }); camera.on('pitch', (d) => { pitched = d.data; }); const pitchPromise = camera.once('pitchend'); camera.on('rollstart', (d) => { rollstarted = d.data; }); camera.on('roll', (d) => { rolled = d.data; }); const rollPromise = camera.once('rollend'); camera.easeTo( {center: [100, 0], zoom: 3.2, bearing: 90, duration: 0, pitch: 45, roll: 30}, eventData); const moveResults = await movePromise; expect(camera._zooming).toBeFalsy(); expect(camera._rotating).toBeFalsy(); expect(camera._rolling).toBeFalsy(); expect(movestarted).toBe('ok'); expect(moved).toBe('ok'); expect(zoomed).toBe('ok'); expect(rotated).toBe('ok'); expect(rolled).toBe('ok'); expect(pitched).toBe('ok'); expect(moveResults.data).toBe('ok'); const zoomResults = await zoomPromise; expect(zoomstarted).toBe('ok'); expect(zoomed).toBe('ok'); expect(zoomResults.data).toBe('ok'); const rotateResults = await rotatePromise; expect(rotatestarted).toBe('ok'); expect(rotated).toBe('ok'); expect(rotateResults.data).toBe('ok'); const pitchResults = await pitchPromise; expect(pitchstarted).toBe('ok'); expect(pitched).toBe('ok'); expect(pitchResults.data).toBe('ok'); const rollResults = await rollPromise; expect(rollstarted).toBe('ok'); expect(rolled).toBe('ok'); expect(rollResults.data).toBe('ok'); }); test('does not emit zoom events if not zooming', async () => { const camera = createCamera(); const spy = vi.fn(); camera.on('zoomstart', spy); camera.on('zoom', spy); camera.on('zoomend', spy); const promise = camera.once('moveend'); camera.easeTo({center: [100, 0], duration: 0}); await promise; expect(spy).not.toHaveBeenCalled(); }); test('stops existing ease', () => { const camera = createCamera(); camera.easeTo({center: [200, 0], duration: 100}); camera.easeTo({center: [100, 0], duration: 0}); expect(camera.getCenter()).toEqual({lng: 100, lat: 0}); }); test('can be called from within a moveend event handler', async () => { const camera = createCamera(); const stub = vi.spyOn(browser, 'now'); stub.mockImplementation(() => 0); camera.easeTo({center: [100, 0], duration: 10}); let promise = camera.once('moveend'); // setTimeout to avoid a synchronous callback setTimeout(() => { stub.mockImplementation(() => 10); camera.simulateFrame(); }, 0); await promise; camera.easeTo({center: [200, 0], duration: 10}); promise = camera.once('moveend'); // setTimeout to avoid a synchronous callback setTimeout(() => { stub.mockImplementation(() => 20); camera.simulateFrame(); }, 0); await promise; camera.easeTo({center: [300, 0], duration: 10}); promise = camera.once('moveend'); setTimeout(() => { stub.mockImplementation(() => 30); camera.simulateFrame(); }, 0); await promise; }); test('pans eastward across the antimeridian', async () => { const camera = createCamera(); const stub = vi.spyOn(browser, 'now'); camera.setCenter([170, 0]); let crossedAntimeridian; camera.on('move', () => { if (camera.getCenter().lng > 170) { crossedAntimeridian = true; } }); const promise = camera.once('moveend'); stub.mockImplementation(() => 0); camera.easeTo({center: [-170, 0], duration: 10}); setTimeout(() => { stub.mockImplementation(() => 1); camera.simulateFrame(); setTimeout(() => { stub.mockImplementation(() => 10); camera.simulateFrame(); }, 0); }, 0); await promise; expect(crossedAntimeridian).toBeTruthy(); }); test('does not pan eastward across the antimeridian on a single-globe mercator map', async () => { const camera = createCamera({renderWorldCopies: false, zoom: 2}); camera.setCenter([170, 0]); const initialLng = camera.getCenter().lng; const promise = camera.once('moveend'); camera.easeTo({center: [210, 0], duration: 0}); await promise; expect(camera.getCenter().lng).toBeCloseTo(initialLng, 0); }); test('pans westward across the antimeridian', async () => { const camera = createCamera(); const stub = vi.spyOn(browser, 'now'); camera.setCenter([-170, 0]); let crossedAntimeridian; camera.on('move', () => { if (camera.getCenter().lng < -170) { crossedAntimeridian = true; } }); const promise = camera.once('moveend'); stub.mockImplementation(() => 0); camera.easeTo({center: [170, 0], duration: 10}); setTimeout(() => { stub.mockImplementation(() => 1); camera.simulateFrame(); setTimeout(() => { stub.mockImplementation(() => 10); camera.simulateFrame(); }, 0); }, 0); await promise; expect(crossedAntimeridian).toBeTruthy(); }); test('does not pan westward across the antimeridian on a single-globe mercator map', async () => { const camera = createCamera({renderWorldCopies: false, zoom: 2}); camera.setCenter([-170, 0]); const initialLng = camera.getCenter().lng; const promise = camera.once('moveend'); camera.easeTo({center: [-210, 0], duration: 0}); await promise; expect(camera.getCenter().lng).toBeCloseTo(initialLng, 0); }); test('animation occurs when prefers-reduced-motion: reduce is set but overridden by essential: true', async () => { const camera = createCamera(); Object.defineProperty(browser, 'prefersReducedMotion', {value: true}); const stubNow = vi.spyOn(browser, 'now'); // camera transition expected to take in this range when prefersReducedMotion is set and essential: true, // when a duration of 200 is requested const min = 100; const max = 300; let startTime; camera.on('movestart', () => { startTime = browser.now(); }); const promise = camera.once('moveend'); setTimeout(() => { stubNow.mockImplementation(() => 0); camera.simulateFrame(); camera.easeTo({center: [100, 0], zoom: 3.2, bearing: 90, duration: 200, essential: true}); setTimeout(() => { stubNow.mockImplementation(() => 200); camera.simulateFrame(); }, 0); }, 0); await promise; const endTime = browser.now(); const timeDiff = endTime - startTime; expect(timeDiff >= min && timeDiff < max).toBeTruthy(); }); test('duration is 0 when prefers-reduced-motion: reduce is set', async () => { const camera = createCamera(); Object.defineProperty(browser, 'prefersReducedMotion', {value: true}); let startTime; camera.on('movestart', () => { startTime = new Date(); }); const promise = camera.once('moveend'); camera.easeTo({center: [100, 0], zoom: 3.2, bearing: 90, duration: 1000}); await promise; const endTime = new Date(); const timeDiff = endTime.getTime() - startTime.getTime(); expect(timeDiff >= 0 && timeDiff < 10).toBeTruthy(); }); test('jumpTo on("move") during easeTo with zoom, pitch, etc', () => { const camera = createCamera(); const spy = vi.fn(); camera.on('moveend', spy); camera.easeTo({zoom: 20, bearing: 90, pitch: 60, duration: 500}, {done: true}); camera.once('move', () => { camera.jumpTo({pitch: 40}); }); camera.simulateFrame(); camera.simulateFrame(); expect(spy.mock.calls.find(c => 'done' in c[0])).toBeTruthy(); }); test('jumpTo on("zoom") during easeTo', () => { const camera = createCamera(); const spy = vi.fn(); camera.on('moveend', spy); camera.easeTo({zoom: 20, duration: 500}, {done: true}); camera.once('zoom', () => { camera.jumpTo({pitch: 40}); }); camera.simulateFrame(); camera.simulateFrame(); expect(spy.mock.calls.find(c => 'done' in c[0])).toBeTruthy(); }); test('jumpTo on("pitch") during easeTo', () => { const camera = createCamera(); const spy = vi.fn(); camera.on('moveend', spy); camera.easeTo({pitch: 60, duration: 500}, {done: true}); camera.once('pitch', () => { camera.jumpTo({pitch: 40}); }); camera.simulateFrame(); camera.simulateFrame(); expect(spy.mock.calls.find(c => 'done' in c[0])).toBeTruthy(); }); test('jumpTo on("rotate") during easeTo', () => { const camera = createCamera(); const spy = vi.fn(); camera.on('moveend', spy); camera.easeTo({bearing: 90, duration: 500}, {done: true}); camera.once('rotate', () => { camera.jumpTo({pitch: 40}); }); camera.simulateFrame(); camera.simulateFrame(); expect(spy.mock.calls.find(c => 'done' in c[0])).toBeTruthy(); }); }); describe('flyTo', () => { test('pans to specified location', () => { const camera = createCamera(); camera.flyTo({center: [100, 0], animate: false}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 100, lat: 0}); }); test('throws on invalid center argument', () => { const camera = createCamera(); expect(() => { camera.flyTo({center: 1 as any}); }).toThrow(Error); }); test('does not throw when cameras current zoom is sufficiently greater than passed zoom option', () => { const camera = createCamera({zoom: 22, center: [0, 0]}); expect(() => camera.flyTo({zoom: 10, center: [0, 0]})).not.toThrow(); }); test('does not throw when cameras current zoom is above maxzoom and an offset creates infinite zoom out factor', () => { const transform = new MercatorTransform(0, 20.9999, 0, 60, true); transform.resize(512, 512); const camera = attachSimulateFrame(new CameraMock(transform, new MercatorCameraHelper(), {} as any)) .jumpTo({zoom: 21, center: [0, 0]}); camera._update = () => {}; expect(() => camera.flyTo({zoom: 7.5, center: [0, 0], offset: [0, 70]})).not.toThrow(); }); test('zooms to specified level', () => { const camera = createCamera(); camera.flyTo({zoom: 3.2, animate: false}); expect(fixedNum(camera.getZoom())).toBe(3.2); }); test('zooms to integer level without floating point errors', () => { const camera = createCamera({zoom: 0.6}); camera.flyTo({zoom: 2, animate: false}); expect(camera.getZoom()).toBe(2); }); test('Zoom out from the same position to the same position with animation', async () => { const pos = {lng: 0, lat: 0}; const camera = createCamera({zoom: 20, center: pos}); const stub = vi.spyOn(browser, 'now'); const promise = camera.once('moveend'); stub.mockImplementation(() => 0); camera.flyTo({zoom: 19, center: pos, duration: 2}); stub.mockImplementation(() => 3); camera.simulateFrame(); await promise; expect(fixedLngLat(camera.getCenter())).toEqual(fixedLngLat(pos)); expect(camera.getZoom()).toBe(19); }); test('rotates to specified bearing', () => { const camera = createCamera(); camera.flyTo({bearing: 90, animate: false}); expect(camera.getBearing()).toBe(90); }); test('tilts to specified pitch', () => { const camera = createCamera(); camera.flyTo({pitch: 45, animate: false}); expect(camera.getPitch()).toBeCloseTo(45, 6); }); test('rolls to specified roll', () => { const camera = createCamera(); camera.flyTo({pitch: 1, roll: 45, animate: false}); expect(camera.getRoll()).toBeCloseTo(45, 6); }); test('roll behavior at Euler angle singularity', () => { const camera = createCamera(); camera.flyTo({bearing: 0, pitch: 0, roll: 45, animate: false}); expect(camera.getRoll()).toBeCloseTo(45, 6); expect(camera.getPitch()).toBeCloseTo(0, 6); expect(camera.getBearing()).toBeCloseTo(0, 6); }); test('bearing behavior at Euler angle singularity', () => { const camera = createCamera(); camera.flyTo({bearing: 45, pitch: 0, roll: 0, animate: false}); expect(camera.getRoll()).toBeCloseTo(0, 6); expect(camera.getPitch()).toBeCloseTo(0, 6); expect(camera.getBearing()).toBeCloseTo(45, 6); }); test('pans and zooms', () => { const camera = createCamera(); camera.flyTo({center: [100, 0], zoom: 3.2, animate: false}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 100, lat: 0}); expect(fixedNum(camera.getZoom())).toBe(3.2); }); test('pans and rotates', () => { const camera = createCamera(); camera.flyTo({center: [100, 0], bearing: 90, animate: false}); expect(fixedLngLat(camera.getCenter())).toEqual({lng: 100, lat: 0}); expect(camera.getBearing()).toBe(90); }); test('zooms and rotates', () => { const camera = createCamera();