standardize API of polar internal routine

- always use angles in radians in angles.js and polar/helpers.js
- adapt polar/helpers.js call signatures to match the
  ones in angles.js

Author: etpinard

src/lib/angles.js

@@ -9,6 +9,7 @@
 'use strict';
 
 var PI = Math.PI;
+var twoPI = 2 * PI;
 
 function deg2rad(deg) {
     return deg / 180 * PI;
@@ -32,12 +33,11 @@ function wrap180(deg) {
  * is sector a full circle?
  * ... this comes up a lot in SVG path-drawing routines
  *
- * @param {2-item array} sector sector angles in *degrees*
+ * @param {2-item array} aBnds : angular bounds in *radians*
  * @return {boolean}
  */
-function isFullCircle(sector) {
-    var arc = Math.abs(sector[1] - sector[0]);
-    return arc === 360;
+function isFullCircle(aBnds) {
+    return Math.abs(aBnds[1] - aBnds[0]) === twoPI;
 }
 
 /**
@@ -68,24 +68,24 @@ function angleDist(a, b) {
  * is angle inside sector?
  *
  * @param {number} a : angle to test in *radians*
- * @param {2-item array} sector : sector angles in *degrees*
+ * @param {2-item array} aBnds : sector's angular bounds in *radians*
  * @param {boolean}
  */
-function isAngleInsideSector(a, sector) {
-    if(isFullCircle(sector)) return true;
+function isAngleInsideSector(a, aBnds) {
+    if(isFullCircle(aBnds)) return true;
 
     var s0, s1;
 
-    if(sector[0] < sector[1]) {
-        s0 = sector[0];
-        s1 = sector[1];
+    if(aBnds[0] < aBnds[1]) {
+        s0 = aBnds[0];
+        s1 = aBnds[1];
     } else {
-        s0 = sector[1];
-        s1 = sector[0];
+        s0 = aBnds[1];
+        s1 = aBnds[0];
     }
 
-    s0 = wrap360(s0);
-    s1 = wrap360(s1);
+    s0 = wrap360(rad2deg(s0));
+    s1 = wrap360(rad2deg(s1));
     if(s0 > s1) s1 += 360;
 
     var a0 = wrap360(rad2deg(a));
@@ -99,21 +99,21 @@ function isAngleInsideSector(a, sector) {
  *
  * @param {number} r : pt's radial coordinate
  * @param {number} a : pt's angular coordinate in *radians*
- * @param {2-item array} rRng : sector's radial range
- * @param {2-item array} sector : sector angles in *degrees*
+ * @param {2-item array} rBnds : sector's radial bounds
+ * @param {2-item array} aBnds : sector's angular bounds in *radians*
  * @return {boolean}
  */
-function isPtInsideSector(r, a, rRng, sector) {
-    if(!isAngleInsideSector(a, sector)) return false;
+function isPtInsideSector(r, a, rBnds, aBnds) {
+    if(!isAngleInsideSector(a, aBnds)) return false;
 
     var r0, r1;
 
-    if(rRng[0] < rRng[1]) {
-        r0 = rRng[0];
-        r1 = rRng[1];
+    if(rBnds[0] < rBnds[1]) {
+        r0 = rBnds[0];
+        r1 = rBnds[1];
     } else {
-        r0 = rRng[1];
-        r1 = rRng[0];
+        r0 = rBnds[1];
+        r1 = rBnds[0];
     }
 
     return r >= r0 && r <= r1;
@@ -124,14 +124,14 @@ function _path(r0, r1, a0, a1, cx, cy, isClosed) {
     cx = cx || 0;
     cy = cy || 0;
 
-    var isCircle = isFullCircle([a0, a1].map(rad2deg));
+    var isCircle = isFullCircle([a0, a1]);
     var aStart, aMid, aEnd;
     var rStart, rEnd;
 
     if(isCircle) {
         aStart = 0;
         aMid = PI;
-        aEnd = 2 * PI;
+        aEnd = twoPI;
     } else {
         if(a0 < a1) {
             aStart = a0;
@@ -195,8 +195,8 @@ function _path(r0, r1, a0, a1, cx, cy, isClosed) {
  * path an arc
  *
  * @param {number} r : radius
- * @param {number} a0 : first angular coordinate
- * @param {number} a1 : second angular coordinate
+ * @param {number} a0 : first angular coordinate in *radians*
+ * @param {number} a1 : second angular coordinate in *radians*
  * @param {number (optional)} cx : x coordinate of center
  * @param {number (optional)} cy : y coordinate of center
  * @return {string} svg path
@@ -209,8 +209,8 @@ function pathArc(r, a0, a1, cx, cy) {
  * path a sector
  *
  * @param {number} r : radius
- * @param {number} a0 : first angular coordinate
- * @param {number} a1 : second angular coordinate
+ * @param {number} a0 : first angular coordinate in *radians*
+ * @param {number} a1 : second angular coordinate in *radians*
  * @param {number (optional)} cx : x coordinate of center
  * @param {number (optional)} cy : y coordinate of center
  * @return {string} svg path
@@ -224,8 +224,8 @@ function pathSector(r, a0, a1, cx, cy) {
  *
  * @param {number} r0 : first radial coordinate
  * @param {number} r1 : second radial coordinate
- * @param {number} a0 : first angular coordinate
- * @param {number} a1 : second angular coordinate
+ * @param {number} a0 : first angular coordinate in *radians*
+ * @param {number} a1 : second angular coordinate in *radians*
  * @param {number (optional)} cx : x coordinate of center
  * @param {number (optional)} cy : y coordinate of center
  * @return {string} svg path

src/plots/polar/helpers.js

@@ -15,34 +15,33 @@ var findIndexOfMin = Lib.findIndexOfMin;
 var isAngleInsideSector = Lib.isAngleInsideSector;
 var angleDelta = Lib.angleDelta;
 var angleDist = Lib.angleDist;
-var deg2rad = Lib.deg2rad;
 
 /**
  * is pt (r,a) inside polygon made up vertices at angles 'vangles'
  * inside a given polar sector
  *
  * @param {number} r : pt's radial coordinate
  * @param {number} a : pt's angular coordinate in *radians*
- * @param {2-item array} rRng : sector's radial range
- * @param {2-item array} sector : sector angles in *degrees*
+ * @param {2-item array} rBnds : sector's radial bounds
+ * @param {2-item array} aBnds : sector's angular bounds *radians*
  * @param {array} vangles : angles of polygon vertices in *radians*
  * @return {boolean}
  */
-function isPtInsidePolygon(r, a, rRng, sector, vangles) {
-    if(!isAngleInsideSector(a, sector)) return false;
+function isPtInsidePolygon(r, a, rBnds, aBnds, vangles) {
+    if(!isAngleInsideSector(a, aBnds)) return false;
 
     var r0, r1;
 
-    if(rRng[0] < rRng[1]) {
-        r0 = rRng[0];
-        r1 = rRng[1];
+    if(rBnds[0] < rBnds[1]) {
+        r0 = rBnds[0];
+        r1 = rBnds[1];
     } else {
-        r0 = rRng[1];
-        r1 = rRng[0];
+        r0 = rBnds[1];
+        r1 = rBnds[0];
     }
 
-    var polygonIn = polygonTester(makePolygon(r0, sector, vangles));
-    var polygonOut = polygonTester(makePolygon(r1, sector, vangles));
+    var polygonIn = polygonTester(makePolygon(r0, aBnds[0], aBnds[1], vangles));
+    var polygonOut = polygonTester(makePolygon(r1, aBnds[0], aBnds[1], vangles));
     var xy = [r * Math.cos(a), r * Math.sin(a)];
     return polygonOut.contains(xy) && !polygonIn.contains(xy);
 }
@@ -128,7 +127,7 @@ function makeRegularPolygon(r, vangles) {
     return vertices;
 }
 
-function makeClippedPolygon(r, sector, vangles) {
+function makeClippedPolygon(r, a0, a1, vangles) {
     var len = vangles.length;
     var vertices = [];
     var i, j;
@@ -146,18 +145,15 @@ function makeClippedPolygon(r, sector, vangles) {
     }
 
     function isInside(v) {
-        return isAngleInsideSector(v, sector);
+        return isAngleInsideSector(v, [a0, a1]);
     }
 
-    var s0 = deg2rad(sector[0]);
-    var s1 = deg2rad(sector[1]);
-
-    // find index in sector closest to sector[0],
+    // find index in sector closest to a0
     // use it to find intersection of v[i0] <-> v[i0-1] edge with sector radius
     var i0 = findIndexOfMin(vangles, function(v) {
-        return isInside(v) ? angleDist(v, s0) : Infinity;
+        return isInside(v) ? angleDist(v, a0) : Infinity;
     });
-    var xy0 = findXY(vangles[i0], vangles[cycleIndex(i0 - 1)], s0);
+    var xy0 = findXY(vangles[i0], vangles[cycleIndex(i0 - 1)], a0);
     vertices.push(xy0);
 
     // fill in in-sector vertices
@@ -167,12 +163,12 @@ function makeClippedPolygon(r, sector, vangles) {
         vertices.push(a2xy(va));
     }
 
-    // find index in sector closest to sector[1],
+    // find index in sector closest to a1,
     // use it to find intersection of v[iN] <-> v[iN+1] edge with sector radius
     var iN = findIndexOfMin(vangles, function(v) {
-        return isInside(v) ? angleDist(v, s1) : Infinity;
+        return isInside(v) ? angleDist(v, a1) : Infinity;
     });
-    var xyN = findXY(vangles[iN], vangles[cycleIndex(iN + 1)], s1);
+    var xyN = findXY(vangles[iN], vangles[cycleIndex(iN + 1)], a1);
     vertices.push(xyN);
 
     vertices.push([0, 0]);
@@ -181,16 +177,16 @@ function makeClippedPolygon(r, sector, vangles) {
     return vertices;
 }
 
-function makePolygon(r, sector, vangles) {
-    return Lib.isFullCircle(sector) ?
+function makePolygon(r, a0, a1, vangles) {
+    return Lib.isFullCircle([a0, a1]) ?
         makeRegularPolygon(r, vangles) :
-        makeClippedPolygon(r, sector, vangles);
+        makeClippedPolygon(r, a0, a1, vangles);
 }
 
-function findPolygonOffset(r, sector, vangles) {
+function findPolygonOffset(r, a0, a1, vangles) {
     var minX = Infinity;
     var minY = Infinity;
-    var vertices = makePolygon(r, sector, vangles);
+    var vertices = makePolygon(r, a0, a1, vangles);
 
     for(var i = 0; i < vertices.length; i++) {
         var v = vertices[i];
@@ -240,15 +236,16 @@ function transformForSVG(pts0, cx, cy) {
  * path polygon
  *
  * @param {number} r : polygon 'radius'
- * @param {2-item array} sector : polar sector in which polygon is clipped
+ * @param {number} a0 : first angular coordinate in *radians*
+ * @param {number} a1 : second angular coordinate in *radians*
  * @param {array} vangles : angles of polygon vertices in *radians*
  * @param {number (optional)} cx : x coordinate of center
  * @param {number (optional)} cy : y coordinate of center
  * @return {string} svg path
  *
  */
-function pathPolygon(r, sector, vangles, cx, cy) {
-    var poly = makePolygon(r, sector, vangles);
+function pathPolygon(r, a0, a1, vangles, cx, cy) {
+    var poly = makePolygon(r, a0, a1, vangles);
     return 'M' + transformForSVG(poly, cx, cy).join('L');
 }
 
@@ -260,14 +257,15 @@ function pathPolygon(r, sector, vangles, cx, cy) {
  *
  * @param {number} r0 : first radial coordinate
  * @param {number} r1 : second radial coordinate
- * @param {2-item array} sector : polar sector in which polygon is clipped
+ * @param {number} a0 : first angular coordinate in *radians*
+ * @param {number} a1 : second angular coordinate in *radians*
  * @param {array} vangles : angles of polygon vertices in *radians*
  * @param {number (optional)} cx : x coordinate of center
  * @param {number (optional)} cy : y coordinate of center
  * @return {string} svg path
  *
  */
-function pathPolygonAnnulus(r0, r1, sector, vangles, cx, cy) {
+function pathPolygonAnnulus(r0, r1, a0, a1, vangles, cx, cy) {
     var rStart, rEnd;
 
     if(r0 < r1) {
@@ -278,8 +276,8 @@ function pathPolygonAnnulus(r0, r1, sector, vangles, cx, cy) {
         rEnd = r0;
     }
 
-    var inner = transformForSVG(makePolygon(rStart, sector, vangles), cx, cy);
-    var outer = transformForSVG(makePolygon(rEnd, sector, vangles), cx, cy);
+    var inner = transformForSVG(makePolygon(rStart, a0, a1, vangles), cx, cy);
+    var outer = transformForSVG(makePolygon(rEnd, a0, a1, vangles), cx, cy);
     return 'M' + outer.reverse().join('L') + 'M' + inner.join('L');
 }