Merge main into feature/XRI3 (#1050)

Merge main into feature/XRI3

Author: keveleigh

org.mixedrealitytoolkit.core/CHANGELOG.md

@@ -47,6 +47,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## Unreleased 3.x
 
+### Changed
+
+* Updated tests to follow existing MRTK test patterns. [PR #1046](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1046)
+
 ### Fixed
 
 * Fixed broken project validation help link, for item 'MRTK3 profile may need to be assigned for the Standalone build target' (Issue #882) [PR #886](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/886)

org.mixedrealitytoolkit.core/Tests/Runtime/InteractableEventRouterTests.cs

@@ -4,6 +4,7 @@
 // Disable "missing XML comment" warning for tests. While nice to have, this documentation is not required.
 #pragma warning disable CS1591
 
+using MixedReality.Toolkit.Core.Tests;
 using MixedReality.Toolkit.Experimental;
 using NUnit.Framework;
 using System.Collections;
@@ -17,7 +18,7 @@ namespace MixedReality.Toolkit.UX.Runtime.Tests
     /// <summary>
     /// Tests for the <see cref="InteractableEventRouter"/> class.
     /// </summary>
-    public class InteractableEventRouterTests : MonoBehaviour
+    public class InteractableEventRouterTests : BaseRuntimeTests
     {
         private GameObject level0 = null;
         private GameObject interactorObject = null;
@@ -39,7 +40,7 @@ public class InteractableEventRouterTests : MonoBehaviour
 
         /// <summary>
         /// A cached reference to the <see cref="XRInteractionManager"/> in the scene.
-        /// Cleared during <see cref="Teardown"/> at the end of each test.
+        /// Cleared during <see cref="TearDown"/> at the end of each test.
         /// </summary>
         private XRInteractionManager CachedInteractionManager
         {
@@ -53,18 +54,17 @@ private XRInteractionManager CachedInteractionManager
             }
         }
 
-        [SetUp]
-        public void Init()
+        public override IEnumerator Setup()
         {
+            yield return base.Setup();
             CreateTestObjectsWithEventRouter();
         }
 
-        [TearDown]
-        public void Teardown()
+        public override IEnumerator TearDown()
         {
             if (level0 != null)
             {
-                Destroy(level0);
+                Object.Destroy(level0);
             }
 
             interactorObject = null;
@@ -81,6 +81,8 @@ public void Teardown()
             level1_testInteractableParent = null;
             level2_statefulInteractableChild = null;
             level2_testInteractableChild = null;
+
+            yield return base.TearDown();
         }
 
         [UnityTest]
@@ -271,7 +273,7 @@ public IEnumerator MultipleInteractableEventRoutersOnlyOneBubbledEventTest()
         {
             var levelA = new GameObject("level a");
             var levelB = new GameObject("level b");
- 
+
             // Setup level b 
             levelB.AddComponent<StatefulInteractable>();
             var levelB_testInteractableParent = levelB.AddComponent<TestInteractableParent>();
@@ -303,7 +305,7 @@ public IEnumerator MultipleInteractableEventRoutersOnlyOneBubbledEventTest()
             Assert.AreEqual(1, levelB_testInteractableParent.ChildSelectExitedCount, "The child select exited event should have occurred once.");
 
 
-            Destroy(levelA);
+            Object.Destroy(levelA);
             level0 = null;
             level1 = null;
             level2 = null;
@@ -347,7 +349,7 @@ public IEnumerator MultipleInteractableEventRoutersOnlyOneTrickledEventTest()
             Assert.AreEqual(1, level2_testInteractableChild.ParentSelectExitedCount, "The parent select exited event should have occurred once.");
 
 
-            Destroy(levelA);
+            Object.Destroy(levelA);
             level0 = null;
             level1 = null;
             level2 = null;

org.mixedrealitytoolkit.input/Assets/Default Configs/MRTKSyntheticHandsConfig.asset

@@ -49,7 +49,7 @@ MonoBehaviour:
       m_Interactions: 
       m_SingletonActionBindings: []
       m_Flags: 0
-    m_Reference: {fileID: -6131295136447488360, guid: 18c412191cdc9274897f101c7fd5316f, type: 3}
+    m_Reference: {fileID: -294446728694031702, guid: 18c412191cdc9274897f101c7fd5316f, type: 3}
   rightHandPosition:
     m_UseReference: 1
     m_Action:
@@ -85,4 +85,4 @@ MonoBehaviour:
       m_Interactions: 
       m_SingletonActionBindings: []
       m_Flags: 0
-    m_Reference: {fileID: 187161793506945269, guid: 18c412191cdc9274897f101c7fd5316f, type: 3}
+    m_Reference: {fileID: 2995356199736570127, guid: 18c412191cdc9274897f101c7fd5316f, type: 3}

org.mixedrealitytoolkit.input/CHANGELOG.md

@@ -9,6 +9,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 * Added a project validation rule to ensure the Unity XR Hands subsystem is enabled in the OpenXR settings when the corresponding MRTK subsystem is enabled. [PR #973](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/973)
 * Added support for Unity's com.unity.cloud.gltfast and com.unity.cloud.ktx packages when loading controller models. [PR #631](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/631)
 * Added toggle for frame rate independent smoothing in camera simulation. [PR #1011](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1011)
+* Added implementation for the synthesized TriggerButton, accounting for animation smoothing. [PR #1043](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1043)
+* Added a "squeeze" alias for the grip states, to account for broader input action mapping support. [PR #1043](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1043)
 
 ### Fixed
 
@@ -17,6 +19,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 ### Changed
 
 * Updated the minimum editor version to 2022.3.6f1 [PR #1003](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1003)
+* Updated tests to follow existing MRTK test patterns. [PR #1046](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1046)
+* Remapped the synthetic hands config to read the float "select value" action instead of the bool "select" action, since it's read as a float. [PR #1043](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1043)
 
 ### Removed
 

org.mixedrealitytoolkit.input/Controllers/ArticulatedHandController.cs

@@ -78,15 +78,8 @@ protected override void UpdateInput(XRControllerState controllerState)
                 // If we still don't have an aggregator, then don't update selects.
                 if (XRSubsystemHelpers.HandsAggregator == null) { return; }
 
-                bool gotPinchData = XRSubsystemHelpers.HandsAggregator.TryGetPinchProgress(
-                    handNode,
-                    out bool isPinchReady,
-                    out bool isPinching,
-                    out float pinchAmount
-                );
-
                 // If we got pinch data, write it into our select interaction state.
-                if (gotPinchData)
+                if (XRSubsystemHelpers.HandsAggregator.TryGetPinchProgress(handNode, out bool isPinchReady, out _, out float pinchAmount))
                 {
                     // Workaround for missing select actions on devices without interaction profiles
                     // for hands, such as Varjo and Quest. Should be removed once we have universal

org.mixedrealitytoolkit.input/Simulation/Devices/MRTKSimulatedControllerState.cs

@@ -42,7 +42,7 @@ public struct MRTKSimulatedControllerState : IInputStateTypeInfo
         /// <summary>
         /// Represents the user's grip on the controller.
         /// </summary>
-        [InputControl(usage = "Grip", layout = "Axis")]
+        [InputControl(usage = "Grip", alias = "squeeze", layout = "Axis")]
         [FieldOffset(12)]
         public float grip;
 
@@ -60,7 +60,7 @@ public struct MRTKSimulatedControllerState : IInputStateTypeInfo
         [InputControl(name = nameof(XRSimulatedController.primaryTouch), usage = "PrimaryTouch", layout = "Button", bit = (uint)ControllerButton.PrimaryTouch)]
         [InputControl(name = nameof(XRSimulatedController.secondaryButton), usage = "SecondaryButton", layout = "Button", bit = (uint)ControllerButton.SecondaryButton)]
         [InputControl(name = nameof(XRSimulatedController.secondaryTouch), usage = "SecondaryTouch", layout = "Button", bit = (uint)ControllerButton.SecondaryTouch)]
-        [InputControl(name = nameof(XRSimulatedController.gripButton), usage = "GripButton", layout = "Button", bit = (uint)ControllerButton.GripButton, alias = "gripPressed")]
+        [InputControl(name = nameof(XRSimulatedController.gripButton), usage = "GripButton", layout = "Button", bit = (uint)ControllerButton.GripButton, aliases = new[] { "gripPressed", "squeezeClicked" })]
         [InputControl(name = nameof(XRSimulatedController.triggerButton), usage = "TriggerButton", layout = "Button", bit = (uint)ControllerButton.TriggerButton, alias = "triggerPressed")]
         [InputControl(name = nameof(XRSimulatedController.menuButton), usage = "MenuButton", layout = "Button", bit = (uint)ControllerButton.MenuButton)]
         [InputControl(name = nameof(XRSimulatedController.primary2DAxisClick), usage = "Primary2DAxisClick", layout = "Button", bit = (uint)ControllerButton.Primary2DAxisClick)]

org.mixedrealitytoolkit.input/Simulation/Devices/SimulatedController.cs

@@ -435,10 +435,7 @@ private void ApplyState(ControllerControls controls)
                 // simulatedControllerState.primary2DAxis = controls.Primary2DAxis;
                 // simulatedControllerState.secondary2DAxis = controls.Secondary2DAxis;
 
-                // Note: if trigger button is activated, the joint synthesizer will instantly pinch, without smoothing.
-                // If smoothed pinch is desired, use controls.TriggerAxis.
                 simulatedControllerState.WithButton(ControllerButton.TriggerButton, controls.TriggerButton);
-
                 simulatedControllerState.WithButton(ControllerButton.GripButton, controls.GripButton);
 
                 // todo: "soon"

org.mixedrealitytoolkit.input/Simulation/InputSimulator.cs

@@ -314,11 +314,6 @@ public ControllerSimulationSettings RightControllerSettings
             set => rightControllerSettings = value;
         }
 
-        // Should we pass the trigger button straight through to the device?
-        // This will not smooth the trigger press; typically, we should
-        // modulate the trigger axis control ourselves for smooth pinch/unpinch.
-        private bool shouldUseTriggerButton = false;
-
         // TODO: Drive from inspector/simulator options.
         private float triggerSmoothTime = 0.1f;
 
@@ -556,14 +551,7 @@ private void UpdateSimulatedController(Handedness handedness)
 #endif // LATER
 
                     // Buttons available to hands and controllers
-                    // Should we pass the trigger button straight through to the device?
-                    // This will not smooth the trigger press; typically, we should
-                    // modulate the trigger axis control ourselves for smooth pinch/unpinch,
-                    // and this is false.
-                    if (shouldUseTriggerButton)
-                    {
-                        controls.TriggerButton = ctrlSettings.TriggerButton.action.IsPressed();
-                    }
+                    controls.TriggerButton = controls.TriggerAxis >= InputSystem.settings.defaultButtonPressPoint;
                     controls.GripButton = ctrlSettings.GripButton.action.IsPressed();
 
                     if (ctrlSettings.SimulationMode == ControllerSimulationMode.MotionController)

org.mixedrealitytoolkit.input/Tests/Runtime/Utilities/InputTestUtilities.cs

@@ -10,7 +10,6 @@
 using System.Collections.Concurrent;
 using UnityEngine;
 using UnityEngine.InputSystem;
-using UnityEngine.XR.Interaction.Toolkit;
 
 using Object = UnityEngine.Object;
 
@@ -22,7 +21,7 @@
 
 namespace MixedReality.Toolkit.Input.Tests
 {
-    public class InputTestUtilities
+    public static class InputTestUtilities
     {
         private const string MRTKRigPrefabGuid = "4d7e2f87fefe0ba468719b15288b46e7";
         private static readonly string MRTKRigPrefabPath = AssetDatabase.GUIDToAssetPath(MRTKRigPrefabGuid);
@@ -59,7 +58,7 @@ public class InputTestUtilities
         /// to ensure that tests will run quickly in general, and can be set to true manually in specific
         /// test cases using the example below.
         /// </summary>
-        /// <example> 
+        /// <example>
         /// <code>
         ///     [UnityTest]
         ///     public IEnumerator YourTestCase()
@@ -221,7 +220,7 @@ public static void TeardownRig()
         /// </summary>
         /// <remarks>
         /// This will create two <see cref="SimulatedController"/> object, a <see cref="SimulatedHMD"/>
-        /// object, and the associated <see cref="ControllerControls"/> objects. 
+        /// object, and the associated <see cref="ControllerControls"/> objects.
         /// </remarks>
         /// <param name="rayHalfLife">
         /// Optional value for ray smoothing halflife, handy for suppressing smoothing during automated tests.
@@ -300,7 +299,7 @@ public static IEnumerator SetHandTrackingState(Handedness handedness, bool isTra
         /// </summary>
         /// <remarks>
         /// <para>
-        /// This moves the hand from <paramref name="startPosition"/> to <paramref name="endPosition"/>, rotates the hand from 
+        /// This moves the hand from <paramref name="startPosition"/> to <paramref name="endPosition"/>, rotates the hand from
         /// <paramref name="startRotation"/> to <paramref name="endRotation"/>, and smooths the handshape
         /// based on the provided <paramref name="handshapeId"/> over the number of steps provided by <paramref name="numSteps"/>.
         /// </para>
@@ -411,7 +410,7 @@ public static IEnumerator RotateHand(
         /// </summary>
         /// <remarks>
         /// <para>
-        /// This rotates the hand to <paramref name="newRotation"/>, and smooths the handshape based on the provided 
+        /// This rotates the hand to <paramref name="newRotation"/>, and smooths the handshape based on the provided
         /// <paramref name="handshapeId"/> over the number of steps provided by <paramref name="numSteps"/>.
         /// </para>
         /// <para>
@@ -453,7 +452,7 @@ public static IEnumerator PointHandToTarget(Vector3 target, HandshapeId handshap
         /// </summary>
         /// <remarks>
         /// <para>
-        /// This smooths the handshape based on the provided/ <paramref name="handshapeId"/> over the number of 
+        /// This smooths the handshape based on the provided/ <paramref name="handshapeId"/> over the number of
         /// steps provided by <paramref name="numSteps"/>.
         /// </para>
         /// <para>
@@ -711,7 +710,7 @@ public enum RigVersion
             /// Force the use of a rig that does not use the deprecated XRI controller components, but still utilizes
             /// all the custom MRTK interactors.
             /// </summary>
-            Version2 = 2, 
+            Version2 = 2,
         }
 
         /// <summary>
@@ -831,6 +830,7 @@ public bool Update()
                 );
                 float pinchAmount = Mathf.Lerp(startingPinchAmount, isPinching ? 1 : 0, t);
 
+                request.controls.TriggerButton = pinchAmount >= InputSystem.settings.defaultButtonPressPoint;
                 request.controls.TriggerAxis = pinchAmount;
                 switch (request.anchorPoint)
                 {

org.mixedrealitytoolkit.spatialmanipulation/CHANGELOG.md

@@ -34,6 +34,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 * Fixed tap to place `StartPlacement()` when called just after instantiation of the component. [PR #785](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/785)
 * Fix null ref in SpatialManipulationReticle when multiple interactables are hovered. [PR #873](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/873)
 * ConstantViewSize solver now retains the initial scale and aspect ratio [PR #719](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/719)
+* Fixed Follow solver frequently logging "Look Rotation Viewing Vector Is Zero" [PR #895](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/895)
 
 ## [3.3.0] - 2024-04-30