docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Vector4EqualityComparer

    Use this class to compare two Vector4 objects for equality with NUnit constraints. Call Vector4EqualityComparer.Instance to perform comparisons using default calculation error value 0.0001f. To set a custom test value, instantiate a new comparer using the one argument constructor.

    Inheritance
    object
    Vector4EqualityComparer
    Implements
    IEqualityComparer<Vector4>
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.TestTools.Utils
    Assembly: UnityEngine.TestRunner.dll
    Syntax
    public class Vector4EqualityComparer : IEqualityComparer<Vector4>

    Constructors

    Vector4EqualityComparer(float)

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

    Declaration
    public Vector4EqualityComparer(float allowedError)
    Parameters
    Type Name Description
    float allowedError

    This value identifies the calculation error allowed.

    Properties

    Instance

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

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

    Methods

    Equals(Vector4, Vector4)

    Compares the actual and expected Vector4 objects for equality using AreFloatsEqual(float, float, float) to compare the x, y, z, and w attributes of Vector4.

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

    The expected Vector4 used for comparison

    Vector4 actual

    The actual Vector4 to test

    Returns
    Type Description
    bool

    True if the vectors are equals, false otherwise.

    Examples
    [TestFixture]
     public class Vector4Test
     {
         [Test]
         public void VerifyThat_TwoVector4ObjectsAreEqual()
         {
             // Custom error 10e-6f
             var actual = new Vector4(0, 0, 1e-6f, 1e-6f);
             var expected = new Vector4(1e-6f, 0f, 0f, 0f);
             var comparer = new Vector4EqualityComparer(10e-6f);
    
             Assert.That(actual, Is.EqualTo(expected).Using(comparer));
    
             // Default error 0.0001f
             actual = new Vector4(0.01f, 0.01f, 0f, 0f);
             expected = new Vector4(0.01f, 0.01f, 0f, 0f);
    
             Assert.That(actual, Is.EqualTo(expected).Using(Vector4EqualityComparer.Instance));
         }
     }

    GetHashCode(Vector4)

    Serves as the default hash function.

    Declaration
    public int GetHashCode(Vector4 vec4)
    Parameters
    Type Name Description
    Vector4 vec4

    A not null Vector4 object

    Returns
    Type Description
    int

    Returns 0

    Implements

    IEqualityComparer<T>
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)