Merge pull request #3109 from fperucic/snap-feature

Snap feature
2015-03-27 14:45:57 +01:00
parent 98c510a729 d740640321
commit 254039a6ab
4 changed files with 866 additions and 1 deletions
@@ -2468,7 +2468,7 @@ olx.interaction.ModifyOptions.prototype.deleteCondition;

 /**
 * Pixel tolerance for considering the pointer close enough to a segment or
- * vertex for editing. Default is `10` pixels.
+ * vertex for editing.
 * @type {number|undefined}
 * @api
 */
@@ -2689,6 +2689,43 @@ olx.interaction.SelectOptions.prototype.toggleCondition;
 olx.interaction.SelectOptions.prototype.multi;


+/**
+ * Options for snap
+ * @typedef {{
+ *     features: (ol.Collection.<ol.Feature>|undefined),
+ *     pixelTolerance: (number|undefined),
+ *     source: (ol.source.Vector|undefined)
+ * }}
+ * @api
+ */
+olx.interaction.SnapOptions;
+
+
+/**
+ * Snap to these features. Either this option or source should be provided.
+ * @type {ol.Collection.<ol.Feature>|undefined}
+ * @api
+ */
+olx.interaction.SnapOptions.prototype.features;
+
+
+/**
+ * Pixel tolerance for considering the pointer close enough to a segment or
+ * vertex for editing. Default is `10` pixels.
+ * @type {number|undefined}
+ * @api
+ */
+olx.interaction.SnapOptions.prototype.pixelTolerance;
+
+
+/**
+ * Snap to features from this source. Either this option or features should be provided
+ * @type {ol.source.Vector|undefined}
+ * @api
+ */
+olx.interaction.SnapOptions.prototype.source;
+
+
 /**
 * Namespace.
 * @type {Object}