Skip to content

Keep orthographic zoom scales in fullLayout #4292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 25, 2019
Merged

Keep orthographic zoom scales in fullLayout #4292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4a649f0
record glplot aspect in fullLayout aspectratio
archmoj Oct 21, 2019
fe19e47
Store direct aspectratio edits and emit relayout
archmoj Oct 23, 2019
b92230a
Save camera and aspectratio only if they change before redraw the scene
archmoj Oct 23, 2019
d825c0e
improve relayout update object - now depends on changed parameter
archmoj Oct 24, 2019
d486dcd
correct initializeGLPlot argument
archmoj Oct 24, 2019
496059c
simplify gl3d pixelRatio pass
archmoj Oct 24, 2019
e4a30be
add new tests to cover both orthographic and perspective cases
archmoj Oct 24, 2019
3b28fae
add few more tests to lock down the orthographic relayout issue
archmoj Oct 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
"gl-mat4": "^1.2.0",
"gl-mesh3d": "^2.1.1",
"gl-plot2d": "^1.4.2",
"gl-plot3d": "^2.2.2",
"gl-plot3d": "^2.3.0",
"gl-pointcloud2d": "^1.0.2",
"gl-scatter3d": "^1.2.2",
"gl-select-box": "^1.0.3",
Expand Down
24 changes: 17 additions & 7 deletions src/components/modebar/buttons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,17 +344,27 @@ function handleCamera3d(gd, ev) {

for(var i = 0; i < sceneIds.length; i++) {
var sceneId = sceneIds[i];
var key = sceneId + '.camera';
var camera = sceneId + '.camera';
var aspectratio = sceneId + '.aspectratio';
var scene = fullLayout[sceneId]._scene;
var didUpdate;

if(attr === 'resetLastSave') {
aobj[key + '.up'] = scene.viewInitial.up;
aobj[key + '.eye'] = scene.viewInitial.eye;
aobj[key + '.center'] = scene.viewInitial.center;
aobj[camera + '.up'] = scene.viewInitial.up;
aobj[camera + '.eye'] = scene.viewInitial.eye;
aobj[camera + '.center'] = scene.viewInitial.center;
didUpdate = true;
} else if(attr === 'resetDefault') {
aobj[key + '.up'] = null;
aobj[key + '.eye'] = null;
aobj[key + '.center'] = null;
aobj[camera + '.up'] = null;
aobj[camera + '.eye'] = null;
aobj[camera + '.center'] = null;
didUpdate = true;
}

if(didUpdate) {
aobj[aspectratio + '.x'] = scene.viewInitial.aspectratio.x;
aobj[aspectratio + '.y'] = scene.viewInitial.aspectratio.y;
aobj[aspectratio + '.z'] = scene.viewInitial.aspectratio.z;
}
}

Expand Down
3 changes: 1 addition & 2 deletions src/plot_api/subroutines.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,8 +578,7 @@ exports.doCamera = function(gd) {
var sceneLayout = fullLayout[sceneIds[i]];
var scene = sceneLayout._scene;

var cameraData = sceneLayout.camera;
scene.setCamera(cameraData);
scene.setViewport(sceneLayout);
}
};

Expand Down
169 changes: 129 additions & 40 deletions src/plots/gl3d/scene.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@

'use strict';

var createCamera = require('gl-plot3d').createCamera;
var createPlot = require('gl-plot3d').createScene;
var glPlot3d = require('gl-plot3d');
var createCamera = glPlot3d.createCamera;
var createPlot = glPlot3d.createScene;

var getContext = require('webgl-context');
var passiveSupported = require('has-passive-events');

Expand Down Expand Up @@ -246,10 +248,10 @@ function tryCreatePlot(scene, cameraObject, pixelRatio, canvas, gl) {
return failed < 2;
}

function initializeGLPlot(scene, pixelRatio, canvas, gl) {
function initializeGLPlot(scene, canvas, gl) {
scene.initializeGLCamera();

var success = tryCreatePlot(scene, scene.camera, pixelRatio, canvas, gl);
var success = tryCreatePlot(scene, scene.camera, scene.pixelRatio, canvas, gl);
/*
* createPlot will throw when webgl is not enabled in the client.
* Lets return an instance of the module with all functions noop'd.
Expand All @@ -259,22 +261,48 @@ function initializeGLPlot(scene, pixelRatio, canvas, gl) {
if(!success) return showNoWebGlMsg(scene);

var gd = scene.graphDiv;
var layout = gd.layout;

var makeUpdate = function() {
var update = {};

if(scene.isCameraChanged(layout)) {
// camera updates
update[scene.id + '.camera'] = scene.getCamera();
}

if(scene.isAspectChanged(layout)) {
// scene updates
update[scene.id + '.aspectratio'] = scene.glplot.getAspectratio();
}

return update;
};

var relayoutCallback = function(scene) {
if(scene.fullSceneLayout.dragmode === false) return;

var update = {};
update[scene.id + '.camera'] = getLayoutCamera(scene.camera);
scene.saveCamera(gd.layout);
var update = makeUpdate();
scene.saveLayout(layout);
scene.graphDiv.emit('plotly_relayout', update);
};

scene.glplot.canvas.addEventListener('mouseup', function() {
relayoutCallback(scene);
});

scene.glplot.canvas.addEventListener('wheel', function() {
scene.glplot.canvas.addEventListener('wheel', function(e) {
if(gd._context._scrollZoom.gl3d) {
if(scene.glplot.camera._ortho) {
var s = (e.deltaX > e.deltaY) ? 1.1 : 1.0 / 1.1;
var o = scene.glplot.getAspectratio();
scene.glplot.setAspectratio({
x: s * o.x,
y: s * o.y,
z: s * o.z
});
}

relayoutCallback(scene);
}
}, passiveSupported ? {passive: false} : false);
Expand All @@ -283,8 +311,7 @@ function initializeGLPlot(scene, pixelRatio, canvas, gl) {
if(scene.fullSceneLayout.dragmode === false) return;
if(scene.camera.mouseListener.buttons === 0) return;

var update = {};
update[scene.id + '.camera'] = getLayoutCamera(scene.camera);
var update = makeUpdate();
scene.graphDiv.emit('plotly_relayouting', update);
});

Expand Down Expand Up @@ -366,7 +393,7 @@ function Scene(options, fullLayout) {
this.convertAnnotations = Registry.getComponentMethod('annotations3d', 'convert');
this.drawAnnotations = Registry.getComponentMethod('annotations3d', 'draw');

initializeGLPlot(this, this.pixelRatio);
initializeGLPlot(this);
}

var proto = Scene.prototype;
Expand All @@ -390,16 +417,15 @@ proto.recoverContext = function() {
var scene = this;
var gl = this.glplot.gl;
var canvas = this.glplot.canvas;
var camera = this.glplot.camera;
var pixelRatio = this.glplot.pixelRatio;

this.glplot.dispose();

function tryRecover() {
if(gl.isContextLost()) {
requestAnimationFrame(tryRecover);
return;
}
if(!initializeGLPlot(scene, camera, pixelRatio, canvas, gl)) {
if(!initializeGLPlot(scene, canvas, gl)) {
Lib.error('Catastrophic and unrecoverable WebGL error. Context lost.');
return;
}
Expand Down Expand Up @@ -496,7 +522,7 @@ proto.plot = function(sceneData, fullLayout, layout) {
this.spikeOptions.merge(fullSceneLayout);

// Update camera and camera mode
this.setCamera(fullSceneLayout.camera);
this.setViewport(fullSceneLayout);
this.updateFx(fullSceneLayout.dragmode, fullSceneLayout.hovermode);
this.camera.enableWheel = this.graphDiv._context._scrollZoom.gl3d;

Expand Down Expand Up @@ -720,8 +746,16 @@ proto.plot = function(sceneData, fullLayout, layout) {
* Finally assign the computed aspecratio to the glplot module. This will have an effect
* on the next render cycle.
*/
this.glplot.aspect = aspectRatio;

this.glplot.setAspectratio(fullSceneLayout.aspectratio);

// save 'initial' camera view settings for modebar button
if(!this.viewInitial.aspectratio) {
this.viewInitial.aspectratio = {
x: fullSceneLayout.aspectratio.x,
y: fullSceneLayout.aspectratio.y,
z: fullSceneLayout.aspectratio.z
};
}

// Update frame position for multi plots
var domain = fullSceneLayout.domain || null;
Expand Down Expand Up @@ -751,18 +785,18 @@ proto.destroy = function() {
this.glplot = null;
};

// getOrbitCamera :: plotly_coords -> orbit_camera_coords
// getCameraArrays :: plotly_coords -> gl-plot3d_coords
// inverse of getLayoutCamera
function getOrbitCamera(camera) {
function getCameraArrays(camera) {
return [
[camera.eye.x, camera.eye.y, camera.eye.z],
[camera.center.x, camera.center.y, camera.center.z],
[camera.up.x, camera.up.y, camera.up.z]
];
}

// getLayoutCamera :: orbit_camera_coords -> plotly_coords
// inverse of getOrbitCamera
// getLayoutCamera :: gl-plot3d_coords -> plotly_coords
// inverse of getCameraArrays
function getLayoutCamera(camera) {
return {
up: {x: camera.up[0], y: camera.up[1], z: camera.up[2]},
Expand All @@ -772,24 +806,25 @@ function getLayoutCamera(camera) {
};
}

// get camera position in plotly coords from 'orbit-camera' coords
proto.getCamera = function getCamera() {
// get camera position in plotly coords from 'gl-plot3d' coords
proto.getCamera = function() {
this.glplot.camera.view.recalcMatrix(this.camera.view.lastT());
return getLayoutCamera(this.glplot.camera);
};

// set camera position with a set of plotly coords
proto.setCamera = function setCamera(cameraData) {
this.glplot.camera.lookAt.apply(this, getOrbitCamera(cameraData));
// set gl-plot3d camera position and scene aspects with a set of plotly coords
proto.setViewport = function(sceneLayout) {
var cameraData = sceneLayout.camera;

this.glplot.camera.lookAt.apply(this, getCameraArrays(cameraData));
this.glplot.setAspectratio(sceneLayout.aspectratio);

var newOrtho = (cameraData.projection.type === 'orthographic');
var oldOrtho = this.glplot.camera._ortho;

if(newOrtho !== oldOrtho) {
this.glplot.redraw();

var pixelRatio = this.glplot.pixelRatio;

var RGBA = this.glplot.clearColor;
this.glplot.gl.clearColor(
RGBA[0], RGBA[1], RGBA[2], RGBA[3]
Expand All @@ -801,32 +836,30 @@ proto.setCamera = function setCamera(cameraData) {

this.glplot.dispose();

initializeGLPlot(this, pixelRatio);
initializeGLPlot(this);
this.glplot.camera._ortho = newOrtho;
}
};

// save camera to user layout (i.e. gd.layout)
proto.saveCamera = function saveCamera(layout) {
var fullLayout = this.fullLayout;
proto.isCameraChanged = function(layout) {
var cameraData = this.getCamera();
var cameraNestedProp = Lib.nestedProperty(layout, this.id + '.camera');
var cameraDataLastSave = cameraNestedProp.get();
var hasChanged = false;

function same(x, y, i, j) {
var vectors = ['up', 'center', 'eye'];
var components = ['x', 'y', 'z'];
return y[vectors[i]] && (x[vectors[i]][components[j]] === y[vectors[i]][components[j]]);
}

var changed = false;
if(cameraDataLastSave === undefined) {
hasChanged = true;
changed = true;
} else {
for(var i = 0; i < 3; i++) {
for(var j = 0; j < 3; j++) {
if(!same(cameraData, cameraDataLastSave, i, j)) {
hasChanged = true;
changed = true;
break;
}
}
Expand All @@ -835,19 +868,75 @@ proto.saveCamera = function saveCamera(layout) {
if(!cameraDataLastSave.projection || (
cameraData.projection &&
cameraData.projection.type !== cameraDataLastSave.projection.type)) {
hasChanged = true;
changed = true;
}
}

return changed;
};

proto.isAspectChanged = function(layout) {
var aspectData = this.glplot.getAspectratio();
var aspectNestedProp = Lib.nestedProperty(layout, this.id + '.aspectratio');
var aspectDataLastSave = aspectNestedProp.get();

return (
aspectDataLastSave === undefined || (
aspectDataLastSave.x !== aspectData.x ||
aspectDataLastSave.y !== aspectData.y ||
aspectDataLastSave.z !== aspectData.z
));
};

// save camera to user layout (i.e. gd.layout)
proto.saveLayout = function(layout) {
var fullLayout = this.fullLayout;

var cameraData;
var cameraNestedProp;
var cameraDataLastSave;

var aspectData;
var aspectNestedProp;
var aspectDataLastSave;

var cameraChanged = this.isCameraChanged(layout);
var aspectChanged = this.isAspectChanged(layout);

var hasChanged = cameraChanged || aspectChanged;
if(hasChanged) {
var preGUI = {};
preGUI[this.id + '.camera'] = cameraDataLastSave;
if(cameraChanged) {
cameraData = this.getCamera();
cameraNestedProp = Lib.nestedProperty(layout, this.id + '.camera');
cameraDataLastSave = cameraNestedProp.get();

preGUI[this.id + '.camera'] = cameraDataLastSave;
}
if(aspectChanged) {
aspectData = this.glplot.getAspectratio();
aspectNestedProp = Lib.nestedProperty(layout, this.id + '.aspectratio');
aspectDataLastSave = aspectNestedProp.get();

preGUI[this.id + '.aspectratio'] = aspectDataLastSave;
}
Registry.call('_storeDirectGUIEdit', layout, fullLayout._preGUI, preGUI);

cameraNestedProp.set(cameraData);
if(cameraChanged) {
cameraNestedProp.set(cameraData);

var cameraFullNP = Lib.nestedProperty(fullLayout, this.id + '.camera');
cameraFullNP.set(cameraData);
var cameraFullNP = Lib.nestedProperty(fullLayout, this.id + '.camera');
cameraFullNP.set(cameraData);
}

if(aspectChanged) {
aspectNestedProp.set(aspectData);

var aspectFullNP = Lib.nestedProperty(fullLayout, this.id + '.aspectratio');
aspectFullNP.set(aspectData);

this.glplot.redraw();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, why do we need to redraw here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We used to redraw in scene wheel listener after updating gl-plot3d.aspect which is now moved to here so that we record the new before update.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess that's ok, it's just feels a little odd to me that a method called saveLayout ends up redrawing things in some cases.

Non-blocking.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could possibly make gl3d/scene.js file more readable at one point.
I keep this in mind when we have time to refactor it in another PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I keep this in mind when we have time to refactor it in another PR.

Awesome. Thank you very much cleaning up this code!!

}
}

return hasChanged;
Expand Down
Loading