summaryrefslogtreecommitdiff
path: root/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md
diff options
context:
space:
mode:
authorAndrew Lee <alee14498@protonmail.com>2020-04-20 19:09:33 -0400
committerAndrew Lee <alee14498@protonmail.com>2020-04-20 19:09:33 -0400
commit7c1e566113d59699af1624186c64eca67f063fc6 (patch)
tree5a6850a695986872d5d0b09d7dab8421628fe33e /Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md
parentdd117b77aae1d8be7563b360d05b842a73b7dab2 (diff)
downloadProject-Sandbox-7c1e566113d59699af1624186c64eca67f063fc6.tar.gz
Project-Sandbox-7c1e566113d59699af1624186c64eca67f063fc6.tar.bz2
Project-Sandbox-7c1e566113d59699af1624186c64eca67f063fc6.zip
Upgraded Unity
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.md46
1 files changed, 0 insertions, 46 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
deleted file mode 100644
index c55bb07..0000000
--- a/Library/PackageCache/com.unity.test-framework@1.1.11/Documentation~/reference-comparer-quaternion.md
+++ /dev/null
@@ -1,46 +0,0 @@
-# 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));
- }
-}
-```
-