Merge pull request #6498 from anntzer/artist-contains-checks-canvas-identity

dstansby · web-flow · commit ea4274ea0dc4 · 2019-07-19T12:06:39.000+01:00
Check canvas identity in Artist.contains.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -381,6 +381,32 @@ def get_children(self):
         r"""Return a list of the child `.Artist`\s of this `.Artist`."""
         return []
 
+    def _default_contains(self, mouseevent, figure=None):
+        """
+        Base impl. for checking whether a mouseevent happened in an artist.
+
+        1. If the artist defines a custom checker, use it.
+        2. If the artist figure is known and the event did not occur in that
+           figure (by checking its ``canvas`` attribute), reject it.
+        3. Otherwise, return `None, {}`, indicating that the subclass'
+           implementation should be used.
+
+        Subclasses should start their definition of `contains` as follows:
+
+            inside, info = self._default_contains(mouseevent)
+            if inside is not None:
+                return inside, info
+            # subclass-specific implementation follows
+
+        The `canvas` kwarg is provided for the implementation of
+        `Figure.contains`.
+        """
+        if callable(self._contains):
+            return self._contains(self, mouseevent)
+        if figure is not None and mouseevent.canvas is not figure.canvas:
+            return False, {}
+        return None, {}
+
     def contains(self, mouseevent):
         """Test whether the artist contains the mouse event.
 
@@ -401,8 +427,9 @@ def contains(self, mouseevent):
         --------
         set_contains, get_contains
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         _log.warning("%r needs 'contains' method", self.__class__.__name__)
         return False, {}
 
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -4200,8 +4200,9 @@ def get_children(self):
 
     def contains(self, mouseevent):
         # docstring inherited.
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         return self.patch.contains(mouseevent)
 
     def contains_point(self, point):
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -242,8 +242,9 @@ def contains(self, mouseevent):
         This function always returns false.  It is more useful to test if the
         axis as a whole contains the mouse rather than the set of tick marks.
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         return False, {}
 
     def set_pad(self, val):
@@ -1923,8 +1924,9 @@ class XAxis(Axis):
     def contains(self, mouseevent):
         """Test whether the mouse event occurred in the x axis.
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
 
         x, y = mouseevent.x, mouseevent.y
         try:
@@ -2208,8 +2210,9 @@ def contains(self, mouseevent):
 
         Returns *True* | *False*
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
 
         x, y = mouseevent.x, mouseevent.y
         try:
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -352,8 +352,9 @@ def contains(self, mouseevent):
         Returns ``bool, dict(ind=itemlist)``, where every item in itemlist
         contains the event.
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
 
         if not self.get_visible():
             return False, {}
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -671,8 +671,9 @@ def contains(self, mouseevent):
         -------
             bool, {}
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent, figure=self)
+        if inside is not None:
+            return inside, info
         inside = self.bbox.contains(mouseevent.x, mouseevent.y)
         return inside, {}
 
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py
@@ -589,8 +589,9 @@ def contains(self, mouseevent):
         """
         Test whether the mouse event occurred within the image.
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         # 1) This doesn't work for figimage; but figimage also needs a fix
         #    below (as the check cannot use x/ydata and extents).
         # 2) As long as the check below uses x/ydata, we need to test axes
@@ -1299,8 +1300,9 @@ def get_window_extent(self, renderer=None):
 
     def contains(self, mouseevent):
         """Test whether the mouse event occurred within the image."""
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
 
         if not self.get_visible():  # or self.get_figure()._renderer is None:
             return False, {}
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -1148,6 +1148,9 @@ def _find_best_position(self, width, height, renderer, consider=None):
         return l, b
 
     def contains(self, event):
+        inside, info = self._default_contains(event)
+        if inside is not None:
+            return inside, info
         return self.legendPatch.contains(event)
 
     def set_draggable(self, state, use_blit=False, update='loc'):
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -446,8 +446,9 @@ def contains(self, mouseevent):
 
             TODO: sort returned indices by distance
         """
-        if callable(self._contains):
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
 
         if not isinstance(self.pickradius, Number):
             raise ValueError("pick radius should be a distance")
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -228,6 +228,9 @@ def contains(self, mouseevent):
         --------
         .Artist.contains
         """
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         for c in self.get_children():
             a, b = c.contains(mouseevent)
             if a:
@@ -1556,8 +1559,11 @@ def anncoords(self, coords):
         self.boxcoords = coords
         self.stale = True
 
-    def contains(self, event):
-        t, tinfo = self.offsetbox.contains(event)
+    def contains(self, mouseevent):
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
+        t, tinfo = self.offsetbox.contains(mouseevent)
         #if self.arrow_patch is not None:
         #    a, ainfo=self.arrow_patch.contains(event)
         #    t = t or a
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -130,8 +130,9 @@ def contains(self, mouseevent, radius=None):
         -------
         (bool, empty dict)
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         radius = self._process_radius(radius)
         codes = self.get_path().codes
         if codes is not None:
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
@@ -369,6 +369,9 @@ def set_figure(self, fig):
         self.text.set_figure(fig)
 
     def contains(self, mouseevent):
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         # Maybe the dictionary should allow one to
         # distinguish between a text hit and a vector hit.
         if (self.text.contains(mouseevent)[0] or
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -434,9 +434,9 @@ def _get_grid_bbox(self, renderer):
 
     def contains(self, mouseevent):
         # docstring inherited
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
-
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
         # TODO: Return index of the cell containing the cursor so that the user
         # doesn't have to bind to each one individually.
         renderer = self.figure._cachedRenderer
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -194,8 +194,9 @@ def contains(self, mouseevent):
         -------
         bool : bool
         """
-        if self._contains is not None:
-            return self._contains(self, mouseevent)
+        inside, info = self._default_contains(mouseevent)
+        if inside is not None:
+            return inside, info
 
         if not self.get_visible() or self._renderer is None:
             return False, {}
@@ -2180,8 +2181,9 @@ def transform(renderer) -> Transform
             self.arrow_patch = None
 
     def contains(self, event):
-        if self._contains is not None:
-            return self._contains(self, event)
+        inside, info = self._default_contains(event)
+        if inside is not None:
+            return inside, info
         contains, tinfo = Text.contains(self, event)
         if self.arrow_patch is not None:
             in_patch, _ = self.arrow_patch.contains(event)
