Add some helper methods to Patches

dstansby · dstansby · commit 2251bd95efb7 · 2021-12-16T13:30:18.000Z
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -806,6 +806,25 @@ def get_xy(self):
         """Return the left and bottom coords of the rectangle as a tuple."""
         return self._x0, self._y0
 
+    def get_edge_midpoints(self):
+        """
+        Return midpoints of the edges of the rectangle, moving clockwise from
+        the center of the left-hand edge.
+        """
+        return self.get_patch_transform().transform(
+            [(0, 0.5), (0.5, 1), (1, 0.5), (0.5, 0)])
+
+    def get_corners(self):
+        """
+        Return the corners of the rectangle, moving clockwise from (x0, y0).
+        """
+        return self.get_patch_transform().transform(
+            [(0, 0), (1, 0), (1, 1), (0, 1)])
+
+    def get_center(self):
+        """Return the centre of the rectangle."""
+        return self.get_patch_transform().transform((0.5, 0.5))
+
     def get_width(self):
         """Return the width of the rectangle."""
         return self._width
@@ -1657,6 +1676,22 @@ def get_angle(self):
 
     angle = property(get_angle, set_angle)
 
+    def get_corners(self):
+        """
+        Return the corners of the ellipse bounding box, moving clockwise from
+        the lower left.
+        """
+        return self.get_patch_transform().transform(
+            [(-1, -1), (1, -1), (1, 1), (-1, 1)])
+
+    def get_edge_midpoints(self):
+        """
+        Return the edge midpoints of the ellipse bounding box, moving clockwise
+        from the left hand edge.
+        """
+        return self.get_patch_transform().transform(
+            [(-1, 0), (0, 1), (1, 0), (0, -1)])
+
 
 class Annulus(Patch):
     """
diff --git a/lib/matplotlib/tests/test_patches.py b/lib/matplotlib/tests/test_patches.py
@@ -6,7 +6,7 @@
 import pytest
 
 import matplotlib as mpl
-from matplotlib.patches import (Annulus, Patch, Polygon, Rectangle,
+from matplotlib.patches import (Annulus, Ellipse, Patch, Polygon, Rectangle,
                                 FancyArrowPatch)
 from matplotlib.testing.decorators import image_comparison, check_figures_equal
 from matplotlib.transforms import Bbox
@@ -54,6 +54,28 @@ def test_Polygon_close():
     assert_array_equal(p.get_xy(), xyclosed)
 
 
+def test_corners_edges():
+    loc = [-6, 3]
+    width = 1
+    height = 5
+
+    corners = ((-6, 3), (-5, 3), (-5, 8), (-6, 8))
+    edges = ((-6, 5.5), (-5.5, 8), (-5, 5.5), (-5.5, 3))
+    # A rotated rectangle
+    rect = Rectangle(loc, width, height)
+    assert_array_equal(rect.get_corners(), corners)
+    assert_array_equal(rect.get_edge_midpoints(), edges)
+    assert_array_equal(rect.get_center(), (-5.5, 5.5))
+
+    # Ellipse uses center as reference point
+    loc = [loc[0] + width / 2,
+           loc[1] + height / 2]
+    print(loc)
+    ellipse = Ellipse(loc, width, height)
+    assert_array_equal(ellipse.get_corners(), corners)
+    assert_array_equal(ellipse.get_edge_midpoints(), edges)
+
+
 def test_rotate_rect():
     loc = np.asarray([1.0, 2.0])
     width = 2
