Merge pull request qiao#19 from tapio/dont-cross-corners

Finalizing dontCrossCorners

Author: qiao

README.md

@@ -126,6 +126,19 @@ var finder = new PF.AStarFinder({
 });
 ```
 
+When diagonal movement is enabled, you might want to prevent the path from touching the corners of the occupied grid blocks. This is usually desirable if the objects using the path have physical width and can also move between the grid cells.
+
+To enable the corner crossing prevention:
+
+```javascript
+var finder = new PF.AStarFinder({
+    allowDiagonal: true,
+    dontCrossCorners: true
+});
+```
+
+Note that `dontCrossCorners` only makes sense when `allowDiagonal` is also used. Currently all algorithms except `JumpPointFinder` support this feature.
+
 For `AStarFinder`, `BestFirstFinder` and all their `Bi` relatives, you may indicate which heuristic function to use.
 
 The predefined heuristics are `PF.Heuristic.manhattan`(defalut), `PF.Heuristic.chebyshev` and `PF.Heuristic.euclidean`.

visual/index.html

@@ -84,6 +84,8 @@ <h3>Options</h3>
             <label class="option_label">Allow Diagonal</label> <br>
             <input type="checkbox" class="bi-directional">
             <label class="option_label">Bi-directional</label> <br>
+            <input type="checkbox" class="dont_cross_corners">
+            <label class="option_label">Don't Cross Corners</label> <br>
           </div>
         </div>
 
@@ -109,6 +111,8 @@ <h3>Options</h3>
             <label class="option_label">Allow Diagonal</label> <br>
             <input type="checkbox" class="bi-directional">
             <label class="option_label">Bi-directional</label> <br>
+            <input type="checkbox" class="dont_cross_corners">
+            <label class="option_label">Don't Cross Corners</label> <br>
           </div>
         </div>
 
@@ -122,6 +126,8 @@ <h3>Options</h3>
             <label class="option_label">Allow Diagonal</label> <br>
             <input type="checkbox" class="bi-directional">
             <label class="option_label">Bi-directional</label> <br>
+            <input type="checkbox" class="dont_cross_corners">
+            <label class="option_label">Don't Cross Corners</label> <br>
           </div>
         </div>
 

visual/js/panel.js

@@ -62,10 +62,18 @@ var Panel = {
                                      '.allow_diagonal:checked').val() !== 'undefined';
             biDirectional = typeof $('#breadthfirst_section ' +
                                      '.bi-directional:checked').val() !== 'undefined';
+            dontCrossCorners = typeof $('#breadthfirst_section ' +
+                                     '.dont_cross_corners:checked').val() !=='undefined';
             if (biDirectional) {
-                finder = new PF.BiBreadthFirstFinder({allowDiagonal: allowDiagonal});
+                finder = new PF.BiBreadthFirstFinder({
+                    allowDiagonal: allowDiagonal,
+                    dontCrossCorners: dontCrossCorners
+                });
             } else {
-                finder = new PF.BreadthFirstFinder({allowDiagonal: allowDiagonal});
+                finder = new PF.BreadthFirstFinder({
+                    allowDiagonal: allowDiagonal,
+                    dontCrossCorners: dontCrossCorners
+                });
             }
             break;
 
@@ -74,15 +82,19 @@ var Panel = {
                                      '.allow_diagonal:checked').val() !== 'undefined';
             biDirectional = typeof $('#bestfirst_section ' +
                                      '.bi-directional:checked').val() !== 'undefined';
+            dontCrossCorners = typeof $('#bestfirst_section ' +
+                                     '.dont_cross_corners:checked').val() !=='undefined';
             heuristic = $('input[name=bestfirst_heuristic]:checked').val();
             if (biDirectional) {
                 finder = new PF.BiBestFirstFinder({
                     allowDiagonal: allowDiagonal,
+                    dontCrossCorners: dontCrossCorners,
                     heuristic: PF.Heuristic[heuristic]
                 });
             } else {
                 finder = new PF.BestFirstFinder({
                     allowDiagonal: allowDiagonal,
+                    dontCrossCorners: dontCrossCorners,
                     heuristic: PF.Heuristic[heuristic]
                 });
             }
@@ -93,10 +105,18 @@ var Panel = {
                                      '.allow_diagonal:checked').val() !== 'undefined';
             biDirectional = typeof $('#dijkstra_section ' +
                                      '.bi-directional:checked').val() !=='undefined';
+            dontCrossCorners = typeof $('#dijkstra_section ' +
+                                     '.dont_cross_corners:checked').val() !=='undefined';
             if (biDirectional) {
-                finder = new PF.BiDijkstraFinder({allowDiagonal: allowDiagonal});
+                finder = new PF.BiDijkstraFinder({
+                    allowDiagonal: allowDiagonal,
+                    dontCrossCorners: dontCrossCorners
+                });
             } else {
-                finder = new PF.DijkstraFinder({allowDiagonal: allowDiagonal});
+                finder = new PF.DijkstraFinder({
+                    allowDiagonal: allowDiagonal,
+                    dontCrossCorners: dontCrossCorners
+                });
             }
             break;