cleanup streamtube/

- reuse cone colorbar
- compute x/y/z bounds in calc
- pass cmin/cmax to meshData.vertexIntensityBounds
- rename starting position attributes
  cx/cy/cz -> startx/starty/startz
- misc cleanup to bring streamtube closer to cone
- add new TODOs

Author: etpinard

src/traces/streamtube/attributes.js

@@ -19,95 +19,67 @@ var extendFlat = require('../../lib/extend').extendFlat;
 var attrs = {
     x: {
         valType: 'data_array',
-        editType: 'calc',
-        description: ''
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: 'Sets the x coordinates of the vector field'
     },
     y: {
         valType: 'data_array',
-        editType: 'calc'
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: 'Sets the y coordinates of the vector field'
     },
     z: {
         valType: 'data_array',
-        editType: 'calc'
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: 'Sets the z coordinates of the vector field'
     },
 
     u: {
         valType: 'data_array',
         editType: 'calc',
-        description: [
-        ].join(' ')
+        description: 'Sets the x components of the vector field.'
     },
     v: {
         valType: 'data_array',
         editType: 'calc',
-        description: [
-        ].join(' ')
-
+        description: 'Sets the y components of the vector field.'
     },
     w: {
         valType: 'data_array',
         editType: 'calc',
-        description: [
-        ].join(' ')
-
-    },
-
-    cx: {
-        valType: 'data_array',
-        editType: 'calc+clearAxisTypes',
-        description: [
-        ].join(' ')
-    },
-    cy: {
-        valType: 'data_array',
-        editType: 'calc+clearAxisTypes',
-        description: [
-        ].join(' ')
-    },
-    cz: {
-        valType: 'data_array',
-        editType: 'calc+clearAxisTypes',
-        description: [
-        ].join(' ')
+        description: 'Sets the z components of the vector field.'
     },
 
-    bounds: {
+    startx: {
         valType: 'data_array',
-        editType: 'calc+clearAxisTypes',
-        description: [
-        ].join(' ')
-    },
-
-    colormap: {
-        valType: 'string',
-        role: 'style',
         editType: 'calc',
         description: [
+            'Sets the x components of the starting position of the streamtubes',
+            ''
         ].join(' ')
     },
-
-    maxLength: {
-        valType: 'number',
-        min: 1,
-        dflt: 1000,
+    starty: {
+        valType: 'data_array',
         editType: 'calc',
         description: [
+            'Sets the y components of the starting position of the streamtubes',
+            ''
         ].join(' ')
     },
-
-    widthScale: {
-        valType: 'number',
-        role: 'style',
-        min: 0,
-        dflt: 100,
+    startz: {
+        valType: 'data_array',
         editType: 'calc',
         description: [
+            'Sets the z components of the starting position of the streamtubes',
+            ''
         ].join(' ')
     },
 
     // TODO
-//     sizemode: {},
-//     sizescale: {},
+    // maxLength
+    // widthScale
 
     text: {
         valType: 'string',
@@ -116,22 +88,29 @@ var attrs = {
         arrayOk: true,
         editType: 'calc',
         description: [
-
+            'Sets the text elements associated with the cones.',
+            'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
+            'these elements will be seen in the hover labels.'
         ].join(' ')
     }
 };
 
-extendFlat(attrs, colorAttrs('', 'calc', false), {
+extendFlat(attrs, colorAttrs('', 'calc', true), {
     showscale: colorscaleAttrs.showscale,
     colorbar: colorbarAttrs
 });
+delete attrs.color;
 
-var fromMesh3d = ['opacity', 'flatshading', 'lightposition', 'lighting'];
-
+var fromMesh3d = ['opacity', 'lightposition', 'lighting'];
 fromMesh3d.forEach(function(k) {
     attrs[k] = mesh3dAttrs[k];
 });
 
-attrs.hoverinfo = extendFlat({}, baseAttrs.hoverinfo, {editType: 'calc'});
+// TODO maybe add divergence field?
+attrs.hoverinfo = extendFlat({}, baseAttrs.hoverinfo, {
+    editType: 'calc',
+    flags: ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'],
+    dflt: 'x+y+z+norm+text+name'
+});
 
 module.exports = attrs;

src/traces/streamtube/calc.js

@@ -11,7 +11,73 @@
 var colorscaleCalc = require('../../components/colorscale/calc');
 
 module.exports = function calc(gd, trace) {
-    if(trace.intensity) {
-        colorscaleCalc(trace, trace.intensity, '', 'c');
+    var i;
+
+    var u = trace.u;
+    var v = trace.v;
+    var w = trace.w;
+    var vlen = Math.min(u.length, v.length, w.length);
+    var normMax = -Infinity;
+    var normMin = Infinity;
+
+    for(i = 0; i < vlen; i++) {
+        var uu = u[i];
+        var vv = v[i];
+        var ww = w[i];
+        var norm = Math.sqrt(uu * uu + vv * vv + ww * ww);
+
+        normMax = Math.max(normMax, norm);
+        normMin = Math.min(normMin, norm);
+    }
+
+    colorscaleCalc(trace, [normMin, normMax], '', 'c');
+
+    var xMax = -Infinity;
+    var xMin = Infinity;
+    var yMax = -Infinity;
+    var yMin = Infinity;
+    var zMax = -Infinity;
+    var zMin = Infinity;
+
+    var x = trace.x;
+    var y = trace.y;
+    var z = trace.z;
+    var plen = Math.min(x.length, y.length, z.length);
+
+    for(i = 0; i < plen; i++) {
+        var xx = x[i];
+        xMax = Math.max(xMax, xx);
+        xMin = Math.min(xMin, xx);
+
+        var yy = y[i];
+        yMax = Math.max(yMax, yy);
+        yMin = Math.min(yMin, yy);
+
+        var zz = z[i];
+        zMax = Math.max(zMax, zz);
+        zMin = Math.min(zMin, zz);
+    }
+
+    var startx = trace.startx;
+    var starty = trace.starty;
+    var startz = trace.startz;
+    var slen = Math.min(startx.length, starty.length, startz.length);
+
+    for(i = 0; i < slen; i++) {
+        var sx = startx[i];
+        xMax = Math.max(xMax, sx);
+        xMin = Math.min(xMin, sx);
+
+        var sy = starty[i];
+        yMax = Math.max(yMax, sy);
+        yMin = Math.min(yMin, sy);
+
+        var sz = startz[i];
+        zMax = Math.max(zMax, sz);
+        zMin = Math.min(zMin, sz);
     }
+
+    trace._xbnds = [xMin, xMax];
+    trace._ybnds = [yMin, yMax];
+    trace._zbnds = [zMin, zMax];
 };