Add tests for Plane.Raycast() extension

Exanite · Jul 4, 2024 · f1a2a82 · f1a2a82
1 parent fdaaccb
commit f1a2a82
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 2 deletions.
diff --git a/Tests/Utilities/MathUtilityTests.cs b/Tests/Utilities/MathUtilityTests.cs
@@ -3,6 +3,7 @@
 #endif
 
 using System.Numerics;
+using Exanite.Core.Numerics;
 using Exanite.Core.Utilities;
 using NUnit.Framework;
 
@@ -79,5 +80,32 @@ public void CreatePlane_ReturnsExpectedResult2()
             Assert.IsTrue(MathUtility.IsApproximatelyEqual(-1, plane.D));
             Assert.IsTrue(MathUtility.IsApproximatelyEqual(Vector3.UnitX, plane.Normal));
         }
+
+        [TestCase]
+        public void PlaneRaycast_ReturnsExpectedResult1()
+        {
+            var expectedDistance = 10;
+            var expectedPosition = new Vector2(1, 2);
+
+            var plane = MathUtility.CreatePlane(Vector3.UnitZ, Vector3.Zero);
+            var ray = new Ray(new Vector3(expectedPosition.X, expectedPosition.Y, -expectedDistance), Vector3.UnitZ, 0);
+
+            var isHit = plane.Raycast(ray, out var distance);
+
+            Assert.IsTrue(isHit);
+            Assert.IsTrue(MathUtility.IsApproximatelyEqual(expectedDistance, distance));
+            Assert.IsTrue(MathUtility.IsApproximatelyEqual(expectedPosition.Xy0(), ray.GetPoint(distance)));
+        }
+
+        [TestCase]
+        public void PlaneRaycast_ReturnsExpectedResult2()
+        {
+            var plane = MathUtility.CreatePlane(Vector3.UnitZ, Vector3.Zero);
+            var ray = new Ray(new Vector3(1, 2, -10), -Vector3.UnitZ, 0);
+
+            var isHit = plane.Raycast(ray, out _);
+
+            Assert.IsFalse(isHit);
+        }
     }
 }
diff --git a/Utilities/MathUtility.cs b/Utilities/MathUtility.cs
@@ -286,21 +286,26 @@ public static Plane CreatePlane(Vector3 normal, Vector3 position)
             return new Plane(normal, distance);
         }
 
+        /// <summary>
+        /// Casts a ray against the specified plane.
+        /// <para/>
+        /// The ray's length is ignored during this check.
+        /// </summary>
         public static bool Raycast(this Plane plane, Ray ray, out float distance)
         {
             var vdot = Vector3.Dot(ray.Direction, plane.Normal);
             var ndot = -Vector3.Dot(ray.Origin, plane.Normal) - plane.D;
 
             if (IsApproximatelyEqual(vdot, 0f))
             {
-                distance = 0.0F;
+                distance = 0f;
 
                 return false;
             }
 
             distance = ndot / vdot;
 
-            return distance > 0.0F;
+            return distance > 0f;
         }
 
         #endregion