Class Vector2EqualityComparer

Use this class to compare two Vector2 objects for equality with NUnit constraints. Use the static Instance to have the calculation error value set to default 0.0001f. For any other error value, instantiate a new comparer object with the one argument constructor.

Inheritance
object
Vector2EqualityComparer
Implements
Inherited Members
Namespace: UnityEngine.TestTools.Utils
Assembly: UnityEngine.TestRunner.dll
Syntax
public class Vector2EqualityComparer : IEqualityComparer<Vector2>

Constructors

Vector2EqualityComparer(float)

Initializes an instance of Vector2Equality comparer with custom allowed calculation error.

Declaration
public Vector2EqualityComparer(float error)
Parameters
Type Name Description
float error

This value identifies the calculation error allowed.

Properties

Instance

A comparer instance with the default error value set to 0.0001f.

Declaration
public static Vector2EqualityComparer Instance { get; }
Property Value
Type Description
Vector2EqualityComparer

Methods

Equals(Vector2, Vector2)

Compares the actual and expected Vector2 objects for equality using the AreFloatsEqual(float, float, float) method.

Declaration
public bool Equals(Vector2 expected, Vector2 actual)
Parameters
Type Name Description
Vector2 expected

The expected Vector2 used for comparison
Vector2 actual

The actual Vector2 to test
Returns
Type Description
bool

True if the vectors are equals, false otherwise.
Examples

The following example shows how to verify if two Vector2 are equals

[TestFixture]
 public class Vector2Test
 {
     [Test]
     public void VerifyThat_TwoVector2ObjectsAreEqual()
     {
         // Custom calculation error
         var actual = new Vector2(10e-7f, 10e-7f);
         var expected = new Vector2(0f, 0f);
         var comparer = new Vector2EqualityComparer(10e-6f);

         Assert.That(actual, Is.EqualTo(expected).Using(comparer));

         //Default error 0.0001f
         actual = new Vector2(0.01f, 0.01f);
         expected = new Vector2(0.01f, 0.01f);

         Assert.That(actual, Is.EqualTo(expected).Using(Vector2EqualityComparer.Instance));
      }
  }

GetHashCode(Vector2)

Serves as the default hash function.

Declaration
public int GetHashCode(Vector2 vec2)
Parameters
Type Name Description
Vector2 vec2

A not null Vector2
Returns
Type Description
int

Returns 0

Implements