feat(camera): Make jumpTo, easeTo, and flyTo respect the zoomSnap map option by snapping the zoom level to the nearest valid increment (maplibre#7338)

* respect snapZoom for zoom setting functions

* changelog

Author: CommanderStorm

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 - Make `fitBounds` and `fitScreenCoordinates` respect the `zoomSnap` map option by snapping the zoom level down to keep bounds fully visible ([#7332](https://github.com/maplibre/maplibre-gl-js/issues/7332) (by [@CommanderStorm](https://github.com/CommanderStorm))
+- Make `jumpTo`, `easeTo`, and `flyTo` respect the `zoomSnap` map option by snapping the zoom level to the nearest valid increment ([#7333](https://github.com/maplibre/maplibre-gl-js/issues/7333) (by [@CommanderStorm](https://github.com/CommanderStorm))
 
 ## 5.21.1
 

src/ui/camera.test.ts

@@ -393,6 +393,18 @@ describe('jumpTo', () => {
         camera.jumpTo({center: [1, 2]});
         expect(!camera.isEasing()).toBeTruthy();
     });
+
+    test('respects zoomSnap', () => {
+        const camera = createCamera({zoomSnap: 1});
+        camera.jumpTo({zoom: 2.3});
+        expect(camera.getZoom()).toBe(2);
+    });
+
+    test('zoomSnap=0 does not snap zoom', () => {
+        const camera = createCamera({zoomSnap: 0});
+        camera.jumpTo({zoom: 2.3});
+        expect(camera.getZoom()).toBe(2.3);
+    });
 });
 
 describe('setCenter', () => {
@@ -466,6 +478,12 @@ describe('setZoom', () => {
         camera.setZoom(5);
         expect(!camera.isEasing()).toBeTruthy();
     });
+
+    test('respects zoomSnap', () => {
+        const camera = createCamera({zoomSnap: 0.5});
+        camera.setZoom(2.7);
+        expect(camera.getZoom()).toBe(2.5);
+    });
 });
 
 describe('setBearing', () => {
@@ -1303,6 +1321,18 @@ describe('easeTo', () => {
 
         expect(camera.getBearing()).toEqual(97);
     });
+
+    test('respects zoomSnap', () => {
+        const camera = createCamera({zoomSnap: 1});
+        camera.easeTo({zoom: 2.7, duration: 0});
+        expect(camera.getZoom()).toBe(3);
+    });
+
+    test('zoomSnap=0 does not snap zoom', () => {
+        const camera = createCamera({zoomSnap: 0});
+        camera.easeTo({zoom: 2.7, duration: 0});
+        expect(camera.getZoom()).toBe(2.7);
+    });
 });
 
 describe('flyTo', () => {
@@ -2117,6 +2147,18 @@ describe('flyTo', () => {
         camera._finalizeElevation();
         expect(camera._elevationFreeze).toBeFalsy();
     });
+
+    test('respects zoomSnap', () => {
+        const camera = createCamera({zoomSnap: 1});
+        camera.flyTo({zoom: 2.7, animate: false});
+        expect(camera.getZoom()).toBe(3);
+    });
+
+    test('zoomSnap=0 does not snap zoom', () => {
+        const camera = createCamera({zoomSnap: 0});
+        camera.flyTo({zoom: 2.7, animate: false});
+        expect(camera.getZoom()).toBe(2.7);
+    });
 });
 
 describe('isEasing', () => {

src/ui/camera.ts

@@ -948,6 +948,10 @@ export abstract class Camera extends Evented {
     jumpTo(options: JumpToOptions, eventData?: any): this {
         this.stop();
 
+        if ('zoom' in options && this._zoomSnap) {
+            options.zoom = evaluateZoomSnap(options.zoom, this._zoomSnap);
+        }
+
         const tr = this._getTransformForUpdate();
         let bearingChanged = false,
             pitchChanged = false;
@@ -1120,6 +1124,10 @@ export abstract class Camera extends Evented {
             easing: defaultEasing
         }, options);
 
+        if ('zoom' in options && this._zoomSnap) {
+            options.zoom = evaluateZoomSnap(options.zoom, this._zoomSnap);
+        }
+
         if (options.animate === false || (!options.essential && browser.prefersReducedMotion)) {
             options.duration = 0;
         }
@@ -1436,6 +1444,10 @@ export abstract class Camera extends Evented {
             easing: defaultEasing
         }, options);
 
+        if ('zoom' in options && this._zoomSnap) {
+            options.zoom = evaluateZoomSnap(options.zoom, this._zoomSnap);
+        }
+
         const tr = this._getTransformForUpdate(),
             startBearing = tr.bearing,
             startPitch = tr.pitch,