improve auto starting position algo

Author: etpinard

src/traces/streamtube/convert.js

@@ -65,6 +65,20 @@ function distinctVals(col) {
     return Lib.distinctVals(col).vals;
 }
 
+function getDfltStartingPositions(vec) {
+    var len = vec.length;
+    var s;
+
+    if(len > 2) {
+        s = vec.slice(1, len - 1);
+    } else if(len === 2) {
+        s = [(vec[0] + vec[1]) / 2];
+    } else {
+        s = vec;
+    }
+    return s;
+}
+
 function getBoundPads(vec) {
     var len = vec.length;
     if(len === 1) {
@@ -116,30 +130,24 @@ function convert(scene, trace) {
             toDataCoords(trace.starts.z.slice(0, slen), 'zaxis')
         );
     } else {
-        // Default starting positions: cut xz plane at min-y,
+        // Default starting positions:
+        //
+        // if len>2, cut xz plane at min-y,
         // takes all x/y/z pts on that plane except those on the edges
-        // to generate "well-defined" tubes
-        var sy0 = sceneLayout.yaxis.d2l(trace._ybnds[0]) * dataScale[1];
-        var sx, sz;
-        if(valsx.length > 2 && valsz.length > 2) {
-            sx = valsx.slice(1, valsx.length - 1);
-            sz = valsz.slice(1, valsy.length - 1);
-        } else {
-            // use all pts on 2x2 and 1x1 planes
-            sx = valsx.slice();
-            sz = valsz.slice();
-        }
-
+        // to generate "well-defined" tubes,
+        //
+        // if len=2, take position halfway between two the pts,
+        //
+        // if len=1, take that pt
+        var sy0 = meshy[0];
+        var sx = getDfltStartingPositions(meshx);
+        var sz = getDfltStartingPositions(meshz);
         var startingPositions = new Array(sx.length * sz.length);
         var m = 0;
 
         for(var i = 0; i < sx.length; i++) {
             for(var k = 0; k < sz.length; k++) {
-                startingPositions[m++] = [
-                    sceneLayout.xaxis.d2l(sx[i]) * dataScale[0],
-                    sy0,
-                    sceneLayout.zaxis.d2l(sz[k]) * dataScale[2]
-                ];
+                startingPositions[m++] = [sx[i], sy0, sz[k]];
             }
         }
         tubeOpts.startingPositions = startingPositions;

test/jasmine/tests/streamtube_test.js

@@ -105,6 +105,82 @@ describe('@gl Test streamtube autorange', function() {
     });
 });
 
+describe('@gl Test streamtube starting positions defaults:', function() {
+    var gd;
+
+    beforeEach(function() {
+        gd = createGraphDiv();
+    });
+
+    afterEach(function() {
+        Plotly.purge(gd);
+        destroyGraphDiv();
+    });
+
+    function makeFigure(nx, ny, nz) {
+        var trace = {
+            type: 'streamtube',
+            x: [], y: [], z: [],
+            u: [], v: [], w: []
+        };
+
+        for(var i = 0; i < nx; i++) {
+            for(var j = 0; j < ny; j++) {
+                for(var k = 0; k < nz; k++) {
+                    trace.x.push(i);
+                    trace.y.push(j);
+                    trace.z.push(k);
+                    trace.u.push(1 + Math.sin(i));
+                    trace.v.push(Math.cos(j));
+                    trace.w.push(0.3 * Math.sin(k * 0.3));
+                }
+            }
+        }
+
+        return {data: [trace]};
+    }
+
+    function _assert(exp) {
+        var scene = gd._fullLayout.scene._scene;
+        var obj = scene.glplot.objects[0];
+        expect(exp.positionsLength).toBe(obj.positions.length, 'positions length');
+        expect(exp.cellsLength).toBe(obj.cells.length, 'cells length');
+    }
+
+    it('should cut xz at min-y and take all x/y/z pts on that plane except those on the edges', function(done) {
+        Plotly.plot(gd, makeFigure(3, 3, 3)).then(function() {
+            _assert({
+                positionsLength: 1536,
+                cellsLength: 512
+            });
+        })
+        .catch(failTest)
+        .then(done);
+    });
+
+    it('should take middle pt if mesh vector has length 2', function(done) {
+        Plotly.plot(gd, makeFigure(3, 3, 2)).then(function() {
+            _assert({
+                positionsLength: 1200,
+                cellsLength: 400
+            });
+        })
+        .catch(failTest)
+        .then(done);
+    });
+
+    it('should take pt if mesh vector has length 1', function(done) {
+        Plotly.plot(gd, makeFigure(1, 3, 2)).then(function() {
+            _assert({
+                positionsLength: 720,
+                cellsLength: 240
+            });
+        })
+        .catch(failTest)
+        .then(done);
+    });
+});
+
 describe('@gl Test streamtube interactions', function() {
     var gd;