add 'contourgl' module (first pass)

Author: etpinard

lib/index.js

@@ -30,7 +30,10 @@ Core.register([
     require('./scattergeo'),
     require('./choropleth'),
     require('./scattergl'),
-    require('./scatterternary')
+    require('./scatterternary'),
+
+    // TODO remove
+    require('../src/traces/contourgl')
 ]);
 
 module.exports = Core;

package.json

@@ -52,6 +52,7 @@
     "delaunay-triangulate": "^1.1.6",
     "es6-promise": "^3.0.2",
     "fast-isnumeric": "^1.1.1",
+    "gl-contour2d": "^1.0.1",
     "gl-error2d": "^1.0.0",
     "gl-error3d": "^1.0.0",
     "gl-heatmap2d": "^1.0.2",

src/traces/contourgl/convert.js

@@ -0,0 +1,149 @@
+/**
+* Copyright 2012-2016, 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 createContour2D = require('gl-contour2d');
+var createHeatmap2D = require('gl-heatmap2d');
+
+var str2RGBArray = require('../../lib/str2rgbarray');
+var makeScaleFunc = require('../../components/colorscale/make_scale_function');
+
+
+function Contour(scene, uid) {
+    this.scene = scene;
+    this.uid = uid;
+
+    this.name = '';
+    this.hoverinfo = 'all';
+
+    this.xData = [];
+    this.yData = [];
+    this.zData = [];
+    this.textLabels = [];
+
+    this.idToIndex = [];
+    this.bounds = [0, 0, 0, 0];
+
+    this.contourOptions = {
+        z: new Float32Array(),
+        x: [],
+        y: [],
+        shape: [0, 0],
+        levels: [0],
+        levelColors: [0, 0, 0, 1],
+        lineWidth: 1
+    };
+    this.contour = createContour2D(scene.glplot, this.contourOptions);
+    this.contour._trace = this;
+
+    this.heatmapOptions = {
+        z: new Float32Array(),
+        x: [],
+        y: [],
+        shape: [0, 0],
+        colorLevels: [0],
+        colorValues: [0, 0, 0, 0]
+    };
+    this.heatmap = createHeatmap2D(scene.glplot, this.heatmapOptions);
+    this.heatmap._trace = this;
+}
+
+var proto = Contour.prototype;
+
+proto.handlePick = function(pickResult) {
+    var index = pickResult.pointId,
+        options = this.contourOptions,
+        shape = options.shape;
+
+    return {
+        trace: this,
+        dataCoord: pickResult.dataCoord,
+        traceCoord: [
+            options.x[index % shape[0]],
+            options.y[Math.floor(index / shape[0])],
+            options.z[index]
+        ],
+        textLabel: this.textLabels[index],
+        name: this.name,
+        hoverinfo: this.hoverinfo
+    };
+};
+
+proto.update = function(fullTrace, calcTrace) {
+    var calcPt = calcTrace[0];
+
+    this.name = fullTrace.name;
+    this.hoverinfo = fullTrace.hoverinfo;
+
+    // convert z from 2D -> 1D
+    var z = calcPt.z;
+    this.contourOptions.z = this.heatmapOptions.z = new Float32Array([].concat.apply([], z));
+
+    var rowLen = z[0].length,
+        colLen = z.length;
+    this.contourOptions.shape = this.heatmapOptions.shape = [rowLen, colLen];
+
+    this.contourOptions.x = this.heatmapOptions.x = calcPt.x;
+    this.contourOptions.y = this.heatmapOptions.y = calcPt.y;
+
+    var colorOptions = convertColorscale(fullTrace);
+    this.contourOptions.levels = colorOptions.levels;
+    this.contourOptions.levelColors = colorOptions.levelColors;
+
+    // convert text from 2D -> 1D
+    this.textLabels = [].concat.apply([], fullTrace.text);
+
+    this.contour.update(this.contourOptions);
+    this.heatmap.update(this.heatmapOptions);
+};
+
+proto.dispose = function() {
+    this.contour.dispose();
+    this.heatmap.dispose();
+};
+
+function convertColorscale(fullTrace) {
+    var contours = fullTrace.contours,
+        start = contours.start,
+        end = contours.end,
+        size = contours.size;
+
+    var sclFunc = makeScaleFunc(
+        fullTrace.colorscale,
+        fullTrace.zmin, fullTrace.zmax
+    );
+
+    var N = Math.floor((end - start) / size),
+        levels = new Array(N),
+        levelColors = new Array(4 * N);
+
+    for(var i = 0; i < N; i++) {
+        var level = levels[i] = start + size * i;
+        var color = str2RGBArray(sclFunc(level));
+
+        for(var j = 0; j < 4; j++) {
+            levelColors[(4 * i) + j] = color[j];
+        }
+    }
+
+    return {
+        levels: levels,
+        levelColors: levelColors
+    };
+}
+
+function createContour(scene, fullTrace, calcTrace) {
+    var plot = new Contour(scene, fullTrace.uid);
+    plot.update(fullTrace, calcTrace);
+
+    return plot;
+}
+
+module.exports = createContour;

src/traces/contourgl/index.js

@@ -0,0 +1,31 @@
+/**
+* Copyright 2012-2016, 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 ContourGl = {};
+
+ContourGl.attributes = require('../contour/attributes');
+ContourGl.supplyDefaults = require('../contour/defaults');
+ContourGl.colorbar = require('../contour/colorbar');
+
+ContourGl.calc = require('../contour/calc');
+ContourGl.plot = require('./convert');
+
+ContourGl.moduleType = 'trace';
+ContourGl.name = 'contourgl';
+ContourGl.basePlotModule = require('../../plots/gl2d');
+ContourGl.categories = ['gl2d', '2dMap'];
+ContourGl.meta = {
+    description: [
+        'WebGL contour (beta)'
+    ].join(' ')
+};
+
+module.exports = ContourGl;