Merge pull request #3488 from plotly/volume4d

Volume - new gl3d trace

Author: archmoj

Diff for: lib/index-gl3d.js

@@ -14,6 +14,8 @@ Plotly.register([
     require('./scatter3d'),
     require('./surface'),
     require('./mesh3d'),
+    require('./isosurface'),
+    require('./volume'),
     require('./cone'),
     require('./streamtube')
 ]);

Diff for: lib/index.js

@@ -29,6 +29,7 @@ Plotly.register([
     require('./scatter3d'),
     require('./surface'),
     require('./isosurface'),
+    require('./volume'),
     require('./mesh3d'),
     require('./cone'),
     require('./streamtube'),

Diff for: lib/volume.js

@@ -0,0 +1,11 @@
+/**
+* Copyright 2012-2019, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+module.exports = require('../src/traces/volume');

Diff for: package-lock.json

@@ -78,7 +78,7 @@
     "gl-heatmap2d": "^1.0.5",
     "gl-line3d": "^1.1.11",
     "gl-mat4": "^1.2.0",
-    "gl-mesh3d": "^2.0.10",
+    "gl-mesh3d": "^2.1.0",
     "gl-plot2d": "^1.4.2",
     "gl-plot3d": "^2.2.1",
     "gl-pointcloud2d": "^1.0.2",

Diff for: package.json

@@ -12,7 +12,7 @@ var isNumeric = require('fast-isnumeric');
 var tinycolor = require('tinycolor2');
 
 var baseTraceAttrs = require('../plots/attributes');
-var scales = require('../components/colorscale/scales');
+var colorscales = require('../components/colorscale/scales');
 var DESELECTDIM = require('../constants/interactions').DESELECTDIM;
 
 var nestedProperty = require('./nested_property');
@@ -164,7 +164,7 @@ exports.valObjectMeta = {
     colorscale: {
         description: [
             'A Plotly colorscale either picked by a name:',
-            '(any of', Object.keys(scales.scales).join(', '), ')',
+            '(any of', Object.keys(colorscales.scales).join(', '), ')',
             'customized as an {array} of 2-element {arrays} where',
             'the first element is the normalized color level value',
             '(starting at *0* and ending at *1*),',
@@ -173,7 +173,7 @@ exports.valObjectMeta = {
         requiredOpts: [],
         otherOpts: ['dflt'],
         coerceFunction: function(v, propOut, dflt) {
-            propOut.set(scales.get(v, dflt));
+            propOut.set(colorscales.get(v, dflt));
         }
     },
     angle: {

Diff for: src/lib/coerce.js

@@ -123,7 +123,7 @@ function render(scene) {
                 vectorTx.push(selection.textLabel);
             }
             tx = vectorTx.join('<br>');
-        } else if(trace.type === 'isosurface') {
+        } else if(trace.type === 'isosurface' || trace.type === 'volume') {
             labels.valueLabel = Axes.tickText(scene.mockAxis, scene.mockAxis.d2l(selection.traceCoordinate[3]), 'hover').text;
             vectorTx.push('value: ' + labels.valueLabel);
             if(selection.textLabel) {

Diff for: src/plots/gl3d/scene.js

@@ -20,18 +20,7 @@ function distinctVals(col) {
     return Lib.distinctVals(col).vals;
 }
 
-function IsosurfaceTrace(scene, mesh, uid) {
-    this.scene = scene;
-    this.uid = uid;
-    this.mesh = mesh;
-    this.name = '';
-    this.data = null;
-    this.showContour = false;
-}
-
-var proto = IsosurfaceTrace.prototype;
-
-function findNearestOnAxis(w, arr) {
+var findNearestOnAxis = function(w, arr) {
     for(var q = arr.length - 1; q > 0; q--) {
         var min = Math.min(arr[q], arr[q - 1]);
         var max = Math.max(arr[q], arr[q - 1]);
@@ -46,8 +35,19 @@ function findNearestOnAxis(w, arr) {
         id: 0,
         distRatio: 0
     };
+};
+
+function IsosurfaceTrace(scene, mesh, uid) {
+    this.scene = scene;
+    this.uid = uid;
+    this.mesh = mesh;
+    this.name = '';
+    this.data = null;
+    this.showContour = false;
 }
 
+var proto = IsosurfaceTrace.prototype;
+
 proto.handlePick = function(selection) {
     if(selection.object === this.mesh) {
         var rawId = selection.data.index;
@@ -87,7 +87,7 @@ proto.update = function(data) {
     var scene = this.scene;
     var layout = scene.fullSceneLayout;
 
-    this.data = generateIsosurfaceMesh(data);
+    this.data = generateIsoMeshes(data);
 
     // Unpack position data
     function toDataCoords(axis, coord, scale, calendar) {
@@ -134,7 +134,7 @@ proto.dispose = function() {
     this.mesh.dispose();
 };
 
-function generateIsosurfaceMesh(data) {
+function generateIsoMeshes(data) {
     data._i = [];
     data._j = [];
     data._k = [];
@@ -1035,4 +1035,8 @@ function createIsosurfaceTrace(scene, data) {
     return result;
 }
 
-module.exports = createIsosurfaceTrace;
+module.exports = {
+    findNearestOnAxis: findNearestOnAxis,
+    generateIsoMeshes: generateIsoMeshes,
+    createIsosurfaceTrace: createIsosurfaceTrace,
+};

Diff for: src/traces/isosurface/convert.js

@@ -8,16 +8,20 @@
 
 'use strict';
 
-var Registry = require('../../registry');
 var Lib = require('../../lib');
-var colorscaleDefaults = require('../../components/colorscale/defaults');
+var Registry = require('../../registry');
 var attributes = require('./attributes');
+var colorscaleDefaults = require('../../components/colorscale/defaults');
 
-module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
+function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     function coerce(attr, dflt) {
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
+    supplyIsoDefaults(traceIn, traceOut, defaultColor, layout, coerce);
+}
+
+function supplyIsoDefaults(traceIn, traceOut, defaultColor, layout, coerce) {
     var isomin = coerce('isomin');
     var isomax = coerce('isomax');
 
@@ -103,4 +107,9 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     // disable 1D transforms (for now)
     traceOut._length = null;
+}
+
+module.exports = {
+    supplyDefaults: supplyDefaults,
+    supplyIsoDefaults: supplyIsoDefaults
 };

Diff for: src/traces/isosurface/defaults.js

@@ -12,13 +12,13 @@
 var Isosurface = {};
 
 Isosurface.attributes = require('./attributes');
-Isosurface.supplyDefaults = require('./defaults');
+Isosurface.supplyDefaults = require('./defaults').supplyDefaults;
 Isosurface.calc = require('./calc');
 Isosurface.colorbar = {
     min: 'cmin',
     max: 'cmax'
 };
-Isosurface.plot = require('./convert');
+Isosurface.plot = require('./convert').createIsosurfaceTrace;
 
 Isosurface.moduleType = 'trace';
 Isosurface.name = 'isosurface',

Diff for: src/traces/isosurface/index.js

@@ -0,0 +1,93 @@
+/**
+* Copyright 2012-2019, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var colorscaleAttrs = require('../../components/colorscale/attributes');
+var isosurfaceAttrs = require('../isosurface/attributes');
+var baseAttrs = require('../../plots/attributes');
+
+var extendFlat = require('../../lib/extend').extendFlat;
+var overrideAll = require('../../plot_api/edit_types').overrideAll;
+
+var attrs = module.exports = overrideAll(extendFlat({
+    x: isosurfaceAttrs.x,
+    y: isosurfaceAttrs.y,
+    z: isosurfaceAttrs.z,
+    value: isosurfaceAttrs.value,
+    isomin: isosurfaceAttrs.isomin,
+    isomax: isosurfaceAttrs.isomax,
+    surface: isosurfaceAttrs.surface,
+    spaceframe: {
+        show: {
+            valType: 'boolean',
+            role: 'info',
+            dflt: false,
+            description: [
+                'Displays/hides tetrahedron shapes between minimum and',
+                'maximum iso-values. Often useful when either caps or',
+                'surfaces are disabled or filled with values less than 1.'
+            ].join(' ')
+        },
+        fill: {
+            valType: 'number',
+            role: 'style',
+            min: 0,
+            max: 1,
+            dflt: 1,
+            description: [
+                'Sets the fill ratio of the `spaceframe` elements. The default fill value',
+                'is 1 meaning that they are entirely shaded. Applying a `fill` ratio less',
+                'than one would allow the creation of openings parallel to the edges.'
+            ].join(' ')
+        }
+    },
+
+    slices: isosurfaceAttrs.slices,
+    caps: isosurfaceAttrs.caps,
+    text: isosurfaceAttrs.text,
+    hovertext: isosurfaceAttrs.hovertext,
+    hovertemplate: isosurfaceAttrs.hovertemplate
+},
+
+colorscaleAttrs('', {
+    colorAttr: '`value`',
+    showScaleDflt: true,
+    editTypeOverride: 'calc'
+}), {
+
+    colorbar: isosurfaceAttrs.colorbar,
+    opacity: isosurfaceAttrs.opacity,
+    opacityscale: {
+        valType: 'any',
+        role: 'style',
+        editType: 'calc',
+        description: [
+            'Sets the opacityscale.',
+            ' The opacityscale must be an array containing',
+            ' arrays mapping a normalized value to an opacity value.',
+            ' At minimum, a mapping for the lowest (0) and highest (1)',
+            ' values are required. For example,',
+            ' `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower values would have',
+            ' higher opacity values and those in the middle would be more transparent',
+            ' Alternatively, `opacityscale` may be a palette name string',
+            ' of the following list: \'min\', \'max\', \'extremes\' and \'uniform\'.',
+            ' The default is \'uniform\'.'
+        ].join('')
+    },
+
+    lightposition: isosurfaceAttrs.lightposition,
+    lighting: isosurfaceAttrs.lighting,
+    flatshading: isosurfaceAttrs.flatshading,
+    contour: isosurfaceAttrs.contour,
+
+    hoverinfo: extendFlat({}, baseAttrs.hoverinfo)
+}), 'calc', 'nested');
+
+attrs.x.editType = attrs.y.editType = attrs.z.editType = attrs.value.editType = 'calc+clearAxisTypes';
+attrs.transforms = undefined;