added angle_vectors_projected

Author: obucklin

src/compas/geometry/__init__.py

@@ -99,6 +99,7 @@
     angle_points_xy,
     angle_vectors,
     angle_vectors_signed,
+    angle_vectors_projected,
     angle_vectors_xy,
     angles_points,
     angles_points_xy,
@@ -488,6 +489,7 @@
     "angle_points_xy",
     "angle_vectors",
     "angle_vectors_signed",
+    "angle_vectors_projected",
     "angle_vectors_xy",
     "angles_points",
     "angles_points_xy",

src/compas/geometry/_core/angles.py

@@ -147,7 +147,7 @@ def angle_vectors_projected(u, v, normal, deg=False, tol=None):
     Examples
     --------
     >>> normal = [0.0, 0.0, 1.0]
-    >>> angle_vectors_signed([0.0, 1.0, 0.0], [1.0, 0.0, 0.0], normal)
+    >>> angle_vectors_projected([0.0, 1.0, -1.0], [1.0, 0.0, 1.0], normal)
     -1.57079
 
     """

tests/compas/compas_api.json

@@ -263,6 +263,7 @@
       "angle_points_xy",
       "angle_vectors",
       "angle_vectors_signed",
+      "angle_vectors_projected",
       "angle_vectors_xy",
       "angles_points",
       "angles_points_xy",
@@ -648,4 +649,4 @@
       "yellow"
     ]
   }
-}
+}

tests/compas/compas_api_ipy.json

@@ -241,6 +241,7 @@
       "angle_points_xy",
       "angle_vectors",
       "angle_vectors_signed",
+      "angle_vectors_projected",
       "angle_vectors_xy",
       "angles_points",
       "angles_points_xy",
@@ -578,4 +579,4 @@
       "yellow"
     ]
   }
-}
+}

tests/compas/geometry/test_core.py

@@ -10,6 +10,7 @@
 from compas.geometry import angle_planes
 from compas.geometry import angles_vectors
 from compas.geometry import angle_vectors_signed
+from compas.geometry import angle_vectors_projected
 from compas.geometry import centroid_points
 from compas.geometry import centroid_polyhedron
 from compas.geometry import length_vector
@@ -137,6 +138,15 @@ def test_angle_vectors_signed(u, v, normal, result):
     assert TOL.is_close(angle_vectors_signed(u, v, normal), result)
 
 
+@pytest.mark.parametrize(
+    "u,v,normal,result",
+    [
+        ([1, 0, 1], [0, 1, -1], [0, 0, 1], +pi / 2),
+        ([1, 0, 1], [0, 1, -1], [0, 0, -1], -pi / 2),
+    ],
+)
+def test_angle_vectors_projected(u, v, normal, result):
+    assert TOL.is_close(angle_vectors_projected(u, v, normal), result)
 # ==============================================================================
 # average
 # ==============================================================================