Merge branch 'refs/heads/master' into stage-document-architecture

1 files changed, 779 insertions, 477 deletions

diff --git a/js/tools/PenTool.js b/js/tools/PenTool.js
index 7fc8dd95..8ecc9f79 100755
--- a/js/tools/PenTool.js
+++ b/js/tools/PenTool.js
@@ -14,12 +14,10 @@ var ElementMediator = require("js/mediators/element-mediator").ElementMediator;
 var TagTool = require("js/tools/TagTool").TagTool;
 var ElementController = require("js/controllers/elements/element-controller").ElementController;
 var snapManager = require("js/helper-classes/3D/snap-manager").SnapManager;
-
+var ViewUtils = require("js/helper-classes/3D/view-utils").ViewUtils;
 var AnchorPoint = require("js/lib/geom/anchor-point").AnchorPoint;
 var SubPath = require("js/lib/geom/sub-path").SubPath;
 
-//todo remove this global var
-var g_DoPenToolMouseMove = true;
 
 exports.PenTool = Montage.create(ShapeTool, {
 
@@ -35,14 +33,11 @@ exports.PenTool = Montage.create(ShapeTool, {
     _parentNode: { enumerable: false, value: null, writable: true },
     _toolsPropertiesContainer: { enumerable: false, value: null, writable: true },
 
-    // Need to keep track of current mouse position for KEY modifiers event which do not have mouse coordinates
-    _currentX: { value: 0, writable: true },
-    _currentY: { value: 0, writable: true },
-
-    //the subpaths are what is displayed on the screen currently, with _selectedSubpath being the active one currently being edited
-    _selectedSubpath: { value: null, writable: true },
-    _makeMultipleSubpaths: { value: true, writable: true },    //set this to true if you want to keep making subpaths after closing current subpath
+    //set this to true if you want to keep making subpaths after closing current subpath (debugging only)
+    _makeMultipleSubpaths: { value: true, writable: true },
 
+    //set this to false if you don't want the mouse move handler being called when the mouse is not down (debugging only)
+    _trackMouseMoveWhenUp: {value: true, writable: false},
 
     //whether the user has held down the Alt key
     _isAltDown: { value: false, writable: true },
@@ -50,29 +45,37 @@ exports.PenTool = Montage.create(ShapeTool, {
     //whether the user has held down the Esc key
     _isEscapeDown: {value: false, writable: true },
 
-    //whether we have just started a new path (set true in mousedown, and set false in mouse up
+    //whether we have just started a new path (may set true in mousedown, and always set false in mouse up
+    //todo this seems to be unnecessary
     _isNewPath: {value: false, writable: true},
 
     //whether we have clicked one of the endpoints after entering the pen tool in ENTRY_SELECT_PATH edit mode
     _isPickedEndPointInSelectPathMode: {value: false, writable: true},
 
     //when the user wants to place a selected anchor point on top of another point, this is the target where the point will be placed
-    _snapTarget: { value: null, writable: true },
+    _snapTargetIndex: { value: -1, writable: true },
+
+    //index of the anchor point that the user has hovered over
+    _hoveredAnchorIndex: {value: -1, writable: true},
 
-    //whether or not we're using webgl for drawing
+    //whether or not we're using webgl for drawing (set to false until we have webgl-ready stroke and fill regions)
     _useWebGL: {value: false, writable: false },
 
-    //the canvas created by the pen tool...this is grown or shrunk with the path (if the canvas was not already provided)
-    _penCanvas: { value: null, writable: true },
+    //the _selectedSubpath is the active subpath currently being edited
+    _selectedSubpath: { value: null, writable: true },
 
-    //the plane matrix for the first click...so the entire path is on the same plane
-    _penPlaneMat: { value: null, writable: true },
+    //the canvas for the selected subpath...this is grown or shrunk by the pen tool with the subpath (if the canvas was not already provided)
+    _selectedSubpathCanvas: { value: null, writable: true },
 
-    //index of the anchor point that the user has hovered over
-    _hoveredAnchorIndex: {value: -1, writable: true},
+    //the plane matrix for the first click...so the entire path is on the same plane
+    //  todo this might be unnecessary as we can get this from element mediator (but that may be slow)
+    _selectedSubpathPlaneMat: { value: null, writable: true },
 
-    //constants used for picking points --- NOTE: these should be user-settable parameters
-    _PICK_POINT_RADIUS: { value: 10, writable: false },
+    //the center of the subpath center in stageworld space
+    _selectedSubpathCanvasCenter: {value: null, writable: true},
+    
+    //constants used for picking points --- todo: these should be user-settable parameters
+    _PICK_POINT_RADIUS: { value: 4, writable: false },
     _DISPLAY_ANCHOR_RADIUS: { value: 5, writable: false },
     _DISPLAY_SELECTED_ANCHOR_RADIUS: { value: 10, writable: false },
     _DISPLAY_SELECTED_ANCHOR_PREV_RADIUS: { value: 2, writable: false },
@@ -86,34 +89,49 @@ exports.PenTool = Montage.create(ShapeTool, {
     EDIT_PREV_NEXT: { value: 8, writable: false },
     _editMode: { value: this.EDIT_NONE, writable: true },
 
-    //constants used for selection modes on entry to pen tool (mutually exclusive)
+    //constants used for selection modes on entry to pen tool (mutually exclusive i.e. cannot be OR-ed)
     ENTRY_SELECT_NONE: { value: 0, writable: false},
     ENTRY_SELECT_CANVAS: { value: 1, writable: false},
     ENTRY_SELECT_PATH: { value: 2, writable: false},
     _entryEditMode: {value: this.ENTRY_SELECT_NONE, writable: true},
-    
 
+    //constants used for limiting size of the subpath canvas
+    _MAX_CANVAS_DIMENSION: {value: 3000, writable: false},
 
-    _getUnsnappedPosition: {
-        value: function(x,y){
+    /*
+    // get the stage world position corresponding to the (x,y) mouse event position by querying the snap manager
+    //  but temporarily turning off all snapping
+    _getMouseEventPosition : {
+        value: function(x,y, getStageWorld, doSnap){
             var elemSnap = snapManager.elementSnapEnabled();
             var gridSnap = snapManager.gridSnapEnabled();
             var alignSnap = snapManager.snapAlignEnabled();
 
-            snapManager.enableElementSnap(false);
-            snapManager.enableGridSnap(false);
-            snapManager.enableSnapAlign(false);
+            if (!doSnap){
+                snapManager.enableElementSnap(false);
+                snapManager.enableGridSnap(false);
+                snapManager.enableSnapAlign(false);
+            }
 
             var point = webkitConvertPointFromPageToNode(this.application.ninja.stage.canvas, new WebKitPoint(x,y));
-            var unsnappedpos = DrawingToolBase.getHitRecPos(snapManager.snap(point.x, point.y, false));
+            var pos;
+            if (getStageWorld){
+                pos = (snapManager.snap(point.x, point.y, false)).calculateStageWorldPoint();    
+            } else {
+                pos = (snapManager.snap(point.x, point.y, false)).getScreenPoint();
+            }
+            var dragPlane = snapManager.getDragPlane();
 
-            snapManager.enableElementSnap(elemSnap);
-            snapManager.enableGridSnap(gridSnap);
-            snapManager.enableSnapAlign(alignSnap);
+            if (!doSnap){
+                snapManager.enableElementSnap(elemSnap);
+                snapManager.enableGridSnap(gridSnap);
+                snapManager.enableSnapAlign(alignSnap);
+            }
 
-            return unsnappedpos;
+            return [pos, dragPlane];
         }
     },
+    */
 
     ShowToolProperties: {
         value: function () {
@@ -126,6 +144,61 @@ exports.PenTool = Montage.create(ShapeTool, {
 
     },
 
+    //use the snap manager to build a hit record corresponding to the screen X, Y position
+    // will use the plane of the selected path as the working plane if available, else use stage
+    getHitRecord:{
+        value: function(x,y, doSnap){
+            var elemSnap = snapManager.elementSnapEnabled();
+            var gridSnap = snapManager.gridSnapEnabled();
+            var alignSnap = snapManager.snapAlignEnabled();
+
+            if (!doSnap){
+                snapManager.enableElementSnap(false);
+                snapManager.enableGridSnap(false);
+                snapManager.enableSnapAlign(false);
+            }
+
+            if (this._selectedSubpathCanvas){
+                var drawingCanvas = this._selectedSubpathCanvas;
+                var contentPlane = ViewUtils.getUnprojectedElementPlane(drawingCanvas);
+                snapManager.pushWorkingPlane(contentPlane);
+
+            }
+            var tmpPoint = webkitConvertPointFromPageToNode(this.application.ninja.stage.canvas, new WebKitPoint(x,y));
+            var hitRec = snapManager.snap(tmpPoint.x, tmpPoint.y, false);
+            if (this._selectedSubpathCanvas){
+                snapManager.popWorkingPlane();
+            }
+
+            if (!doSnap){
+                snapManager.enableElementSnap(elemSnap);
+                snapManager.enableGridSnap(gridSnap);
+                snapManager.enableSnapAlign(alignSnap);
+            }
+            return hitRec;
+        }
+    },
+
+    // **********************************************************************************************************
+    //  Mouse down handler
+    //  IF the selected subpath is null, it means we're going to start a new subpath
+    //      Create a new subpath
+    //  Compute the mouse position in stage world space (lying on stage or selected subpath canvas)
+    //  IF selected subpath does not have a canvas yet,
+    //      IF this is the first anchor point of the selected subpath
+    //          Store the plane mat and drag plane of this hit record (will be used for creating a canvas)
+    //      Add the mouse position (in stage world space) as an anchor point
+    //  ELSE (we may add to the selected subpath)
+    //      Compute the mouse position in local (selected subpath canvas) space
+    //      IF we hit the path:
+    //          Either select an anchor or insert an anchor and select it
+    //          (also set proper flags when select endpoint of open path in ENTRY_SELECT_PATH mode)
+    //      ELSE
+    //          If selected subpath is closed (and we're not in ENTRY_SELECT_PATH mode)
+    //              Create a new subpath
+    //          Add the mouse position (in selected subpath's local space) as an anchor point (call global to local)
+    //  Draw the selected subpath anchors and the selected subpath itself in the stage's context
+    // **********************************************************************************************************
     HandleLeftButtonDown:
     {
         value: function (event) {