diff options
| author | Andrew Lee <alee14498@protonmail.com> | 2020-04-19 17:19:32 -0400 |
|---|---|---|
| committer | Andrew Lee <alee14498@protonmail.com> | 2020-04-19 17:19:32 -0400 |
| commit | c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78 (patch) | |
| tree | ee4d51c7c1d633e11f46453ef1edd3c77c4ef9f7 /Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md | |
| download | Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.tar.gz Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.tar.bz2 Project-Sandbox-c55fba8ab2a1c9d3df65eda4a5a1e957f4aa1f78.zip | |
Inital commit
Diffstat (limited to 'Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md')
| -rw-r--r-- | Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md new file mode 100644 index 0000000..c55bb07 --- /dev/null +++ b/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md @@ -0,0 +1,46 @@ +# QuaternionEqualityComparer
+
+Use this utility to compare two [Quaternion](https://docs.unity3d.com/ScriptReference/Quaternion.html) objects for equality with [NUnit](http://www.nunit.org/) assertion constraints. Use the static instance `QuaternionEqualityComparer.Instance` to have the default calculation error value set to 0.00001f. For any other custom error value, use the [one argument constructor](#constructors).
+
+## Static properties
+
+| Syntax | Description |
+| ---------- | ---------------------------------------------------------- |
+| `Instance` | A comparer instance with the default error value 0.00001f. |
+
+## Constructors
+
+| Syntax | Description |
+| ------------------------------------------------ | ------------------------------------------------------------ |
+| `QuaternionEqualityComparer(float allowedError)` | Creates an instance of the comparer with a custom allowed error value. |
+
+## Public methods
+
+| Syntax | Description |
+| ----------------------------------------------------- | ------------------------------------------------------------ |
+| `bool Equals(Quaternion expected, Quaternion actual)` | Compares the `actual` and `expected` `Quaternion` objects for equality using the [Quaternion.Dot](https://docs.unity3d.com/ScriptReference/Quaternion.Dot.html) method. |
+
+## Example
+
+```c#
+[TestFixture]
+public class QuaternionTest
+{
+ [Test]
+ public void VerifyThat_TwoQuaternionsAreEqual()
+ {
+ var actual = new Quaternion(10f, 0f, 0f, 0f);
+ var expected = new Quaternion(1f, 10f, 0f, 0f);
+ var comparer = new QuaternionEqualityComparer(10e-6f);
+
+ Assert.That(actual, Is.EqualTo(expected).Using(comparer));
+
+ //Using default error 0.00001f
+ actual = new Quaternion(10f, 0f, 0.1f, 0f);
+ expected = new Quaternion(1f, 10f, 0.1f, 0f);
+
+ Assert.That(actual, Is.EqualTo(expected).Using(QuaternionEqualityComparer.Instance));
+ }
+}
+```
+
|