docs(physics2d): Primitives

Engine.Physics2D/Primitives/AABB.cs

@@ -4,16 +4,47 @@ using Syntriax.Engine.Core;
 
 namespace Syntriax.Engine.Physics2D.Primitives;
 
+/// <summary>
+/// Represents an Axis-Aligned Bounding Box (AABB) in 2D space.
+/// </summary>
+/// <param name="lowerBoundary">The lower boundary of the <see cref="AABB"/>.</param>
+/// <param name="upperBoundary">The upper boundary of the <see cref="AABB"/>.</param>
+/// <remarks>
+/// Initializes a new instance of the <see cref="AABB"/> struct with the specified lower and upper boundaries.
+/// </remarks>
 [System.Diagnostics.DebuggerDisplay("LowerBoundary: {LowerBoundary.ToString(), nq}, UpperBoundary: {UpperBoundary.ToString(), nq}")]
-public readonly struct AABB(Vector2D LowerBoundary, Vector2D UpperBoundary)
+public readonly struct AABB(Vector2D lowerBoundary, Vector2D upperBoundary)
 {
-    public readonly Vector2D LowerBoundary { get; init; } = LowerBoundary;
-    public readonly Vector2D UpperBoundary { get; init; } = UpperBoundary;
+    /// <summary>
+    /// The lower boundary of the <see cref="AABB"/>.
+    /// </summary>
+    public readonly Vector2D LowerBoundary = lowerBoundary;
 
+    /// <summary>
+    /// The upper boundary of the <see cref="AABB"/>.
+    /// </summary>
+    public readonly Vector2D UpperBoundary = upperBoundary;
+
+    /// <summary>
+    /// Gets the center point of the <see cref="AABB"/>.
+    /// </summary>
     public readonly Vector2D Center => (LowerBoundary + UpperBoundary) * .5f;
+
+    /// <summary>
+    /// Gets the size of the <see cref="AABB"/>.
+    /// </summary>
     public readonly Vector2D Size => LowerBoundary.FromTo(UpperBoundary).Abs();
+
+    /// <summary>
+    /// Gets half the size of the <see cref="AABB"/>.
+    /// </summary>
     public readonly Vector2D SizeHalf => Size * .5f;
 
+    /// <summary>
+    /// Creates an <see cref="AABB"/> from a collection of <see cref="Vector2D"/>s.
+    /// </summary>
+    /// <param name="vectors">The collection of <see cref="Vector2D"/>s.</param>
+    /// <returns>An <see cref="AABB"/> that bounds all the <see cref="Vector2D"/>s.</returns>
     public static AABB FromVectors(IEnumerable<Vector2D> vectors)
     {
         int counter = 0;
@@ -34,13 +65,33 @@ public readonly struct AABB(Vector2D LowerBoundary, Vector2D UpperBoundary)
         return new(lowerBoundary, upperBoundary);
     }
 
+    /// <summary>
+    /// Checks if two <see cref="AABB"/>s are approximately equal.
+    /// </summary>
+    /// <param name="left">The first <see cref="AABB"/>.</param>
+    /// <param name="right">The second <see cref="AABB"/>.</param>
+    /// <returns><see cref="true"/> if the <see cref="AABB"/>s are approximately equal; otherwise, <see cref="false"/>.</returns>
     public static bool ApproximatelyEquals(AABB left, AABB right)
         => left.LowerBoundary.ApproximatelyEquals(right.LowerBoundary) && left.UpperBoundary.ApproximatelyEquals(right.UpperBoundary);
 }
 
+/// <summary>
+/// Provides extension methods for the <see cref="AABB"/> struct.
+/// </summary>
 public static class AABBExtensions
 {
+    /// <summary>
+    /// Converts a collection of <see cref="Vector2D"/>s to an <see cref="AABB"/>.
+    /// </summary>
+    /// <param name="vectors">The collection of <see cref="Vector2D"/>s.</param>
+    /// <returns>An <see cref="AABB"/> that bounds all the <see cref="Vector2D"/>s.</returns>
     public static AABB ToAABB(this IEnumerable<Vector2D> vectors) => AABB.FromVectors(vectors);
 
+    /// <summary>
+    /// Checks if two <see cref="AABB"/>s are approximately equal.
+    /// </summary>
+    /// <param name="left">The first <see cref="AABB"/>.</param>
+    /// <param name="right">The second <see cref="AABB"/>.</param>
+    /// <returns><see cref="true"/> if the <see cref="AABB"/>s are approximately equal; otherwise, <see cref="false"/>.</returns>
     public static bool ApproximatelyEquals(this AABB left, AABB right) => AABB.ApproximatelyEquals(left, right);
 }