Deprecate unit_cube-related methods in Axes3D

oscargus · oscargus · commit acdc25636c34 · 2022-10-21T14:17:33.000+02:00
diff --git a/doc/api/next_api_changes/deprecations/24240-OG.rst b/doc/api/next_api_changes/deprecations/24240-OG.rst
@@ -0,0 +1,6 @@
+``unit_cube``, ``tunit_cube``, and ``tunit_edges``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... of `.Axes3D` are deprecated without replacements. If you rely on them,
+please copy the code of the corresponding private function (name starting
+with ``_``).
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -236,7 +236,11 @@ def get_zaxis(self):
     w_zaxis = _api.deprecated("3.1", alternative="zaxis", removal="3.8")(
         property(lambda self: self.zaxis))
 
+    @_api.deprecated("3.7")
     def unit_cube(self, vals=None):
+        return self._unit_cube(vals)
+
+    def _unit_cube(self, vals=None):
         minx, maxx, miny, maxy, minz, maxz = vals or self.get_w_lims()
         return [(minx, miny, minz),
                 (maxx, miny, minz),
@@ -247,15 +251,23 @@ def unit_cube(self, vals=None):
                 (maxx, maxy, maxz),
                 (minx, maxy, maxz)]
 
+    @_api.deprecated("3.7")
     def tunit_cube(self, vals=None, M=None):
+        return self._tunit_cube(vals, M)
+
+    def _tunit_cube(self, vals=None, M=None):
         if M is None:
             M = self.M
-        xyzs = self.unit_cube(vals)
+        xyzs = self._unit_cube(vals)
         tcube = proj3d.proj_points(xyzs, M)
         return tcube
 
+    @_api.deprecated("3.7")
     def tunit_edges(self, vals=None, M=None):
-        tc = self.tunit_cube(vals, M)
+        return self._tunit_edges(vals, M)
+
+    def _tunit_edges(self, vals=None, M=None):
+        tc = self._tunit_cube(vals, M)
         edges = [(tc[0], tc[1]),
                  (tc[1], tc[2]),
                  (tc[2], tc[3]),
@@ -496,7 +508,7 @@ def draw(self, renderer):
 
     def get_axis_position(self):
         vals = self.get_w_lims()
-        tc = self.tunit_cube(vals, self.M)
+        tc = self._tunit_cube(vals, self.M)
         xhigh = tc[1][2] > tc[2][2]
         yhigh = tc[3][2] > tc[2][2]
         zhigh = tc[0][2] > tc[2][2]
@@ -1063,7 +1075,7 @@ def format_coord(self, xd, yd):
                     ).replace("-", "\N{MINUS SIGN}")
 
         # nearest edge
-        p0, p1 = min(self.tunit_edges(),
+        p0, p1 = min(self._tunit_edges(),
                      key=lambda edge: proj3d._line2d_seg_dist(
                          edge[0], edge[1], (xd, yd)))
 
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -257,7 +257,7 @@ def _get_coord_info(self, renderer):
 
         # Project the bounds along the current position of the cube:
         bounds = mins[0], maxs[0], mins[1], maxs[1], mins[2], maxs[2]
-        bounds_proj = self.axes.tunit_cube(bounds, self.axes.M)
+        bounds_proj = self.axes._tunit_cube(bounds, self.axes.M)
 
         # Determine which one of the parallel planes are higher up:
         means_z0 = np.zeros(3)
