Make color equality exact

space-wizards · Jun 23, 2024 · eeca1f6 · eeca1f6
1 parent e2cf4ee
commit eeca1f6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 13 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -35,7 +35,7 @@ END TEMPLATE-->
 
 ### Breaking changes
 
-*None yet*
+* The `Color` struct's equality methods now check for exact equality. Use `MathHelper.CloseToPercent(Color, Color)` for the previous functionality.
 
 ### New features
 

diff --git a/Robust.Shared.Maths/Color.cs b/Robust.Shared.Maths/Color.cs
@@ -997,12 +997,7 @@ public readonly string ToHexNoAlpha()
         /// <param name="other">The Color structure to compare to.</param>
         /// <returns>True if both Color structures contain the same components; false otherwise.</returns>
         public readonly bool Equals(Color other)
-        {
-            // TODO COLOR why is this approximate
-            // This method literally doesn't do what its docstring says it does.
-            // If people wanted approximate equality, they can check that manually.
-            return MathHelper.CloseToPercent(this, other);
-        }
+            => RGBA == other.RGBA;
 
         [PublicAPI]
         public enum BlendFactor : byte

diff --git a/Robust.UnitTesting/Shared/Maths/Color_Test.cs b/Robust.UnitTesting/Shared/Maths/Color_Test.cs
@@ -344,7 +344,7 @@ public void ToFromSrgb([ValueSource(nameof(FourFloatsSource))] (float, float, fl
             var controlColor = new Color(rf, gf, bf, af);
             var color = Color.FromSrgb(Color.ToSrgb(controlColor));
 
-            Assert.That(color, Is.EqualTo(controlColor));
+            Assert.That(MathHelper.CloseToPercent(color, controlColor));
         }
 
         [Test]
@@ -355,7 +355,7 @@ public void ToFromHsl([ValueSource(nameof(FourFloatsSource))] (float, float, flo
             var controlColor = new Color(rf, gf, bf, af);
             var color = Color.FromHsl(Color.ToHsl(controlColor));
 
-            Assert.That(color, Is.EqualTo(controlColor));
+            Assert.That(MathHelper.CloseToPercent(color, controlColor));
         }
 
         [Test]
@@ -366,7 +366,7 @@ public void ToFromHsv([ValueSource(nameof(FourFloatsSource))] (float, float, flo
             var controlColor = new Color(rf, gf, bf, af);
             var color = Color.FromHsv(Color.ToHsv(controlColor));
 
-            Assert.That(color, Is.EqualTo(controlColor));
+            Assert.That(MathHelper.CloseToPercent(color, controlColor));
         }
 
         [Test]
@@ -393,7 +393,7 @@ public void ToFromYcbcr([ValueSource(nameof(FourFloatsSource))] (float, float, f
             var controlColor = new Color(rf, gf, bf, af);
             var color = Color.FromYcbcr(Color.ToYcbcr(controlColor));
 
-            Assert.That(color, Is.EqualTo(controlColor));
+            Assert.That(MathHelper.CloseToPercent(color, controlColor));
         }
 
         [Test]
@@ -404,7 +404,7 @@ public void ToFromHcy([ValueSource(nameof(FourFloatsSource))] (float, float, flo
             var controlColor = new Color(rf, gf, bf, af);
             var color = Color.FromHcy(Color.ToHcy(controlColor));
 
-            Assert.That(color, Is.EqualTo(controlColor));
+            Assert.That(MathHelper.CloseToPercent(color, controlColor));
         }
 
         static IEnumerable<float> InterpolationValues => new float[]
@@ -430,7 +430,7 @@ public void InterpolateBetween([ValueSource(nameof(FourFloatsSource))] (float, f
             var interColor = Color.InterpolateBetween(color1, color2, interpolation);
             var inverseInterColor = Color.InterpolateBetween(color2, color1, 1 - interpolation);
 
-            Assert.That(interColor, Is.EqualTo(inverseInterColor));
+            Assert.That(MathHelper.CloseToPercent(interColor, inverseInterColor));
         }
 
         [Test]