Merge pull request #603 from OpenGeoscience/refactor-interactor-actions

Refactor how actions are specified and detected.

src/action.js

@@ -0,0 +1,17 @@
+//////////////////////////////////////////////////////////////////////////////
+/**
+ * Common object containing all action types that are provided by the GeoJS
+ * API.
+ */
+//////////////////////////////////////////////////////////////////////////////
+var geo_action = {
+  momentum: 'geo_action_momentum',
+  pan: 'geo_action_pan',
+  rotate: 'geo_action_rotate',
+  select: 'geo_action_select',
+  unzoomselect: 'geo_action_unzoomselect',
+  zoom: 'geo_action_zoom',
+  zoomselect: 'geo_action_zoomselect'
+};
+
+module.exports = geo_action;

src/event.js

@@ -224,6 +224,63 @@ geo_event.zoomselect = 'geo_zoomselect';
 //////////////////////////////////////////////////////////////////////////////
 geo_event.unzoomselect = 'geo_unzoomselect';
 
+//////////////////////////////////////////////////////////////////////////////
+/**
+ * Triggered when an action is initiated with mouse down
+ *
+ * @property {object} state The action state
+ * @property {geo.mouseState} mouse The mouse state
+ * @property {object} event The triggering event
+ */
+//////////////////////////////////////////////////////////////////////////////
+geo_event.actiondown = 'geo_actiondown';
+
+//////////////////////////////////////////////////////////////////////////////
+/**
+ * Triggered when an action is being processed during mouse movement.
+ *
+ * @property {object} state The action state
+ * @property {geo.mouseState} mouse The mouse state
+ * @property {object} event The triggering event
+ */
+//////////////////////////////////////////////////////////////////////////////
+geo_event.actionmove = 'geo_actionmove';
+
+//////////////////////////////////////////////////////////////////////////////
+/**
+ * Triggered when an action is ended with a mouse up.
+ *
+ * @property {object} state The action state
+ * @property {geo.mouseState} mouse The mouse state
+ * @property {object} event The triggering event
+ */
+//////////////////////////////////////////////////////////////////////////////
+geo_event.actionup = 'geo_actionup';
+
+//////////////////////////////////////////////////////////////////////////////
+/**
+ * Triggered when an action results in a selection.
+ *
+ * @property {object} state The action state
+ * @property {geo.mouseState} mouse The mouse state
+ * @property {object} event The triggering event
+ * @property {object} lowerLeft Lower left of selection in screen coordinates
+ * @property {object} upperRight Upper right of selection in screen coordinates
+ */
+//////////////////////////////////////////////////////////////////////////////
+geo_event.actionselection = 'geo_actionselection';
+
+//////////////////////////////////////////////////////////////////////////////
+/**
+ * Triggered when an action is triggered with a mouse wheel event.
+ *
+ * @property {object} state The action state
+ * @property {geo.mouseState} mouse The mouse state
+ * @property {object} event The triggering event
+ */
+//////////////////////////////////////////////////////////////////////////////
+geo_event.actionwheel = 'geo_actionwheel';
+
 //////////////////////////////////////////////////////////////////////////////
 /**
  * Triggered before a map navigation animation begins.  Set

src/index.js

@@ -41,6 +41,7 @@ module.exports = $.extend({
   featureLayer: require('./featureLayer'),
   fetchQueue: require('./fetchQueue'),
   fileReader: require('./fileReader'),
+  geo_action: require('./action'),
   geomFeature: require('./geomFeature'),
   graphFeature: require('./graphFeature'),
   imageTile: require('./imageTile'),