var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { if (typeof b !== "function" && b !== null) throw new TypeError("Class extends value " + String(b) + " is not a constructor or null"); extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); /** * @module ol/interaction/Snap */ import CollectionEventType from '../CollectionEventType.js'; import EventType from '../events/EventType.js'; import PointerInteraction from './Pointer.js'; import RBush from '../structs/RBush.js'; import VectorEventType from '../source/VectorEventType.js'; import { FALSE, TRUE } from '../functions.js'; import { boundingExtent, createEmpty } from '../extent.js'; import { closestOnCircle, closestOnSegment, squaredDistance, } from '../coordinate.js'; import { fromCircle } from '../geom/Polygon.js'; import { fromUserCoordinate, getUserProjection, toUserCoordinate, } from '../proj.js'; import { getUid } from '../util.js'; import { getValues } from '../obj.js'; import { listen, unlistenByKey } from '../events.js'; /** * @typedef {Object} Result * @property {import("../coordinate.js").Coordinate|null} vertex Vertex. * @property {import("../pixel.js").Pixel|null} vertexPixel VertexPixel. */ /** * @typedef {Object} SegmentData * @property {import("../Feature.js").default} feature Feature. * @property {Array} segment Segment. */ /** * @typedef {Object} Options * @property {import("../Collection.js").default} [features] Snap to these features. Either this option or source should be provided. * @property {boolean} [edge=true] Snap to edges. * @property {boolean} [vertex=true] Snap to vertices. * @property {number} [pixelTolerance=10] Pixel tolerance for considering the pointer close enough to a segment or * vertex for snapping. * @property {import("../source/Vector.js").default} [source] Snap to features from this source. Either this option or features should be provided */ /** * @param {import("../source/Vector.js").VectorSourceEvent|import("../Collection.js").CollectionEvent} evt Event. * @return {import("../Feature.js").default} Feature. */ function getFeatureFromEvent(evt) { if ( /** @type {import("../source/Vector.js").VectorSourceEvent} */ (evt).feature) { return /** @type {import("../source/Vector.js").VectorSourceEvent} */ (evt) .feature; } else if ( /** @type {import("../Collection.js").CollectionEvent} */ (evt).element) { return /** @type {import("../Feature.js").default} */ ( /** @type {import("../Collection.js").CollectionEvent} */ (evt).element); } } var tempSegment = []; /** * @classdesc * Handles snapping of vector features while modifying or drawing them. The * features can come from a {@link module:ol/source/Vector~VectorSource} or {@link module:ol/Collection~Collection} * Any interaction object that allows the user to interact * with the features using the mouse can benefit from the snapping, as long * as it is added before. * * The snap interaction modifies map browser event `coordinate` and `pixel` * properties to force the snap to occur to any interaction that them. * * Example: * * import Snap from 'ol/interaction/Snap'; * * const snap = new Snap({ * source: source * }); * * map.addInteraction(snap); * * @api */ var Snap = /** @class */ (function (_super) { __extends(Snap, _super); /** * @param {Options} [opt_options] Options. */ function Snap(opt_options) { var _this = this; var options = opt_options ? opt_options : {}; var pointerOptions = /** @type {import("./Pointer.js").Options} */ (options); if (!pointerOptions.handleDownEvent) { pointerOptions.handleDownEvent = TRUE; } if (!pointerOptions.stopDown) { pointerOptions.stopDown = FALSE; } _this = _super.call(this, pointerOptions) || this; /** * @type {import("../source/Vector.js").default|null} * @private */ _this.source_ = options.source ? options.source : null; /** * @private * @type {boolean} */ _this.vertex_ = options.vertex !== undefined ? options.vertex : true; /** * @private * @type {boolean} */ _this.edge_ = options.edge !== undefined ? options.edge : true; /** * @type {import("../Collection.js").default|null} * @private */ _this.features_ = options.features ? options.features : null; /** * @type {Array} * @private */ _this.featuresListenerKeys_ = []; /** * @type {Object} * @private */ _this.featureChangeListenerKeys_ = {}; /** * Extents are preserved so indexed segment can be quickly removed * when its feature geometry changes * @type {Object} * @private */ _this.indexedFeaturesExtents_ = {}; /** * If a feature geometry changes while a pointer drag|move event occurs, the * feature doesn't get updated right away. It will be at the next 'pointerup' * event fired. * @type {!Object} * @private */ _this.pendingFeatures_ = {}; /** * @type {number} * @private */ _this.pixelTolerance_ = options.pixelTolerance !== undefined ? options.pixelTolerance : 10; /** * Segment RTree for each layer * @type {import("../structs/RBush.js").default} * @private */ _this.rBush_ = new RBush(); /** * @const * @private * @type {Object>, import("../geom/Geometry.js").default): void>} */ _this.GEOMETRY_SEGMENTERS_ = { 'Point': _this.segmentPointGeometry_.bind(_this), 'LineString': _this.segmentLineStringGeometry_.bind(_this), 'LinearRing': _this.segmentLineStringGeometry_.bind(_this), 'Polygon': _this.segmentPolygonGeometry_.bind(_this), 'MultiPoint': _this.segmentMultiPointGeometry_.bind(_this), 'MultiLineString': _this.segmentMultiLineStringGeometry_.bind(_this), 'MultiPolygon': _this.segmentMultiPolygonGeometry_.bind(_this), 'GeometryCollection': _this.segmentGeometryCollectionGeometry_.bind(_this), 'Circle': _this.segmentCircleGeometry_.bind(_this), }; return _this; } /** * Add a feature to the collection of features that we may snap to. * @param {import("../Feature.js").default} feature Feature. * @param {boolean} [opt_listen] Whether to listen to the feature change or not * Defaults to `true`. * @api */ Snap.prototype.addFeature = function (feature, opt_listen) { var register = opt_listen !== undefined ? opt_listen : true; var feature_uid = getUid(feature); var geometry = feature.getGeometry(); if (geometry) { var segmenter = this.GEOMETRY_SEGMENTERS_[geometry.getType()]; if (segmenter) { this.indexedFeaturesExtents_[feature_uid] = geometry.getExtent(createEmpty()); var segments = /** @type {Array>} */ ([]); segmenter(segments, geometry); if (segments.length === 1) { this.rBush_.insert(boundingExtent(segments[0]), { feature: feature, segment: segments[0], }); } else if (segments.length > 1) { var extents = segments.map(function (s) { return boundingExtent(s); }); var segmentsData = segments.map(function (segment) { return ({ feature: feature, segment: segment, }); }); this.rBush_.load(extents, segmentsData); } } } if (register) { this.featureChangeListenerKeys_[feature_uid] = listen(feature, EventType.CHANGE, this.handleFeatureChange_, this); } }; /** * @param {import("../Feature.js").default} feature Feature. * @private */ Snap.prototype.forEachFeatureAdd_ = function (feature) { this.addFeature(feature); }; /** * @param {import("../Feature.js").default} feature Feature. * @private */ Snap.prototype.forEachFeatureRemove_ = function (feature) { this.removeFeature(feature); }; /** * @return {import("../Collection.js").default|Array} Features. * @private */ Snap.prototype.getFeatures_ = function () { var features; if (this.features_) { features = this.features_; } else if (this.source_) { features = this.source_.getFeatures(); } return features; }; /** * @param {import("../MapBrowserEvent.js").default} evt Map browser event. * @return {boolean} `false` to stop event propagation. */ Snap.prototype.handleEvent = function (evt) { var result = this.snapTo(evt.pixel, evt.coordinate, evt.map); if (result) { evt.coordinate = result.vertex.slice(0, 2); evt.pixel = result.vertexPixel; } return _super.prototype.handleEvent.call(this, evt); }; /** * @param {import("../source/Vector.js").VectorSourceEvent|import("../Collection.js").CollectionEvent} evt Event. * @private */ Snap.prototype.handleFeatureAdd_ = function (evt) { var feature = getFeatureFromEvent(evt); this.addFeature(feature); }; /** * @param {import("../source/Vector.js").VectorSourceEvent|import("../Collection.js").CollectionEvent} evt Event. * @private */ Snap.prototype.handleFeatureRemove_ = function (evt) { var feature = getFeatureFromEvent(evt); this.removeFeature(feature); }; /** * @param {import("../events/Event.js").default} evt Event. * @private */ Snap.prototype.handleFeatureChange_ = function (evt) { var feature = /** @type {import("../Feature.js").default} */ (evt.target); if (this.handlingDownUpSequence) { var uid = getUid(feature); if (!(uid in this.pendingFeatures_)) { this.pendingFeatures_[uid] = feature; } } else { this.updateFeature_(feature); } }; /** * Handle pointer up events. * @param {import("../MapBrowserEvent.js").default} evt Event. * @return {boolean} If the event was consumed. */ Snap.prototype.handleUpEvent = function (evt) { var featuresToUpdate = getValues(this.pendingFeatures_); if (featuresToUpdate.length) { featuresToUpdate.forEach(this.updateFeature_.bind(this)); this.pendingFeatures_ = {}; } return false; }; /** * Remove a feature from the collection of features that we may snap to. * @param {import("../Feature.js").default} feature Feature * @param {boolean} [opt_unlisten] Whether to unlisten to the feature change * or not. Defaults to `true`. * @api */ Snap.prototype.removeFeature = function (feature, opt_unlisten) { var unregister = opt_unlisten !== undefined ? opt_unlisten : true; var feature_uid = getUid(feature); var extent = this.indexedFeaturesExtents_[feature_uid]; if (extent) { var rBush = this.rBush_; var nodesToRemove_1 = []; rBush.forEachInExtent(extent, function (node) { if (feature === node.feature) { nodesToRemove_1.push(node); } }); for (var i = nodesToRemove_1.length - 1; i >= 0; --i) { rBush.remove(nodesToRemove_1[i]); } } if (unregister) { unlistenByKey(this.featureChangeListenerKeys_[feature_uid]); delete this.featureChangeListenerKeys_[feature_uid]; } }; /** * Remove the interaction from its current map and attach it to the new map. * Subclasses may set up event handlers to get notified about changes to * the map here. * @param {import("../PluggableMap.js").default} map Map. */ Snap.prototype.setMap = function (map) { var currentMap = this.getMap(); var keys = this.featuresListenerKeys_; var features = /** @type {Array} */ (this.getFeatures_()); if (currentMap) { keys.forEach(unlistenByKey); keys.length = 0; features.forEach(this.forEachFeatureRemove_.bind(this)); } _super.prototype.setMap.call(this, map); if (map) { if (this.features_) { keys.push(listen(this.features_, CollectionEventType.ADD, this.handleFeatureAdd_, this), listen(this.features_, CollectionEventType.REMOVE, this.handleFeatureRemove_, this)); } else if (this.source_) { keys.push(listen(this.source_, VectorEventType.ADDFEATURE, this.handleFeatureAdd_, this), listen(this.source_, VectorEventType.REMOVEFEATURE, this.handleFeatureRemove_, this)); } features.forEach(this.forEachFeatureAdd_.bind(this)); } }; /** * @param {import("../pixel.js").Pixel} pixel Pixel * @param {import("../coordinate.js").Coordinate} pixelCoordinate Coordinate * @param {import("../PluggableMap.js").default} map Map. * @return {Result|null} Snap result */ Snap.prototype.snapTo = function (pixel, pixelCoordinate, map) { var lowerLeft = map.getCoordinateFromPixel([ pixel[0] - this.pixelTolerance_, pixel[1] + this.pixelTolerance_, ]); var upperRight = map.getCoordinateFromPixel([ pixel[0] + this.pixelTolerance_, pixel[1] - this.pixelTolerance_, ]); var box = boundingExtent([lowerLeft, upperRight]); var segments = this.rBush_.getInExtent(box); var segmentsLength = segments.length; if (segmentsLength === 0) { return null; } var projection = map.getView().getProjection(); var projectedCoordinate = fromUserCoordinate(pixelCoordinate, projection); var closestVertex; var minSquaredDistance = Infinity; var squaredPixelTolerance = this.pixelTolerance_ * this.pixelTolerance_; var getResult = function () { if (closestVertex) { var vertexPixel = map.getPixelFromCoordinate(closestVertex); var squaredPixelDistance = squaredDistance(pixel, vertexPixel); if (squaredPixelDistance <= squaredPixelTolerance) { return { vertex: closestVertex, vertexPixel: [ Math.round(vertexPixel[0]), Math.round(vertexPixel[1]), ], }; } } return null; }; if (this.vertex_) { for (var i = 0; i < segmentsLength; ++i) { var segmentData = segments[i]; if (segmentData.feature.getGeometry().getType() !== 'Circle') { segmentData.segment.forEach(function (vertex) { var tempVertexCoord = fromUserCoordinate(vertex, projection); var delta = squaredDistance(projectedCoordinate, tempVertexCoord); if (delta < minSquaredDistance) { closestVertex = vertex; minSquaredDistance = delta; } }); } } var result = getResult(); if (result) { return result; } } if (this.edge_) { for (var i = 0; i < segmentsLength; ++i) { var vertex = null; var segmentData = segments[i]; if (segmentData.feature.getGeometry().getType() === 'Circle') { var circleGeometry = segmentData.feature.getGeometry(); var userProjection = getUserProjection(); if (userProjection) { circleGeometry = circleGeometry .clone() .transform(userProjection, projection); } vertex = toUserCoordinate(closestOnCircle(projectedCoordinate, /** @type {import("../geom/Circle.js").default} */ (circleGeometry)), projection); } else { var _a = segmentData.segment, segmentStart = _a[0], segmentEnd = _a[1]; // points have only one coordinate if (segmentEnd) { tempSegment[0] = fromUserCoordinate(segmentStart, projection); tempSegment[1] = fromUserCoordinate(segmentEnd, projection); vertex = closestOnSegment(projectedCoordinate, tempSegment); } } if (vertex) { var delta = squaredDistance(projectedCoordinate, vertex); if (delta < minSquaredDistance) { closestVertex = vertex; minSquaredDistance = delta; } } } var result = getResult(); if (result) { return result; } } return null; }; /** * @param {import("../Feature.js").default} feature Feature * @private */ Snap.prototype.updateFeature_ = function (feature) { this.removeFeature(feature, false); this.addFeature(feature, false); }; /** * @param {Array>} segments Segments * @param {import("../geom/Circle.js").default} geometry Geometry. * @private */ Snap.prototype.segmentCircleGeometry_ = function (segments, geometry) { var projection = this.getMap().getView().getProjection(); var circleGeometry = geometry; var userProjection = getUserProjection(); if (userProjection) { circleGeometry = /** @type {import("../geom/Circle.js").default} */ (circleGeometry.clone().transform(userProjection, projection)); } var polygon = fromCircle(circleGeometry); if (userProjection) { polygon.transform(projection, userProjection); } var coordinates = polygon.getCoordinates()[0]; for (var i = 0, ii = coordinates.length - 1; i < ii; ++i) { segments.push(coordinates.slice(i, i + 2)); } }; /** * @param {Array>} segments Segments * @param {import("../geom/GeometryCollection.js").default} geometry Geometry. * @private */ Snap.prototype.segmentGeometryCollectionGeometry_ = function (segments, geometry) { var geometries = geometry.getGeometriesArray(); for (var i = 0; i < geometries.length; ++i) { var segmenter = this.GEOMETRY_SEGMENTERS_[geometries[i].getType()]; if (segmenter) { segmenter(segments, geometries[i]); } } }; /** * @param {Array>} segments Segments * @param {import("../geom/LineString.js").default} geometry Geometry. * @private */ Snap.prototype.segmentLineStringGeometry_ = function (segments, geometry) { var coordinates = geometry.getCoordinates(); for (var i = 0, ii = coordinates.length - 1; i < ii; ++i) { segments.push(coordinates.slice(i, i + 2)); } }; /** * @param {Array>} segments Segments * @param {import("../geom/MultiLineString.js").default} geometry Geometry. * @private */ Snap.prototype.segmentMultiLineStringGeometry_ = function (segments, geometry) { var lines = geometry.getCoordinates(); for (var j = 0, jj = lines.length; j < jj; ++j) { var coordinates = lines[j]; for (var i = 0, ii = coordinates.length - 1; i < ii; ++i) { segments.push(coordinates.slice(i, i + 2)); } } }; /** * @param {Array>} segments Segments * @param {import("../geom/MultiPoint.js").default} geometry Geometry. * @private */ Snap.prototype.segmentMultiPointGeometry_ = function (segments, geometry) { geometry.getCoordinates().forEach(function (point) { segments.push([point]); }); }; /** * @param {Array>} segments Segments * @param {import("../geom/MultiPolygon.js").default} geometry Geometry. * @private */ Snap.prototype.segmentMultiPolygonGeometry_ = function (segments, geometry) { var polygons = geometry.getCoordinates(); for (var k = 0, kk = polygons.length; k < kk; ++k) { var rings = polygons[k]; for (var j = 0, jj = rings.length; j < jj; ++j) { var coordinates = rings[j]; for (var i = 0, ii = coordinates.length - 1; i < ii; ++i) { segments.push(coordinates.slice(i, i + 2)); } } } }; /** * @param {Array>} segments Segments * @param {import("../geom/Point.js").default} geometry Geometry. * @private */ Snap.prototype.segmentPointGeometry_ = function (segments, geometry) { segments.push([geometry.getCoordinates()]); }; /** * @param {Array>} segments Segments * @param {import("../geom/Polygon.js").default} geometry Geometry. * @private */ Snap.prototype.segmentPolygonGeometry_ = function (segments, geometry) { var rings = geometry.getCoordinates(); for (var j = 0, jj = rings.length; j < jj; ++j) { var coordinates = rings[j]; for (var i = 0, ii = coordinates.length - 1; i < ii; ++i) { segments.push(coordinates.slice(i, i + 2)); } } }; return Snap; }(PointerInteraction)); export default Snap; //# sourceMappingURL=Snap.js.map