Merge pull request #210 from pygame-community/rename_polygon_get_bounding_box

Renamed Polygon get_bounding_box to as_rect

Author: itzpr3d4t0r

benchmarks/GEOMETRY_polygon_benchmark.py

@@ -182,10 +182,10 @@ def polygon(self):
     ("NC float list", "po100.collidepoint([0.0, 1000.0])"),
 ]
 
-get_bounding_box_tests = [
-    ("3", "po3.get_bounding_box()"),
-    ("4", "po4.get_bounding_box()"),
-    ("100", "po100.get_bounding_box()"),
+as_rect_tests = [
+    ("3", "po3.as_rect()"),
+    ("4", "po4.as_rect()"),
+    ("100", "po100.as_rect()"),
 ]
 
 subscript_assignment_tests = [
@@ -228,7 +228,7 @@ def polygon(self):
     ("Rotate", rotate_tests),
     ("Rotate_ip", rotate_ip_tests),
     ("Collidepoint", collidepoint_tests),
-    ("Get Bounding Box", get_bounding_box_tests),
+    ("Get Bounding Box", as_rect_tests),
     ("Subscript", subscript_tests),
     ("Subscript Assignment", subscript_assignment_tests),
     ("Scale", scale_tests),

docs/geometry.rst

@@ -192,7 +192,7 @@ other objects.
 
     scale_ip: Scales the polygon by the given amount in place.
 
-    get_bounding_box: Returns the smallest rectangle that contains the polygon.
+    as_rect: Returns the smallest rectangle that contains the polygon.
 
     as_segments: Returns a list of lines that make up the polygon.
 

docs/polygon.rst

@@ -344,10 +344,10 @@ Polygon Methods
 
       .. ## Polygon.pop_vertex ##
 
-    .. method:: get_bounding_box
+    .. method:: as_rect
 
         | :sl:`returns the bounding box of the polygon`
-        | :sg:`get_bounding_box() -> Rect`
+        | :sg:`as_rect() -> Rect`
 
         Returns a `pygame.Rect` object that contains the `Polygon`. The Rect object will
         be the smallest rectangle that contains the `Polygon`.
@@ -361,7 +361,7 @@ Polygon Methods
             Keep in mind that the more vertices the polygon has, the more CPU time it will
             take to calculate the bounding box.
 
-      .. ## Polygon.get_bounding_box ##
+      .. ## Polygon.as_rect ##
 
     .. method:: scale
 

geometry.pyi

@@ -245,7 +245,7 @@ class Polygon:
     @overload
     def collidepoint(self, point: Coordinate) -> bool: ...
     def collideline(self, line: LineValue, only_edges: bool = False) -> bool: ...
-    def get_bounding_box(self) -> Rect: ...
+    def as_rect(self) -> Rect: ...
     def is_convex(self) -> bool: ...
     @overload
     def collidecircle(self, polygon: CircleValue, only_edges: bool = False) -> bool: ...

src_c/polygon.c

@@ -1119,7 +1119,7 @@ pg_polygon_rotate_ip(pgPolygonObject *self, PyObject *const *args,
 }
 
 static PyObject *
-pg_polygon_get_bounding_box(pgPolygonObject *self, PyObject *_null)
+pg_polygon_as_rect(pgPolygonObject *self, PyObject *_null)
 {
     /* Return a Rect object that is the smallest rectangle that contains
        the polygon. */
@@ -1313,7 +1313,7 @@ static struct PyMethodDef pg_polygon_methods[] = {
     {"collideline", (PyCFunction)pg_polygon_collideline, METH_FASTCALL, NULL},
     {"collidecircle", (PyCFunction)pg_polygon_collidecircle, METH_FASTCALL,
      NULL},
-    {"get_bounding_box", (PyCFunction)pg_polygon_get_bounding_box, METH_NOARGS,
+    {"as_rect", (PyCFunction)pg_polygon_as_rect, METH_NOARGS,
      NULL},
     {"is_convex", (PyCFunction)pg_polygon_is_convex, METH_NOARGS, NULL},
     {"__copy__", (PyCFunction)pg_polygon_copy, METH_NOARGS, NULL},

test/test_polygon.py

@@ -1531,11 +1531,11 @@ def test_assign_vertices_center_Vector2(self):
 
         self.assertEqual((2.5, 2.5), poly.center)
 
-    def test_get_bounding_box_horizontal_line(self):
+    def test_as_rect_horizontal_line(self):
         vertices = [(0, 0), (1, 0), (2, 0), (3, 0)]
         poly = Polygon(vertices)
 
-        bounding_box = poly.get_bounding_box()
+        bounding_box = poly.as_rect()
         expected_bounding_box = _calculate_bounding_box(vertices)
 
         self.assertTrue(bounding_box.width > 0)
@@ -1545,11 +1545,11 @@ def test_get_bounding_box_horizontal_line(self):
         for vertex in vertices:
             self.assertTrue(bounding_box.collidepoint(vertex))
 
-    def test_get_bounding_box_vertical_line(self):
+    def test_as_rect_vertical_line(self):
         vertices = [(0, 0), (0, 1), (0, 2), (0, 3)]
         poly = Polygon(vertices)
 
-        bounding_box = poly.get_bounding_box()
+        bounding_box = poly.as_rect()
         expected_bounding_box = _calculate_bounding_box(vertices)
 
         self.assertTrue(bounding_box.width > 0)
@@ -1559,11 +1559,11 @@ def test_get_bounding_box_vertical_line(self):
         for vertex in vertices:
             self.assertTrue(bounding_box.collidepoint(vertex))
 
-    def test_get_bounding_box_square(self):
+    def test_as_rect_square(self):
         vertices = [(0, 0), (0, 1), (1, 1), (1, 0)]
         poly = Polygon(vertices)
 
-        bounding_box = poly.get_bounding_box()
+        bounding_box = poly.as_rect()
         expected_bounding_box = _calculate_bounding_box(vertices)
 
         self.assertTrue(bounding_box.width > 0)
@@ -1573,11 +1573,11 @@ def test_get_bounding_box_square(self):
         for vertex in vertices:
             self.assertTrue(bounding_box.collidepoint(vertex))
 
-    def test_get_bounding_box_diagonal_line(self):
+    def test_as_rect_diagonal_line(self):
         vertices = [(0, 0), (1, 1), (2, 2), (3, 3)]
         poly = Polygon(vertices)
 
-        bounding_box = poly.get_bounding_box()
+        bounding_box = poly.as_rect()
         expected_bounding_box = _calculate_bounding_box(vertices)
 
         self.assertTrue(bounding_box.width > 0)
@@ -1587,11 +1587,11 @@ def test_get_bounding_box_diagonal_line(self):
         for vertex in vertices:
             self.assertTrue(bounding_box.collidepoint(vertex))
 
-    def test_get_bounding_box_negative_positions(self):
+    def test_as_rect_negative_positions(self):
         vertices = [(0.5, 0.5), (-0.5, -0.5), (1.5, 1.5), (-1.5, -1.5)]
         poly = Polygon(vertices)
 
-        bounding_box = poly.get_bounding_box()
+        bounding_box = poly.as_rect()
         expected_bounding_box = _calculate_bounding_box(vertices)
 
         self.assertTrue(bounding_box.width > 0)
@@ -1601,13 +1601,13 @@ def test_get_bounding_box_negative_positions(self):
         for vertex in vertices:
             self.assertTrue(bounding_box.collidepoint(vertex))
 
-    def test_get_bounding_box_nonsimple_random_positions(self):
+    def test_as_rect_nonsimple_random_positions(self):
         vertices = []
         for i in range(1000):
             vertices.append((random.uniform(-100, 100), random.uniform(-100, 100)))
         poly = Polygon(vertices)
 
-        bounding_box = poly.get_bounding_box()
+        bounding_box = poly.as_rect()
         expected_bounding_box = _calculate_bounding_box(vertices)
 
         self.assertTrue(bounding_box.width > 0)
@@ -1617,18 +1617,18 @@ def test_get_bounding_box_nonsimple_random_positions(self):
         for vertex in vertices:
             self.assertTrue(bounding_box.collidepoint(vertex))
 
-    def test_get_bounding_box_return_type(self):
-        """Tests whether the get_bounding_box method returns a Rect."""
+    def test_as_rect_return_type(self):
+        """Tests whether the as_rect method returns a Rect."""
         poly = Polygon(_some_vertices.copy())
-        self.assertIsInstance(poly.get_bounding_box(), Rect)
+        self.assertIsInstance(poly.as_rect(), Rect)
 
-    def test_get_bounding_box_argnum(self):
-        """Tests whether the get_bounding_box method correctly handles invalid parameter
+    def test_as_rect_argnum(self):
+        """Tests whether the as_rect method correctly handles invalid parameter
         numbers."""
         poly = Polygon(_some_vertices.copy())
 
         with self.assertRaises(TypeError):
-            poly.get_bounding_box(1)
+            poly.as_rect(1)
 
     def test_assign_subscript(self):
         """Tests whether assigning to a subscript works correctly."""