diff --git a/Bonk/AABB.cs b/Bonk/AABB.cs index bc2d1de..0dd4b7c 100644 --- a/Bonk/AABB.cs +++ b/Bonk/AABB.cs @@ -26,11 +26,13 @@ namespace MoonTools.Bonk public float Right { get { return Max.X; } } public float Left { get { return Min.X; } } + /// /// The top of the AABB. Assumes a downward-aligned Y axis, so this value will be smaller than Bottom. /// /// public float Top { get { return Min.Y; } } + /// /// The bottom of the AABB. Assumes a downward-aligned Y axis, so this value will be larger than Top. /// diff --git a/Bonk/NarrowPhase/NarrowPhase.cs b/Bonk/NarrowPhase/NarrowPhase.cs index 4881955..1288e01 100644 --- a/Bonk/NarrowPhase/NarrowPhase.cs +++ b/Bonk/NarrowPhase/NarrowPhase.cs @@ -60,7 +60,7 @@ namespace MoonTools.Bonk } /// - /// Tests if a multishape-transform and shape-transform pair are overlapping. + /// Tests if a multishape-transform and shape-transform pair are overlapping. /// Note that this must perform pairwise comparison so the worst-case performance of this method will vary inversely with the amount of shapes in the multishape. /// /// @@ -78,7 +78,7 @@ namespace MoonTools.Bonk } /// - /// Tests if a multishape-transform and shape-transform pair are overlapping. + /// Tests if a multishape-transform and shape-transform pair are overlapping. /// Note that this must perform pairwise comparison so the worst-case performance of this method will vary inversely with the amount of shapes in the multishape. /// /// @@ -96,7 +96,7 @@ namespace MoonTools.Bonk } /// - /// Tests if two multishape-transform pairs are overlapping. + /// Tests if two multishape-transform pairs are overlapping. /// Note that this must perform pairwise comparison so the worst-case performance of this method will vary inversely with the amount of shapes in the multishapes. /// /// diff --git a/Bonk/Shapes/Point.cs b/Bonk/Shapes/Point.cs index a70bc6a..5efe53d 100644 --- a/Bonk/Shapes/Point.cs +++ b/Bonk/Shapes/Point.cs @@ -4,6 +4,9 @@ using MoonTools.Structs; namespace MoonTools.Bonk { + /// + /// A Point is "that which has not part". All points by themselves are identical. + /// public struct Point : IShape2D, IEquatable { public AABB AABB { get; } diff --git a/Bonk/Shapes/Polygon.cs b/Bonk/Shapes/Polygon.cs index be8b7a8..0fa2970 100644 --- a/Bonk/Shapes/Polygon.cs +++ b/Bonk/Shapes/Polygon.cs @@ -59,7 +59,7 @@ namespace MoonTools.Bonk public bool Equals(IShape2D other) { - return (other is Polygon otherPolygon && Equals(otherPolygon)); + return other is Polygon otherPolygon && Equals(otherPolygon); } public bool Equals(Polygon other) diff --git a/Bonk/SweepTest/SweepResult.cs b/Bonk/SweepTest/SweepResult.cs index 05c6dce..0c2d4ff 100644 --- a/Bonk/SweepTest/SweepResult.cs +++ b/Bonk/SweepTest/SweepResult.cs @@ -5,7 +5,7 @@ namespace MoonTools.Bonk { public struct SweepResult where T : IEquatable { - public static SweepResult False = new SweepResult(); + public readonly static SweepResult False = new SweepResult(); public bool Hit { get; } public Vector2 Motion { get; }