Change kwarg to computed_zorder

Kent · Kent · commit 61451ee7419f · 2021-02-25T22:14:40.000-07:00
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -49,7 +49,7 @@ class Axes3D(Axes):
     def __init__(
             self, fig, rect=None, *args,
             azim=-60, elev=30, sharez=None, proj_type='persp',
-            box_aspect=None, force_zorder=False,
+            box_aspect=None, computed_zorder=True,
             **kwargs):
         """
         Parameters
@@ -66,10 +66,10 @@ def __init__(
             Other axes to share z-limits with.
         proj_type : {'persp', 'ortho'}
             The projection type, default 'persp'.
-        force_zorder : bool, optional
-            Force use of each collection and patch's zorder to determine
-            draw order. If this option is True, automatic draw order is
-            completely disabled. Defaults to False.
+        computed_zorder : bool, optional
+            If this option is True, draw order is computed automatically.
+            Otherwise, each collection and patch's zorder is used to determine
+            draw order. Defaults to True.
         auto_add_to_figure : bool, default: True
             Prior to Matplotlib 3.4 Axes3D would add themselves
             to their host Figure on init.  Other Axes class do not
@@ -89,7 +89,7 @@ def __init__(
         .. versionadded:: 1.2.1
             The *sharez* parameter.
         .. versionadded:: TBD
-            The *force_zorder* parameter.
+            The *computed_zorder* parameter.
         """
 
         if rect is None:
@@ -98,7 +98,7 @@ def __init__(
         self.initial_azim = azim
         self.initial_elev = elev
         self.set_proj_type(proj_type)
-        self.force_zorder = force_zorder
+        self.computed_zorder = computed_zorder
 
         self.xy_viewLim = Bbox.unit()
         self.zz_viewLim = Bbox.unit()
@@ -484,26 +484,26 @@ def do_3d_projection(artist):
                     "%(since)s and will be removed %(removal)s.")
                 return artist.do_3d_projection(renderer)
 
-            if self.force_zorder:
-                for col in self.collections:
-                    col.do_3d_projection()
-                for patch in self.patches:
-                    patch.do_3d_projection()
-            else:
-                # Calculate projection of collections and patches and zorder them.
-                # Make sure they are drawn above the grids.
+            if self.computed_zorder:
+                # Calculate projection of collections and patches and zorder
+                # them. Make sure they are drawn above the grids.
                 zorder_offset = max(axis.get_zorder()
                                     for axis in self._get_axis_list()) + 1
                 for i, col in enumerate(
                         sorted(self.collections,
-                            key=do_3d_projection,
-                            reverse=True)):
+                               key=do_3d_projection,
+                               reverse=True)):
                     col.zorder = zorder_offset + i
                 for i, patch in enumerate(
                         sorted(self.patches,
-                            key=do_3d_projection,
-                            reverse=True)):
+                               key=do_3d_projection,
+                               reverse=True)):
                     patch.zorder = zorder_offset + i
+            else:
+                for col in self.collections:
+                    col.do_3d_projection()
+                for patch in self.patches:
+                    patch.do_3d_projection()
 
             if self._axis3don:
                 # Draw panes first
@@ -3518,6 +3518,7 @@ def stem(self, x, y, z, *, linefmt='C0-', markerfmt='C0o', basefmt='C3-',
 
     stem3D = stem
 
+
 docstring.interpd.update(Axes3D_kwdoc=artist.kwdoc(Axes3D))
 docstring.dedent_interpd(Axes3D.__init__)
 
diff --git a/lib/mpl_toolkits/tests/baseline_images/test_mplot3d/computed_zorder.png b/lib/mpl_toolkits/tests/baseline_images/test_mplot3d/computed_zorder.png
diff --git a/lib/mpl_toolkits/tests/test_mplot3d.py b/lib/mpl_toolkits/tests/test_mplot3d.py
@@ -1427,13 +1427,13 @@ def test_subfigure_simple():
     ax = sf[1].add_subplot(1, 1, 1, projection='3d', label='other')
 
 
-@image_comparison(baseline_images=['force_zorder'], remove_text=True,
+@image_comparison(baseline_images=['computed_zorder'], remove_text=True,
                   extensions=['png'])
-def test_force_zorder():
+def test_computed_zorder():
     fig = plt.figure()
     ax1 = fig.add_subplot(221, projection='3d')
     ax2 = fig.add_subplot(222, projection='3d')
-    ax2.force_zorder = True
+    ax2.computed_zorder = False
 
     # create a horizontal plane
     corners = ((0, 0, 0), (0, 5, 0), (5, 5, 0), (5, 0, 0))
@@ -1456,7 +1456,7 @@ def test_force_zorder():
 
     ax3 = fig.add_subplot(223, projection='3d')
     ax4 = fig.add_subplot(224, projection='3d')
-    ax4.force_zorder = True
+    ax4.computed_zorder = False
 
     dim = 10
     X, Y = np.meshgrid((-dim, dim), (-dim, dim))
