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 1 commit
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
Prev Previous commit
Next Next commit
Save camera and aspectratio only if they change before redraw the scene 
- consider aspectratio changes in modebar home and initial views
- bump gl-plot3d 2.3.0
  • Loading branch information
@archmoj
archmoj committed Oct 23, 2019
commit b92230a0b99f883dd009e89890afc7555450a7a2
5 changes: 3 additions & 2 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": "git://github.com/gl-vis/gl-plot3d.git#83e9c9406976e5ee92bf1f1851e4366e516c06f7",
"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
84 changes: 47 additions & 37 deletions src/plots/gl3d/scene.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,10 @@ function initializeGLPlot(scene, pixelRatio, canvas, gl) {
// camera updates
update[scene.id + '.camera'] = getLayoutCamera(scene.camera);

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

return update;
};
Expand All @@ -290,15 +292,12 @@ function initializeGLPlot(scene, pixelRatio, canvas, gl) {
if(gd._context._scrollZoom.gl3d) {
if(scene.glplot.camera._ortho) {
var s = (e.deltaX > e.deltaY) ? 1.1 : 1.0 / 1.1;

var aspectratio = scene.fullSceneLayout.aspectratio;

aspectratio.x = scene.glplot.aspect[0] *= s;
aspectratio.y = scene.glplot.aspect[1] *= s;
aspectratio.z = scene.glplot.aspect[2] *= s;

scene.glplot.setAspectratio(aspectratio);
scene.glplot.redraw();
var o = scene.glplot.getAspectratio();
scene.glplot.setAspectratio({
x: s * o.x,
y: s * o.y,
z: s * o.z
});
}

relayoutCallback(scene);
Expand Down Expand Up @@ -747,6 +746,15 @@ proto.plot = function(sceneData, fullLayout, layout) {
*/
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;
var size = fullLayout._size || null;
Expand Down Expand Up @@ -841,25 +849,25 @@ proto.saveLayout = function saveLayout(layout) {
var cameraNestedProp = Lib.nestedProperty(layout, this.id + '.camera');
var cameraDataLastSave = cameraNestedProp.get();


var aspectData = this.glplot.getAspectratio();
var aspectNestedProp = Lib.nestedProperty(layout, this.id + '.camera');
var aspectNestedProp = Lib.nestedProperty(layout, this.id + '.aspectratio');
var aspectDataLastSave = aspectNestedProp.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 cameraChanged = false;
if(cameraDataLastSave === undefined) {
hasChanged = true;
cameraChanged = true;
} else {
for(var i = 0; i < 3; i++) {
for(var j = 0; j < 3; j++) {
if(!same(cameraData, cameraDataLastSave, i, j)) {
hasChanged = true;
cameraChanged = true;
break;
}
}
Expand All @@ -868,37 +876,39 @@ proto.saveLayout = function saveLayout(layout) {
if(!cameraDataLastSave.projection || (
cameraData.projection &&
cameraData.projection.type !== cameraDataLastSave.projection.type)) {
hasChanged = true;
cameraChanged = true;
}
}

if(!hasChanged) {
if(aspectDataLastSave === undefined) {
hasChanged = true;
} else {
if(
aspectDataLastSave.x !== aspectData.x ||
aspectDataLastSave.y !== aspectData.y ||
aspectDataLastSave.z !== aspectData.z
) {
hasChanged = true;
}
}
}
var aspectChanged = (
aspectDataLastSave === undefined || (
aspectDataLastSave.x !== aspectData.x ||
aspectDataLastSave.y !== aspectData.y ||
aspectDataLastSave.z !== aspectData.z
));

var hasChanged = cameraChanged || aspectChanged;
if(hasChanged) {
var preGUI = {};
preGUI[this.id + '.camera'] = cameraDataLastSave;
preGUI[this.id + '.aspectratio'] = aspectDataLastSave;
if(cameraChanged) preGUI[this.id + '.camera'] = cameraDataLastSave;
if(aspectChanged) 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);
var aspectFullNP = Lib.nestedProperty(fullLayout, this.id + '.aspectratio');
aspectFullNP.set(aspectData);

this.glplot.redraw();
Copy link
Contributor

@etpinard etpinard Oct 24, 2019

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

@archmoj archmoj Oct 24, 2019

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

@etpinard etpinard Oct 24, 2019

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

@archmoj archmoj Oct 24, 2019

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

@etpinard etpinard Oct 24, 2019

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
18 changes: 0 additions & 18 deletions test/jasmine/tests/gl3d_plot_interact_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,24 +906,6 @@ describe('Test gl3d drag and wheel interactions', function() {
return scroll(sceneTarget2);
})
.then(function() {
expect(
gd._fullLayout.scene2.aspectratio.x
).toEqual(
gd._fullLayout.scene2._scene.glplot.aspect[0]
);

expect(
gd._fullLayout.scene2.aspectratio.y
).toEqual(
gd._fullLayout.scene2._scene.glplot.aspect[1]
);

expect(
gd._fullLayout.scene2.aspectratio.z
).toEqual(
gd._fullLayout.scene2._scene.glplot.aspect[2]
);

_assertAndReset(2);
})
.catch(failTest)
Expand Down