expose Path.contains_points as a method of Patch

yymao · yymao · commit 33d56d84bac8 · 2018-01-03T13:17:48.000-05:00
`Patch` has the method `contains_point` but not `contains_points`, but the latter is supported by `Path`. This PR adds `contains_points` to `Patch`.
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -143,14 +143,29 @@ def contains(self, mouseevent, radius=None):
 
     def contains_point(self, point, radius=None):
         """
-        Returns *True* if the given point is inside the path
+        Returns `True` if the given point is inside the path
         (transformed with its transform attribute).
+        
+        `radius` allows the path to be made slightly larger or smaller.
         """
         radius = self._process_radius(radius)
         return self.get_path().contains_point(point,
                                               self.get_transform(),
                                               radius)
 
+    def contains_points(self, points, radius=None):
+        """
+        Returns a bool array which is `True` if the (closed) path contains the corresponding point.
+        (transformed with its transform attribute).
+        
+        `points` should be an N x 2 array. 
+        `radius` allows the path to be made slightly larger or smaller.
+        """
+        radius = self._process_radius(radius)
+        return self.get_path().contains_points(points,
+                                              self.get_transform(),
+                                              radius)
+
     def update_from(self, other):
         """
         Updates this :class:`Patch` from the properties of *other*.
