Include sensor shapes in result from all Space.query methods. #280

Author: viblo

CHANGELOG.rst

@@ -10,13 +10,14 @@ TODO: Add note of new collision handler logic!
 
 This is a big cleanup release with several breaking changes. If you upgrade from an older version, make sure to pay attention, especially the Space.bodies, Space.shapes and shape.constraints updates can break silently! 
 
-Extra thanks for Github user aetle for a number of suggestions and feedback for this Pymunk release!
+Extra thanks for Github user aatle for a number of suggestions and feedback for this Pymunk release!
 
 
 Changes:
 
 Breaking changes
 
+- Unified all Space.query methods to include sensor shapes. Previsouly the nearest methods filtered them out.
 - Changed Space.shapes, Space.bodies and Space.constraints to return a KeysView of instead of a list of the items. Note that this means the returned collection is no longer a copy. To get the old behavior, you can convert to list manually, like list(space.shapes).
 - At least one of the two bodies attached to constraint/joint must be dynamic.  
 - Vec2d now supports bool to test if zero. (bool(Vec2d(2,3) == True) Note this is a breaking change.
@@ -46,7 +47,7 @@ Other improvements
 - Improved documentation in many places (Vec2d, Poly, Shape and more)
 - Internal cleanup of code
 
-Extra thanks for aetle for a number of suggestions for improvements in this pymunk release
+Extra thanks for aatle for a number of suggestions for improvements in this Pymunk release
 
 
 

CITATION.cff

@@ -5,6 +5,6 @@ authors:
     given-names: "Victor"
 title: "Pymunk"
 abstract: "A easy-to-use pythonic rigid body 2d physics library"
-version: 6.11.1
+version: 7.0.0
 date-released: 2025-02-09
 url: "https://pymunk.org"

Munk2D

@@ -32,7 +32,7 @@
 cp = _chipmunk_cffi.lib
 ffi = _chipmunk_cffi.ffi
 
-version = "6.11.1"
+version = "7.0.0"
 
 chipmunk_version = "%s-%s" % (
     ffi.string(cp.cpVersionString).decode("utf-8"),

pymunk/_version.py

@@ -762,13 +762,11 @@ def point_query(
         the point must be a under a certain depth within a shape to be
         considered a match.
 
+        Sensor shapes are included in the result.
+
         See :py:class:`ShapeFilter` for details about how the shape_filter
         parameter can be used.
 
-        .. Note::
-            Sensor shapes are included in the result (In
-            :py:meth:`Space.point_query_nearest` they are not)
-
         :param point: Where to check for collision in the Space
         :type point: :py:class:`~vec2d.Vec2d` or (float,float)
         :param float max_distance: Match only within this distance
@@ -806,8 +804,7 @@ def point_query_nearest(
         parameter can be used.
 
         .. Note::
-            Sensor shapes are not included in the result (In
-            :py:meth:`Space.point_query` they are)
+            Sensor shapes are included in the result. (Changed in Pymunk 7.0)
 
         :param point: Where to check for collision in the Space
         :type point: :py:class:`~vec2d.Vec2d` or (float,float)
@@ -849,9 +846,7 @@ def segment_query(
         See :py:class:`ShapeFilter` for details about how the shape_filter
         parameter can be used.
 
-        .. Note::
-            Sensor shapes are included in the result (In
-            :py:meth:`Space.segment_query_first` they are not)
+        Sensor shapes are included in the result.
 
         :param start: Starting point
         :param end: End point
@@ -892,8 +887,7 @@ def segment_query_first(
         collision detection.
 
         .. Note::
-            Sensor shapes are not included in the result (In
-            :py:meth:`Space.segment_query` they are)
+            Sensor shapes are included in the result. (Changed in Pymunk 7.0)
 
         See :py:class:`ShapeFilter` for details about how the shape_filter
         parameter can be used.
@@ -923,7 +917,6 @@ def bb_query(self, bb: "BB", shape_filter: ShapeFilter) -> list[Shape]:
         The filter is applied to the query and follows the same rules as the
         collision detection.
 
-        .. Note::
             Sensor shapes are included in the result
 
         :param bb: Bounding box
@@ -945,7 +938,6 @@ def bb_query(self, bb: "BB", shape_filter: ShapeFilter) -> list[Shape]:
     def shape_query(self, shape: Shape) -> list[ShapeQueryInfo]:
         """Query a space for any shapes overlapping the given shape
 
-        .. Note::
             Sensor shapes are included in the result
 
         :param shape: Shape to query with

pymunk/space.py

@@ -339,6 +339,42 @@ def testStaticPointQueries(self) -> None:
         self.assertEqual(hits[0].shape, c)
         self._tearDown()
 
+    def testSensorQueries(self) -> None:
+        s = p.Space()
+
+        b1 = p.Body(1, 1)
+        b1.position = 3, 0
+        s1 = p.Circle(b1, 1)
+        s1.sensor = True
+        s.add(b1, s1)
+
+        b2 = p.Body(1, 1)
+        b2.position = 6, 0
+        s2 = p.Circle(b2, 1)
+        s.add(b2, s2)
+
+        print()
+        print("Shapes", s1, s2)
+        r = s.bb_query(p.BB(0, 0, 10, 10), p.ShapeFilter())
+        assert len(r), 2
+
+        r = s.point_query((0, 0), 10, p.ShapeFilter())
+        assert len(r), 2
+
+        r = s.point_query_nearest((0, 0), 10, p.ShapeFilter())
+        assert r != None
+        self.assertEqual(r.shape, s1)
+
+        r = s.shape_query(p.Circle(p.Body(body_type=p.Body.KINEMATIC), 10))
+        assert len(r), 2
+
+        r = s.segment_query((0, 0), (10, 0), 1, p.ShapeFilter())
+        assert len(r), 2
+
+        r = s.segment_query_first((0, 0), (10, 0), 1, p.ShapeFilter())
+        assert r != None
+        self.assertEqual(r.shape, s1)
+
     def testReindexShape(self) -> None:
         s = p.Space()
 

pymunk/tests/test_space.py

@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pymunk"
-version = "6.11.1" # remember to change me for new versions!
+version = "7.0.0" # remember to change me for new versions!
 # Require cffi >1.14.0 since that (and older) has problem with returing structs from functions.
 # Require cffi >= 1.17.1 since older cant work with latest setuptools version
 dependencies = [