From 2b19b24a263a6756c0a06fcc4af1d7d8a105aabd Mon Sep 17 00:00:00 2001
From: Syntriax <syntriax@gmail.com>
Date: Thu, 1 Feb 2024 12:26:28 +0300
Subject: [PATCH] docs(physics2d): Abstract

---
 .../Abstract/ICircleCollider2D.cs             | 10 ++++++++
 Engine.Physics2D/Abstract/ICollider2D.cs      | 23 +++++++++++++++++++
 .../Abstract/ICollisionDetector2D.cs          | 12 ++++++++++
 .../Abstract/ICollisionResolver2D.cs          |  7 ++++++
 Engine.Physics2D/Abstract/IPhysicsEngine2D.cs | 10 ++++++++
 .../Abstract/IPhysicsMaterial2D.cs            | 10 ++++++++
 Engine.Physics2D/Abstract/IRigidBody2D.cs     | 20 ++++++++++++++++
 Engine.Physics2D/Abstract/IShapeCollider2D.cs | 11 +++++++++
 8 files changed, 103 insertions(+)

diff --git a/Engine.Physics2D/Abstract/ICircleCollider2D.cs b/Engine.Physics2D/Abstract/ICircleCollider2D.cs
index 2391e53..a41820f 100644
--- a/Engine.Physics2D/Abstract/ICircleCollider2D.cs
+++ b/Engine.Physics2D/Abstract/ICircleCollider2D.cs
@@ -2,8 +2,18 @@ using Syntriax.Engine.Physics2D.Primitives;
 
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+/// <summary>
+/// Represents a <see cref="ICollider2D"/> with the shape of a <see cref="Circle"/>.
+/// </summary>
 public interface ICircleCollider2D : ICollider2D
 {
+    /// <summary>
+    /// The local <see cref="Circle"/> shape of the <see cref="ICollider2D"/>.
+    /// </summary>
     Circle CircleLocal { get; set; }
+
+    /// <summary>
+    /// The world space representation of the <see cref="Circle"/> shape.
+    /// </summary>
     Circle CircleWorld { get; }
 }
diff --git a/Engine.Physics2D/Abstract/ICollider2D.cs b/Engine.Physics2D/Abstract/ICollider2D.cs
index 5d2a5ff..8663860 100644
--- a/Engine.Physics2D/Abstract/ICollider2D.cs
+++ b/Engine.Physics2D/Abstract/ICollider2D.cs
@@ -4,15 +4,38 @@ using Syntriax.Engine.Core.Abstract;
 
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+/// <summary>
+/// Represents a 2D collider.
+/// </summary>
 public interface ICollider2D : IBehaviour, IAssignableTransform
 {
+    /// <summary>
+    /// Event triggered when a collision is detected.
+    /// </summary>
     Action<ICollider2D, CollisionDetectionInformation>? OnCollisionDetected { get; set; }
+
+    /// <summary>
+    /// Event triggered when a collision is resolved.
+    /// </summary>
     Action<ICollider2D, CollisionDetectionInformation>? OnCollisionResolved { get; set; }
 
+    /// <summary>
+    /// Event triggered when another <see cref="ICollider2D"/> triggers this <see cref="ICollider2D"/>.
+    /// </summary>
     Action<ICollider2D, ICollider2D>? OnTriggered { get; set; }
 
+    /// <summary>
+    /// The <see cref="IRigidBody2D"/> associated with the <see cref="ICollider2D"/>.
+    /// </summary>
     IRigidBody2D? RigidBody2D { get; }
+
+    /// <summary>
+    /// The value indicating whether the <see cref="ICollider2D"/> is a trigger.
+    /// </summary>
     bool IsTrigger { get; set; }
 
+    /// <summary>
+    /// Recalculates <see cref="ICollider2D"/> properties.
+    /// </summary>
     void Recalculate();
 }
diff --git a/Engine.Physics2D/Abstract/ICollisionDetector2D.cs b/Engine.Physics2D/Abstract/ICollisionDetector2D.cs
index d76da2a..63e89e4 100644
--- a/Engine.Physics2D/Abstract/ICollisionDetector2D.cs
+++ b/Engine.Physics2D/Abstract/ICollisionDetector2D.cs
@@ -2,7 +2,19 @@ using Syntriax.Engine.Physics2D.Abstract;
 
 namespace Syntriax.Engine.Physics2D;
 
+/// <summary>
+/// Represents a 2D collision detector.
+/// </summary>
 public interface ICollisionDetector2D
 {
+    /// <summary>
+    /// Attempts to detect a collision between two <see cref="ICollider2D"/>s.
+    /// </summary>
+    /// <typeparam name="T1">Type of the first <see cref="ICollider2D"/>.</typeparam>
+    /// <typeparam name="T2">Type of the second <see cref="ICollider2D"/>.</typeparam>
+    /// <param name="left">The first <see cref="ICollider2D"/>.</param>
+    /// <param name="right">The second <see cref="ICollider2D"/>.</param>
+    /// <param name="collisionInformation">Information about the collision.</param>
+    /// <returns><see cref="true"/> if a collision is detected, otherwise <see cref="false"/>.</returns>
     bool TryDetect<T1, T2>(T1 left, T2 right, out CollisionDetectionInformation collisionInformation) where T1 : ICollider2D where T2 : ICollider2D;
 }
diff --git a/Engine.Physics2D/Abstract/ICollisionResolver2D.cs b/Engine.Physics2D/Abstract/ICollisionResolver2D.cs
index 05672a0..17fd4fd 100644
--- a/Engine.Physics2D/Abstract/ICollisionResolver2D.cs
+++ b/Engine.Physics2D/Abstract/ICollisionResolver2D.cs
@@ -1,6 +1,13 @@
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+/// <summary>
+/// Represents a 2D collision resolver.
+/// </summary>
 public interface ICollisionResolver2D
 {
+    /// <summary>
+    /// Resolves collisions based on collision detection information provided.
+    /// </summary>
+    /// <param name="collisionInformation">Information about the collision.</param>
     void Resolve(CollisionDetectionInformation collisionInformation);
 }
diff --git a/Engine.Physics2D/Abstract/IPhysicsEngine2D.cs b/Engine.Physics2D/Abstract/IPhysicsEngine2D.cs
index 36bd191..d2ad40e 100644
--- a/Engine.Physics2D/Abstract/IPhysicsEngine2D.cs
+++ b/Engine.Physics2D/Abstract/IPhysicsEngine2D.cs
@@ -1,8 +1,18 @@
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+/// <summary>
+/// Represents a 2D physics engine.
+/// </summary>
 public interface IPhysicsEngine2D
 {
+    /// <summary>
+    /// The number of iterations the <see cref="IPhysicsEngine2D"/> performs per step.
+    /// </summary>
     int IterationCount { get; set; }
 
+    /// <summary>
+    /// Advances the physics simulation by the specified time.
+    /// </summary>
+    /// <param name="deltaTime">The time step.</param>
     void Step(float deltaTime);
 }
diff --git a/Engine.Physics2D/Abstract/IPhysicsMaterial2D.cs b/Engine.Physics2D/Abstract/IPhysicsMaterial2D.cs
index c533cda..6019a91 100644
--- a/Engine.Physics2D/Abstract/IPhysicsMaterial2D.cs
+++ b/Engine.Physics2D/Abstract/IPhysicsMaterial2D.cs
@@ -1,7 +1,17 @@
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+/// <summary>
+/// Represents a 2D physics object's responsive attributes.
+/// </summary>
 public interface IPhysicsMaterial2D
 {
+    /// <summary>
+    /// The friction coefficient of the physics object.
+    /// </summary>
     float Friction { get; }
+
+    /// <summary>
+    /// The restitution (bounciness) coefficient of the physics object.
+    /// </summary>
     float Restitution { get; }
 }
diff --git a/Engine.Physics2D/Abstract/IRigidBody2D.cs b/Engine.Physics2D/Abstract/IRigidBody2D.cs
index ef8a5c2..9b8b68c 100644
--- a/Engine.Physics2D/Abstract/IRigidBody2D.cs
+++ b/Engine.Physics2D/Abstract/IRigidBody2D.cs
@@ -3,13 +3,33 @@ using Syntriax.Engine.Core.Abstract;
 
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+/// <summary>
+/// Represents a 2D rigid body in the engine.
+/// </summary>
 public interface IRigidBody2D : IBehaviour, IAssignableTransform
 {
+    /// <summary>
+    /// The physics material of the <see cref="IRigidBody2D"/>.
+    /// </summary>
     IPhysicsMaterial2D Material { get; set; }
 
+    /// <summary>
+    /// The velocity of the <see cref="IRigidBody2D"/>.
+    /// </summary>
     Vector2D Velocity { get; set; }
+
+    /// <summary>
+    /// The angular velocity (rotation rate) of the <see cref="IRigidBody2D"/>.
+    /// </summary>
     float AngularVelocity { get; set; }
 
+    /// <summary>
+    /// The mass of the <see cref="IRigidBody2D"/>.
+    /// </summary>
     float Mass { get; set; }
+
+    /// <summary>
+    /// The value indicating whether the <see cref="IRigidBody2D"/> is static/immovable.
+    /// </summary>
     bool IsStatic { get; set; }
 }
diff --git a/Engine.Physics2D/Abstract/IShapeCollider2D.cs b/Engine.Physics2D/Abstract/IShapeCollider2D.cs
index 2cc5218..96d4d1f 100644
--- a/Engine.Physics2D/Abstract/IShapeCollider2D.cs
+++ b/Engine.Physics2D/Abstract/IShapeCollider2D.cs
@@ -2,8 +2,19 @@ using Syntriax.Engine.Physics2D.Primitives;
 
 namespace Syntriax.Engine.Physics2D.Abstract;
 
+
+/// <summary>
+/// Represents a <see cref="ICollider2D"/> with a custom <see cref="Shape"/>.
+/// </summary>
 public interface IShapeCollider2D : ICollider2D
 {
+    /// <summary>
+    /// Gets or sets the local <see cref="Shape"/> of the <see cref="ICollider2D"/>.
+    /// </summary>
     Shape ShapeLocal { get; set; }
+
+    /// <summary>
+    /// Gets the world space representation of the <see cref="Shape"/>.
+    /// </summary>
     Shape ShapeWorld { get; }
 }