/** * @module ol/interaction/DragPan */ import {scale as scaleCoordinate, rotate as rotateCoordinate} from '../coordinate.js'; import {easeOut} from '../easing.js'; import {noModifierKeys, primaryAction} from '../events/condition.js'; import {FALSE} from '../functions.js'; import PointerInteraction, {centroid as centroidFromPointers} from './Pointer.js'; /** * @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~noModifierKeys} and {@link module:ol/events/condition~primaryAction}. * @property {import("../Kinetic.js").default} [kinetic] Kinetic inertia to apply to the pan. */ /** * @classdesc * Allows the user to pan the map by dragging the map. * @api */ class DragPan extends PointerInteraction { /** * @param {Options=} opt_options Options. */ constructor(opt_options) { super({ stopDown: FALSE }); const options = opt_options ? opt_options : {}; /** * @private * @type {import("../Kinetic.js").default|undefined} */ this.kinetic_ = options.kinetic; /** * @type {import("../pixel.js").Pixel} */ this.lastCentroid = null; /** * @type {number} */ this.lastPointersCount_; /** * @type {boolean} */ this.panning_ = false; /** * @private * @type {import("../events/condition.js").Condition} */ this.condition_ = options.condition ? options.condition : defaultCondition; /** * @private * @type {boolean} */ this.noKinetic_ = false; } /** * @inheritDoc */ handleDragEvent(mapBrowserEvent) { if (!this.panning_) { this.panning_ = true; this.getMap().getView().beginInteraction(); } const targetPointers = this.targetPointers; const centroid = centroidFromPointers(targetPointers); if (targetPointers.length == this.lastPointersCount_) { if (this.kinetic_) { this.kinetic_.update(centroid[0], centroid[1]); } if (this.lastCentroid) { const delta = [ this.lastCentroid[0] - centroid[0], centroid[1] - this.lastCentroid[1] ]; const map = mapBrowserEvent.map; const view = map.getView(); scaleCoordinate(delta, view.getResolution()); rotateCoordinate(delta, view.getRotation()); view.adjustCenter(delta); } } else if (this.kinetic_) { // reset so we don't overestimate the kinetic energy after // after one finger down, tiny drag, second finger down this.kinetic_.begin(); } this.lastCentroid = centroid; this.lastPointersCount_ = targetPointers.length; } /** * @inheritDoc */ handleUpEvent(mapBrowserEvent) { const map = mapBrowserEvent.map; const view = map.getView(); if (this.targetPointers.length === 0) { if (!this.noKinetic_ && this.kinetic_ && this.kinetic_.end()) { const distance = this.kinetic_.getDistance(); const angle = this.kinetic_.getAngle(); const center = /** @type {!import("../coordinate.js").Coordinate} */ (view.getCenter()); const centerpx = map.getPixelFromCoordinate(center); const dest = map.getCoordinateFromPixel([ centerpx[0] - distance * Math.cos(angle), centerpx[1] - distance * Math.sin(angle) ]); view.animate({ center: view.getConstrainedCenter(dest), duration: 500, easing: easeOut }); } if (this.panning_) { this.panning_ = false; view.endInteraction(); } return false; } else { if (this.kinetic_) { // reset so we don't overestimate the kinetic energy after // after one finger up, tiny drag, second finger up this.kinetic_.begin(); } this.lastCentroid = null; return true; } } /** * @inheritDoc */ handleDownEvent(mapBrowserEvent) { if (this.targetPointers.length > 0 && this.condition_(mapBrowserEvent)) { const map = mapBrowserEvent.map; const view = map.getView(); this.lastCentroid = null; // stop any current animation if (view.getAnimating()) { view.cancelAnimations(); } if (this.kinetic_) { this.kinetic_.begin(); } // No kinetic as soon as more than one pointer on the screen is // detected. This is to prevent nasty pans after pinch. this.noKinetic_ = this.targetPointers.length > 1; return true; } else { return false; } } } /** * @param {import("../MapBrowserPointerEvent.js").default} mapBrowserEvent Browser event. * @return {boolean} Combined condition result. */ function defaultCondition(mapBrowserEvent) { return noModifierKeys(mapBrowserEvent) && primaryAction(mapBrowserEvent); } export default DragPan;