Merge pull request #1118 from katarametin/fixed_is_point_in_circle_xy

Fixed `is_point_in_circle_xy` second argument to access the origin of…

Author: gonzalocasas

AUTHORS.md

@@ -35,3 +35,4 @@
 - Gene Ting-Chun Kao <<[email protected]>> [@GeneKao](https://github.com/GeneKao)
 - 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)

CHANGELOG.md

@@ -29,7 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Fixed serialization of sphere and cylinder Breps in `RhinoBrep`.
 * Fixed serialization of some trimmed shapes in `RhinoBrep`.
 * Freeze black version to 22.12.0.
-
+* Fixed `is_point_in_circle_xy` second argument to access the origin of the plane of the circle.
+ 
 ### Removed
 
 

CONTRIBUTING.md

@@ -36,8 +36,13 @@ In short, this is how that works.
    invoke test
    ```
 
-5. Start making your changes to the **master** branch (or branch off of it).
-6. Auto-format your code using `black <path_to_source_file>`.
+5. Start making your changes to the **main** branch (or branch off of it).
+6. Auto-format your code using:
+
+   ```bash
+   invoke format
+   ```
+
 7. Make sure all tests still pass:
 
    ```bash

src/compas/geometry/_core/constructors.py

@@ -34,12 +34,8 @@ def circle_from_points(a, b, c):
 
     Returns
     -------
-    [float, float, float]
-        Center of the circle.
-    float
-        Radius of the circle.
-    [float, float, float]
-        Normal of the plane containing the circle.
+    ([float, float, float], [float, float, float]), float
+        Center, normal and radius of the circle respectively.
 
     Notes
     -----
@@ -71,7 +67,7 @@ def circle_from_points(a, b, c):
     Cc = scale_vector(c, C)
     center = sum_vectors([Aa, Bb, Cc])
     radius = length_vector(subtract_vectors(a, center))
-    return center, radius, normal
+    return (center, normal), radius
 
 
 def circle_from_points_xy(a, b, c):
@@ -88,12 +84,8 @@ def circle_from_points_xy(a, b, c):
 
     Returns
     -------
-    [float, float, 0.0]
-        Center of the circle in the XY plane.
-    float
-        Radius of the circle.
-    [0.0, 0.0, 1.0]
-        Normal of the plane containing the circle.
+    ([float, float, float], [float, float, float]), float
+        Center, normal and radius of the circle respectively.
 
     Notes
     -----
@@ -124,4 +116,4 @@ def circle_from_points_xy(a, b, c):
     centerx = (d * e - b * f) / g
     centery = (a * f - c * e) / g
     radius = sqrt((ax - centerx) ** 2 + (ay - centery) ** 2)
-    return [centerx, centery, 0.0], radius, [0.0, 0.0, 1.0]
+    return ([centerx, centery, 0.0], [0.0, 0.0, 1.0]), radius

src/compas/geometry/predicates/predicates_2.py

@@ -337,7 +337,7 @@ def is_point_in_circle_xy(point, circle):
     ----------
     point : [float, float, float] | :class:`~compas.geometry.Point`
         XY(Z) coordinates of a point (Z will be ignored).
-    circle : [point, float]
+    circle : [[point, vector], float] | :class:`~compas.geometry.Circle`
         Center and radius of the circle on the XY plane.
 
     Returns
@@ -347,7 +347,7 @@ def is_point_in_circle_xy(point, circle):
         False otherwise.
 
     """
-    dis = distance_point_point_xy(point, circle[0])
+    dis = distance_point_point_xy(point, circle[0][0])
     if dis <= circle[1]:
         return True
     return False

tests/compas/geometry/predicates/test_predicates_2.py

@@ -0,0 +1,26 @@
+from compas.geometry import Circle
+from compas.geometry import Plane
+from compas.geometry import Point
+from compas.geometry import Vector
+from compas.geometry import is_point_in_circle_xy
+
+
+def test_is_point_in_circle_xy():
+    pt = [1, 2, 0]  # only testing in xy
+    circle = [[[2, 2, 10], [0, 0, 1]], 4.7]
+
+    assert is_point_in_circle_xy(pt, circle) is True
+
+    pt_outside = [15, 15, 0]
+    assert is_point_in_circle_xy(pt_outside, circle) is False
+
+
+def test_is_point_in_circle_xy_class_input():
+    pt_inside = Point(1, 2, 0)
+    plane = Plane(Point(2, 2, 10), Vector(0, 0, 1))
+    radius = 4.7
+    circle = Circle(plane, radius)
+    assert is_point_in_circle_xy(pt_inside, circle) is True
+
+    pt_outside = Point(15, 15, 0)
+    assert is_point_in_circle_xy(pt_outside, circle) is False