Add rcParams for 3D pane color

oscargus · oscargus · commit 05db8447b284 · 2022-10-08T09:27:04.000+02:00
diff --git a/doc/users/next_whats_new/3d_pane_color_rcparams.rst b/doc/users/next_whats_new/3d_pane_color_rcparams.rst
@@ -0,0 +1,17 @@
+rcParam for 3D pane color
+-------------------------
+
+The rcParams :rc:`axes3d.panecolorx`, :rc:`axes3d.panecolory`,
+:rc:`axes3d.panecolorz` can be used to change the color of the background
+panes in 3D plots. Note that it is often beneficial to give them slightly
+different shades to obtain a "3D effect" and to make them slightly transparent
+(alpha < 1).
+
+.. code-block:: python
+
+    import matplotlib.pyplot as plt
+    with plt.rc_context({'axes3d.panecolorx': (0.9, 0.0, 0.0, 0.5),
+                         'axes3d.panecolory': (0.7, 0.0, 0.0, 0.5),
+                         'axes3d.panecolorz': (0.8, 0.0, 0.0, 0.5)}):
+        fig = plt.figure()
+        fig.add_subplot(projection='3d')
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -427,6 +427,9 @@
 #polaraxes.grid: True  # display grid on polar axes
 #axes3d.grid:    True  # display grid on 3D axes
 
+#axes3d.panecolorx:    (0.95, 0.95, 0.95, 0.5)  # background pane on 3D axes
+#axes3d.panecolory:    (0.90, 0.90, 0.90, 0.5)  # background pane on 3D axes
+#axes3d.panecolorz:    (0.925, 0.925, 0.925, 0.5)  # background pane on 3D axes
 
 ## ***************************************************************************
 ## * AXIS                                                                    *
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1020,6 +1020,10 @@ def _convert_validator_spec(key, conv):
     "polaraxes.grid": validate_bool,  # display polar grid or not
     "axes3d.grid":    validate_bool,  # display 3d grid
 
+    "axes3d.panecolorx":    validate_color,  # 3d background pane
+    "axes3d.panecolory":    validate_color,  # 3d background pane
+    "axes3d.panecolorz":    validate_color,  # 3d background pane
+
     # scatter props
     "scatter.marker":     validate_string,
     "scatter.edgecolors": validate_string,
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -61,12 +61,9 @@ class Axis(maxis.XAxis):
 
     # Some properties for the axes
     _AXINFO = {
-        'x': {'i': 0, 'tickdir': 1, 'juggled': (1, 0, 2),
-              'color': (0.95, 0.95, 0.95, 0.5)},
-        'y': {'i': 1, 'tickdir': 0, 'juggled': (0, 1, 2),
-              'color': (0.90, 0.90, 0.90, 0.5)},
-        'z': {'i': 2, 'tickdir': 0, 'juggled': (0, 2, 1),
-              'color': (0.925, 0.925, 0.925, 0.5)},
+        'x': {'i': 0, 'tickdir': 1, 'juggled': (1, 0, 2)},
+        'y': {'i': 1, 'tickdir': 0, 'juggled': (0, 1, 2)},
+        'z': {'i': 2, 'tickdir': 0, 'juggled': (0, 2, 1)},
     }
 
     def _old_init(self, adir, v_intervalx, d_intervalx, axes, *args,
@@ -97,9 +94,14 @@ def __init__(self, *args, **kwargs):
         # This is a temporary member variable.
         # Do not depend on this existing in future releases!
         self._axinfo = self._AXINFO[name].copy()
+        # Common parts
+        self._axinfo.update({
+            'label': {'va': 'center', 'ha': 'center'},
+            'color': mpl.rcParams[f'axes3d.panecolor{name}'],
+        })
+
         if mpl.rcParams['_internal.classic_mode']:
             self._axinfo.update({
-                'label': {'va': 'center', 'ha': 'center'},
                 'tick': {
                     'inward_factor': 0.2,
                     'outward_factor': 0.1,
@@ -117,7 +119,6 @@ def __init__(self, *args, **kwargs):
             })
         else:
             self._axinfo.update({
-                'label': {'va': 'center', 'ha': 'center'},
                 'tick': {
                     'inward_factor': 0.2,
                     'outward_factor': 0.1,
diff --git a/lib/mpl_toolkits/tests/baseline_images/test_mplot3d/panecolor_rcparams.png b/lib/mpl_toolkits/tests/baseline_images/test_mplot3d/panecolor_rcparams.png
diff --git a/lib/mpl_toolkits/tests/test_mplot3d.py b/lib/mpl_toolkits/tests/test_mplot3d.py
@@ -2034,3 +2034,14 @@ def test_arc_pathpatch():
                    angle=20, theta1=10, theta2=130)
     ax.add_patch(a)
     art3d.pathpatch_2d_to_3d(a, z=0, zdir='z')
+
+
+@image_comparison(baseline_images=['panecolor_rcparams.png'],
+                  remove_text=True,
+                  style='mpl20')
+def test_panecolor_rcparams():
+    with plt.rc_context({'axes3d.panecolorx': 'r',
+                         'axes3d.panecolory': 'g',
+                         'axes3d.panecolorz': 'b'}):
+        fig = plt.figure(figsize=(1, 1))
+        fig.add_subplot(projection='3d')
