Add Circle colliderect() (#2560)

Co-authored-by: Emc2356 <63981925+emc2356@users.noreply.github.com>
Co-authored-by: NovialRiptide <35881688+novialriptide@users.noreply.github.com>
Co-authored-by: ScriptLineStudios <scriptlinestudios@protonmail.com>
Co-authored-by: Avaxar <44055981+avaxar@users.noreply.github.com>
Co-authored-by: maqa41 <amehebbet41@gmail.com>

Author: 6 people

buildconfig/stubs/pygame/geometry.pyi

@@ -7,7 +7,7 @@ from typing import (
     Sequence,
 )
 
-from ._common import Coordinate
+from ._common import Coordinate, RectValue
 
 _CanBeCircle = Union[Circle, Tuple[Coordinate, float], Sequence[float]]
 
@@ -76,6 +76,12 @@ class Circle:
     @overload
     def collidecircle(self, center: Coordinate, r: float) -> bool: ...
     @overload
+    def colliderect(self, rect: RectValue) -> bool: ...
+    @overload
+    def colliderect(self, x: float, y: float, w: float, h: float) -> bool: ...
+    @overload
+    def colliderect(self, topleft: Coordinate, size: Coordinate) -> bool: ...
+    @overload
     def update(self, circle: _CircleValue) -> None: ...
     @overload
     def update(self, x: float, y: float, r: float) -> None: ...

docs/reST/ref/geometry.rst

@@ -176,6 +176,21 @@
 
          .. ## Circle.collidecircle ##
 
+   .. method:: colliderect
+
+         | :sl:`checks if a rectangle intersects the circle`
+         | :sg:`colliderect(Rect) -> bool`
+         | :sg:`colliderect((x, y, width, height)) -> bool`
+         | :sg:`colliderect(x, y, width, height) -> bool`
+         | :sg:`colliderect((x, y), (width, height)) -> bool`
+
+         The `colliderect` method tests whether a given rectangle intersects the `Circle`. It
+         takes either a `Rect` object, a tuple of (x, y, width, height) coordinates, or separate
+         x, y coordinates and width, height as its argument. Returns `True` if any portion
+         of the rectangle overlaps with the `Circle`, `False` otherwise.
+         
+         .. ## Circle.colliderect ##
+
    .. method:: update
 
          | :sl:`updates the circle position and radius`

src_c/circle.c

@@ -302,11 +302,56 @@ pg_circle_collidecircle(pgCircleObject *self, PyObject *const *args,
         pgCollision_CircleCircle(&self->circle, &other_circle));
 }
 
+static PyObject *
+pg_circle_colliderect(pgCircleObject *self, PyObject *const *args,
+                      Py_ssize_t nargs)
+{
+    double x, y, w, h;
+
+    if (nargs == 1) {
+        SDL_FRect temp, *tmp;
+        if (!(tmp = pgFRect_FromObject(args[0], &temp))) {
+            return RAISE(PyExc_TypeError,
+                         "Invalid rect, must be RectType or sequence of 4 "
+                         "numbers");
+        }
+        x = (double)tmp->x;
+        y = (double)tmp->y;
+        w = (double)tmp->w;
+        h = (double)tmp->h;
+    }
+    else if (nargs == 2) {
+        if (!pg_TwoDoublesFromObj(args[0], &x, &y) ||
+            !pg_TwoDoublesFromObj(args[1], &w, &h)) {
+            return RAISE(PyExc_TypeError,
+                         "Invalid rect, all 4 fields must be numeric");
+        }
+    }
+    else if (nargs == 4) {
+        if (!pg_DoubleFromObj(args[0], &x) || !pg_DoubleFromObj(args[1], &y) ||
+            !pg_DoubleFromObj(args[2], &w) || !pg_DoubleFromObj(args[3], &h)) {
+            return RAISE(PyExc_TypeError,
+                         "Invalid rect, all 4 fields must be numeric");
+        }
+    }
+    else {
+        PyErr_Format(
+            PyExc_TypeError,
+            "Invalid number of arguments, expected 1, 2 or 4 (got %zd)",
+            nargs);
+        return NULL;
+    }
+
+    return PyBool_FromLong(pgCollision_RectCircle(x, y, w, h, &self->circle));
+}
+
 static struct PyMethodDef pg_circle_methods[] = {
     {"collidepoint", (PyCFunction)pg_circle_collidepoint, METH_FASTCALL,
      DOC_CIRCLE_COLLIDEPOINT},
     {"collidecircle", (PyCFunction)pg_circle_collidecircle, METH_FASTCALL,
      DOC_CIRCLE_COLLIDECIRCLE},
+    {"colliderect", (PyCFunction)pg_circle_colliderect, METH_FASTCALL,
+     DOC_CIRCLE_COLLIDERECT},
     {"update", (PyCFunction)pg_circle_update, METH_FASTCALL,
      DOC_CIRCLE_UPDATE},
     {"__copy__", (PyCFunction)pg_circle_copy, METH_NOARGS, DOC_CIRCLE_COPY},

src_c/collisions.c

@@ -1,14 +1,14 @@
 #include "collisions.h"
 
-static int
+static inline int
 pgCollision_CirclePoint(pgCircleBase *circle, double Cx, double Cy)
 {
     double dx = circle->x - Cx;
     double dy = circle->y - Cy;
     return dx * dx + dy * dy <= circle->r * circle->r;
 }
 
-static int
+static inline int
 pgCollision_CircleCircle(pgCircleBase *A, pgCircleBase *B)
 {
     double dx, dy;
@@ -20,3 +20,16 @@ pgCollision_CircleCircle(pgCircleBase *A, pgCircleBase *B)
 
     return dx * dx + dy * dy <= sum_radi * sum_radi;
 }
+
+static inline int
+pgCollision_RectCircle(double rx, double ry, double rw, double rh,
+                       pgCircleBase *circle)
+{
+    const double cx = circle->x, cy = circle->y;
+    const double r_bottom = ry + rh, r_right = rx + rw;
+
+    const double test_x = (cx < rx) ? rx : ((cx > r_right) ? r_right : cx);
+    const double test_y = (cy < ry) ? ry : ((cy > r_bottom) ? r_bottom : cy);
+
+    return pgCollision_CirclePoint(circle, test_x, test_y);
+}

src_c/collisions.h

@@ -3,10 +3,14 @@
 
 #include "geometry.h"
 
-static int
+static inline int
 pgCollision_CirclePoint(pgCircleBase *circle, double, double);
 
-static int
+static inline int
 pgCollision_CircleCircle(pgCircleBase *, pgCircleBase *);
 
+static inline int
+pgCollision_RectCircle(double rx, double ry, double rw, double rh,
+                       pgCircleBase *circle);
+
 #endif /* ~_PG_COLLISIONS_H */

src_c/doc/geometry_doc.h

@@ -11,5 +11,6 @@
 #define DOC_CIRCLE_CIRCUMFERENCE "circumference -> float\ncircumference of the circle"
 #define DOC_CIRCLE_COLLIDEPOINT "collidepoint((x, y)) -> bool\ncollidepoint(x, y) -> bool\ncollidepoint(Vector2) -> bool\ntest if a point is inside the circle"
 #define DOC_CIRCLE_COLLIDECIRCLE "collidecircle(Circle) -> bool\ncollidecircle(x, y, radius) -> bool\ncollidecircle((x, y), radius) -> bool\ntest if two circles collide"
+#define DOC_CIRCLE_COLLIDERECT "colliderect(Rect) -> bool\ncolliderect((x, y, width, height)) -> bool\ncolliderect(x, y, width, height) -> bool\ncolliderect((x, y), (width, height)) -> bool\nchecks if a rectangle intersects the circle"
 #define DOC_CIRCLE_UPDATE "update((x, y), radius) -> None\nupdate(x, y, radius) -> None\nupdates the circle position and radius"
 #define DOC_CIRCLE_COPY "copy() -> Circle\nreturns a copy of the circle"

src_c/geometry.c

@@ -22,6 +22,11 @@ MODINIT_DEFINE(geometry)
         return NULL;
     }
 
+    import_pygame_rect();
+    if (PyErr_Occurred()) {
+        return NULL;
+    }
+
     if (PyType_Ready(&pgCircle_Type) < 0) {
         return NULL;
     }

test/geometry_test.py

@@ -2,7 +2,7 @@
 import math
 
 from math import sqrt
-from pygame import Vector2, Vector3
+from pygame import Vector2, Vector3, Rect, FRect
 
 from pygame.geometry import Circle
 
@@ -549,6 +549,73 @@ def test_collidecircle(self):
             c5.collidecircle(c), "Expected False, circles should collide here"
         )
 
+    def test_colliderect_argtype(self):
+        """tests if the function correctly handles incorrect types as parameters"""
+        invalid_types = (None, [], "1", (1,), Vector3(1, 1, 1), 1, True, False)
+
+        c = Circle(10, 10, 4)
+
+        for value in invalid_types:
+            with self.assertRaises(TypeError):
+                c.colliderect(value)
+
+    def test_colliderect_argnum(self):
+        """tests if the function correctly handles incorrect number of parameters"""
+        c = Circle(10, 10, 4)
+        args = [(1), (1, 1), (1, 1, 1), (1, 1, 1, 1, 1)]
+        # no params
+        with self.assertRaises(TypeError):
+            c.colliderect()
+
+        # invalid num
+        for arg in args:
+            with self.assertRaises(TypeError):
+                c.colliderect(*arg)
+
+    def test_colliderect(self):
+        """ensures the function correctly detects collisions with rects"""
+
+        msgt = "Expected True, rect should collide here"
+        msgf = "Expected False, rect should not collide here"
+        # ====================================================
+        c = Circle(0, 0, 5)
+
+        r1, r2, r3 = Rect(2, 2, 4, 4), Rect(10, 15, 43, 24), Rect(0, 5, 4, 4)
+        fr1, fr2, fr3 = FRect(r1), FRect(r2), FRect(r3)
+
+        # colliding single
+        for r in (r1, fr1):
+            self.assertTrue(c.colliderect(r), msgt)
+
+        # not colliding single
+        for r in (r2, fr2):
+            self.assertFalse(c.colliderect(r), msgf)
+
+        # barely colliding single
+        for r in (r3, fr3):
+            self.assertTrue(c.colliderect(r), msgt)
+
+        # colliding 4 args
+        self.assertTrue(c.colliderect(2, 2, 4, 4), msgt)
+
+        # not colliding 4 args
+        self.assertFalse(c.colliderect(10, 15, 43, 24), msgf)
+
+        # barely colliding single
+        self.assertTrue(c.colliderect(0, 4.9999999999999, 4, 4), msgt)
+
+        # ensure FRects aren't truncated
+        c2 = Circle(0, 0, 0.35)
+        c3 = Circle(2, 0, 0.65)
+        fr9 = FRect(0.4, 0.0, 1, 1)
+        self.assertFalse(c2.colliderect(fr9), msgf)
+        self.assertFalse(c2.colliderect(0.4, 0.0, 1, 1), msgf)
+        self.assertFalse(c2.colliderect((0.4, 0.0), (1, 1)), msgf)
+
+        self.assertTrue(c3.colliderect(fr9), msgt)
+        self.assertTrue(c3.colliderect(0.4, 0.0, 1, 1), msgt)
+        self.assertTrue(c3.colliderect((0.4, 0.0), (1, 1)), msgt)
+
     def test_update(self):
         """Ensures that updating the circle position
         and dimension correctly updates position and dimension"""