Revert parameters for view_transformation

scottshambaugh · scottshambaugh · commit 039b97579c72 · 2022-09-05T21:40:39.000-06:00
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -51,7 +51,7 @@ class Axes3D(Axes):
     _axis_names = ("x", "y", "z")
     Axes._shared_axes["z"] = cbook.Grouper()
 
-    dist = _api.deprecate_privatize_attribute("3.7")
+    dist = _api.deprecate_privatize_attribute("3.6")
     vvec = _api.deprecate_privatize_attribute("3.7")
     eye = _api.deprecate_privatize_attribute("3.7")
     sx = _api.deprecate_privatize_attribute("3.7")
@@ -160,6 +160,8 @@ def __init__(
         self.fmt_zdata = None
 
         self.mouse_init()
+        self.figure.canvas.callbacks._connect_picklable(
+            'motion_notify_event', self._on_move)
         self.figure.canvas.callbacks._connect_picklable(
             'button_press_event', self._button_press)
         self.figure.canvas.callbacks._connect_picklable(
@@ -917,13 +919,13 @@ def get_proj(self):
         # Generate the view and projection transformation matrices
         if self._focal_length == np.inf:
             # Orthographic projection
-            viewM = proj3d.view_transformation(u, v, w, eye)
+            viewM = proj3d.view_transformation_uvw(u, v, w, eye)
             projM = proj3d.ortho_transformation(-self._dist, self._dist)
         else:
             # Perspective projection
             # Scale the eye dist to compensate for the focal length zoom effect
             eye_focal = R + self._dist * ps * self._focal_length
-            viewM = proj3d.view_transformation(u, v, w, eye_focal)
+            viewM = proj3d.view_transformation_uvw(u, v, w, eye_focal)
             projM = proj3d.persp_transformation(-self._dist,
                                                 self._dist,
                                                 self._focal_length)
@@ -1245,14 +1247,22 @@ def _set_view_from_bbox(self, bbox, direction='in',
     def zoom_data_limits(self, scale_u, scale_v, scale_w):
         """
         Zoom in or out of a 3D plot.
-        Will scale the data limits by the scale factors, where scale_u,
-        scale_v, and scale_w refer to the scale factors for the viewing axes.
-        These will be transformed to the x, y, z data axes based on the current
-        view angles. A scale factor > 1 zooms out and a scale factor < 1 zooms
-        in.
+        Will scale the data limits by the scale factors. These will be
+        transformed to the x, y, z data axes based on the current view angles.
+        A scale factor > 1 zooms out and a scale factor < 1 zooms in.
+
         For an axes that has had its aspect ratio set to 'equal', 'equalxy',
         'equalyz', or 'equalxz', the relevant axes are constrained to zoom
         equally.
+
+        Parameters
+        ----------
+        scale_u : float
+            Scale factor for the u view axis (view screen horizontal).
+        scale_v : float
+            Scale factor for the v view axis (view screen vertical).
+        scale_w : float
+            Scale factor for the w view axis (view screen depth).
         """
         scale = np.array([scale_u, scale_v, scale_w])
 
@@ -1276,6 +1286,15 @@ def scale_axis_limits(self, scale_x, scale_y, scale_z):
         Keeping the center of the x, y, and z data axes fixed, scale their
         limits by scale factors. A scale factor > 1 zooms out and a scale
         factor < 1 zooms in.
+
+        Parameters
+        ----------
+        scale_x : float
+            Scale factor for the x data axis.
+        scale_y : float
+            Scale factor for the y data axis.
+        scale_z : float
+            Scale factor for the z data axis.
         """
         # Get the axis limits and centers
         minx, maxx, miny, maxy, minz, maxz = self.get_w_lims()
diff --git a/lib/mpl_toolkits/mplot3d/proj3d.py b/lib/mpl_toolkits/mplot3d/proj3d.py
@@ -75,9 +75,26 @@ def rotation_about_vector(v, angle):
 def view_axes(E, R, V, roll):
     """
     Get the unit viewing axes in data coordinates.
-    `u` is towards the right of the screen
-    `v` is towards the top of the screen
-    `w` is out of the screen
+
+    Parameters
+    ----------
+    E : 3-element numpy array
+        The coordinates of the eye/camera.
+    R : 3-element numpy array
+        The coordinates of the center of the view box.
+    V : 3-element numpy array
+        Unit vector in the direction of the vertical axis.
+    roll : float
+        The roll angle in radians.
+
+    Returns
+    -------
+    u : 3-element numpy array
+        Unit vector pointing towards the right of the screen.
+    v : 3-element numpy array
+        Unit vector pointing towards the top of the screen.
+    w : 3-element numpy array
+        Unit vector pointing out of the screen.
     """
     w = (E - R)
     w = w/np.linalg.norm(w)
@@ -94,12 +111,47 @@ def view_axes(E, R, V, roll):
     return u, v, w
 
 
-def view_transformation(u, v, w, E):
+def view_transformation_uvw(u, v, w, E):
+    """
+    Return the view transformation matrix.
+
+    Parameters
+    ----------
+    u : 3-element numpy array
+        Unit vector pointing towards the right of the screen.
+    v : 3-element numpy array
+        Unit vector pointing towards the top of the screen.
+    w : 3-element numpy array
+        Unit vector pointing out of the screen.
+    E : 3-element numpy array
+        The coordinates of the eye/camera.
+    """
     Mr = np.eye(4)
     Mt = np.eye(4)
     Mr[:3, :3] = [u, v, w]
     Mt[:3, -1] = -E
-    return np.dot(Mr, Mt)
+    M = np.dot(Mr, Mt)
+    return M
+
+
+def view_transformation(E, R, V, roll):
+    """
+    Return the view transformation matrix.
+
+    Parameters
+    ----------
+    E : 3-element numpy array
+        The coordinates of the eye/camera.
+    R : 3-element numpy array
+        The coordinates of the center of the view box.
+    V : 3-element numpy array
+        Unit vector in the direction of the vertical axis.
+    roll : float
+        The roll angle in radians.
+    """
+    u, v, w = view_axes(E, R, V, roll)
+    M = view_transformation_uvw(u, v, w, E)
+    return M
 
 
 def persp_transformation(zfront, zback, focal_length):
diff --git a/lib/mpl_toolkits/tests/test_mplot3d.py b/lib/mpl_toolkits/tests/test_mplot3d.py
@@ -976,8 +976,7 @@ def _test_proj_make_M():
     R = np.array([100, 100, 100])
     V = np.array([0, 0, 1])
     roll = 0
-    u, v, w = proj3d.view_axes(E, R, V, roll)
-    viewM = proj3d.view_transformation(u, v, w, E)
+    viewM = proj3d.view_transformation(E, R, V, roll)
     perspM = proj3d.persp_transformation(100, -100, 1)
     M = np.dot(perspM, viewM)
     return M
@@ -1043,8 +1042,7 @@ def test_proj_axes_cube_ortho():
     R = np.array([0, 0, 0])
     V = np.array([0, 0, 1])
     roll = 0
-    u, v, w = proj3d.view_axes(E, R, V, roll)
-    viewM = proj3d.view_transformation(u, v, w, E)
+    viewM = proj3d.view_transformation(E, R, V, roll)
     orthoM = proj3d.ortho_transformation(-1, 1)
     M = np.dot(orthoM, viewM)
 
