geojs 1.9.4 → 1.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geojs",
-  "version": "1.9.4",
+  "version": "1.10.0",
   "description": "JavaScript Geo Visualization and Analysis Library",
   "homepage": "https://github.com/OpenGeoscience/geojs",
   "license": "Apache-2.0",

package/src/action.js

@@ -17,7 +17,8 @@ var geo_action = {
   zoomselect: 'geo_action_zoomselect',
 
   // annotation actions -- some are also added by the registry
-  annotation_edit_handle: 'geo_annotation_edit_handle'
+  annotation_edit_handle: 'geo_annotation_edit_handle',
+  annotation_cursor: 'geo_annotation_cursor'
 };
 
 module.exports = geo_action;

package/src/annotation/annotation.js

@@ -15,7 +15,8 @@ var annotationState = {
   create: 'create',
   done: 'done',
   highlight: 'highlight',
-  edit: 'edit'
+  edit: 'edit',
+  cursor: 'cursor'
 };
 
 var annotationActionOwner = 'annotationAction';
@@ -153,10 +154,13 @@ var annotation = function (type, args) {
 
   /**
    * Assign a new id to this annotation.
+   *
+   * @returns {this}
    */
   this.newId = function () {
     annotationId += 1;
     m_id = annotationId;
+    return m_this;
   };
 
   /**
@@ -308,6 +312,27 @@ var annotation = function (type, args) {
     return m_this;
   };
 
+  this._cursorHandleMousemove = function (evt) {
+    m_this.layer()._handleMouseMoveModifiers(evt);
+    const center = m_this._cursorCenter;
+    const delta = {
+      x: evt.mapgcs.x - center.x,
+      y: evt.mapgcs.y - center.y
+    };
+    if (delta.x || delta.y) {
+      const curPts = m_this._coordinates();
+      var pts = m_this._coordinatesMapFunc(curPts, function (elem) {
+        return {x: elem.x + delta.x, y: elem.y + delta.y};
+      });
+      m_this._coordinates(pts);
+      m_this._cursorCenter = evt.mapgcs;
+      m_this.modified();
+      m_this.draw();
+      return true;
+    }
+    return false;
+  };
+
   /**
    * Get or set the state of this annotation.
    *
@@ -328,6 +353,17 @@ var annotation = function (type, args) {
           annotation: m_this
         });
       }
+      if (m_this.layer()) {
+        m_this.layer().geoOff(geo_event.mousemove, m_this._cursorHandleMousemove);
+      }
+      switch (m_state) {
+        case annotationState.cursor:
+          m_this._cursorCenter = util.centerFromPerimeter(m_this._coordinates());
+          if (m_this.layer()) {
+            m_this.layer().geoOn(geo_event.mousemove, m_this._cursorHandleMousemove);
+          }
+          break;
+      }
     }
     return m_this;
   };
@@ -356,6 +392,18 @@ var annotation = function (type, args) {
           owner: annotationActionOwner,
           input: 'pan'
         }];
+      case annotationState.cursor:
+        return [{
+          action: geo_action.annotation_cursor,
+          name: 'annotation cursor',
+          owner: annotationActionOwner,
+          input: 'pan'
+        }, {
+          action: geo_action.annotation_cursor,
+          name: 'annotation cursor',
+          owner: annotationActionOwner,
+          input: 'left'
+        }];
       default:
         return [];
     }
@@ -479,7 +527,7 @@ var annotation = function (type, args) {
       /* For style objects, re-extend them without recursion.  This allows
        * setting colors without an opacity field, for instance. */
       ['style', 'createStyle', 'editStyle', 'editHandleStyle', 'labelStyle',
-        'highlightStyle'
+        'highlightStyle', 'cursorStyle'
       ].forEach(function (key) {
         if (arg1[key] !== undefined) {
           $.extend(m_options[key], arg1[key]);
@@ -528,8 +576,8 @@ var annotation = function (type, args) {
    *    current style with the values in the specified object.
    * @param {*} [arg2] If `arg1` is a string, the new value for that style.
    * @param {string} [styleType='style'] The name of the style type, such as
-   *    `createStyle`, `editStyle`, `editHandleStyle`, `labelStyle`, or
-   *    `highlightStyle`.
+   *    `createStyle`, `editStyle`, `editHandleStyle`, `labelStyle`,
+   *    `highlightStyle`, or `cursorStyle`.
    * @returns {object|this} Either the entire style object, the value of a
    *    specific style, or the current class instance.
    */
@@ -578,12 +626,18 @@ var annotation = function (type, args) {
    * @instance
    */
   /**
-   * Calls {@link geo.annotation#style} with `styleType='highlightHandleStyle'`.
-   * @function highlightHandleStyle
+   * Calls {@link geo.annotation#style} with `styleType='highlightStyle'`.
+   * @function highlightStyle
    * @memberof geo.annotation
    * @instance
    */
-  ['createStyle', 'editStyle', 'editHandleStyle', 'labelStyle', 'highlightStyle'
+  /**
+   * Calls {@link geo.annotation#style} with `styleType='cursorStyle'`.
+   * @function cursorStyle
+   * @memberof geo.annotation
+   * @instance
+   */
+  ['createStyle', 'editStyle', 'editHandleStyle', 'labelStyle', 'highlightStyle', 'cursorStyle'
   ].forEach(function (styleType) {
     m_this[styleType] = function (arg1, arg2) {
       return m_this.style(arg1, arg2, styleType);
@@ -608,6 +662,10 @@ var annotation = function (type, args) {
       return $.extend({}, m_options.style, m_options.editStyle,
                       m_options[state + 'Style']);
     }
+    if (state === annotationState.cursor) {
+      return $.extend({}, m_options.style, m_options.editStyle,
+                      m_options.createStyle, m_options[state + 'Style']);
+    }
     return m_options[state + 'Style'] || m_options.style || {};
   };
 

package/src/annotation/polygonAnnotation.js

@@ -3,6 +3,7 @@ const inherit = require('../inherit');
 const registerAnnotation = require('../registry').registerAnnotation;
 const lineFeature = require('../lineFeature');
 const polygonFeature = require('../polygonFeature');
+const util = require('../util');
 
 const annotation = require('./annotation').annotation;
 const annotationState = require('./annotation').state;
@@ -61,6 +62,9 @@ var polygonAnnotation = function (args) {
         }
         return m_this.options('vertices')[i];
       }
+    },
+    cursorStyle: {
+      position: util.identityFunction
     }
   }, args);
   args.vertices = args.vertices || args.coordinates || [];
@@ -332,6 +336,13 @@ polygonAnnotation.defaults = $.extend({}, annotation.defaults, {
     stroke: false,
     strokeColor: {r: 0, g: 0, b: 1}
   },
+  cursorStyle: {
+    closed: true,
+    fillColor: {r: 0.3, g: 0.3, b: 0.3},
+    fillOpacity: 0.25,
+    stroke: true,
+    strokeColor: {r: 0, g: 0, b: 1}
+  },
   allowBooleanOperations: true
 });
 

package/src/annotationLayer.js

@@ -184,6 +184,15 @@ var annotationLayer = function (arg) {
             }
           }
           break;
+        case m_this.modes.cursor:
+          m_this.currentAnnotation._cursorHandleMousemove(evt.mouse);
+          update = m_this.currentAnnotation.processAction(evt);
+          m_this.geoTrigger(geo_event.annotation.cursor_action, {
+            annotation: m_this.currentAnnotation,
+            operation: m_this.currentBooleanOperation(),
+            evt: evt
+          });
+          break;
         default:
           update = m_this.currentAnnotation.processAction(evt);
           break;
@@ -261,7 +270,7 @@ var annotationLayer = function (arg) {
    * @param {geo.event} evt The mouse move or click event.
    */
   this._handleMouseMoveModifiers = function (evt) {
-    if (m_this.mode() !== m_this.modes.edit && m_this.currentAnnotation.options('allowBooleanOperations') && m_this.currentAnnotation._coordinates().length < 2) {
+    if (m_this.mode() !== m_this.modes.edit && m_this.currentAnnotation.options('allowBooleanOperations') && (m_this.currentAnnotation._coordinates().length < 2 || m_this.mode() === m_this.modes.cursor)) {
       if (evt.modifiers) {
         const mod = (evt.modifiers.shift ? 's' : '') + (evt.modifiers.ctrl ? 'c' : '') + (evt.modifiers.meta || evt.modifiers.alt ? 'a' : '');
         if (m_this._currentBooleanClass === m_this._booleanClasses[mod]) {
@@ -392,6 +401,13 @@ var annotationLayer = function (arg) {
       update = m_this.currentAnnotation.mouseClick(evt);
       m_this._updateFromEvent(update);
       retrigger = !m_this.mode();
+      if (m_this.mode() === m_this.modes.cursor) {
+        m_this.geoTrigger(geo_event.annotation.cursor_click, {
+          annotation: m_this.currentAnnotation,
+          operation: m_this.currentBooleanOperation(),
+          evt: evt
+        });
+      }
     } else if (!m_this.mode() && !m_this.currentAnnotation && m_this.options('clickToEdit')) {
       var highlighted = m_this.annotations().filter(function (ann) {
         return ann.state() === geo_annotation.state.highlight;
@@ -591,7 +607,8 @@ var annotationLayer = function (arg) {
 
   /* A list of special modes */
   this.modes = {
-    edit: 'edit'
+    edit: 'edit',
+    cursor: 'cursor'
   };
 
   /* Keys are short-hand for preferred event modifiers.  Values are classes to
@@ -608,11 +625,13 @@ var annotationLayer = function (arg) {
    *
    * @param {string|null} [arg] `undefined` to get the current mode, `null` to
    *    stop creating/editing, `this.modes.edit` (`'edit'`) plus an annotation
-   *    to switch to edit mode, or the name of the type of annotation to
-   *    create.  Available annotations can listed via
+   *    to switch to edit mode, `this.modes.cursor` plus an annotation to
+   *    switch to using the annotation as a cursor, or the name of the type of
+   *    annotation to create.  Available annotations can listed via
    *    {@link geo.listAnnotations}.
-   * @param {geo.annotation} [editAnnotation] If `arg === this.modes.edit`,
-   *    this is the annotation that should be edited.
+   * @param {geo.annotation} [editAnnotation] If `arg === this.modes.edit` or
+   *    `arg === this.modes.cursor`, this is the annotation that should be
+   *    edited or used.
    * @param {object} [options] Additional options to pass when creating an
    *    annotation.
    * @returns {string|null|this} The current mode or the layer.
@@ -622,11 +641,14 @@ var annotationLayer = function (arg) {
     if (arg === undefined) {
       return m_mode;
     }
-    if (arg !== m_mode || (arg === m_this.modes.edit && editAnnotation !== m_this.editAnnotation) || (arg !== m_this.modes.edit && arg && !m_this.currentAnnotation)) {
+    if (arg !== m_mode ||
+        ((arg === m_this.modes.edit || arg === m_this.modes.cursor) && editAnnotation !== m_this.editAnnotation) ||
+        (arg !== m_this.modes.edit && arg !== m_this.modes.cursor && arg && !m_this.currentAnnotation)
+    ) {
       var createAnnotation, actions,
           mapNode = m_this.map().node(), oldMode = m_mode;
       m_mode = arg;
-      mapNode.toggleClass('annotation-input', !!(m_mode && m_mode !== m_this.modes.edit));
+      mapNode.toggleClass('annotation-input', !!(m_mode && m_mode !== m_this.modes.edit && m_mode !== m_this.modes.cursor));
       if (!m_mode || m_mode === m_this.modes.edit) {
         Object.values(m_this._booleanClasses).forEach((c) => mapNode.toggleClass(c, false));
         m_this._currentBooleanClass = undefined;
@@ -649,6 +671,12 @@ var annotationLayer = function (arg) {
             m_this.modified();
             m_this.draw();
             break;
+          case geo_annotation.state.cursor:
+            m_this.currentAnnotation.state(geo_annotation.state.done);
+            m_this.modified();
+            m_this.draw();
+            m_this.map().node().toggleClass('annotation-cursor', false);
+            break;
         }
         m_this.currentAnnotation = null;
       }
@@ -656,6 +684,12 @@ var annotationLayer = function (arg) {
         m_this.currentAnnotation = editAnnotation;
         m_this.currentAnnotation.state(geo_annotation.state.edit);
         m_this.modified();
+      } else if (m_mode === m_this.modes.cursor) {
+        m_this.currentAnnotation = editAnnotation;
+        m_this.currentAnnotation.state(geo_annotation.state.cursor);
+        m_this.modified();
+        m_this.map().node().toggleClass('annotation-cursor', true);
+        actions = m_this.currentAnnotation.actions(geo_annotation.state.cursor);
       } else if (registry.registries.annotations[m_mode]) {
         createAnnotation = registry.registries.annotations[m_mode].func;
       }
@@ -669,13 +703,15 @@ var annotationLayer = function (arg) {
         m_this.currentAnnotation = createAnnotation(options);
         m_this.addAnnotation(m_this.currentAnnotation, null);
         actions = m_this.currentAnnotation.actions(geo_annotation.state.create);
+      }
+      if (actions) {
         $.each(actions, function (idx, action) {
           m_this.map().interactor().addAction(action);
         });
       }
       m_this.geoTrigger(geo_event.annotation.mode, {
         mode: m_mode, oldMode: oldMode});
-      if (oldMode === m_this.modes.edit) {
+      if (oldMode === m_this.modes.edit || oldMode === m_this.modes.cursor) {
         m_this.modified();
       }
     }

package/src/event.js

@@ -706,4 +706,32 @@ geo_event.annotation.mode = 'geo_annotation_mode';
  */
 geo_event.annotation.boolean = 'geo_annotation_boolean';
 
+/**
+ * Triggered when an annotation is in cursor mode and the mouse is clicked.
+ *
+ * @event geo.event.annotation.cursor_click
+ * @type {geo.event.base}
+ * @property {geo.annotation} annotation The annotation that is being operated
+ *      on.
+ * @property {string} operation The operation being performed.
+ * @property {boolean} [cancel] If the handle sets this to false, don't apply
+ *      the operation to the annotation layer.
+ * @property {object} event The triggering event.
+ */
+geo_event.annotation.cursor_click = 'geo_annotation_cursor_click';
+
+/**
+ * Triggered when an annotation is in cursor mode and an action occurs.
+ *
+ * @event geo.event.annotation.cursor_action
+ * @type {geo.event.base}
+ * @property {geo.annotation} annotation The annotation that is being operated
+ *      on.
+ * @property {string} operation The operation being performed.
+ * @property {boolean} [cancel] If the handle sets this to false, don't apply
+ *      the operation to the annotation layer.
+ * @property {object} event The triggering event.
+ */
+geo_event.annotation.cursor_action = 'geo_annotation_cursor_action';
+
 module.exports = geo_event;

package/src/main.styl

@@ -58,6 +58,17 @@
     &.annotation-xor
       cursor embedurl("./css/cursor-crosshair-xor.svg") 12 12,crosshair
 
+  &.annotation-cursor
+    cursor crosshair
+    &.annotation-intersect
+      cursor embedurl("./css/cursor-crosshair-intersect.svg") 12 12,crosshair
+    &.annotation-difference
+      cursor embedurl("./css/cursor-crosshair-difference.svg") 12 12,crosshair
+    &.annotation-union
+      cursor embedurl("./css/cursor-crosshair-union.svg") 12 12,crosshair
+    &.annotation-xor
+      cursor embedurl("./css/cursor-crosshair-xor.svg") 12 12,crosshair
+
   &.highlight-focus
     &:after
       content ""

package/src/mapInteractor.js

@@ -134,6 +134,7 @@ var mapInteractor = function (args) {
       m_boundKeys,
       m_touchHandler,
       m_state,
+      m_nextStateId = 0,
       m_queue,
       $node,
       m_selectionLayer = null,
@@ -1117,6 +1118,7 @@ var mapInteractor = function (args) {
       };
 
       // store the state object
+      m_nextStateId += 1;
       m_state = {
         action: action,
         actionRecord: actionRecord,
@@ -1124,6 +1126,7 @@ var mapInteractor = function (args) {
         initialZoom: map.zoom(),
         initialRotation: map.rotation(),
         initialEventRotation: evt.rotation,
+        stateId: m_nextStateId,
         delta: {x: 0, y: 0}
       };