Merge pull request #6938 from plotly/cone-sizemode-vector

Add "raw" `sizemode` to cone trace

draftlogs/6938_add.md

@@ -0,0 +1,2 @@
+ - Add "raw" sizemode to cone trace [[#6938](https://github.com/plotly/plotly.js/pull/6938)]
+

src/traces/cone/attributes.js

@@ -96,13 +96,14 @@ var attrs = {
 
     sizemode: {
         valType: 'enumerated',
-        values: ['scaled', 'absolute'],
+        values: ['scaled', 'absolute', 'raw'],
         editType: 'calc',
         dflt: 'scaled',
         description: [
             '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).'
+            '*absolute* value (in the same units as the vector field).',
+            'To display sizes in actual vector length use *raw*.'
         ].join(' ')
     },
     sizeref: {
@@ -115,7 +116,8 @@ var attrs = {
             '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 *raw*, its default value is *1*.',
+            '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(' ')

src/traces/cone/convert.js

@@ -79,15 +79,20 @@ function convert(scene, trace) {
     coneOpts.vertexIntensityBounds = [cOpts.min / trace._normMax, cOpts.max / trace._normMax];
     coneOpts.coneOffset = anchor2coneOffset[trace.anchor];
 
-    if(trace.sizemode === 'scaled') {
+
+    var sizemode = trace.sizemode;
+    if(sizemode === 'scaled') {
         // unitless sizeref
         coneOpts.coneSize = trace.sizeref || 0.5;
-    } else {
+    } else if(sizemode === 'absolute') {
         // sizeref here has unit of velocity
         coneOpts.coneSize = trace.sizeref && trace._normMax ?
             trace.sizeref / trace._normMax :
             0.5;
+    } else if(sizemode === 'raw') {
+        coneOpts.coneSize = trace.sizeref;
     }
+    coneOpts.coneSizemode = sizemode;
 
     var meshData = conePlot(coneOpts);
 

src/traces/cone/defaults.js

@@ -26,8 +26,8 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return;
     }
 
-    coerce('sizeref');
-    coerce('sizemode');
+    var sizemode = coerce('sizemode');
+    coerce('sizeref', sizemode === 'raw' ? 1 : 0.5);
 
     coerce('anchor');
 

stackgl_modules/index.js

@@ -13782,6 +13782,7 @@ module.exports = function(vectorfield, bounds) {
 	var positionVectors = [];
 	var vectorScale = Infinity;
 	var skipIt = false;
+	var rawSizemodemode = vectorfield.coneSizemode === 'raw';
 	for (var i = 0; i < positions.length; i++) {
 		var p = positions[i];
 		minX = Math.min(p[0], minX);
@@ -13795,7 +13796,7 @@ module.exports = function(vectorfield, bounds) {
 		if (vec3.length(u) > maxNorm) {
 			maxNorm = vec3.length(u);
 		}
-		if (i) {
+		if (i && !rawSizemodemode) {
 			// Find vector scale [w/ units of time] using "successive" positions
 			// (not "adjacent" with would be O(n^2)),
 			//
@@ -13834,7 +13835,9 @@ module.exports = function(vectorfield, bounds) {
 	}
 	geo.vectorScale = vectorScale;
 
-	var coneScale = vectorfield.coneSize || 0.5;
+	var coneScale = vectorfield.coneSize || (
+		rawSizemodemode ? 1 :0.5
+	);
 
 	if (vectorfield.absoluteConeSize) {
 		coneScale = vectorfield.absoluteConeSize * invertedMaxNorm;

stackgl_modules/package.json

@@ -13,7 +13,7 @@
     "box-intersect": "plotly/box-intersect#v1.1.0",
     "convex-hull": "^1.0.3",
     "delaunay-triangulate": "^1.1.6",
-    "gl-cone3d": "^1.5.2",
+    "gl-cone3d": "^1.6.0",
     "gl-error3d": "^1.0.16",
     "gl-heatmap2d": "^1.1.1",
     "gl-line3d": "1.2.1",

test/image/mocks/zz-gl3d_cone-sizemode_vector.json

@@ -0,0 +1,65 @@
+{
+  "data": [
+    {
+      "type": "cone",
+      "x": [1, 2, 3],
+      "y": [1, 2, 3],
+      "z": [1, 2, 3],
+      "u": [1, 0, 0],
+      "v": [0, 3, 0],
+      "w": [0, 0, 2],
+      "sizemode": "raw",
+      "anchor": "tip",
+      "colorbar": {
+        "title": { "text": "raw<br>sizeref: 1" },
+        "x": 0,
+        "xanchor": "right"
+      }
+    },
+    {
+      "type": "cone",
+      "x": [1, 2, 3],
+      "y": [1, 2, 3],
+      "z": [1, 2, 3],
+      "u": [0.5, 0, 0],
+      "v": [0, 1.5, 0],
+      "w": [0, 0, 1],
+      "sizemode": "raw",
+      "anchor": "tip",
+      "colorbar": {
+        "title": { "text": "rawr<br>sizeref: 1" }
+      },
+      "scene": "scene2"
+    }
+  ],
+  "layout": {
+    "scene": {
+      "domain": {"x": [0, 0.5]},
+      "aspectratio": {
+        "x": 1.5,
+        "y": 1.5,
+        "z": 1.5
+      },
+      "camera": {
+        "projection": {"type": "orthographic"},
+        "up": {"x": 0, "y": 1, "z": 0},
+        "eye": {"x": 0, "y": 0, "z": 3}
+      }
+    },
+    "scene2": {
+      "domain": {"x": [0.5, 1]},
+      "aspectratio": {
+        "x": 1.5,
+        "y": 1.5,
+        "z": 1.5
+      },
+      "camera": {
+        "projection": {"type": "orthographic"},
+        "up": {"x": 0, "y": 1, "z": 0},
+        "eye": {"x": 0, "y": 0, "z": 3}
+      }
+    },
+    "width": 1000,
+    "height": 500
+  }
+}

test/image/mocks/zz-gl3d_cone-sizemode_vector2.json

@@ -0,0 +1,67 @@
+{
+  "data": [
+    {
+      "type": "cone",
+      "x": [1, 2, 3],
+      "y": [1, 2, 3],
+      "z": [1, 2, 3],
+      "u": [1, 0, 0],
+      "v": [0, 3, 0],
+      "w": [0, 0, 2],
+      "sizemode": "raw",
+      "anchor": "tip",
+      "sizeref": 0.5,
+      "colorbar": {
+        "title": { "text": "raw<br>sizeref: 2" },
+        "x": 0,
+        "xanchor": "right"
+      }
+    },
+    {
+      "type": "cone",
+      "x": [1, 2, 3],
+      "y": [1, 2, 3],
+      "z": [1, 2, 3],
+      "u": [0.5, 0, 0],
+      "v": [0, 1.5, 0],
+      "w": [0, 0, 1],
+      "sizemode": "raw",
+      "anchor": "tip",
+      "sizeref": 2,
+      "colorbar": {
+        "title": { "text": "raw<br>sizeref: 2" }
+      },
+      "scene": "scene2"
+    }
+  ],
+  "layout": {
+    "scene": {
+      "domain": {"x": [0, 0.5]},
+      "aspectratio": {
+        "x": 1.5,
+        "y": 1.5,
+        "z": 1.5
+      },
+      "camera": {
+        "projection": {"type": "orthographic"},
+        "up": {"x": 0, "y": 1, "z": 0},
+        "eye": {"x": 0, "y": 0, "z": 3}
+      }
+    },
+    "scene2": {
+      "domain": {"x": [0.5, 1]},
+      "aspectratio": {
+        "x": 1.5,
+        "y": 1.5,
+        "z": 1.5
+      },
+      "camera": {
+        "projection": {"type": "orthographic"},
+        "up": {"x": 0, "y": 1, "z": 0},
+        "eye": {"x": 0, "y": 0, "z": 3}
+      }
+    },
+    "width": 1000,
+    "height": 500
+  }
+}