added x y contours on or between all data points of surface trace

Author: archmoj

src/traces/surface/attributes.js

@@ -43,6 +43,18 @@ function makeContourAttr(axLetter) {
                 'dimension are drawn.'
             ].join(' ')
         },
+        onpoints: {
+            valType: 'number',
+            role: 'info',
+            max: 1,
+            min: 0,
+            dflt: 0,
+            description: [
+                'Determines whether or contour lines about the', axLetter,
+                'dimension are drawn on all data points. Ratios between 0 and 1',
+                'e.g. 0.5 could also be applied to locate contours between data points'
+            ].join(' ')
+        },
         project: {
             x: makeContourProjAttr('x'),
             y: makeContourProjAttr('y'),
@@ -257,3 +269,4 @@ colorscaleAttrs('', {
 
 attrs.x.editType = attrs.y.editType = attrs.z.editType = 'calc+clearAxisTypes';
 attrs.transforms = undefined;
+delete attrs.contours.z.onpoints;

src/traces/surface/convert.js

@@ -25,11 +25,13 @@ function SurfaceTrace(scene, surface, uid) {
     this.surface = surface;
     this.data = null;
     this.showContour = [false, false, false];
+    this.onPointsContour = [false, false]; // note: only available on x & y not z.
     this.minValues = [Infinity, Infinity, Infinity];
     this.maxValues = [-Infinity, -Infinity, -Infinity];
     this.dataScaleX = 1.0;
     this.dataScaleY = 1.0;
     this.refineData = true;
+    this.objectOffset = [0, 0, 0];
 }
 
 var proto = SurfaceTrace.prototype;
@@ -347,10 +349,53 @@ proto.setContourLevels = function() {
     var nlevels = [[], [], []];
     var needsUpdate = false;
 
-    for(var i = 0; i < 3; ++i) {
+    var i, j;
+
+    for(i = 0; i < 3; ++i) {
         if(this.showContour[i]) {
             needsUpdate = true;
-            nlevels[i] = this.scene.contourLevels[i];
+
+            nlevels[i] = [];
+            for(j = 0; j < this.scene.contourLevels[i].length; j++) {
+                nlevels[i][j] = this.scene.contourLevels[i][j];
+            }
+
+            if(i < 2 && this.onPointsContour[i] !== 0) {
+
+                var ratio = this.onPointsContour[i];
+
+                var len = (i === 0) ?
+                    this.data.z[0].length :
+                    this.data._ylength;
+
+                for(var q = (ratio < 1) ? 1 : 0; q < len; q++) {
+
+                    var here = (i === 0) ?
+                        this.getXat(q, 0) * this.scene.dataScale[i] :
+                        this.getYat(0, q) * this.scene.dataScale[i];
+
+                    var value;
+                    if(ratio < 1) {
+                        var prev = (i === 0) ?
+                            this.getXat(q - 1, 0) * this.scene.dataScale[i] :
+                            this.getYat(0, q - 1) * this.scene.dataScale[i];
+
+                        value = here * ratio + prev * (1 - ratio);
+                    } else {
+                        value = here;
+                    }
+
+                    var found = false;
+                    for(j = 0; j < nlevels[i].length; j++) {
+                        if(value === nlevels[i][j]) {
+                            found = true;
+                            break;
+                        }
+                    }
+                    if(found === false) nlevels[i].push(value);
+                }
+            }
+
         }
     }
 
@@ -437,15 +482,15 @@ proto.update = function(data) {
     }
 
     for(i = 0; i < 3; i++) {
-        data._objectOffset[i] = 0.5 * (this.minValues[i] + this.maxValues[i]);
+        this.objectOffset[i] = 0.5 * (this.minValues[i] + this.maxValues[i]);
     }
 
     for(i = 0; i < 3; i++) {
         for(j = 0; j < xlen; j++) {
             for(k = 0; k < ylen; k++) {
                 v = rawCoords[i][j][k];
                 if(v !== null && v !== undefined) {
-                    rawCoords[i][j][k] -= data._objectOffset[i];
+                    rawCoords[i][j][k] -= this.objectOffset[i];
                 }
             }
         }
@@ -545,8 +590,11 @@ proto.update = function(data) {
                 surface.highlightTint[i] = params.contourTint[i] = 1;
             }
             params.contourWidth[i] = contourParams.width;
+
+            if(i < 2) this.onPointsContour[i] = contourParams.onpoints;
         } else {
             this.showContour[i] = false;
+            if(i < 2) this.onPointsContour[i] = 0;
         }
 
         if(contourParams.highlight) {
@@ -560,11 +608,7 @@ proto.update = function(data) {
         params.vertexColor = true;
     }
 
-    params.objectOffset = [
-        data._objectOffset[0],
-        data._objectOffset[1],
-        data._objectOffset[2]
-    ];
+    params.objectOffset = this.objectOffset;
 
     params.coords = coords;
     surface.update(params);

src/traces/surface/defaults.js

@@ -36,8 +36,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     traceOut._xlength = (Array.isArray(x) && Lib.isArrayOrTypedArray(x[0])) ? z.length : z[0].length;
     traceOut._ylength = z.length;
 
-    traceOut._objectOffset = [0, 0, 0];
-
     var handleCalendarDefaults = Registry.getComponentMethod('calendars', 'handleTraceDefaults');
     handleCalendarDefaults(traceIn, traceOut, ['x', 'y', 'z'], layout);
 
@@ -76,6 +74,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
             coerce(contourDim + '.color');
             coerce(contourDim + '.width');
             coerce(contourDim + '.usecolormap');
+            if(i < 2) coerce(contourDim + '.onpoints');
         }
 
         if(highlight) {

test/image/mocks/gl3d_surface_contour_on-xy-data-points.json

@@ -0,0 +1,57 @@
+{
+    "data": [
+        {
+        "type": "surface",
+        "contours": {
+            "x": { "show": true, "onpoints": 1 },
+            "y": { "show": true, "onpoints": 1 },
+            "z": { "show": false}
+        },
+        "x": [0, 0.25, 0.5, 0.75, 1],
+        "y": [0, 0.25, 0.5, 0.75, 1],
+        "z": [
+            [0, 1, 0, 1, 0],
+            [1, 0, 1, 0, 1],
+            [0, 1, 0, 1, 0],
+            [1, 0, 1, 0, 1],
+            [0, 1, 0, 1, 0]
+        ]
+        },
+        {
+            "type": "surface",
+            "contours": {
+                "x": { "show": true, "onpoints": 0.5 },
+                "y": { "show": true, "onpoints": 0.5 },
+                "z": { "show": false}
+            },
+            "x": [1.5, 1.75, 2, 2.25, 2.5],
+            "y": [0, 0.25, 0.5, 0.75, 1],
+            "z": [
+                [0, 1, 0, 1, 0],
+                [1, 0, 1, 0, 1],
+                [0, 1, 0, 1, 0],
+                [1, 0, 1, 0, 1],
+                [0, 1, 0, 1, 0]
+            ]
+        }
+    ],
+    "layout": {
+        "title": "Surface contours on or between all x & y data points",
+        "width": 900,
+        "height": 600,
+        "scene": {
+            "xaxis": { "nticks": 1 },
+            "yaxis": { "nticks": 1 },
+            "zaxis": { "nticks": 1 },
+            "camera": {
+                "eye": { "x": 0, "y": -0.9, "z": 1.8 },
+                "center": { "x": 0, "y": 0, "z": 0 }
+            },
+            "aspectratio": {
+                "x": 2,
+                "y": 1,
+                "z": 1
+            }
+        }
+    }
+}

test/jasmine/tests/surface_test.js

@@ -62,6 +62,7 @@ describe('Test surface', function() {
             expect(traceOut.contours.x).toEqual(fullOpts);
             expect(traceOut.contours.y).toEqual(Lib.extendDeep({}, fullOpts, {
                 show: true,
+                onpoints: 0,
                 color: '#444',
                 width: 2,
                 usecolormap: false