git push -f# This is a combination of 2 commits.

scottshambaugh · scottshambaugh · commit b5fc59d58fb2 · 2022-01-02T13:49:26.000-07:00
Clean up 3d plot box_aspect zooming

linting

Cleanup
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -129,6 +129,9 @@ def __init__(
         # they can't be defined until Axes.__init__ has been called
         self.view_init(self.initial_elev, self.initial_azim, self.initial_roll)
 
+        # set the initial zoom level
+        self.zoom = 1
+
         self._sharez = sharez
         if sharez is not None:
             self._shared_axes["z"].join(self, sharez)
@@ -329,7 +332,7 @@ def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
         super().set_aspect(
             aspect, adjustable=adjustable, anchor=anchor, share=share)
 
-    def set_box_aspect(self, aspect, *, zoom=1):
+    def set_box_aspect(self, aspect=None, *, zoom=None):
         """
         Set the axes box aspect.
 
@@ -346,22 +349,27 @@ def set_box_aspect(self, aspect, *, zoom=1):
 
         Parameters
         ----------
-        aspect : 3-tuple of floats or None
+        aspect : 3-tuple of floats or None, default: (4:4:3)
             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
-
-        zoom : float
-            Control overall size of the Axes3D in the figure.
+        zoom : float, default: None
+            Control overall size of the Axes3D in the figure. A value of None
+            keeps the current zoom level.
         """
+        # self.zoom is first set in Axes3D init
+        if zoom is not None:
+            if zoom <= 0:
+                raise ValueError(f'Argument zoom = {zoom} must be > 0')
+            self.zoom = zoom
+
         if aspect is None:
             aspect = np.asarray((4, 4, 3), dtype=float)
         else:
             aspect = np.asarray(aspect, dtype=float)
             _api.check_shape((3,), aspect=aspect)
         # default scale tuned to match the mpl32 appearance.
-        aspect *= 1.8294640721620434 * zoom / np.linalg.norm(aspect)
+        aspect *= 1.8294640721620434 * self.zoom / np.linalg.norm(aspect)
 
         self._box_aspect = aspect
         self.stale = True
@@ -1006,7 +1014,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
