Skip to content

Clean up 3d plot box_aspect zooming #22084

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 1 commit into from
Jan 11, 2022
+19 −11
Merged

Clean up 3d plot box_aspect zooming #22084

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions doc/api/next_api_changes/deprecations/22084-SS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
``Axes3D.dist``
~~~~~~~~~~~~~~~
... has been privatized. Use the ``zoom`` keyword argument in
`.Axes3D.set_box_aspect` instead.
26 changes: 15 additions & 11 deletions lib/mpl_toolkits/mplot3d/axes3d.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ class Axes3D(Axes):
_axis_names = ("x", "y", "z")
Axes._shared_axes["z"] = cbook.Grouper()

dist = _api.deprecate_privatize_attribute("3.6")

def __init__(
self, fig, rect=None, *args,
elev=30, azim=-60, roll=0, sharez=None, proj_type='persp',
Expand Down Expand Up @@ -198,10 +200,10 @@ def convert_zunits(self, z):
def set_top_view(self):
# this happens to be the right view for the viewing coordinates
# moved up and to the left slightly to fit labels and axes
xdwl = 0.95 / self.dist
xdw = 0.9 / self.dist
ydwl = 0.95 / self.dist
ydw = 0.9 / self.dist
xdwl = 0.95 / self._dist
xdw = 0.9 / self._dist
ydwl = 0.95 / self._dist
ydw = 0.9 / self._dist
# This is purposely using the 2D Axes's set_xlim and set_ylim,
# because we are trying to place our viewing pane.
super().set_xlim(-xdwl, xdw, auto=None)
Expand Down Expand Up @@ -349,12 +351,14 @@ def set_box_aspect(self, aspect, *, zoom=1):
aspect : 3-tuple of floats or None
Changes the physical dimensions of the Axes3D, such that the ratio
of the axis lengths in display units is x:y:z.
If None, defaults to (4,4,3).

If None, defaults to 4:4:3

zoom : float
Control overall size of the Axes3D in the figure.
zoom : float, default: 1
Control overall size of the Axes3D in the figure. Must be > 0.
"""
if zoom <= 0:
raise ValueError(f'Argument zoom = {zoom} must be > 0')

if aspect is None:
aspect = np.asarray((4, 4, 3), dtype=float)
else:
Expand Down Expand Up @@ -1006,7 +1010,7 @@ def view_init(self, elev=None, azim=None, roll=None, vertical_axis="z"):
The axis to align vertically. *azim* rotates about this axis.
"""

self.dist = 10
self._dist = 10 # The camera distance from origin. Behaves like zoom

if elev is None:
self.elev = self.initial_elev
Expand Down Expand Up @@ -1081,7 +1085,7 @@ def get_proj(self):

# The coordinates for the eye viewing point. The eye is looking
# towards the middle of the box of data from a distance:
eye = R + self.dist * ps
eye = R + self._dist * ps

# TODO: Is this being used somewhere? Can it be removed?
self.eye = eye
Expand All @@ -1095,7 +1099,7 @@ def get_proj(self):
V[self._vertical_axis] = -1 if abs(elev_rad) > 0.5 * np.pi else 1

viewM = proj3d.view_transformation(eye, R, V, roll_rad)
projM = self._projection(-self.dist, self.dist)
projM = self._projection(-self._dist, self._dist)
M0 = np.dot(viewM, worldM)
M = np.dot(projM, M0)
return M
Expand Down