Merge pull request matplotlib#23199 from oscargus/donotsetnewclippath

Do not set clip path if it exists

Author: greglucas

lib/matplotlib/axes/_axes.py

@@ -687,7 +687,8 @@ def text(self, x, y, s, fontdict=None, **kwargs):
             **kwargs,
         }
         t = mtext.Text(x, y, text=s, **effective_kwargs)
-        t.set_clip_path(self.patch)
+        if t.get_clip_path() is None:
+            t.set_clip_path(self.patch)
         self._add_text(t)
         return t
 
@@ -700,7 +701,7 @@ def annotate(self, text, xy, xytext=None, xycoords='data', textcoords=None,
                              textcoords=textcoords, arrowprops=arrowprops,
                              annotation_clip=annotation_clip, **kwargs)
         a.set_transform(mtransforms.IdentityTransform())
-        if 'clip_on' in kwargs:
+        if kwargs.get('clip_on', False) and a.get_clip_path() is None:
             a.set_clip_path(self.patch)
         self._add_text(a)
         return a

lib/matplotlib/axes/_base.py

@@ -2215,7 +2215,8 @@ def add_artist(self, a):
         self._children.append(a)
         a._remove_method = self._children.remove
         self._set_artist_props(a)
-        a.set_clip_path(self.patch)
+        if a.get_clip_path() is None:
+            a.set_clip_path(self.patch)
         self.stale = True
         return a
 
@@ -2423,7 +2424,8 @@ def add_table(self, tab):
         _api.check_isinstance(mtable.Table, tab=tab)
         self._set_artist_props(tab)
         self._children.append(tab)
-        tab.set_clip_path(self.patch)
+        if tab.get_clip_path() is None:
+            tab.set_clip_path(self.patch)
         tab._remove_method = self._children.remove
         return tab
 

lib/matplotlib/figure.py

@@ -505,7 +505,7 @@ def add_artist(self, artist, clip=False):
         if not artist.is_transform_set():
             artist.set_transform(self.transSubfigure)
 
-        if clip:
+        if clip and artist.get_clip_path() is None:
             artist.set_clip_path(self.patch)
 
         self.stale = True

lib/matplotlib/patheffects.py

@@ -368,7 +368,7 @@ def draw_path(self, renderer, gc, tpath, affine, rgbFace):
         self.patch.set_transform(affine + self._offset_transform(renderer))
         self.patch.set_clip_box(gc.get_clip_rectangle())
         clip_path = gc.get_clip_path()
-        if clip_path:
+        if clip_path and self.patch.get_clip_path() is None:
             self.patch.set_clip_path(*clip_path)
         self.patch.draw(renderer)
 

lib/matplotlib/tests/baseline_images/test_axes/preset_clip_paths.png

@@ -18,7 +18,7 @@
 
 import matplotlib
 import matplotlib as mpl
-from matplotlib import rc_context
+from matplotlib import rc_context, patheffects
 from matplotlib._api import MatplotlibDeprecationWarning
 import matplotlib.colors as mcolors
 import matplotlib.dates as mdates
@@ -8441,6 +8441,43 @@ def test_zorder_and_explicit_rasterization():
         fig.savefig(b, format='pdf')
 
 
+@image_comparison(["preset_clip_paths.png"], remove_text=True, style="mpl20")
+def test_preset_clip_paths():
+    fig, ax = plt.subplots()
+
+    poly = mpl.patches.Polygon(
+        [[1, 0], [0, 1], [-1, 0], [0, -1]], facecolor="#ddffdd",
+        edgecolor="#00ff00", linewidth=2, alpha=0.5)
+
+    ax.add_patch(poly)
+
+    line = mpl.lines.Line2D((-1, 1), (0.5, 0.5), clip_on=True, clip_path=poly)
+    line.set_path_effects([patheffects.withTickedStroke()])
+    ax.add_artist(line)
+
+    line = mpl.lines.Line2D((-1, 1), (-0.5, -0.5), color='r', clip_on=True,
+                            clip_path=poly)
+    ax.add_artist(line)
+
+    poly2 = mpl.patches.Polygon(
+        [[-1, 1], [0, 1], [0, -0.25]], facecolor="#beefc0", alpha=0.3,
+        edgecolor="#faded0", linewidth=2, clip_on=True, clip_path=poly)
+    ax.add_artist(poly2)
+
+    # When text clipping works, the "Annotation" text should be clipped
+    ax.annotate('Annotation', (-0.75, -0.75), xytext=(0.1, 0.75),
+                arrowprops={'color': 'k'}, clip_on=True, clip_path=poly)
+
+    poly3 = mpl.patches.Polygon(
+        [[0, 0], [0, 0.5], [0.5, 0.5], [0.5, 0]], facecolor="g", edgecolor="y",
+        linewidth=2, alpha=0.3, clip_on=True, clip_path=poly)
+
+    fig.add_artist(poly3, clip=True)
+
+    ax.set_xlim(-1, 1)
+    ax.set_ylim(-1, 1)
+
+
 @mpl.style.context('default')
 def test_rc_axes_label_formatting():
     mpl.rcParams['axes.labelcolor'] = 'red'