3D cone traces

lib/cone.js

@@ -0,0 +1,11 @@
+/**
+* Copyright 2012-2018, 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/cone');

lib/index-gl3d.js

@@ -13,7 +13,8 @@ var Plotly = require('./core');
 Plotly.register([
     require('./scatter3d'),
     require('./surface'),
-    require('./mesh3d')
+    require('./mesh3d'),
+    require('./cone')
 ]);
 
 module.exports = Plotly;

lib/index.js

@@ -26,6 +26,7 @@ Plotly.register([
     require('./scatter3d'),
     require('./surface'),
     require('./mesh3d'),
+    require('./cone'),
 
     require('./scattergeo'),
     require('./choropleth'),

package.json

@@ -70,6 +70,7 @@
     "es6-promise": "^3.0.2",
     "fast-isnumeric": "^1.1.1",
     "font-atlas-sdf": "^1.3.3",
+    "gl-cone3d": "[email protected]:gl-vis/gl-cone3d#c675b25e5991e63d0ad23ed24d712c496c28cd72",
     "gl-contour2d": "^1.1.4",
     "gl-error3d": "^1.0.7",
     "gl-heatmap2d": "^1.0.4",

src/lib/gl_format_color.js

@@ -10,6 +10,7 @@
 'use strict';
 
 var isNumeric = require('fast-isnumeric');
+var tinycolor = require('tinycolor2');
 var rgba = require('color-normalize');
 
 var Colorscale = require('../components/colorscale');
@@ -85,4 +86,21 @@ function formatColor(containerIn, opacityIn, len) {
     return colorOut;
 }
 
-module.exports = formatColor;
+function parseColorScale(colorscale, alpha) {
+    if(alpha === undefined) alpha = 1;
+
+    return colorscale.map(function(elem) {
+        var index = elem[0];
+        var color = tinycolor(elem[1]);
+        var rgb = color.toRgb();
+        return {
+            index: index,
+            rgb: [rgb.r, rgb.g, rgb.b, alpha]
+        };
+    });
+}
+
+module.exports = {
+    formatColor: formatColor,
+    parseColorScale: parseColorScale
+};

src/traces/cone/attributes.js

@@ -0,0 +1,134 @@
+/**
+* Copyright 2012-2018, 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 colorAttrs = require('../../components/colorscale/color_attributes');
+var colorscaleAttrs = require('../../components/colorscale/attributes');
+var colorbarAttrs = require('../../components/colorbar/attributes');
+var mesh3dAttrs = require('../mesh3d/attributes');
+var baseAttrs = require('../../plots/attributes');
+
+var extendFlat = require('../../lib/extend').extendFlat;
+
+var attrs = {
+    x: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: [
+            'Sets the x positions of the cones.',
+            'When `vx`, `vy`, `vz` are not set,',
+            ' these are also the x coordinates of the u/v/w vector field.'
+        ].join(' ')
+    },
+    y: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: [
+            'Sets the y positions of the cones.',
+            'When `vx`, `vy`, `vz` are not set,',
+            ' these are also the y coordinates of the u/v/w vector field.'
+        ].join(' ')
+    },
+    z: {
+        valType: 'data_array',
+        role: 'info',
+        editType: 'calc+clearAxisTypes',
+        description: [
+            'Sets the z positions of the cones.',
+            'When `vx`, `vy`, `vz` are not set,',
+            ' these are also the z coordinates of the u/v/w vector field.'
+        ].join(' ')
+    },
+
+    u: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Sets the x components of the vector field.'
+    },
+    v: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Sets the y components of the vector field.'
+    },
+    w: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Sets the z components of the vector field.'
+    },
+
+    vx: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Sets the x coordinates of the vector field mesh.'
+    },
+    vy: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Sets the y coordinates of the vector field mesh.'
+    },
+    vz: {
+        valType: 'data_array',
+        editType: 'calc',
+        description: 'Sets the z coordinates of the vector field mesh.'
+    },
+
+    sizemode: {
+        valType: 'enumerated',
+        values: ['scaled', 'absolute'],
+        role: 'info',
+        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.'
+        ].join(' ')
+    },
+    sizeref: {
+        valType: 'number',
+        role: 'info',
+        editType: 'calc',
+        min: 0,
+        dflt: 1,
+        description: 'Sets the cone size reference value.'
+    },
+
+    text: {
+        valType: 'string',
+        role: 'info',
+        dflt: '',
+        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', true), {
+    showscale: colorscaleAttrs.showscale,
+    colorbar: colorbarAttrs
+});
+delete attrs.color;
+
+var fromMesh3d = ['opacity', 'flatshading', 'lightposition', 'lighting'];
+
+fromMesh3d.forEach(function(k) {
+    attrs[k] = mesh3dAttrs[k];
+});
+
+attrs.hoverinfo = extendFlat({}, baseAttrs.hoverinfo, {editType: 'calc'});
+
+module.exports = attrs;

src/traces/cone/calc.js

@@ -0,0 +1,25 @@
+/**
+* Copyright 2012-2018, 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 cone2mesh = require('./helpers').cone2mesh;
+var colorscaleCalc = require('../../components/colorscale/calc');
+
+module.exports = function calc(gd, trace) {
+    var fullLayout = gd._fullLayout;
+
+    // TODO skip when 'cmin' and 'cmax' are set
+    // TODO find way to "merge" this cone2mesh call with the one in convert.js
+    //
+    // TODO should show in absolute or normalize length?
+
+    var meshData = cone2mesh(trace, fullLayout[trace.scene]);
+
+    colorscaleCalc(trace, meshData.vertexIntensity, '', 'c');
+};

src/traces/cone/colorbar.js

@@ -0,0 +1,37 @@
+/**
+* Copyright 2012-2018, 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 Plots = require('../../plots/plots');
+var Colorscale = require('../../components/colorscale');
+var drawColorbar = require('../../components/colorbar/draw');
+
+module.exports = function colorbar(gd, cd) {
+    var trace = cd[0].trace;
+    var cbId = 'cb' + trace.uid;
+    var cmin = trace.cmin;
+    var cmax = trace.cmax;
+
+    gd._fullLayout._infolayer.selectAll('.' + cbId).remove();
+
+    if(!trace.showscale) {
+        Plots.autoMargin(gd, cbId);
+        return;
+    }
+
+    var cb = cd[0].t.cb = drawColorbar(gd, cbId);
+    var sclFunc = Colorscale.makeColorScaleFunc(
+        Colorscale.extractScale(trace.colorscale, cmin, cmax),
+        {noNumericCheck: true}
+    );
+
+    cb.fillcolor(sclFunc)
+        .filllevels({start: cmin, end: cmax, size: (cmax - cmin) / 254})
+        .options(trace.colorbar)();
+};

src/traces/cone/convert.js

@@ -0,0 +1,92 @@
+/**
+* Copyright 2012-2018, 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 createScatterPlot = require('gl-scatter3d');
+var createConeMesh = require('gl-cone3d').createConeMesh;
+var cone2mesh = require('./helpers').cone2mesh;
+
+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) {
+        var selectIndex = selection.index = selection.data.index;
+
+        selection.traceCoordinate = [
+            this.data.x[selectIndex],
+            this.data.y[selectIndex],
+            this.data.z[selectIndex]
+        ];
+
+        var text = this.data.text;
+        if(Array.isArray(text) && text[selectIndex] !== undefined) {
+            selection.textLabel = text[selectIndex];
+        } else if(text) {
+            selection.textLabel = text;
+        }
+
+        return true;
+    }
+};
+
+function convert(scene, trace) {
+    return cone2mesh(trace, scene.fullSceneLayout, scene.dataScale);
+}
+
+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();
+};
+
+function createConeTrace(scene, data) {
+    var gl = scene.glplot.gl;
+
+    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;
+}
+
+module.exports = createConeTrace;