/** * @module ol/interaction/MouseWheelZoom */ import {always, focus} from '../events/condition.js'; import EventType from '../events/EventType.js'; import {DEVICE_PIXEL_RATIO, FIREFOX} from '../has.js'; import Interaction, {zoomByDelta} from './Interaction.js'; import {clamp} from '../math.js'; /** * @enum {string} */ export const Mode = { TRACKPAD: 'trackpad', WHEEL: 'wheel' }; /** * @typedef {Object} Options * @property {import("../events/condition.js").Condition} [condition] A function that * takes an {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a * boolean to indicate whether that event should be handled. Default is * {@link module:ol/events/condition~always}. * In addition, if there is a `tabindex` attribute on the map element, * {@link module:ol/events/condition~focus} will also be applied. * @property {number} [maxDelta=1] Maximum mouse wheel delta. * @property {number} [duration=250] Animation duration in milliseconds. * @property {number} [timeout=80] Mouse wheel timeout duration in milliseconds. * @property {boolean} [useAnchor=true] Enable zooming using the mouse's * location as the anchor. When set to `false`, zooming in and out will zoom to * the center of the screen instead of zooming on the mouse's location. */ /** * @classdesc * Allows the user to zoom the map by scrolling the mouse wheel. * @api */ class MouseWheelZoom extends Interaction { /** * @param {Options=} opt_options Options. */ constructor(opt_options) { const options = opt_options ? opt_options : {}; super(/** @type {import("./Interaction.js").InteractionOptions} */ (options)); /** * @private * @type {number} */ this.totalDelta_ = 0; /** * @private * @type {number} */ this.lastDelta_ = 0; /** * @private * @type {number} */ this.maxDelta_ = options.maxDelta !== undefined ? options.maxDelta : 1; /** * @private * @type {number} */ this.duration_ = options.duration !== undefined ? options.duration : 250; /** * @private * @type {number} */ this.timeout_ = options.timeout !== undefined ? options.timeout : 80; /** * @private * @type {boolean} */ this.useAnchor_ = options.useAnchor !== undefined ? options.useAnchor : true; /** * @private * @type {import("../events/condition.js").Condition} */ this.condition_ = options.condition ? options.condition : always; /** * @private * @type {?import("../coordinate.js").Coordinate} */ this.lastAnchor_ = null; /** * @private * @type {number|undefined} */ this.startTime_ = undefined; /** * @private * @type {?} */ this.timeoutId_; /** * @private * @type {Mode|undefined} */ this.mode_ = undefined; /** * Trackpad events separated by this delay will be considered separate * interactions. * @type {number} */ this.trackpadEventGap_ = 400; /** * @type {?} */ this.trackpadTimeoutId_; /** * The number of delta values per zoom level * @private * @type {number} */ this.deltaPerZoom_ = 300; } /** * @private * @param {import("../MapBrowserEvent").default} mapBrowserEvent Event. * @return {boolean} Condition passes. */ conditionInternal_(mapBrowserEvent) { let pass = true; if (mapBrowserEvent.map.getTargetElement().hasAttribute('tabindex')) { pass = focus(mapBrowserEvent); } return pass && this.condition_(mapBrowserEvent); } /** * @private */ endInteraction_() { this.trackpadTimeoutId_ = undefined; const view = this.getMap().getView(); view.endInteraction(undefined, this.lastDelta_ ? (this.lastDelta_ > 0 ? 1 : -1) : 0, this.lastAnchor_); } /** * Handles the {@link module:ol/MapBrowserEvent map browser event} (if it was a mousewheel-event) and eventually * zooms the map. * @override */ handleEvent(mapBrowserEvent) { if (!this.conditionInternal_(mapBrowserEvent)) { return true; } const type = mapBrowserEvent.type; if (type !== EventType.WHEEL) { return true; } mapBrowserEvent.preventDefault(); const map = mapBrowserEvent.map; const wheelEvent = /** @type {WheelEvent} */ (mapBrowserEvent.originalEvent); if (this.useAnchor_) { this.lastAnchor_ = mapBrowserEvent.coordinate; } // Delta normalisation inspired by // https://github.com/mapbox/mapbox-gl-js/blob/001c7b9/js/ui/handler/scroll_zoom.js let delta; if (mapBrowserEvent.type == EventType.WHEEL) { delta = wheelEvent.deltaY; if (FIREFOX && wheelEvent.deltaMode === WheelEvent.DOM_DELTA_PIXEL) { delta /= DEVICE_PIXEL_RATIO; } if (wheelEvent.deltaMode === WheelEvent.DOM_DELTA_LINE) { delta *= 40; } } if (delta === 0) { return false; } else { this.lastDelta_ = delta; } const now = Date.now(); if (this.startTime_ === undefined) { this.startTime_ = now; } if (!this.mode_ || now - this.startTime_ > this.trackpadEventGap_) { this.mode_ = Math.abs(delta) < 4 ? Mode.TRACKPAD : Mode.WHEEL; } const view = map.getView(); if (this.mode_ === Mode.TRACKPAD && !view.getConstrainResolution()) { if (this.trackpadTimeoutId_) { clearTimeout(this.trackpadTimeoutId_); } else { if (view.getAnimating()) { view.cancelAnimations(); } view.beginInteraction(); } this.trackpadTimeoutId_ = setTimeout(this.endInteraction_.bind(this), this.timeout_); view.adjustZoom(-delta / this.deltaPerZoom_, this.lastAnchor_); this.startTime_ = now; return false; } this.totalDelta_ += delta; const timeLeft = Math.max(this.timeout_ - (now - this.startTime_), 0); clearTimeout(this.timeoutId_); this.timeoutId_ = setTimeout(this.handleWheelZoom_.bind(this, map), timeLeft); return false; } /** * @private * @param {import("../PluggableMap.js").default} map Map. */ handleWheelZoom_(map) { const view = map.getView(); if (view.getAnimating()) { view.cancelAnimations(); } let delta = -clamp(this.totalDelta_, -this.maxDelta_ * this.deltaPerZoom_, this.maxDelta_ * this.deltaPerZoom_) / this.deltaPerZoom_; if (view.getConstrainResolution()) { // view has a zoom constraint, zoom by 1 delta = delta ? delta > 0 ? 1 : -1 : 0; } zoomByDelta(view, delta, this.lastAnchor_, this.duration_); this.mode_ = undefined; this.totalDelta_ = 0; this.lastAnchor_ = null; this.startTime_ = undefined; this.timeoutId_ = undefined; } /** * Enable or disable using the mouse's location as an anchor when zooming * @param {boolean} useAnchor true to zoom to the mouse's location, false * to zoom to the center of the map * @api */ setMouseAnchor(useAnchor) { this.useAnchor_ = useAnchor; if (!useAnchor) { this.lastAnchor_ = null; } } } export default MouseWheelZoom;