Predicates2 new methods addition

AUTHORS.md

@@ -36,3 +36,4 @@
 - Chen Kasirer <<[email protected]>> [@chenkasirer](https://github.com/chenkasirer)
 - Nickolas Maslarinos <<[email protected]>> [@nmaslarinos](https://github.com/nmaslarinos)
 - Katerina Toumpektsi <<[email protected]>> [@katarametin](https://github.com/katarametin)
+- Joelle Baehr-Bruyere <<[email protected]>> [@baehrjo](https://github.com/baehrjo)

CHANGELOG.md

@@ -10,11 +10,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * Added `create_id` to `compas_ghpython.utilities`. (moved from `compas_fab`)
+* Added new predicates in `predicates_2` for points and polygons (XY) : `polygon_to_polygon_relationship_xy`, `point_to_polygon_relationship_xy`, `is_intersection_polygon_polygon_xy`
 
 ### Changed
 
 * Fixed bug that caused a new-line at the end of the `compas.HERE` constant in IronPython for Mac.
 * Fixed Grasshopper `draw_polylines` method to return `PolylineCurve` instead of `Polyline` because the latter shows as only points.
+* Fixed bug in the `is_polygon_in_polygon_xy` that was not correctly generating all the edges of the second polygon before checking for intersections.
 * Fixed uninstall post-process.
 
 ### Removed

src/compas/geometry/predicates/predicates_2.py

@@ -19,6 +19,9 @@
     "is_point_in_convex_polygon_xy",
     "is_point_in_circle_xy",
     "is_polygon_in_polygon_xy",
+    "polygon_to_polygon_relationship_xy",
+    "point_to_polygon_relationship_xy",
+    "is_intersection_polygon_polygon_xy",
     "is_intersection_line_line_xy",
     "is_intersection_segment_segment_xy",
 ]
@@ -383,7 +386,7 @@ def is_polygon_in_polygon_xy(polygon1, polygon2):
         for i in range(len(polygon1)):
             line = [polygon1[-i], polygon1[-i - 1]]
             for j in range(len(polygon2)):
-                line_ = [polygon2[-j], polygon2[j - 1]]
+                line_ = [polygon2[-j], polygon2[-j - 1]]
                 if is_intersection_segment_segment_xy(line, line_):
                     return False
         for pt in polygon2:
@@ -392,6 +395,118 @@ def is_polygon_in_polygon_xy(polygon1, polygon2):
         return False
 
 
+def polygon_to_polygon_relationship_xy(polygon1, polygon2):
+    """Determine if a polygon (polygon1) is inside, intersects, is outside or contains another polygon (polygon2) on the XY-plane.
+
+    Parameters
+    ----------
+    polygon1 : sequence[point] | :class:`~compas.geometry.Polygon`
+        List of XY(Z) coordinates of points representing the locations of the corners of the polygon to examine the position regarding the boundary polygon (Z will be ignored).
+        The vertices are assumed to be in order. The polygon is assumed to be closed:
+        the first and last vertex in the sequence should not be the same.
+    polygon2 : sequence[point] | :class:`~compas.geometry.Polygon`
+        List of XY(Z) coordinates of points representing the locations of the corners of the boundary polygon (Z will be ignored).
+        The vertices are assumed to be in order. The polygon is assumed to be closed:
+        the first and last vertex in the sequence should not be the same.
+
+    Returns
+    -------
+    int
+        1 if polygon1 is inside polygon2.
+        0 if polygon1 intersects polygon2.
+        -1 if polygon1 is outside polygon2.
+        -2 if polygon1 contains polygon2 (polygon2 is inside polygon1).
+    """
+    for i in range(len(polygon1)):
+        line1 = [polygon1[i], polygon1[i - 1]]
+        for j in range(len(polygon2)):
+            line2 = [polygon2[j], polygon2[j - 1]]
+            if is_intersection_segment_segment_xy(line1, line2):
+                return 0
+    for pt in polygon1:
+        if is_point_in_polygon_xy(pt, polygon2):
+            return 1
+    if is_point_in_polygon_xy(polygon2.centroid, polygon1):
+        return -2
+    return -1
+
+
+def point_to_polygon_relationship_xy(point, polygon, tolerance=10**-6):
+    """Determine if a point is inside, outside or on the boundary (with tolerance) of a polygon in the XY-plane.
+
+    Parameters
+    ----------
+    point : [float, float, float] | :class:`~compas.geometry.Point`
+            XY(Z) coordinates of a point (Z will be ignored).
+    polygon : sequence[point] | :class:`~compas.geometry.Polygon`
+        List of XY(Z) coordinates of points representing the locations of the corners of the boundary polygon (Z will be ignored).
+        The vertices are assumed to be in order. The polygon is assumed to be closed:
+        the first and last vertex in the sequence should not be the same.
+
+    Returns
+    -------
+    int
+        1 if point is inside polygon.
+        0 if point is on the boundary of polygon.
+        -1 if point is outside polygon.
+    """
+    x, y = point[0], point[1]
+    polygon = [(p[0], p[1]) for p in polygon]  # make 2D
+    flag = -1
+    for i in range(-1, len(polygon) - 1):
+        x1, y1 = polygon[i]
+        x2, y2 = polygon[i + 1]
+        segment = ([x1, y1], [x2, y2])
+        if is_point_on_segment_xy(point, segment, tolerance):
+            return 0
+        elif y > min(y1, y2):
+            if y <= max(y1, y2):
+                if x <= max(x1, x2):
+                    if y1 != y2:
+                        xinters = (y - y1) * (x2 - x1) / (y2 - y1) + x1
+                    if x1 == x2 or x <= xinters:
+                        flag = -flag
+    return flag
+
+
+def is_intersection_polygon_polygon_xy(polygon1, polygon2):
+    """Determines if two polygons intersect, assuming they lie in the XY plane.
+
+    Parameters
+    ----------
+    polygon1 : sequence[point] | :class:`~compas.geometry.Polygon`
+        A Polygon lying in the XY.
+    polygon2 : sequence[point] | :class:`~compas.geometry.Polygon`
+        A Polygon lying in the XY.
+
+    Returns
+    -------
+    bool
+        True if the polygons intersect. False if they don't.
+
+    Examples
+    --------
+    >>> from compas.geometry import Polygon
+    >>> polygon1 = Polygon([[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [0.0, 1.0]])
+    >>> polygon2 = Polygon([[0.5, 0.5], [1.5, 0.5], [1.5, 1.5], [0.5, 1.5]])
+    >>> is_intersection_polygon_polygon_xy(polygon1, polygon2)
+    True
+
+    >>> from compas.geometry import Polygon
+    >>> polygon1 = Polygon([[0.0, 0.0], [1.0, 0.0], [1.0, 1.0], [0.0, 1.0]])
+    >>> polygon2 = Polygon([[1.5, 1.5], [2.5, 1.5], [2.5, 2.5], [1.5, 2.5]])
+    >>> is_intersection_polygon_polygon_xy(polygon1, polygon2)
+    False
+    """
+    for i in range(len(polygon1)):
+        line1 = [polygon1[i], polygon1[i - 1]]
+        for j in range(len(polygon2)):
+            line2 = [polygon2[j], polygon2[j - 1]]
+            if is_intersection_segment_segment_xy(line1, line2):
+                return True
+    return False
+
+
 def is_intersection_line_line_xy(l1, l2, tol=1e-6):
     """Verifies if two lines intersect on the XY-plane.
 

tests/compas/geometry/predicates/test_predicates_2.py

@@ -1,8 +1,10 @@
 from compas.geometry import Circle
 from compas.geometry import Plane
 from compas.geometry import Point
+from compas.geometry import Polygon
 from compas.geometry import Vector
-from compas.geometry import is_point_in_circle_xy
+from compas.geometry import is_point_in_circle_xy, is_polygon_in_polygon_xy
+from compas.geometry.predicates.predicates_2 import polygon_to_polygon_relationship_xy, point_to_polygon_relationship_xy, is_intersection_polygon_polygon_xy
 
 
 def test_is_point_in_circle_xy():
@@ -24,3 +26,54 @@ def test_is_point_in_circle_xy_class_input():
 
     pt_outside = Point(15, 15, 0)
     assert is_point_in_circle_xy(pt_outside, circle) is False
+
+
+def test_is_polygon_in_polygon_xy():
+    polygon_contour = Polygon([(0, 0, 0), (4, 2, 0), (10, 0, 0), (11, 10, 0), (8, 12, 0), (0, 10, 0)])
+    polygon_inside = Polygon([(5, 5, 0), (10, 5, 0), (10, 10 ,0), (5, 10, 0)])
+    assert is_polygon_in_polygon_xy(polygon_contour, polygon_inside) is True
+
+    polygon_outside = Polygon([(15, 5, 0), (20, 5, 0), (20, 10, 0), (15, 10, 0)])
+    assert is_polygon_in_polygon_xy(polygon_contour, polygon_outside) is False
+
+    polygon_intersecting = Polygon([(10, 10, 0), (10, 5, 0), (15, 5, 0), (15, 10, 0)])
+    assert is_polygon_in_polygon_xy(polygon_contour, polygon_intersecting) is False
+
+    # shifting the vertices list of the same polygon shouldn't affect the containment check output anymore
+    polygon_intersecting_shifted = Polygon(polygon_intersecting[1:] + polygon_intersecting[:1])
+    assert is_polygon_in_polygon_xy(polygon_contour, polygon_intersecting_shifted) is False
+
+
+def test_polygon_to_polygon_relationship_xy():
+    polygon_contour = Polygon([(0, 0, 0), (4, 2, 0), (10, 0, 0), (11, 10, 0), (8, 12, 0), (0, 10, 0)])
+    polygon_inside = Polygon([(5, 5, 0), (10, 5, 0), (10, 10 ,0), (5, 10, 0)])
+    polygon_intersecting = Polygon([(10, 10, 0), (10, 5, 0), (15, 5, 0), (15, 10, 0)])
+    polygon_outside = Polygon([(15, 5, 0), (20, 5, 0), (20, 10, 0), (15, 10, 0)])
+    polygon_containing = Polygon([(-5, -5, 0), (15, -5, 0), (15, 15, 0), (-5, 15, 0)])
+
+    assert polygon_to_polygon_relationship_xy(polygon_inside, polygon_contour) == 1
+    assert polygon_to_polygon_relationship_xy(polygon_intersecting, polygon_contour) == 0
+    assert polygon_to_polygon_relationship_xy(polygon_outside, polygon_contour) == -1
+    assert polygon_to_polygon_relationship_xy(polygon_containing, polygon_contour) == -2
+
+
+def test_point_to_polygon_relationship_xy():
+    polygon = Polygon([(0, 0, 0), (4, 0, 0), (4, 4, 0), (0, 4, 0)])
+    pt_inside = Point(1, 2, 0)
+    pt_boundary = Point(2, 0, 0)
+    pt_outside = Point(5, 5, 0)
+
+    assert point_to_polygon_relationship_xy(pt_inside, polygon) == 1
+    assert point_to_polygon_relationship_xy(pt_boundary, polygon) == 0
+    assert point_to_polygon_relationship_xy(pt_outside, polygon) == -1
+
+
+def test_is_intersection_polygon_polygon_xy():
+    polygon_contour = Polygon([(0, 0, 0), (4, 2, 0), (10, 0, 0), (11, 10, 0), (8, 12, 0), (0, 10, 0)])
+    polygon_inside = Polygon([(5, 5, 0), (10, 5, 0), (10, 10 ,0), (5, 10, 0)])
+    polygon_intersecting = Polygon([(10, 10, 0), (10, 5, 0), (15, 5, 0), (15, 10, 0)])
+    polygon_outside = Polygon([(15, 5, 0), (20, 5, 0), (20, 10, 0), (15, 10, 0)])
+
+    assert is_intersection_polygon_polygon_xy(polygon_inside, polygon_contour) is False
+    assert is_intersection_polygon_polygon_xy(polygon_intersecting, polygon_contour) is True
+    assert is_intersection_polygon_polygon_xy(polygon_outside, polygon_contour) is False