* @module ol/interaction/Modify
*/
import Collection from '../Collection.js';
import CollectionEventType from '../CollectionEventType.js';
import Feature from '../Feature.js';
import MapBrowserEventType from '../MapBrowserEventType.js';
import ObjectEventType from '../ObjectEventType.js';
import {equals} from '../array.js';
import {
closestOnSegment,
distance as coordinateDistance,
equals as coordinatesEqual,
squaredDistance as squaredCoordinateDistance,
squaredDistanceToSegment,
} from '../coordinate.js';
import Event from '../events/Event.js';
import EventType from '../events/EventType.js';
import {
altKeyOnly,
always,
never,
primaryAction,
singleClick,
} from '../events/condition.js';
import {
boundingExtent,
buffer as bufferExtent,
createOrUpdateFromCoordinate as createExtent,
} from '../extent.js';
import Point from '../geom/Point.js';
import {fromCircle} from '../geom/Polygon.js';
import VectorLayer from '../layer/Vector.js';
import {
fromUserCoordinate,
fromUserExtent,
getUserProjection,
toUserCoordinate,
toUserExtent,
} from '../proj.js';
import VectorSource from '../source/Vector.js';
import VectorEventType from '../source/VectorEventType.js';
import RBush from '../structs/RBush.js';
import {createEditingStyle} from '../style/Style.js';
import {getUid} from '../util.js';
import PointerInteraction from './Pointer.js';
import {
getCoordinate,
getTraceTargetUpdate,
getTraceTargets,
} from './tracing.js';
* The segment index assigned to a circle's center when
* breaking up a circle into ModifySegmentDataType segments.
* @type {number}
*/
const CIRCLE_CENTER_INDEX = 0;
* The segment index assigned to a circle's circumference when
* breaking up a circle into ModifySegmentDataType segments.
* @type {number}
*/
const CIRCLE_CIRCUMFERENCE_INDEX = 1;
const tempExtent = [0, 0, 0, 0];
const tempSegment = [];
* @enum {string}
*/
const ModifyEventType = {
* Triggered upon feature modification start
* @event ModifyEvent#modifystart
* @api
*/
MODIFYSTART: 'modifystart',
* Triggered upon feature modification end
* @event ModifyEvent#modifyend
* @api
*/
MODIFYEND: 'modifyend',
};
* @typedef {Object} SegmentData
* @property {Array<number>} [depth] Depth.
* @property {Feature} feature Feature.
* @property {import("../geom/SimpleGeometry.js").default} geometry Geometry.
* @property {number} [index] Index.
* @property {Array<Array<number>>} segment Segment.
* @property {Array<SegmentData>} [featureSegments] FeatureSegments.
*/
* A function that takes a {@link module:ol/Feature~Feature} and returns `true` if
* the feature may be modified or `false` otherwise.
* @typedef {function(Feature):boolean} FilterFunction
*/
* @typedef {[SegmentData, number]} DragSegment
*/
* @typedef {Object} Options
* @property {import("../events/condition.js").Condition} [condition] A function that
* takes a {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a
* boolean to indicate whether that event will be considered to add or move a
* vertex to the sketch. Default is
* {@link module:ol/events/condition.primaryAction}.
* @property {import("../events/condition.js").Condition} [deleteCondition] A function
* that takes a {@link module:ol/MapBrowserEvent~MapBrowserEvent} and returns a
* boolean to indicate whether that event should be handled. By default,
* {@link module:ol/events/condition.singleClick} with
* {@link module:ol/events/condition.altKeyOnly} results in a vertex deletion.
* This combination is handled by wrapping the two condition checks in a single function:
* ```js
* import { altKeyOnly, singleClick } from 'ol/events/condition.js';
*
* function (event) {
* return altKeyOnly(event) && singleClick(event)
* }
* ```
* @property {import("../events/condition.js").Condition} [insertVertexCondition] A
* function that takes a {@link module:ol/MapBrowserEvent~MapBrowserEvent} and
* returns a boolean to indicate whether a new vertex should be added to the sketch
* features. Default is {@link module:ol/events/condition.always}.
* @property {number} [pixelTolerance=10] Pixel tolerance for considering the
* pointer close enough to a segment or vertex for editing.
* @property {import("../style/Style.js").StyleLike|import("../style/flat.js").FlatStyleLike} [style]
* Style used for the modification point or vertex. For linestrings and polygons, this will
* be the affected vertex, for circles a point along the circle, and for points the actual
* point. If not configured, the default edit style is used (see {@link module:ol/style/Style~Style}).
* When using a style function, the point feature passed to the function will have an `existing` property -
* indicating whether there is an existing vertex underneath or not, a `features`
* property - an array whose entries are the features that are being modified, and a `geometries`
* property - an array whose entries are the geometries that are being modified. Both arrays are
* in the same order. The `geometries` are only useful when modifying geometry collections, where
* the geometry will be the particular geometry from the collection that is being modified.
* @property {VectorSource} [source] The vector source with
* features to modify. If a vector source is not provided, a feature collection
* must be provided with the `features` option.
* @property {boolean|import("../layer/BaseVector.js").default} [hitDetection] When configured, point
* features will be considered for modification based on their visual appearance, instead of being within
* the `pixelTolerance` from the pointer location. When a {@link module:ol/layer/BaseVector~BaseVectorLayer} is
* provided, only the rendered representation of the features on that layer will be considered.
* @property {Collection<Feature>} [features]
* The features the interaction works on. If a feature collection is not
* provided, a vector source must be provided with the `source` option.
* @property {FilterFunction} [filter] A function that takes a {@link module:ol/Feature~Feature}
* and returns `true` if the feature may be modified or `false` otherwise.
* @property {boolean|import("../events/condition.js").Condition} [trace=false] Trace a portion of another geometry.
* Tracing starts when two neighboring vertices are dragged onto a trace target, without any other modification in between..
* @property {VectorSource} [traceSource] Source for features to trace. If tracing is active and a `traceSource` is
* not provided, the interaction's `source` will be used. Tracing requires that the interaction is configured with
* either a `traceSource` or a `source`.
* @property {boolean} [wrapX=false] Wrap the world horizontally on the sketch
* overlay.
* @property {boolean} [snapToPointer=!hitDetection] The vertex, point or segment being modified snaps to the
* pointer coordinate when clicked within the `pixelTolerance`.
* @property {function(import("../coordinate.js").Coordinate, import("../coordinate.js").Coordinate): boolean} [sharedVerticesEqual]
* A function that takes two coordinates and returns whether they should be
* considered equal for vertex matching purposes. By default, all coordinate
* dimensions are compared. This is useful when features have mixed coordinate
* dimensions (e.g., XY and XYZ) but should still be treated as sharing vertices
* at the same 2D position.
*/
function getCoordinatesArray(coordinates, geometryType, depth) {
let coordinatesArray;
switch (geometryType) {
case 'LineString':
coordinatesArray = coordinates;
break;
case 'MultiLineString':
case 'Polygon':
coordinatesArray = coordinates[depth[0]];
break;
case 'MultiPolygon':
coordinatesArray = coordinates[depth[1]][depth[0]];
break;
default:
}
return coordinatesArray;
}
* @classdesc
* Events emitted by {@link module:ol/interaction/Modify~Modify} instances are
* instances of this type.
*/
export class ModifyEvent extends Event {
* @param {ModifyEventType} type Type.
* @param {Collection<Feature>} features
* The features modified.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent
* Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
*/
constructor(type, features, mapBrowserEvent) {
super(type);
* The features being modified.
* @type {Collection<Feature>}
* @api
*/
this.features = features;
* Associated {@link module:ol/MapBrowserEvent~MapBrowserEvent}.
* @type {import("../MapBrowserEvent.js").default}
* @api
*/
this.mapBrowserEvent = mapBrowserEvent;
}
}
* @template Return
* @typedef {import("../Observable.js").OnSignature<import("../Observable.js").EventTypes, import("../events/Event.js").default, Return> &
* import("../Observable.js").OnSignature<import("../ObjectEventType.js").Types|
* 'change:active', import("../Object.js").ObjectEvent, Return> &
* import("../Observable.js").OnSignature<'modifyend'|'modifystart', ModifyEvent, Return> &
* import("../Observable.js").CombinedOnSignature<import("../Observable.js").EventTypes|import("../ObjectEventType.js").Types|
* 'change:active'|'modifyend'|'modifystart', Return>} ModifyOnSignature
*/
* @classdesc
* Interaction for modifying feature geometries. To modify features that have
* been added to an existing source, construct the modify interaction with the
* `source` option. If you want to modify features in a collection (for example,
* the collection used by a select interaction), construct the interaction with
* the `features` option. The interaction must be constructed with either a
* `source` or `features` option.
*
* Cartesian distance from the pointer is used to determine the features that
* will be modified. This means that geometries will only be considered for
* modification when they are within the configured `pixelTolerance`. For point
* geometries, the `hitDetection` option can be used to match their visual
* appearance.
*
* By default, the interaction will allow deletion of vertices when the `alt`
* key is pressed. To configure the interaction with a different condition
* for deletion, use the `deleteCondition` option.
* @fires ModifyEvent
* @api
*/
class Modify extends PointerInteraction {
* @param {Options} options Options.
*/
constructor(options) {
super( (options));
this.handleSourceAdd_ = this.handleSourceAdd_.bind(this);
this.handleSourceRemove_ = this.handleSourceRemove_.bind(this);
this.handleExternalCollectionAdd_ =
this.handleExternalCollectionAdd_.bind(this);
this.handleExternalCollectionRemove_ =
this.handleExternalCollectionRemove_.bind(this);
this.handleFeatureChange_ = this.handleFeatureChange_.bind(this);
* @type {ModifyOnSignature<import("../events.js").EventsKey>}
*/
this.on;
* @type {ModifyOnSignature<import("../events.js").EventsKey>}
*/
this.once;
* @type {ModifyOnSignature<void>}
*/
this.un;
* @private
* @type {import("../events/condition.js").Condition}
*/
this.condition_ = options.condition ? options.condition : primaryAction;
* @private
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Browser event.
* @return {boolean} Combined condition result.
*/
this.defaultDeleteCondition_ = function (mapBrowserEvent) {
return altKeyOnly(mapBrowserEvent) && singleClick(mapBrowserEvent);
};
* @type {import("../events/condition.js").Condition}
* @private
*/
this.deleteCondition_ = options.deleteCondition
? options.deleteCondition
: this.defaultDeleteCondition_;
* @type {import("../events/condition.js").Condition}
* @private
*/
this.insertVertexCondition_ = options.insertVertexCondition
? options.insertVertexCondition
: always;
* Editing vertex.
* @type {Feature<Point>}
* @private
*/
this.vertexFeature_ = null;
* Segments intersecting {@link this.vertexFeature_} by segment uid.
* @type {Object<string, boolean>}
* @private
*/
this.vertexSegments_ = null;
* @type {import("../coordinate.js").Coordinate}
* @private
*/
this.lastCoordinate_ = [0, 0];
* Tracks if the next `singleclick` event should be ignored to prevent
* accidental deletion right after vertex creation.
* @type {boolean}
* @private
*/
this.ignoreNextSingleClick_ = false;
* @type {Collection<Feature>}
* @private
*/
this.featuresBeingModified_ = null;
* Segment RTree for each layer
* @type {RBush<SegmentData>}
* @private
*/
this.rBush_ = new RBush();
* @type {number}
* @private
*/
this.pixelTolerance_ =
options.pixelTolerance !== undefined ? options.pixelTolerance : 10;
* @type {boolean}
* @private
*/
this.snappedToVertex_ = false;
* Indicate whether the interaction is currently changing a feature's
* coordinates.
* @type {boolean}
* @private
*/
this.changingFeature_ = false;
* @type {Array<DragSegment>}
* @private
*/
this.dragSegments_ = [];
* Draw overlay where sketch features are drawn.
* @type {VectorLayer}
* @private
*/
this.overlay_ = new VectorLayer({
source: new VectorSource({
useSpatialIndex: false,
wrapX: !!options.wrapX,
}),
style: options.style ? options.style : getDefaultStyleFunction(),
updateWhileAnimating: true,
updateWhileInteracting: true,
});
* @const
* @private
* @type {!Object<string, function(Feature, import("../geom/Geometry.js").default): void>}
*/
this.SEGMENT_WRITERS_ = {
Point: this.writePointGeometry_.bind(this),
LineString: this.writeLineStringGeometry_.bind(this),
LinearRing: this.writeLineStringGeometry_.bind(this),
Polygon: this.writePolygonGeometry_.bind(this),
MultiPoint: this.writeMultiPointGeometry_.bind(this),
MultiLineString: this.writeMultiLineStringGeometry_.bind(this),
MultiPolygon: this.writeMultiPolygonGeometry_.bind(this),
Circle: this.writeCircleGeometry_.bind(this),
GeometryCollection: this.writeGeometryCollectionGeometry_.bind(this),
};
* @type {VectorSource}
* @private
*/
this.source_ = null;
* @type {VectorSource|null}
* @private
*/
this.traceSource_ = options.traceSource || options.source || null;
* @type {import("../events/condition.js").Condition}
* @private
*/
this.traceCondition_;
this.setTrace(options.trace || false);
* @type {import('./tracing.js').TraceState}
* @private
*/
this.traceState_ = {active: false};
* @type {Array<DragSegment>|null}
* @private
*/
this.traceSegments_ = null;
* @type {boolean|import("../layer/BaseVector.js").default}
* @private
*/
this.hitDetection_ = null;
* Useful for performance optimization
* @private
* @type boolean
*/
this.filterFunctionWasSupplied_ =
options.filter != undefined ? true : false;
* @private
* @type {FilterFunction}
*/
this.filter_ = options.filter ? options.filter : () => true;
* @private
* @type {function(import("../coordinate.js").Coordinate, import("../coordinate.js").Coordinate): boolean}
*/
this.coordinatesEqual_ = options.sharedVerticesEqual
? options.sharedVerticesEqual
: coordinatesEqual;
if (!(options.features || options.source)) {
throw new Error(
'The modify interaction requires features collection or a source',
);
}
let features;
if (options.features) {
features = options.features.getArray();
options.features.addEventListener(
CollectionEventType.ADD,
this.handleExternalCollectionAdd_,
);
options.features.addEventListener(
CollectionEventType.REMOVE,
this.handleExternalCollectionRemove_,
);
this.featuresCollection_ = options.features;
} else if (options.source) {
features = options.source.getFeatures();
options.source.addEventListener(
VectorEventType.ADDFEATURE,
this.handleSourceAdd_,
);
options.source.addEventListener(
VectorEventType.REMOVEFEATURE,
this.handleSourceRemove_,
);
this.source_ = options.source;
}
features.forEach((feature) => {
feature.addEventListener(EventType.CHANGE, this.handleFeatureChange_);
if (this.filterFunctionWasSupplied_) {
feature.addEventListener(
ObjectEventType.PROPERTYCHANGE,
this.handleFeatureChange_,
);
}
});
if (options.hitDetection) {
this.hitDetection_ = options.hitDetection;
}
* Internal features array. When adding or removing features, be sure to use
* addFeature_()/removeFeature_() so that the the segment index is adjusted.
* @type {Array<Feature>}
* @private
*/
this.features_ = [];
features
.filter(this.filter_)
.forEach((feature) => this.addFeature_(feature));
* @type {import("../MapBrowserEvent.js").default}
* @private
*/
this.lastPointerEvent_ = null;
* Delta (x, y in map units) between matched rtree vertex and pointer vertex.
* @type {Array<number>}
* @private
*/
this.delta_ = [0, 0];
* @private
*/
this.snapToPointer_ =
options.snapToPointer === undefined
? !this.hitDetection_
: options.snapToPointer;
}
* Toggle tracing mode or set a tracing condition.
*
* @param {boolean|import("../events/condition.js").Condition} trace A boolean to toggle tracing mode or an event
* condition that will be checked when a feature is clicked to determine if tracing should be active.
*/
setTrace(trace) {
let condition;
if (!trace) {
condition = never;
} else if (trace === true) {
condition = always;
} else {
condition = trace;
}
this.traceCondition_ = condition;
}
* Called when a feature is added to the internal features collection
* @param {Feature} feature Feature.
* @private
*/
addFeature_(feature) {
this.features_.push(feature);
const geometry = feature.getGeometry();
if (geometry) {
const writer = this.SEGMENT_WRITERS_[geometry.getType()];
if (writer) {
writer(feature, geometry);
}
}
const map = this.getMap();
if (map && map.isRendered() && this.getActive()) {
this.handlePointerAtPixel_(this.lastCoordinate_);
}
}
* @param {import("../MapBrowserEvent.js").default} evt Map browser event.
* @param {Array<SegmentData>} segments The segments subject to modification.
* @private
*/
willModifyFeatures_(evt, segments) {
if (!this.featuresBeingModified_) {
this.featuresBeingModified_ = new Collection();
const features = this.featuresBeingModified_.getArray();
for (let i = 0, ii = segments.length; i < ii; ++i) {
const feature = segments[i].feature;
if (feature && !features.includes(feature)) {
this.featuresBeingModified_.push(feature);
}
}
if (this.featuresBeingModified_.getLength() === 0) {
this.featuresBeingModified_ = null;
} else {
this.dispatchEvent(
new ModifyEvent(
ModifyEventType.MODIFYSTART,
this.featuresBeingModified_,
evt,
),
);
}
}
}
* Removes a feature from the internal features collection and updates internal state
* accordingly.
* @param {Feature} feature Feature.
* @private
*/
removeFeature_(feature) {
const itemIndex = this.features_.indexOf(feature);
this.features_.splice(itemIndex, 1);
this.removeFeatureSegmentData_(feature);
if (this.vertexFeature_ && this.features_.length === 0) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
}
* @param {Feature} feature Feature.
* @private
*/
removeFeatureSegmentData_(feature) {
const rBush = this.rBush_;
const nodesToRemove = [];
rBush.forEach(
* @param {SegmentData} node RTree node.
*/
function (node) {
if (feature === node.feature) {
nodesToRemove.push(node);
}
},
);
for (let i = nodesToRemove.length - 1; i >= 0; --i) {
const nodeToRemove = nodesToRemove[i];
for (let j = this.dragSegments_.length - 1; j >= 0; --j) {
if (this.dragSegments_[j][0] === nodeToRemove) {
this.dragSegments_.splice(j, 1);
}
}
rBush.remove(nodeToRemove);
}
}
* Activate or deactivate the interaction.
* @param {boolean} active Active.
* @observable
* @api
* @override
*/
setActive(active) {
if (this.vertexFeature_ && !active) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
super.setActive(active);
}
* 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("../Map.js").default} map Map.
* @override
*/
setMap(map) {
this.overlay_.setMap(map);
super.setMap(map);
}
* Get the overlay layer that this interaction renders the modification point or vertex to.
* @return {VectorLayer} Overlay layer.
* @api
*/
getOverlay() {
return this.overlay_;
}
* @param {import("../source/Vector.js").VectorSourceEvent} event Event.
* @private
*/
handleSourceAdd_(event) {
const feature = event.feature;
if (feature) {
this.externalAddFeatureHandler_(feature);
}
}
* @param {import("../source/Vector.js").VectorSourceEvent} event Event.
* @private
*/
handleSourceRemove_(event) {
const feature = event.feature;
if (feature) {
this.externalRemoveFeatureHandler_(feature);
}
}
* @param {import("../Collection.js").CollectionEvent} event Event.
* @private
*/
handleExternalCollectionAdd_(event) {
const feature = event.element;
if (feature) {
this.externalAddFeatureHandler_(feature);
}
}
* @param {import("../Collection.js").CollectionEvent} event Event.
* @private
*/
handleExternalCollectionRemove_(event) {
const feature = event.element;
if (feature) {
this.externalRemoveFeatureHandler_(feature);
}
}
* Common handler for event signaling addition of feature to the supplied features source
* or collection.
* @param {Feature} feature Feature.
*/
externalAddFeatureHandler_(feature) {
feature.addEventListener(EventType.CHANGE, this.handleFeatureChange_);
if (this.filterFunctionWasSupplied_) {
feature.addEventListener(
ObjectEventType.PROPERTYCHANGE,
this.handleFeatureChange_,
);
}
if (this.filter_(feature)) {
this.addFeature_(feature);
}
}
* Common handler for event signaling removal of feature from the supplied features source
* or collection.
* @param {Feature} feature Feature.
*/
externalRemoveFeatureHandler_(feature) {
feature.removeEventListener(EventType.CHANGE, this.handleFeatureChange_);
if (this.filterFunctionWasSupplied_) {
feature.removeEventListener(
ObjectEventType.PROPERTYCHANGE,
this.handleFeatureChange_,
);
}
this.removeFeature_(feature);
}
* Listener for features in external source or features collection. Ensures the feature filter
* is re-run and segment data is updated.
* @param {import("../events/Event.js").default | import("../Object.js").ObjectEvent} evt Event.
* @private
*/
handleFeatureChange_(evt) {
if (!this.changingFeature_) {
const feature = (evt.target);
this.removeFeature_(feature);
this.filter_(feature) && this.addFeature_(feature);
}
}
* @param {Feature} feature Feature
* @param {Point} geometry Geometry.
* @private
*/
writePointGeometry_(feature, geometry) {
const coordinates = geometry.getCoordinates();
const segmentData = {
feature: feature,
geometry: geometry,
segment: [coordinates, coordinates],
};
this.rBush_.insert(geometry.getExtent(), segmentData);
}
* @param {Feature} feature Feature
* @param {import("../geom/MultiPoint.js").default} geometry Geometry.
* @private
*/
writeMultiPointGeometry_(feature, geometry) {
const points = geometry.getCoordinates();
for (let i = 0, ii = points.length; i < ii; ++i) {
const coordinates = points[i];
const segmentData = {
feature: feature,
geometry: geometry,
depth: [i],
index: i,
segment: [coordinates, coordinates],
};
this.rBush_.insert(geometry.getExtent(), segmentData);
}
}
* @param {Feature} feature Feature
* @param {import("../geom/LineString.js").default} geometry Geometry.
* @private
*/
writeLineStringGeometry_(feature, geometry) {
const coordinates = geometry.getCoordinates();
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
const segment = coordinates.slice(i, i + 2);
const segmentData = {
feature: feature,
geometry: geometry,
index: i,
segment: segment,
};
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
* @param {Feature} feature Feature
* @param {import("../geom/MultiLineString.js").default} geometry Geometry.
* @private
*/
writeMultiLineStringGeometry_(feature, geometry) {
const lines = geometry.getCoordinates();
for (let j = 0, jj = lines.length; j < jj; ++j) {
const coordinates = lines[j];
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
const segment = coordinates.slice(i, i + 2);
const segmentData = {
feature: feature,
geometry: geometry,
depth: [j],
index: i,
segment: segment,
};
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
}
* @param {Feature} feature Feature
* @param {import("../geom/Polygon.js").default} geometry Geometry.
* @private
*/
writePolygonGeometry_(feature, geometry) {
const rings = geometry.getCoordinates();
for (let j = 0, jj = rings.length; j < jj; ++j) {
const coordinates = rings[j];
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
const segment = coordinates.slice(i, i + 2);
const segmentData = {
feature: feature,
geometry: geometry,
depth: [j],
index: i,
segment: segment,
};
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
}
* @param {Feature} feature Feature
* @param {import("../geom/MultiPolygon.js").default} geometry Geometry.
* @private
*/
writeMultiPolygonGeometry_(feature, geometry) {
const polygons = geometry.getCoordinates();
for (let k = 0, kk = polygons.length; k < kk; ++k) {
const rings = polygons[k];
for (let j = 0, jj = rings.length; j < jj; ++j) {
const coordinates = rings[j];
for (let i = 0, ii = coordinates.length - 1; i < ii; ++i) {
const segment = coordinates.slice(i, i + 2);
const segmentData = {
feature: feature,
geometry: geometry,
depth: [j, k],
index: i,
segment: segment,
};
this.rBush_.insert(boundingExtent(segment), segmentData);
}
}
}
}
* We convert a circle into two segments. The segment at index
* {@link CIRCLE_CENTER_INDEX} is the
* circle's center (a point). The segment at index
* {@link CIRCLE_CIRCUMFERENCE_INDEX} is
* the circumference, and is not a line segment.
*
* @param {Feature} feature Feature.
* @param {import("../geom/Circle.js").default} geometry Geometry.
* @private
*/
writeCircleGeometry_(feature, geometry) {
const coordinates = geometry.getCenter();
const centerSegmentData = {
feature: feature,
geometry: geometry,
index: CIRCLE_CENTER_INDEX,
segment: [coordinates, coordinates],
};
const circumferenceSegmentData = {
feature: feature,
geometry: geometry,
index: CIRCLE_CIRCUMFERENCE_INDEX,
segment: [coordinates, coordinates],
};
const featureSegments = [centerSegmentData, circumferenceSegmentData];
centerSegmentData.featureSegments = featureSegments;
circumferenceSegmentData.featureSegments = featureSegments;
this.rBush_.insert(createExtent(coordinates), centerSegmentData);
let circleGeometry = (
geometry
);
const userProjection = getUserProjection();
if (userProjection && this.getMap()) {
const projection = this.getMap().getView().getProjection();
circleGeometry = circleGeometry
.clone()
.transform(userProjection, projection);
circleGeometry = fromCircle(
(circleGeometry),
).transform(projection, userProjection);
}
this.rBush_.insert(circleGeometry.getExtent(), circumferenceSegmentData);
}
* @param {Feature} feature Feature
* @param {import("../geom/GeometryCollection.js").default} geometry Geometry.
* @private
*/
writeGeometryCollectionGeometry_(feature, geometry) {
const geometries = geometry.getGeometriesArray();
for (let i = 0; i < geometries.length; ++i) {
const geometry = geometries[i];
const writer = this.SEGMENT_WRITERS_[geometry.getType()];
writer(feature, geometry);
}
}
* @param {import("../coordinate.js").Coordinate} coordinates Coordinates.
* @param {Array<Feature>} features The features being modified.
* @param {Array<import("../geom/SimpleGeometry.js").default>} geometries The geometries being modified.
* @param {boolean} existing The vertex represents an existing vertex.
* @return {Feature} Vertex feature.
* @private
*/
createOrUpdateVertexFeature_(coordinates, features, geometries, existing) {
let vertexFeature = this.vertexFeature_;
if (!vertexFeature) {
vertexFeature = new Feature(new Point(coordinates));
this.vertexFeature_ = vertexFeature;
this.overlay_.getSource().addFeature(vertexFeature);
} else {
const geometry = vertexFeature.getGeometry();
geometry.setCoordinates(coordinates);
}
vertexFeature.set('features', features);
vertexFeature.set('geometries', geometries);
vertexFeature.set('existing', existing);
return vertexFeature;
}
* Handles the {@link module:ol/MapBrowserEvent~MapBrowserEvent map browser event} and may modify the geometry.
* @param {import("../MapBrowserEvent.js").default} mapBrowserEvent Map browser event.
* @return {boolean} `false` to stop event propagation.
* @override
*/
handleEvent(mapBrowserEvent) {
if (!mapBrowserEvent.originalEvent) {
return true;
}
this.lastPointerEvent_ = mapBrowserEvent;
let handled;
if (
!mapBrowserEvent.map.getView().getInteracting() &&
mapBrowserEvent.type == MapBrowserEventType.POINTERMOVE &&
!this.handlingDownUpSequence
) {
this.handlePointerMove_(mapBrowserEvent);
}
if (this.vertexFeature_ && this.deleteCondition_(mapBrowserEvent)) {
if (
mapBrowserEvent.type != MapBrowserEventType.SINGLECLICK ||
!this.ignoreNextSingleClick_
) {
handled = this.removePoint();
} else {
handled = true;
}
}
if (mapBrowserEvent.type == MapBrowserEventType.SINGLECLICK) {
this.ignoreNextSingleClick_ = false;
}
return super.handleEvent(mapBrowserEvent) && !handled;
}
* @param {import("../coordinate.js").Coordinate} pixelCoordinate Pixel coordinate.
* @return {Array<SegmentData>|undefined} Insert vertices and update drag segments.
* @private
*/
findInsertVerticesAndUpdateDragSegments_(pixelCoordinate) {
this.handlePointerAtPixel_(pixelCoordinate);
this.dragSegments_.length = 0;
this.featuresBeingModified_ = null;
const vertexFeature = this.vertexFeature_;
if (!vertexFeature) {
return;
}
const projection = this.getMap().getView().getProjection();
const insertVertices = [];
const vertex = this.vertexFeature_.getGeometry().getCoordinates();
const vertexExtent = boundingExtent([vertex]);
const segmentDataMatches = this.rBush_.getInExtent(vertexExtent);
const componentSegments = {};
segmentDataMatches.sort(compareIndexes);
for (let i = 0, ii = segmentDataMatches.length; i < ii; ++i) {
const segmentDataMatch = segmentDataMatches[i];
const segment = segmentDataMatch.segment;
let uid = getUid(segmentDataMatch.geometry);
const depth = segmentDataMatch.depth;
if (depth) {
uid += '-' + depth.join('-');
}
if (!componentSegments[uid]) {
componentSegments[uid] = new Array(2);
}
if (
segmentDataMatch.geometry.getType() === 'Circle' &&
segmentDataMatch.index === CIRCLE_CIRCUMFERENCE_INDEX
) {
const closestVertex = closestOnSegmentData(
pixelCoordinate,
segmentDataMatch,
projection,
);
if (
this.coordinatesEqual_(closestVertex, vertex) &&
!componentSegments[uid][0]
) {
this.dragSegments_.push([segmentDataMatch, 0]);
componentSegments[uid][0] = segmentDataMatch;
}
continue;
}
if (
this.coordinatesEqual_(segment[0], vertex) &&
!componentSegments[uid][0]
) {
this.dragSegments_.push([segmentDataMatch, 0]);
componentSegments[uid][0] = segmentDataMatch;
continue;
}
if (
this.coordinatesEqual_(segment[1], vertex) &&
!componentSegments[uid][1]
) {
if (
componentSegments[uid][0] &&
componentSegments[uid][0].index === 0
) {
let coordinates = segmentDataMatch.geometry.getCoordinates();
switch (segmentDataMatch.geometry.getType()) {
case 'LineString':
case 'MultiLineString':
continue;
case 'MultiPolygon':
coordinates = coordinates[depth[1]];
case 'Polygon':
if (segmentDataMatch.index !== coordinates[depth[0]].length - 2) {
continue;
}
break;
default:
}
}
this.dragSegments_.push([segmentDataMatch, 1]);
componentSegments[uid][1] = segmentDataMatch;
continue;
}
if (
getUid(segment) in this.vertexSegments_ &&
!componentSegments[uid][0] &&
!componentSegments[uid][1]
) {
insertVertices.push(segmentDataMatch);
}
}
return insertVertices;
}
* @private
*/
deactivateTrace_() {
this.traceState_ = {active: false};
}
* Update the trace.
* @param {import("../MapBrowserEvent.js").default} event Event.
* @private
*/
updateTrace_(event) {
const traceState = this.traceState_;
if (!traceState.active) {
return;
}
if (traceState.targetIndex === -1) {
const startPx = event.map.getPixelFromCoordinate(traceState.startCoord);
if (coordinateDistance(startPx, event.pixel) < this.pixelTolerance_) {
return;
}
}
const updatedTraceTarget = getTraceTargetUpdate(
event.coordinate,
traceState,
event.map,
this.pixelTolerance_,
);
if (
traceState.targetIndex === -1 &&
Math.sqrt(updatedTraceTarget.closestTargetDistance) /
event.map.getView().getResolution() >
this.pixelTolerance_
) {
return;
}
if (traceState.targetIndex !== updatedTraceTarget.index) {
if (traceState.targetIndex !== -1) {
const oldTarget = traceState.targets[traceState.targetIndex];
this.removeTracedCoordinates_(oldTarget.startIndex, oldTarget.endIndex);
} else {
for (const traceSegment of this.traceSegments_) {
const segmentData = traceSegment[0];
const geometry = segmentData.geometry;
const index = traceSegment[1];
const coordinates = geometry.getCoordinates();
const coordinatesArray = getCoordinatesArray(
coordinates,
geometry.getType(),
segmentData.depth,
);
coordinatesArray.splice(segmentData.index + index, 1);
geometry.setCoordinates(coordinates);
if (index === 0) {
segmentData.index -= 1;
}
}
}
const newTarget = traceState.targets[updatedTraceTarget.index];
this.addTracedCoordinates_(
newTarget,
newTarget.startIndex,
updatedTraceTarget.endIndex,
);
} else {
const target = traceState.targets[traceState.targetIndex];
this.addOrRemoveTracedCoordinates_(target, updatedTraceTarget.endIndex);
}
traceState.targetIndex = updatedTraceTarget.index;
const target = traceState.targets[traceState.targetIndex];
target.endIndex = updatedTraceTarget.endIndex;
}
getTraceCandidates_(event) {
const map = this.getMap();
const tolerance = this.pixelTolerance_;
const lowerLeft = map.getCoordinateFromPixel([
event.pixel[0] - tolerance,
event.pixel[1] + tolerance,
]);
const upperRight = map.getCoordinateFromPixel([
event.pixel[0] + tolerance,
event.pixel[1] - tolerance,
]);
const extent = boundingExtent([lowerLeft, upperRight]);
const features = this.traceSource_.getFeaturesInExtent(extent);
return features;
}
* Activate or deactivate trace state based on a browser event.
* @param {import("../MapBrowserEvent.js").default} event Event.
* @private
*/
toggleTraceState_(event) {
if (!this.traceSource_ || !this.traceCondition_(event)) {
return;
}
if (this.traceState_.active) {
this.deactivateTrace_();
this.traceSegments_ = null;
return;
}
const features = this.getTraceCandidates_(event);
if (features.length === 0) {
return;
}
const targets = getTraceTargets(event.coordinate, features);
if (targets.length) {
this.traceState_ = {
active: true,
startCoord: event.coordinate.slice(),
targets: targets,
targetIndex: -1,
};
}
}
* @param {import('./tracing.js').TraceTarget} target The trace target.
* @param {number} endIndex The new end index of the trace.
* @private
*/
addOrRemoveTracedCoordinates_(target, endIndex) {
const previouslyForward = target.startIndex <= target.endIndex;
const currentlyForward = target.startIndex <= endIndex;
if (previouslyForward === currentlyForward) {
if (
(previouslyForward && endIndex > target.endIndex) ||
(!previouslyForward && endIndex < target.endIndex)
) {
this.addTracedCoordinates_(target, target.endIndex, endIndex);
} else if (
(previouslyForward && endIndex < target.endIndex) ||
(!previouslyForward && endIndex > target.endIndex)
) {
this.removeTracedCoordinates_(endIndex, target.endIndex);
}
} else {
this.removeTracedCoordinates_(target.startIndex, target.endIndex);
this.addTracedCoordinates_(target, target.startIndex, endIndex);
}
}
* @param {number} fromIndex The start index.
* @param {number} toIndex The end index.
* @private
*/
removeTracedCoordinates_(fromIndex, toIndex) {
if (fromIndex === toIndex) {
return;
}
let remove = 0;
if (fromIndex < toIndex) {
const start = Math.ceil(fromIndex);
let end = Math.floor(toIndex);
if (end === toIndex) {
end -= 1;
}
remove = end - start + 1;
} else {
const start = Math.floor(fromIndex);
let end = Math.ceil(toIndex);
if (end === toIndex) {
end += 1;
}
remove = start - end + 1;
}
if (remove > 0) {
for (const traceSegment of this.traceSegments_) {
const segmentData = traceSegment[0];
const geometry = segmentData.geometry;
const index = traceSegment[1];
let removeIndex = traceSegment[0].index + 1;
if (index === 1) {
removeIndex -= remove;
}
const coordinates = geometry.getCoordinates();
const coordinatesArray = getCoordinatesArray(
coordinates,
geometry.getType(),
segmentData.depth,
);
coordinatesArray.splice(removeIndex, remove);
geometry.setCoordinates(coordinates);
if (index === 1) {
segmentData.index -= remove;
}
}
}
}
* @param {import('./tracing.js').TraceTarget} target The trace target.
* @param {number} fromIndex The start index.
* @param {number} toIndex The end index.
* @private
*/
addTracedCoordinates_(target, fromIndex, toIndex) {
if (fromIndex === toIndex) {
return;
}
const newCoordinates = [];
if (fromIndex < toIndex) {
const start = Math.ceil(fromIndex);
let end = Math.floor(toIndex);
if (end === toIndex) {
end -= 1;
}
for (let i = start; i <= end; ++i) {
newCoordinates.push(getCoordinate(target.coordinates, i));
}
} else {
const start = Math.floor(fromIndex);
let end = Math.ceil(toIndex);
if (end === toIndex) {
end += 1;
}
for (let i = start; i >= end; --i) {
newCoordinates.push(getCoordinate(target.coordinates, i));
}
}
if (newCoordinates.length) {
for (const traceSegment of this.traceSegments_) {
const segmentData = traceSegment[0];
const geometry = segmentData.geometry;
const index = traceSegment[1];
const insertIndex = segmentData.index + 1;
if (index === 0) {
newCoordinates.reverse();
}
const coordinates = geometry.getCoordinates();
const coordinatesArray = getCoordinatesArray(
coordinates,
geometry.getType(),
segmentData.depth,
);
coordinatesArray.splice(insertIndex, 0, ...newCoordinates);
geometry.setCoordinates(coordinates);
if (index === 1) {
segmentData.index += newCoordinates.length;
}
}
}
}
* @param {import('../coordinate.js').Coordinate} vertex Vertex.
* @param {DragSegment} dragSegment Drag segment.
*/
updateGeometry_(vertex, dragSegment) {
const segmentData = dragSegment[0];
const depth = segmentData.depth;
let coordinates;
const segment = segmentData.segment;
const geometry = segmentData.geometry;
const index = dragSegment[1];
const stride = geometry.getStride();
for (let i = 2; i < stride; ++i) {
vertex[i] = segment[index][i];
}
vertex.length = stride;
switch (geometry.getType()) {
case 'Point':
coordinates = vertex;
segment[0] = vertex;
segment[1] = vertex;
break;
case 'MultiPoint':
coordinates = geometry.getCoordinates();
coordinates[segmentData.index] = vertex;
segment[0] = vertex;
segment[1] = vertex;
break;
case 'LineString':
coordinates = geometry.getCoordinates();
coordinates[segmentData.index + index] = vertex;
segment[index] = vertex;
break;
case 'MultiLineString':
coordinates = geometry.getCoordinates();
coordinates[depth[0]][segmentData.index + index] = vertex;
segment[index] = vertex;
break;
case 'Polygon': {
coordinates = geometry.getCoordinates();
const ring = coordinates[depth[0]];
const targetIndex = segmentData.index + index;
if (
ring[targetIndex][0] === vertex[0] &&
ring[targetIndex][1] === vertex[1]
) {
coordinates = null;
} else {
ring[targetIndex] = vertex;
if (targetIndex === 0) {
ring[ring.length - 1] = vertex;
} else if (targetIndex === ring.length - 1) {
ring[0] = vertex;
}
}
segment[index] = vertex;
break;
}
case 'MultiPolygon': {
coordinates = geometry.getCoordinates();
const mRing = coordinates[depth[1]][depth[0]];
const mTargetIndex = segmentData.index + index;
if (
mRing[mTargetIndex][0] === vertex[0] &&
mRing[mTargetIndex][1] === vertex[1]
) {
coordinates = null;
} else {
mRing[mTargetIndex] = vertex;
if (mTargetIndex === 0) {
mRing[mRing.length - 1] = vertex;
} else if (mTargetIndex === mRing.length - 1) {
mRing[0] = vertex;
}
}
segment[index] = vertex;
break;
}
case 'Circle':
const circle = (
geometry
);
segment[0] = vertex;
segment[1] = vertex;
if (segmentData.index === CIRCLE_CENTER_INDEX) {
this.changingFeature_ = true;
circle.setCenter(vertex);
this.changingFeature_ = false;
} else {
this.changingFeature_ = true;
const projection = this.getMap().getView().getProjection();
let radius = coordinateDistance(
fromUserCoordinate(circle.getCenter(), projection),
fromUserCoordinate(vertex, projection),
);
const userProjection = getUserProjection();
if (userProjection) {
const circleGeometry = circle
.clone()
.transform(userProjection, projection);
circleGeometry.setRadius(radius);
radius = circleGeometry
.transform(projection, userProjection)
.getRadius();
}
circle.setRadius(radius);
this.changingFeature_ = false;
}
break;
default:
}
if (coordinates) {
this.setGeometryCoordinates_(geometry, coordinates);
}
}
* Handle pointer drag events.
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @override
*/
handleDragEvent(evt) {
this.ignoreNextSingleClick_ = false;
this.willModifyFeatures_(
evt,
this.dragSegments_.map(([segment]) => segment),
);
const vertex = [
evt.coordinate[0] + this.delta_[0],
evt.coordinate[1] + this.delta_[1],
];
const features = [];
const geometries = [];
const startTraceCoord =
this.traceState_.active && !this.traceSegments_
? this.traceState_.startCoord
: null;
if (startTraceCoord) {
this.traceSegments_ = [];
for (const dragSegment of this.dragSegments_) {
const segmentData = dragSegment[0];
const eligibleForTracing =
coordinateDistance(
closestOnSegment(startTraceCoord, segmentData.segment),
startTraceCoord,
) /
evt.map.getView().getResolution() <
1;
if (eligibleForTracing) {
this.traceSegments_.push(dragSegment);
}
}
}
for (let i = 0, ii = this.dragSegments_.length; i < ii; ++i) {
const dragSegment = this.dragSegments_[i];
const segmentData = dragSegment[0];
const feature = segmentData.feature;
if (!features.includes(feature)) {
features.push(feature);
}
const geometry = segmentData.geometry;
if (!geometries.includes(geometry)) {
geometries.push(geometry);
}
this.updateGeometry_(vertex, dragSegment);
}
this.updateTrace_(evt);
this.createOrUpdateVertexFeature_(vertex, features, geometries, true);
}
* Handle pointer down events.
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
* @override
*/
handleDownEvent(evt) {
if (!this.condition_(evt)) {
return false;
}
const pixelCoordinate = evt.coordinate;
const insertVertices =
this.findInsertVerticesAndUpdateDragSegments_(pixelCoordinate);
if (insertVertices?.length && this.insertVertexCondition_(evt)) {
this.willModifyFeatures_(evt, insertVertices);
if (this.vertexFeature_) {
const vertex = this.vertexFeature_.getGeometry().getCoordinates();
for (let j = insertVertices.length - 1; j >= 0; --j) {
this.insertVertex_(insertVertices[j], vertex);
}
this.ignoreNextSingleClick_ = true;
}
}
return !!this.vertexFeature_;
}
* Handle pointer up events.
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @return {boolean} If the event was consumed.
* @override
*/
handleUpEvent(evt) {
for (let i = this.dragSegments_.length - 1; i >= 0; --i) {
const segmentData = this.dragSegments_[i][0];
const geometry = segmentData.geometry;
if (geometry.getType() === 'Circle') {
const circle = (
geometry
);
const coordinates = circle.getCenter();
const centerSegmentData = segmentData.featureSegments[0];
const circumferenceSegmentData = segmentData.featureSegments[1];
centerSegmentData.segment[0] = coordinates;
centerSegmentData.segment[1] = coordinates;
circumferenceSegmentData.segment[0] = coordinates;
circumferenceSegmentData.segment[1] = coordinates;
this.rBush_.update(createExtent(coordinates), centerSegmentData);
let circleGeometry = circle;
const userProjection = getUserProjection();
if (userProjection) {
const projection = evt.map.getView().getProjection();
circleGeometry = circleGeometry
.clone()
.transform(userProjection, projection);
circleGeometry = fromCircle(circleGeometry).transform(
projection,
userProjection,
);
}
this.rBush_.update(
circleGeometry.getExtent(),
circumferenceSegmentData,
);
} else {
this.rBush_.update(boundingExtent(segmentData.segment), segmentData);
}
}
if (this.featuresBeingModified_) {
this.toggleTraceState_(evt);
this.dispatchEvent(
new ModifyEvent(
ModifyEventType.MODIFYEND,
this.featuresBeingModified_,
evt,
),
);
this.featuresBeingModified_ = null;
}
return false;
}
* @param {import("../MapBrowserEvent.js").default} evt Event.
* @private
*/
handlePointerMove_(evt) {
this.lastCoordinate_ = evt.coordinate;
this.handlePointerAtPixel_(this.lastCoordinate_);
}
* @param {import("../coordinate.js").Coordinate} pixelCoordinate The pixel Coordinate.
* @private
*/
handlePointerAtPixel_(pixelCoordinate) {
const map = this.getMap();
const pixel = map.getPixelFromCoordinate(pixelCoordinate);
const projection = map.getView().getProjection();
const sortByDistance = function (a, b) {
return (
projectedDistanceToSegmentDataSquared(pixelCoordinate, a, projection) -
projectedDistanceToSegmentDataSquared(pixelCoordinate, b, projection)
);
};
let nodes;
let hitPointGeometry;
if (this.hitDetection_) {
const layerFilter =
typeof this.hitDetection_ === 'object'
? (layer) => layer === this.hitDetection_
: undefined;
map.forEachFeatureAtPixel(
pixel,
(feature, layer, geometry) => {
if (geometry && geometry.getType() === 'Point') {
geometry = new Point(
toUserCoordinate(geometry.getCoordinates(), projection),
);
}
const geom = geometry || feature.getGeometry();
if (
geom &&
geom.getType() === 'Point' &&
feature instanceof Feature &&
this.features_.includes(feature)
) {
hitPointGeometry = (geom);
const coordinate = (feature.getGeometry())
.getFlatCoordinates()
.slice(0, 2);
nodes = [
{
feature,
geometry: hitPointGeometry,
segment: [coordinate, coordinate],
},
];
}
return true;
},
{layerFilter},
);
}
if (!nodes) {
const viewExtent = fromUserExtent(
createExtent(pixelCoordinate, tempExtent),
projection,
);
const buffer = map.getView().getResolution() * this.pixelTolerance_;
const box = toUserExtent(
bufferExtent(viewExtent, buffer, tempExtent),
projection,
);
nodes = this.rBush_.getInExtent(box);
}
if (nodes && nodes.length > 0) {
const node = nodes.sort(sortByDistance)[0];
const closestSegment = node.segment;
let vertex = closestOnSegmentData(pixelCoordinate, node, projection);
const vertexPixel = map.getPixelFromCoordinate(vertex);
let dist = coordinateDistance(pixel, vertexPixel);
if (hitPointGeometry || dist <= this.pixelTolerance_) {
const vertexSegments = {};
vertexSegments[getUid(closestSegment)] = true;
if (!this.snapToPointer_) {
this.delta_[0] = vertex[0] - pixelCoordinate[0];
this.delta_[1] = vertex[1] - pixelCoordinate[1];
}
if (
node.geometry.getType() === 'Circle' &&
node.index === CIRCLE_CIRCUMFERENCE_INDEX
) {
this.snappedToVertex_ = true;
this.createOrUpdateVertexFeature_(
vertex,
[node.feature],
[node.geometry],
this.snappedToVertex_,
);
} else {
const pixel1 = map.getPixelFromCoordinate(closestSegment[0]);
const pixel2 = map.getPixelFromCoordinate(closestSegment[1]);
const squaredDist1 = squaredCoordinateDistance(vertexPixel, pixel1);
const squaredDist2 = squaredCoordinateDistance(vertexPixel, pixel2);
dist = Math.sqrt(Math.min(squaredDist1, squaredDist2));
this.snappedToVertex_ = dist <= this.pixelTolerance_;
if (
!this.snappedToVertex_ &&
!this.insertVertexCondition_(this.lastPointerEvent_)
) {
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
return;
}
if (this.snappedToVertex_) {
vertex =
squaredDist1 > squaredDist2
? closestSegment[1]
: closestSegment[0];
}
this.createOrUpdateVertexFeature_(
vertex,
[node.feature],
[node.geometry],
this.snappedToVertex_,
);
const geometries = {};
geometries[getUid(node.geometry)] = true;
for (let i = 1, ii = nodes.length; i < ii; ++i) {
const segment = nodes[i].segment;
if (
(this.coordinatesEqual_(closestSegment[0], segment[0]) &&
this.coordinatesEqual_(closestSegment[1], segment[1])) ||
(this.coordinatesEqual_(closestSegment[0], segment[1]) &&
this.coordinatesEqual_(closestSegment[1], segment[0]))
) {
const geometryUid = getUid(nodes[i].geometry);
if (!(geometryUid in geometries)) {
geometries[geometryUid] = true;
vertexSegments[getUid(segment)] = true;
}
} else {
break;
}
}
}
this.vertexSegments_ = vertexSegments;
return;
}
}
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
}
* @param {SegmentData} segmentData Segment data.
* @param {import("../coordinate.js").Coordinate} vertex Vertex.
* @return {boolean} A vertex was inserted.
* @private
*/
insertVertex_(segmentData, vertex) {
const segment = segmentData.segment;
const feature = segmentData.feature;
const geometry = segmentData.geometry;
const depth = segmentData.depth;
const index = segmentData.index;
let coordinates;
while (vertex.length < geometry.getStride()) {
vertex.push(0);
}
switch (geometry.getType()) {
case 'MultiLineString':
coordinates = geometry.getCoordinates();
coordinates[depth[0]].splice(index + 1, 0, vertex);
break;
case 'Polygon':
coordinates = geometry.getCoordinates();
coordinates[depth[0]].splice(index + 1, 0, vertex);
break;
case 'MultiPolygon':
coordinates = geometry.getCoordinates();
coordinates[depth[1]][depth[0]].splice(index + 1, 0, vertex);
break;
case 'LineString':
coordinates = geometry.getCoordinates();
coordinates.splice(index + 1, 0, vertex);
break;
default:
return false;
}
this.setGeometryCoordinates_(geometry, coordinates);
const rTree = this.rBush_;
rTree.remove(segmentData);
this.updateSegmentIndices_(geometry, index, depth, 1);
const newSegmentData = {
segment: [segment[0], vertex],
feature: feature,
geometry: geometry,
depth: depth,
index: index,
};
rTree.insert(boundingExtent(newSegmentData.segment), newSegmentData);
this.dragSegments_.push([newSegmentData, 1]);
const newSegmentData2 = {
segment: [vertex, segment[1]],
feature: feature,
geometry: geometry,
depth: depth,
index: index + 1,
};
rTree.insert(boundingExtent(newSegmentData2.segment), newSegmentData2);
this.dragSegments_.push([newSegmentData2, 0]);
return true;
}
* @param {import("../coordinate.js").Coordinate} coordinate The coordinate.
* @return {import("../coordinate.js").Coordinate} The updated pointer coordinate.
* @private
*/
updatePointer_(coordinate) {
if (coordinate) {
this.findInsertVerticesAndUpdateDragSegments_(coordinate);
}
return this.vertexFeature_?.getGeometry().getCoordinates();
}
* Get the current pointer position.
* @return {import("../coordinate.js").Coordinate | null} The current pointer coordinate.
*/
getPoint() {
const coordinate = this.vertexFeature_?.getGeometry().getCoordinates();
if (!coordinate) {
return null;
}
return toUserCoordinate(
coordinate,
this.getMap().getView().getProjection(),
);
}
* Check if a point can be removed from the current linestring or polygon at the current
* pointer position.
* @return {boolean} A point can be deleted at the current pointer position.
* @api
*/
canRemovePoint() {
if (!this.vertexFeature_) {
return false;
}
if (
this.vertexFeature_
.get('geometries')
.every(
(geometry) =>
geometry.getType() === 'Circle' ||
geometry.getType().endsWith('Point'),
)
) {
return false;
}
const coordinate = this.vertexFeature_.getGeometry().getCoordinates();
const segments = this.rBush_.getInExtent(boundingExtent([coordinate]));
return segments.some(
({segment}) =>
this.coordinatesEqual_(segment[0], coordinate) ||
this.coordinatesEqual_(segment[1], coordinate),
);
}
* Removes the vertex currently being pointed from the current linestring or polygon.
* @param {import('../coordinate.js').Coordinate} [coordinate] If provided, the pointer
* will be set to the provided coordinate. If not, the current pointer coordinate will be used.
* @return {boolean} True when a vertex was removed.
* @api
*/
removePoint(coordinate) {
if (coordinate) {
coordinate = fromUserCoordinate(
coordinate,
this.getMap().getView().getProjection(),
);
this.updatePointer_(coordinate);
}
if (
!this.lastPointerEvent_ ||
(this.lastPointerEvent_ &&
this.lastPointerEvent_.type != MapBrowserEventType.POINTERDRAG)
) {
const evt = this.lastPointerEvent_;
this.willModifyFeatures_(
evt,
this.dragSegments_.map(([segment]) => segment),
);
const removed = this.removeVertex_();
if (this.featuresBeingModified_) {
this.dispatchEvent(
new ModifyEvent(
ModifyEventType.MODIFYEND,
this.featuresBeingModified_,
evt,
),
);
}
this.featuresBeingModified_ = null;
return removed;
}
return false;
}
* Removes a vertex from all matching features.
* @return {boolean} True when a vertex was removed.
* @private
*/
removeVertex_() {
const dragSegments = this.dragSegments_;
const segmentsByFeature = {};
let deleted = false;
let component, coordinates, dragSegment, geometry, i, index, left;
let newIndex, right, segmentData, uid;
for (i = dragSegments.length - 1; i >= 0; --i) {
dragSegment = dragSegments[i];
segmentData = dragSegment[0];
uid = getUid(segmentData.feature);
if (segmentData.depth) {
uid += '-' + segmentData.depth.join('-');
}
if (!(uid in segmentsByFeature)) {
segmentsByFeature[uid] = {};
}
if (dragSegment[1] === 0) {
segmentsByFeature[uid].right = segmentData;
segmentsByFeature[uid].index = segmentData.index;
} else if (dragSegment[1] == 1) {
segmentsByFeature[uid].left = segmentData;
segmentsByFeature[uid].index = segmentData.index + 1;
}
}
for (uid in segmentsByFeature) {
right = segmentsByFeature[uid].right;
left = segmentsByFeature[uid].left;
index = segmentsByFeature[uid].index;
newIndex = index - 1;
if (left !== undefined) {
segmentData = left;
} else {
segmentData = right;
}
if (newIndex < 0) {
newIndex = 0;
}
geometry = segmentData.geometry;
coordinates = geometry.getCoordinates();
component = coordinates;
deleted = false;
switch (geometry.getType()) {
case 'MultiLineString':
if (coordinates[segmentData.depth[0]].length > 2) {
coordinates[segmentData.depth[0]].splice(index, 1);
deleted = true;
}
break;
case 'LineString':
if (coordinates.length > 2) {
coordinates.splice(index, 1);
deleted = true;
}
break;
case 'MultiPolygon':
component = component[segmentData.depth[1]];
case 'Polygon':
component = component[segmentData.depth[0]];
if (component.length > 4) {
if (index == component.length - 1) {
index = 0;
}
component.splice(index, 1);
deleted = true;
if (index === 0) {
component.pop();
component.push(component[0]);
newIndex = component.length - 1;
}
}
break;
default:
}
if (deleted) {
this.setGeometryCoordinates_(geometry, coordinates);
const segments = [];
if (left !== undefined) {
this.rBush_.remove(left);
segments.push(left.segment[0]);
}
if (right !== undefined) {
this.rBush_.remove(right);
segments.push(right.segment[1]);
}
if (left !== undefined && right !== undefined) {
const newSegmentData = {
depth: segmentData.depth,
feature: segmentData.feature,
geometry: segmentData.geometry,
index: newIndex,
segment: segments,
};
this.rBush_.insert(
boundingExtent(newSegmentData.segment),
newSegmentData,
);
}
this.updateSegmentIndices_(geometry, index, segmentData.depth, -1);
if (this.vertexFeature_) {
this.overlay_.getSource().removeFeature(this.vertexFeature_);
this.vertexFeature_ = null;
}
dragSegments.length = 0;
}
}
return deleted;
}
* Check if a point can be inserted to the current linestring or polygon at the current
* pointer position.
* @return {boolean} A point can be inserted at the current pointer position.
* @api
*/
canInsertPoint() {
if (!this.vertexFeature_) {
return false;
}
if (
this.vertexFeature_
.get('geometries')
.every(
(geometry) =>
geometry.getType() === 'Circle' ||
geometry.getType().endsWith('Point'),
)
) {
return false;
}
const coordinate = this.vertexFeature_.getGeometry().getCoordinates();
const segments = this.rBush_.getInExtent(boundingExtent([coordinate]));
return segments.some(
({segment}) =>
!(
this.coordinatesEqual_(segment[0], coordinate) ||
this.coordinatesEqual_(segment[1], coordinate)
),
);
}
* Inserts the vertex currently being pointed to the current linestring or polygon.
* @param {import('../coordinate.js').Coordinate} [coordinate] If provided, the pointer
* will be set to the provided coordinate. If not, the current pointer coordinate will be used.
* @return {boolean} A vertex was inserted.
* @api
*/
insertPoint(coordinate) {
const pixelCoordinate = coordinate
? fromUserCoordinate(coordinate, this.getMap().getView().getProjection())
: this.vertexFeature_?.getGeometry().getCoordinates();
if (!pixelCoordinate) {
return false;
}
const insertVertices =
this.findInsertVerticesAndUpdateDragSegments_(pixelCoordinate);
return insertVertices.reduce(
(prev, segmentData) =>
prev || this.insertVertex_(segmentData, pixelCoordinate),
false,
);
}
* @param {import("../geom/SimpleGeometry.js").default} geometry Geometry.
* @param {Array} coordinates Coordinates.
* @private
*/
setGeometryCoordinates_(geometry, coordinates) {
this.changingFeature_ = true;
geometry.setCoordinates(coordinates);
this.changingFeature_ = false;
}
* @param {import("../geom/SimpleGeometry.js").default} geometry Geometry.
* @param {number} index Index.
* @param {Array<number>|undefined} depth Depth.
* @param {number} delta Delta (1 or -1).
* @private
*/
updateSegmentIndices_(geometry, index, depth, delta) {
this.rBush_.forEachInExtent(
geometry.getExtent(),
function (segmentDataMatch) {
if (
segmentDataMatch.geometry === geometry &&
(depth === undefined ||
segmentDataMatch.depth === undefined ||
equals(segmentDataMatch.depth, depth)) &&
segmentDataMatch.index > index
) {
segmentDataMatch.index += delta;
}
},
);
}
* @override
*/
disposeInternal() {
super.disposeInternal();
if (this.featuresCollection_) {
this.featuresCollection_.removeEventListener(
CollectionEventType.ADD,
this.handleExternalCollectionAdd_,
);
this.featuresCollection_.removeEventListener(
CollectionEventType.REMOVE,
this.handleExternalCollectionRemove_,
);
for (const feature of this.featuresCollection_.getArray()) {
feature.removeEventListener(
EventType.CHANGE,
this.handleFeatureChange_,
);
if (this.filterFunctionWasSupplied_) {
feature.removeEventListener(
ObjectEventType.PROPERTYCHANGE,
this.handleFeatureChange_,
);
}
}
} else if (this.source_) {
this.source_.removeEventListener(
VectorEventType.ADDFEATURE,
this.handleSourceAdd_,
);
this.source_.removeEventListener(
VectorEventType.REMOVEFEATURE,
this.handleSourceRemove_,
);
for (const feature of this.source_.getFeatures()) {
feature.removeEventListener(
EventType.CHANGE,
this.handleFeatureChange_,
);
if (this.filterFunctionWasSupplied_) {
feature.removeEventListener(
ObjectEventType.PROPERTYCHANGE,
this.handleFeatureChange_,
);
}
}
}
}
}
* @param {SegmentData} a The first segment data.
* @param {SegmentData} b The second segment data.
* @return {number} The difference in indexes.
*/
function compareIndexes(a, b) {
return a.index - b.index;
}
* Returns the distance from a point to a line segment.
*
* @param {import("../coordinate.js").Coordinate} pointCoordinates The coordinates of the point from
* which to calculate the distance.
* @param {SegmentData} segmentData The object describing the line
* segment we are calculating the distance to.
* @param {import("../proj/Projection.js").default} projection The view projection.
* @return {number} The square of the distance between a point and a line segment.
*/
function projectedDistanceToSegmentDataSquared(
pointCoordinates,
segmentData,
projection,
) {
const geometry = segmentData.geometry;
if (geometry.getType() === 'Circle') {
let circleGeometry = (
geometry
);
if (segmentData.index === CIRCLE_CIRCUMFERENCE_INDEX) {
const userProjection = getUserProjection();
if (userProjection) {
circleGeometry = circleGeometry
.clone()
.transform(userProjection, projection);
}
const distanceToCenterSquared = squaredCoordinateDistance(
circleGeometry.getCenter(),
fromUserCoordinate(pointCoordinates, projection),
);
const distanceToCircumference =
Math.sqrt(distanceToCenterSquared) - circleGeometry.getRadius();
return distanceToCircumference * distanceToCircumference;
}
}
const coordinate = fromUserCoordinate(pointCoordinates, projection);
tempSegment[0] = fromUserCoordinate(segmentData.segment[0], projection);
tempSegment[1] = fromUserCoordinate(segmentData.segment[1], projection);
return squaredDistanceToSegment(coordinate, tempSegment);
}
* Returns the point closest to a given line segment.
*
* @param {import("../coordinate.js").Coordinate} pointCoordinates The point to which a closest point
* should be found.
* @param {SegmentData} segmentData The object describing the line
* segment which should contain the closest point.
* @param {import("../proj/Projection.js").default} projection The view projection.
* @return {import("../coordinate.js").Coordinate} The point closest to the specified line segment.
*/
function closestOnSegmentData(pointCoordinates, segmentData, projection) {
const geometry = segmentData.geometry;
if (
geometry.getType() === 'Circle' &&
segmentData.index === CIRCLE_CIRCUMFERENCE_INDEX
) {
let circleGeometry = (
geometry
);
const userProjection = getUserProjection();
if (userProjection) {
circleGeometry = circleGeometry
.clone()
.transform(userProjection, projection);
}
return toUserCoordinate(
circleGeometry.getClosestPoint(
fromUserCoordinate(pointCoordinates, projection),
),
projection,
);
}
const coordinate = fromUserCoordinate(pointCoordinates, projection);
tempSegment[0] = fromUserCoordinate(segmentData.segment[0], projection);
tempSegment[1] = fromUserCoordinate(segmentData.segment[1], projection);
return toUserCoordinate(
closestOnSegment(coordinate, tempSegment),
projection,
);
}
* @return {import("../style/Style.js").StyleFunction} Styles.
*/
function getDefaultStyleFunction() {
const style = createEditingStyle();
return function (feature, resolution) {
return style['Point'];
};
}
export default Modify;