From 5a358918e10eb19422be0d7563bf686c695b76c6 Mon Sep 17 00:00:00 2001
From: tsauerwein <tobias.sauerwein@camptocamp.com>
Date: Wed, 12 Mar 2014 15:10:17 +0100
Subject: [PATCH] Rename interactions

The idea behind the naming scheme is that for example
for `DragRotate`, `Rotate` is the action and `Drag` the
gesture that issues the action.
---
 src/objectliterals.jsdoc                      | 14 +++++----
 src/ol/interaction/dragpaninteraction.exports |  1 +
 ...aninteraction.js => dragpaninteraction.js} | 14 ++++-----
 src/ol/interaction/interactiondefaults.js     | 30 +++++++++----------
 src/ol/interaction/paninteraction.exports     |  1 -
 .../pinchrotateinteraction.exports            |  1 +
 ...teraction.js => pinchrotateinteraction.js} | 14 ++++-----
 .../interaction/pinchzoominteraction.exports  |  1 +
 ...interaction.js => pinchzoominteraction.js} | 14 ++++-----
 src/ol/interaction/rotateinteraction.exports  |  1 -
 src/ol/interaction/zoominteraction.exports    |  1 -
 test/spec/ol/map.test.js                      |  6 ++--
 12 files changed, 50 insertions(+), 48 deletions(-)
 create mode 100644 src/ol/interaction/dragpaninteraction.exports
 rename src/ol/interaction/{paninteraction.js => dragpaninteraction.js} (90%)
 delete mode 100644 src/ol/interaction/paninteraction.exports
 create mode 100644 src/ol/interaction/pinchrotateinteraction.exports
 rename src/ol/interaction/{rotateinteraction.js => pinchrotateinteraction.js} (88%)
 create mode 100644 src/ol/interaction/pinchzoominteraction.exports
 rename src/ol/interaction/{zoominteraction.js => pinchzoominteraction.js} (88%)
 delete mode 100644 src/ol/interaction/rotateinteraction.exports
 delete mode 100644 src/ol/interaction/zoominteraction.exports

diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc
index 9a6b35247c..f6ed9ff560 100644
--- a/src/objectliterals.jsdoc
+++ b/src/objectliterals.jsdoc
@@ -432,10 +432,12 @@
  *     desired. Default is `true`.
  * @property {boolean|undefined} shiftDragZoom Whether Shift-drag zoom is
  *     desired. Default is `true`.
- * @property {boolean|undefined} pan Whether pan is
+ * @property {boolean|undefined} dragPan Whether drag pan is
+ *     desired. Default is `true`.
+ * @property {boolean|undefined} pinchRotate Whether pinch rotate is
+ *     desired. Default is `true`.
+ * @property {boolean|undefined} pinchZoom Whether pinch zoom is
  *     desired. Default is `true`.
- * @property {boolean|undefined} rotate Whether rotate is desired. Default is `true`.
- * @property {boolean|undefined} zoom Whether zoom is desired. Default is `true`.
  * @property {number|undefined} zoomDelta Zoom delta.
  * @property {number|undefined} zoomDuration Zoom duration.
  * @todo stability experimental
@@ -502,7 +504,7 @@
  */
 
 /**
- * @typedef {Object} olx.interaction.PanOptions
+ * @typedef {Object} olx.interaction.DragPanOptions
  * @property {ol.Kinetic|undefined} kinetic Kinetic inertia to apply to the
  *     pan.
  * @todo stability experimental
@@ -517,14 +519,14 @@
  */
 
 /**
- * @typedef {Object} olx.interaction.RotateOptions
+ * @typedef {Object} olx.interaction.PinchRotateOptions
  * @property {number|undefined} threshold Minimal angle in radians to start a rotation.
  *     Default is `0.3`.
  * @todo stability experimental
  */
 
 /**
- * @typedef {Object} olx.interaction.ZoomOptions
+ * @typedef {Object} olx.interaction.PinchZoomOptions
  * @property {number|undefined} duration Animation duration in milliseconds. Default is `400`.
  * @todo stability experimental
  */
diff --git a/src/ol/interaction/dragpaninteraction.exports b/src/ol/interaction/dragpaninteraction.exports
new file mode 100644
index 0000000000..dbc71bf21a
--- /dev/null
+++ b/src/ol/interaction/dragpaninteraction.exports
@@ -0,0 +1 @@
+@exportSymbol ol.interaction.DragPan
diff --git a/src/ol/interaction/paninteraction.js b/src/ol/interaction/dragpaninteraction.js
similarity index 90%
rename from src/ol/interaction/paninteraction.js
rename to src/ol/interaction/dragpaninteraction.js
index f4d01eadaf..89506c777d 100644
--- a/src/ol/interaction/paninteraction.js
+++ b/src/ol/interaction/dragpaninteraction.js
@@ -1,5 +1,5 @@
 // FIXME works for View2D only
-goog.provide('ol.interaction.Pan');
+goog.provide('ol.interaction.DragPan');
 
 goog.require('goog.asserts');
 goog.require('ol.Kinetic');
@@ -16,10 +16,10 @@ goog.require('ol.interaction.Pointer');
  * Allows the user to pan the map by dragging the map.
  * @constructor
  * @extends {ol.interaction.Pointer}
- * @param {olx.interaction.PanOptions=} opt_options Options.
+ * @param {olx.interaction.DragPanOptions=} opt_options Options.
  * @todo stability experimental
  */
-ol.interaction.Pan = function(opt_options) {
+ol.interaction.DragPan = function(opt_options) {
 
   goog.base(this);
 
@@ -56,13 +56,13 @@ ol.interaction.Pan = function(opt_options) {
   this.noKinetic_ = false;
 
 };
-goog.inherits(ol.interaction.Pan, ol.interaction.Pointer);
+goog.inherits(ol.interaction.DragPan, ol.interaction.Pointer);
 
 
 /**
  * @inheritDoc
  */
-ol.interaction.Pan.prototype.handlePointerDrag = function(mapBrowserEvent) {
+ol.interaction.DragPan.prototype.handlePointerDrag = function(mapBrowserEvent) {
   goog.asserts.assert(this.targetPointers.length >= 1);
   var centroid =
       ol.interaction.Pointer.centroid(this.targetPointers);
@@ -91,7 +91,7 @@ ol.interaction.Pan.prototype.handlePointerDrag = function(mapBrowserEvent) {
 /**
  * @inheritDoc
  */
-ol.interaction.Pan.prototype.handlePointerUp =
+ol.interaction.DragPan.prototype.handlePointerUp =
     function(mapBrowserEvent) {
   var map = mapBrowserEvent.map;
   var view2D = map.getView().getView2D();
@@ -124,7 +124,7 @@ ol.interaction.Pan.prototype.handlePointerUp =
 /**
  * @inheritDoc
  */
-ol.interaction.Pan.prototype.handlePointerDown =
+ol.interaction.DragPan.prototype.handlePointerDown =
     function(mapBrowserEvent) {
   if (this.targetPointers.length > 0 && this.condition_(mapBrowserEvent)) {
     var map = mapBrowserEvent.map;
diff --git a/src/ol/interaction/interactiondefaults.js b/src/ol/interaction/interactiondefaults.js
index 52df9661d5..cebb6c1e5b 100644
--- a/src/ol/interaction/interactiondefaults.js
+++ b/src/ol/interaction/interactiondefaults.js
@@ -3,14 +3,14 @@ goog.provide('ol.interaction');
 goog.require('ol.Collection');
 goog.require('ol.Kinetic');
 goog.require('ol.interaction.DoubleClickZoom');
+goog.require('ol.interaction.DragPan');
 goog.require('ol.interaction.DragRotate');
 goog.require('ol.interaction.DragZoom');
 goog.require('ol.interaction.KeyboardPan');
 goog.require('ol.interaction.KeyboardZoom');
 goog.require('ol.interaction.MouseWheelZoom');
-goog.require('ol.interaction.Pan');
-goog.require('ol.interaction.Rotate');
-goog.require('ol.interaction.Zoom');
+goog.require('ol.interaction.PinchRotate');
+goog.require('ol.interaction.PinchZoom');
 
 
 /**
@@ -50,24 +50,24 @@ ol.interaction.defaults = function(opt_options) {
     }));
   }
 
-  var pan = goog.isDef(options.pan) ?
-      options.pan : true;
-  if (pan) {
-    interactions.push(new ol.interaction.Pan({
+  var dragPan = goog.isDef(options.dragPan) ?
+      options.dragPan : true;
+  if (dragPan) {
+    interactions.push(new ol.interaction.DragPan({
       kinetic: kinetic
     }));
   }
 
-  var rotate = goog.isDef(options.rotate) ?
-      options.rotate : true;
-  if (rotate) {
-    interactions.push(new ol.interaction.Rotate());
+  var pinchRotate = goog.isDef(options.pinchRotate) ?
+      options.pinchRotate : true;
+  if (pinchRotate) {
+    interactions.push(new ol.interaction.PinchRotate());
   }
 
-  var zoom = goog.isDef(options.zoom) ?
-      options.zoom : true;
-  if (zoom) {
-    interactions.push(new ol.interaction.Zoom({
+  var pinchZoom = goog.isDef(options.pinchZoom) ?
+      options.pinchZoom : true;
+  if (pinchZoom) {
+    interactions.push(new ol.interaction.PinchZoom({
       duration: options.zoomDuration
     }));
   }
diff --git a/src/ol/interaction/paninteraction.exports b/src/ol/interaction/paninteraction.exports
deleted file mode 100644
index 4dbcf6cd18..0000000000
--- a/src/ol/interaction/paninteraction.exports
+++ /dev/null
@@ -1 +0,0 @@
-@exportSymbol ol.interaction.Pan
diff --git a/src/ol/interaction/pinchrotateinteraction.exports b/src/ol/interaction/pinchrotateinteraction.exports
new file mode 100644
index 0000000000..91c10d7b0f
--- /dev/null
+++ b/src/ol/interaction/pinchrotateinteraction.exports
@@ -0,0 +1 @@
+@exportSymbol ol.interaction.PinchRotate
diff --git a/src/ol/interaction/rotateinteraction.js b/src/ol/interaction/pinchrotateinteraction.js
similarity index 88%
rename from src/ol/interaction/rotateinteraction.js
rename to src/ol/interaction/pinchrotateinteraction.js
index 1c50fc091c..b5b4c68fce 100644
--- a/src/ol/interaction/rotateinteraction.js
+++ b/src/ol/interaction/pinchrotateinteraction.js
@@ -1,6 +1,6 @@
 // FIXME works for View2D only
 
-goog.provide('ol.interaction.Rotate');
+goog.provide('ol.interaction.PinchRotate');
 
 goog.require('goog.asserts');
 goog.require('goog.style');
@@ -21,10 +21,10 @@ ol.interaction.ROTATE_ANIMATION_DURATION = 250;
  * on a touch screen.
  * @constructor
  * @extends {ol.interaction.Pointer}
- * @param {olx.interaction.RotateOptions=} opt_options Options.
+ * @param {olx.interaction.PinchRotateOptions=} opt_options Options.
  * @todo stability experimental
  */
-ol.interaction.Rotate = function(opt_options) {
+ol.interaction.PinchRotate = function(opt_options) {
 
   goog.base(this);
 
@@ -61,13 +61,13 @@ ol.interaction.Rotate = function(opt_options) {
   this.threshold_ = goog.isDef(options.threshold) ? options.threshold : 0.3;
 
 };
-goog.inherits(ol.interaction.Rotate, ol.interaction.Pointer);
+goog.inherits(ol.interaction.PinchRotate, ol.interaction.Pointer);
 
 
 /**
  * @inheritDoc
  */
-ol.interaction.Rotate.prototype.handlePointerDrag =
+ol.interaction.PinchRotate.prototype.handlePointerDrag =
     function(mapBrowserEvent) {
   goog.asserts.assert(this.targetPointers.length >= 2);
   var rotationDelta = 0.0;
@@ -118,7 +118,7 @@ ol.interaction.Rotate.prototype.handlePointerDrag =
 /**
  * @inheritDoc
  */
-ol.interaction.Rotate.prototype.handlePointerUp =
+ol.interaction.PinchRotate.prototype.handlePointerUp =
     function(mapBrowserEvent) {
   if (this.targetPointers.length < 2) {
     var map = mapBrowserEvent.map;
@@ -140,7 +140,7 @@ ol.interaction.Rotate.prototype.handlePointerUp =
 /**
  * @inheritDoc
  */
-ol.interaction.Rotate.prototype.handlePointerDown =
+ol.interaction.PinchRotate.prototype.handlePointerDown =
     function(mapBrowserEvent) {
   if (this.targetPointers.length >= 2) {
     var map = mapBrowserEvent.map;
diff --git a/src/ol/interaction/pinchzoominteraction.exports b/src/ol/interaction/pinchzoominteraction.exports
new file mode 100644
index 0000000000..4636cdfad8
--- /dev/null
+++ b/src/ol/interaction/pinchzoominteraction.exports
@@ -0,0 +1 @@
+@exportSymbol ol.interaction.PinchZoom
diff --git a/src/ol/interaction/zoominteraction.js b/src/ol/interaction/pinchzoominteraction.js
similarity index 88%
rename from src/ol/interaction/zoominteraction.js
rename to src/ol/interaction/pinchzoominteraction.js
index 7a508ca765..0a6a3cde75 100644
--- a/src/ol/interaction/zoominteraction.js
+++ b/src/ol/interaction/pinchzoominteraction.js
@@ -1,6 +1,6 @@
 // FIXME works for View2D only
 
-goog.provide('ol.interaction.Zoom');
+goog.provide('ol.interaction.PinchZoom');
 
 goog.require('goog.asserts');
 goog.require('goog.style');
@@ -15,10 +15,10 @@ goog.require('ol.interaction.Pointer');
  * on a touch screen.
  * @constructor
  * @extends {ol.interaction.Pointer}
- * @param {olx.interaction.ZoomOptions=} opt_options Options.
+ * @param {olx.interaction.PinchZoomOptions=} opt_options Options.
  * @todo stability experimental
  */
-ol.interaction.Zoom = function(opt_options) {
+ol.interaction.PinchZoom = function(opt_options) {
 
   var options = goog.isDef(opt_options) ? opt_options : {};
 
@@ -49,13 +49,13 @@ ol.interaction.Zoom = function(opt_options) {
   this.lastScaleDelta_ = 1;
 
 };
-goog.inherits(ol.interaction.Zoom, ol.interaction.Pointer);
+goog.inherits(ol.interaction.PinchZoom, ol.interaction.Pointer);
 
 
 /**
  * @inheritDoc
  */
-ol.interaction.Zoom.prototype.handlePointerDrag =
+ol.interaction.PinchZoom.prototype.handlePointerDrag =
     function(mapBrowserEvent) {
   goog.asserts.assert(this.targetPointers.length >= 2);
   var scaleDelta = 1.0;
@@ -100,7 +100,7 @@ ol.interaction.Zoom.prototype.handlePointerDrag =
 /**
  * @inheritDoc
  */
-ol.interaction.Zoom.prototype.handlePointerUp =
+ol.interaction.PinchZoom.prototype.handlePointerUp =
     function(mapBrowserEvent) {
   if (this.targetPointers.length < 2) {
     var map = mapBrowserEvent.map;
@@ -123,7 +123,7 @@ ol.interaction.Zoom.prototype.handlePointerUp =
 /**
  * @inheritDoc
  */
-ol.interaction.Zoom.prototype.handlePointerDown =
+ol.interaction.PinchZoom.prototype.handlePointerDown =
     function(mapBrowserEvent) {
   if (this.targetPointers.length >= 2) {
     var map = mapBrowserEvent.map;
diff --git a/src/ol/interaction/rotateinteraction.exports b/src/ol/interaction/rotateinteraction.exports
deleted file mode 100644
index f9ffb8b1ab..0000000000
--- a/src/ol/interaction/rotateinteraction.exports
+++ /dev/null
@@ -1 +0,0 @@
-@exportSymbol ol.interaction.Rotate
diff --git a/src/ol/interaction/zoominteraction.exports b/src/ol/interaction/zoominteraction.exports
deleted file mode 100644
index c90434c66f..0000000000
--- a/src/ol/interaction/zoominteraction.exports
+++ /dev/null
@@ -1 +0,0 @@
-@exportSymbol ol.interaction.Zoom
diff --git a/test/spec/ol/map.test.js b/test/spec/ol/map.test.js
index 8bcc65f514..ca250da1b2 100644
--- a/test/spec/ol/map.test.js
+++ b/test/spec/ol/map.test.js
@@ -144,9 +144,9 @@ describe('ol.Map', function() {
         keyboard: false,
         mouseWheelZoom: false,
         shiftDragZoom: false,
-        pan: false,
-        rotate: false,
-        zoom: false
+        dragPan: false,
+        pinchRotate: false,
+        pinchZoom: false
       };
     });