Skip to content
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.

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

[BUG]: Shift box_aspect according to vertical_axis #28041

Merged
merged 19 commits into from
Jun 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 18 additions & 4 deletions lib/mpl_toolkits/mplot3d/axes3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ def set_box_aspect(self, aspect, *, zoom=1):
# of the axes in mpl3.8.
aspect *= 1.8294640721620434 * 25/24 * zoom / np.linalg.norm(aspect)

self._box_aspect = aspect
self._box_aspect = self._roll_to_vertical(aspect, reverse=True)
self.stale = True

def apply_aspect(self, position=None):
Expand Down Expand Up @@ -1191,9 +1191,23 @@ def set_proj_type(self, proj_type, focal_length=None):
f"None for proj_type = {proj_type}")
self._focal_length = np.inf

def _roll_to_vertical(self, arr):
"""Roll arrays to match the different vertical axis."""
return np.roll(arr, self._vertical_axis - 2)
def _roll_to_vertical(
self, arr: "np.typing.ArrayLike", reverse: bool = False
) -> np.ndarray:
"""
Roll arrays to match the different vertical axis.

Parameters
----------
arr : ArrayLike
Array to roll.
reverse : bool, default: False
Reverse the direction of the roll.
"""
if reverse:
return np.roll(arr, (self._vertical_axis - 2) * -1)
else:
return np.roll(arr, (self._vertical_axis - 2))

def get_proj(self):
"""Create the projection matrix from the current viewing position."""
Expand Down
18 changes: 18 additions & 0 deletions lib/mpl_toolkits/mplot3d/tests/test_axes3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -2276,6 +2276,24 @@ def test_on_move_vertical_axis(vertical_axis: str) -> None:
)


@pytest.mark.parametrize(
"vertical_axis, aspect_expected",
[
("x", [1.190476, 0.892857, 1.190476]),
("y", [0.892857, 1.190476, 1.190476]),
("z", [1.190476, 1.190476, 0.892857]),
],
)
def test_set_box_aspect_vertical_axis(vertical_axis, aspect_expected):
ax = plt.subplot(1, 1, 1, projection="3d")
ax.view_init(elev=0, azim=0, roll=0, vertical_axis=vertical_axis)
ax.figure.canvas.draw()

ax.set_box_aspect(None)

np.testing.assert_allclose(aspect_expected, ax._box_aspect, rtol=1e-6)


@image_comparison(baseline_images=['arc_pathpatch.png'],
remove_text=True,
style='mpl20')
Expand Down