Refine sub-toggles API for several event handlers

GitOrigin-RevId: be01daa6b534390255f7ac37292bc9e6ea1dcaf9

Author: underoot

src/ui/handler/keyboard.ts

@@ -31,8 +31,10 @@ class KeyboardHandler implements Handler {
     _panStep: number;
     _bearingStep: number;
     _pitchStep: number;
-    _rotationDisabled: boolean;
+    _bearingDisabled: boolean;
+    _pitchDisabled: boolean;
     _panDisabled: boolean;
+    _zoomDisabled: boolean;
 
     /**
     * @private
@@ -42,8 +44,10 @@ class KeyboardHandler implements Handler {
         this._panStep = stepOptions.panStep;
         this._bearingStep = stepOptions.bearingStep;
         this._pitchStep = stepOptions.pitchStep;
-        this._rotationDisabled = false;
+        this._bearingDisabled = false;
+        this._pitchDisabled = false;
         this._panDisabled = false;
+        this._zoomDisabled = false;
     }
 
     blur() {
@@ -56,6 +60,7 @@ class KeyboardHandler implements Handler {
 
     keydown(e: KeyboardEvent): HandlerResult | null | undefined {
         if (e.altKey || e.ctrlKey || e.metaKey) return;
+        if (!this.isEnabled()) return;
 
         let zoomDir = 0;
         let bearingDir = 0;
@@ -117,8 +122,11 @@ class KeyboardHandler implements Handler {
             return;
         }
 
-        if (this._rotationDisabled) {
+        if (this._bearingDisabled) {
             bearingDir = 0;
+        }
+
+        if (this._pitchDisabled) {
             pitchDir = 0;
         }
 
@@ -127,6 +135,10 @@ class KeyboardHandler implements Handler {
             yDir = 0;
         }
 
+        if (this._zoomDisabled) {
+            zoomDir = 0;
+        }
+
         return {
             cameraAnimation: (map: Map) => {
                 const zoom = map.getZoom();
@@ -176,7 +188,7 @@ class KeyboardHandler implements Handler {
      * const isKeyboardEnabled = map.keyboard.isEnabled();
      */
     isEnabled(): boolean {
-        return this._enabled;
+        return this._enabled && !(this._bearingDisabled && this._pitchDisabled && this._panDisabled && this._zoomDisabled);
     }
 
     /**
@@ -193,25 +205,40 @@ class KeyboardHandler implements Handler {
     }
 
     /**
-     * Disables the "keyboard pan/rotate" interaction, leaving the
+     * Disables the "keyboard pitch/rotate" interaction, leaving the
      * "keyboard zoom" interaction enabled.
      *
      * @example
      * map.keyboard.disableRotation();
      */
     disableRotation() {
-        this._rotationDisabled = true;
+        this._pitchDisabled = true;
+        this._bearingDisabled = true;
     }
 
     /**
-     * Enables the "keyboard pan/rotate" interaction.
+     * Enables the "keyboard pitch/rotate" interaction.
      *
      * @example
      * map.keyboard.enable();
      * map.keyboard.enableRotation();
      */
     enableRotation() {
-        this._rotationDisabled = false;
+        this._pitchDisabled = false;
+        this._bearingDisabled = false;
+    }
+
+    /**
+     * Returns a Boolean indicating whether the "keyboard pitch/rotate"
+     * interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "keyboard pitch/rotate"
+     * interaction is enabled.
+     * @example
+     * const isRotationEnabled = map.keyboard.isRotationEnabled();
+     */
+    isRotationEnabled(): boolean {
+        return !this._pitchDisabled && !this._bearingDisabled;
     }
 
     /**
@@ -235,6 +262,120 @@ class KeyboardHandler implements Handler {
     enablePan() {
         this._panDisabled = false;
     }
+
+    /**
+     * Returns a Boolean indicating whether the "keyboard pan" interaction is
+     * enabled.
+     *
+     * @returns {boolean} `true` if the "keyboard pan" interaction is enabled.
+     * @example
+     * const isPanEnabled = map.keyboard.isPanEnabled();
+     */
+    isPanEnabled(): boolean {
+        return !this._panDisabled;
+    }
+
+    /**
+     * Disables the "keyboard zoom" interaction (plus/minus keys), leaving the
+     * "keyboard pan" and "keyboard rotate/pitch" interactions enabled.
+     *
+     * @example
+     * map.keyboard.disableZoom();
+     */
+    disableZoom() {
+        this._zoomDisabled = true;
+    }
+
+    /**
+     * Enables the "keyboard zoom" interaction (plus/minus keys).
+     *
+     * @example
+     * map.keyboard.enable();
+     * map.keyboard.enableZoom();
+     */
+    enableZoom() {
+        this._zoomDisabled = false;
+    }
+
+    /**
+     * Returns a Boolean indicating whether the "keyboard zoom" interaction is
+     * enabled.
+     *
+     * @returns {boolean} `true` if the "keyboard zoom" interaction is enabled.
+     * @example
+     * const isZoomEnabled = map.keyboard.isZoomEnabled();
+     */
+    isZoomEnabled(): boolean {
+        return !this._zoomDisabled;
+    }
+
+    /**
+     * Disables the "keyboard pitch" interaction (Shift+Up/Down), leaving the
+     * "keyboard pan" and "keyboard rotate" interactions enabled.
+     *
+     * @example
+     * map.keyboard.disablePitch();
+     */
+    disablePitch() {
+        this._pitchDisabled = true;
+    }
+
+    /**
+     * Enables the "keyboard pitch" interaction (Shift+Up/Down).
+     *
+     * @example
+     * map.keyboard.enable();
+     * map.keyboard.enablePitch();
+     */
+    enablePitch() {
+        this._pitchDisabled = false;
+    }
+
+    /**
+     * Returns a Boolean indicating whether the "keyboard pitch" interaction is
+     * enabled.
+     *
+     * @returns {boolean} `true` if the "keyboard pitch" interaction is enabled.
+     * @example
+     * const isPitchEnabled = map.keyboard.isPitchEnabled();
+     */
+    isPitchEnabled(): boolean {
+        return !this._pitchDisabled;
+    }
+
+    /**
+     * Disables the "keyboard bearing" interaction (Shift+Left/Right), leaving the
+     * "keyboard pan" and "keyboard pitch" interactions enabled.
+     *
+     * @example
+     * map.keyboard.disableBearing();
+     */
+    disableBearing() {
+        this._bearingDisabled = true;
+    }
+
+    /**
+     * Enables the "keyboard bearing" interaction (Shift+Left/Right).
+     *
+     * @example
+     * map.keyboard.enable();
+     * map.keyboard.enableBearing();
+     */
+    enableBearing() {
+        this._bearingDisabled = false;
+    }
+
+    /**
+     * Returns a Boolean indicating whether the "keyboard bearing" interaction is
+     * enabled.
+     *
+     * @returns {boolean} `true` if the "keyboard bearing" interaction is enabled.
+     * @example
+     * const isBearingEnabled = map.keyboard.isBearingEnabled();
+     */
+    isBearingEnabled(): boolean {
+        return !this._bearingDisabled;
+    }
 }
 
 function easeOut(t: number) {

src/ui/handler/shim/drag_rotate.ts

@@ -13,6 +13,7 @@ export default class DragRotateHandler {
     _mousePitch: MousePitchHandler;
     _pitchWithRotate: boolean;
     _pitchDisabled: boolean;
+    _rotationDisabled: boolean;
 
     /**
      * @param {Object} [options]
@@ -28,6 +29,7 @@ export default class DragRotateHandler {
         this._mouseRotate = mouseRotate;
         this._mousePitch = mousePitch;
         this._pitchDisabled = false;
+        this._rotationDisabled = false;
     }
 
     /**
@@ -37,7 +39,7 @@ export default class DragRotateHandler {
      * map.dragRotate.enable();
      */
     enable() {
-        this._mouseRotate.enable();
+        if (!this._rotationDisabled) this._mouseRotate.enable();
         if (this._pitchWithRotate && !this._pitchDisabled) this._mousePitch.enable();
     }
 
@@ -60,7 +62,14 @@ export default class DragRotateHandler {
      * const isDragRotateEnabled = map.dragRotate.isEnabled();
      */
     isEnabled(): boolean {
-        return this._mouseRotate.isEnabled() && (!this._pitchWithRotate || this._pitchDisabled || this._mousePitch.isEnabled());
+        // If pitchWithRotate is true, then the dragRotate interaction is considered enabled
+        // if either the rotation or pitch interactions are enabled.
+        if (this._pitchWithRotate) {
+            return (!this._rotationDisabled && this._mouseRotate.isEnabled()) ||
+                (!this._pitchDisabled && this._mousePitch.isEnabled());
+        } else {
+            return !this._rotationDisabled && this._mouseRotate.isEnabled();
+        }
     }
 
     /**
@@ -99,4 +108,48 @@ export default class DragRotateHandler {
         this._pitchDisabled = false;
         if (this._pitchWithRotate && this._mouseRotate.isEnabled()) this._mousePitch.enable();
     }
+
+    /**
+     * Returns a Boolean indicating whether the "drag to pitch" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "drag to pitch" interaction is enabled.
+     * @example
+     * const isDragPitchEnabled = map.dragRotate.isPitchEnabled();
+     */
+    isPitchEnabled(): boolean {
+        return !this._pitchDisabled && this._mousePitch.isEnabled();
+    }
+
+    /**
+     * Disables the "drag to rotate" interaction, leaving the "drag to pitch"
+     * interaction enabled.
+     *
+     * @example
+     * map.dragRotate.disableRotation();
+     */
+    disableRotation() {
+        this._rotationDisabled = true;
+        this._mouseRotate.disable();
+    }
+
+    /**
+     * Enables the "drag to rotate" interaction.
+     *
+     * @example
+     * map.dragRotate.enableRotation();
+     */
+    enableRotation() {
+        this._rotationDisabled = false;
+        this._mouseRotate.enable();
+    }
+    /**
+     * Returns a Boolean indicating whether the "drag to rotate" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "drag to rotate" interaction is enabled.
+     * @example
+     * const isDragRotationEnabled = map.dragRotate.isRotationEnabled();
+     */
+    isRotationEnabled(): boolean {
+        return !this._rotationDisabled && this._mouseRotate.isEnabled();
+    }
 }

src/ui/handler/shim/touch_zoom_rotate.ts

@@ -75,9 +75,9 @@ export default class TouchZoomRotateHandler {
      * const isTouchZoomRotateEnabled = map.touchZoomRotate.isEnabled();
      */
     isEnabled(): boolean {
-        return this._touchZoom.isEnabled() &&
-            (this._rotationDisabled || this._touchRotate.isEnabled()) &&
-            (this._tapDragZoomDisabled || this._tapDragZoom.isEnabled());
+        return this._touchZoom.isEnabled() ||
+            (!this._rotationDisabled && this._touchRotate.isEnabled()) ||
+            (!this._tapDragZoomDisabled && this._tapDragZoom.isEnabled());
     }
 
     /**
@@ -115,6 +115,17 @@ export default class TouchZoomRotateHandler {
         if (this._touchZoom.isEnabled()) this._touchRotate.enable();
     }
 
+    /**
+     * Returns a Boolean indicating whether the "pinch to rotate" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "pinch to rotate" interaction is enabled.
+     * @example
+     * const isRotationEnabled = map.touchZoomRotate.isRotationEnabled();
+     */
+    isRotationEnabled(): boolean {
+        return !this._rotationDisabled;
+    }
+
     /**
      * Disables the "tap and drag to zoom" interaction (single-finger zoom by
      * tapping, then on a second tap holding and dragging vertically), leaving
@@ -141,4 +152,15 @@ export default class TouchZoomRotateHandler {
         this._tapDragZoomDisabled = false;
         if (this._touchZoom.isEnabled()) this._tapDragZoom.enable();
     }
+
+    /**
+     * Returns a Boolean indicating whether the "tap and drag to zoom" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "tap and drag to zoom" interaction is enabled.
+     * @example
+     * const isTapDragZoomEnabled = map.touchZoomRotate.isTapDragZoomEnabled();
+     */
+    isTapDragZoomEnabled(): boolean {
+        return !this._tapDragZoomDisabled;
+    }
 }