Merge pull request #2715 from plotly/cone-sizeref-fixes

Cone sizeref fixes

Author: etpinard

package-lock.json

@@ -69,7 +69,7 @@
     "es6-promise": "^3.0.2",
     "fast-isnumeric": "^1.1.1",
     "font-atlas-sdf": "^1.3.3",
-    "gl-cone3d": "^v1.0.1",
+    "gl-cone3d": "^1.1.0",
     "gl-contour2d": "^1.1.4",
     "gl-error3d": "^1.0.7",
     "gl-heatmap2d": "^1.0.4",

package.json

@@ -112,20 +112,26 @@ var attrs = {
         editType: 'calc',
         dflt: 'scaled',
         description: [
-            'Sets the mode by which the cones are sized.',
-            'If *scaled*, `sizeref` scales such that the reference cone size',
-            'for the maximum vector magnitude is 1.',
-            'If *absolute*, `sizeref` scales such that the reference cone size',
-            'for vector magnitude 1 is one grid unit.'
+            'Determines whether `sizeref` is set as a *scaled* (i.e unitless) scalar',
+            '(normalized by the max u/v/w norm in the vector field) or as',
+            '*absolute* value (in the same units as the vector field).'
         ].join(' ')
     },
     sizeref: {
         valType: 'number',
         role: 'info',
         editType: 'calc',
         min: 0,
-        dflt: 1,
-        description: 'Sets the cone size reference value.'
+        description: [
+            'Adjusts the cone size scaling.',
+            'The size of the cones is determined by their u/v/w norm multiplied a factor and `sizeref`.',
+            'This factor (computed internally) corresponds to the minimum "time" to travel across',
+            'two successive x/y/z positions at the average velocity of those two successive positions.',
+            'All cones in a given trace use the same factor.',
+            'With `sizemode` set to *scaled*, `sizeref` is unitless, its default value is *0.5*',
+            'With `sizemode` set to *absolute*, `sizeref` has the same units as the u/v/w vector field,',
+            'its the default value is half the sample\'s maximum vector norm.'
+        ].join(' ')
     },
 
     anchor: {

src/traces/cone/attributes.js

@@ -8,7 +8,6 @@
 
 'use strict';
 
-var createScatterPlot = require('gl-scatter3d');
 var conePlot = require('gl-cone3d');
 var createConeMesh = require('gl-cone3d').createConeMesh;
 
@@ -19,14 +18,13 @@ function Cone(scene, uid) {
     this.scene = scene;
     this.uid = uid;
     this.mesh = null;
-    this.pts = null;
     this.data = null;
 }
 
 var proto = Cone.prototype;
 
 proto.handlePick = function(selection) {
-    if(selection.object === this.pts) {
+    if(selection.object === this.mesh) {
         var selectIndex = selection.index = selection.data.index;
         var xx = this.data.x[selectIndex];
         var yy = this.data.y[selectIndex];
@@ -61,7 +59,6 @@ function zip3(x, y, z) {
 }
 
 var axisName2scaleIndex = {xaxis: 0, yaxis: 1, zaxis: 2};
-var sizeMode2sizeKey = {scaled: 'coneSize', absolute: 'absoluteConeSize'};
 var anchor2coneOffset = {tip: 1, tail: 0, cm: 0.25, center: 0.5};
 var anchor2coneSpan = {tip: 1, tail: 1, cm: 0.75, center: 0.5};
 
@@ -90,17 +87,23 @@ function convert(scene, trace) {
 
     coneOpts.colormap = parseColorScale(trace.colorscale);
     coneOpts.vertexIntensityBounds = [trace.cmin / trace._normMax, trace.cmax / trace._normMax];
-
-    coneOpts[sizeMode2sizeKey[trace.sizemode]] = trace.sizeref;
     coneOpts.coneOffset = anchor2coneOffset[trace.anchor];
 
-    var meshData = conePlot(coneOpts);
+    if(trace.sizemode === 'scaled') {
+        // unitless sizeref
+        coneOpts.coneSize = trace.sizeref || 0.5;
+    } else {
+        // sizeref here has unit of velocity
+        coneOpts.coneSize = trace.sizeref && trace._normMax ?
+            trace.sizeref / trace._normMax :
+            0.5;
+    }
 
-    // stash positions for gl-scatter3d 'hover' trace
-    meshData._pts = coneOpts.positions;
+    var meshData = conePlot(coneOpts);
 
     // pass gl-mesh3d lighting attributes
-    meshData.lightPosition = [trace.lightposition.x, trace.lightposition.y, trace.lightposition.z];
+    var lp = trace.lightposition;
+    meshData.lightPosition = [lp.x, lp.y, lp.z];
     meshData.ambient = trace.lighting.ambient;
     meshData.diffuse = trace.lighting.diffuse;
     meshData.specular = trace.lighting.specular;
@@ -109,8 +112,7 @@ function convert(scene, trace) {
     meshData.opacity = trace.opacity;
 
     // stash autorange pad value
-    trace._pad = anchor2coneSpan[trace.anchor] * meshData.vectorScale * trace.sizeref;
-    if(trace.sizemode === 'scaled') trace._pad *= trace._normMax;
+    trace._pad = anchor2coneSpan[trace.anchor] * meshData.vectorScale * meshData.coneScale * trace._normMax;
 
     return meshData;
 }
@@ -119,14 +121,10 @@ proto.update = function(data) {
     this.data = data;
 
     var meshData = convert(this.scene, data);
-
     this.mesh.update(meshData);
-    this.pts.update({position: meshData._pts});
 };
 
 proto.dispose = function() {
-    this.scene.glplot.remove(this.pts);
-    this.pts.dispose();
     this.scene.glplot.remove(this.mesh);
     this.mesh.dispose();
 };
@@ -137,21 +135,11 @@ function createConeTrace(scene, data) {
     var meshData = convert(scene, data);
     var mesh = createConeMesh(gl, meshData);
 
-    var pts = createScatterPlot({
-        gl: gl,
-        position: meshData._pts,
-        project: false,
-        opacity: 0
-    });
-
     var cone = new Cone(scene, data.uid);
     cone.mesh = mesh;
-    cone.pts = pts;
     cone.data = data;
     mesh._trace = cone;
-    pts._trace = cone;
 
-    scene.glplot.add(pts);
     scene.glplot.add(mesh);
 
     return cone;