com.unity.xr.interaction.toolkit@2.0.3

## [2.0.3] - 2022-07-26

### Fixed
- Fixed the simulated HMD and controllers so they no longer reset to origin after switching focus away and back to the Unity Editor. ([1409417](https://issuetracker.unity3d.com/product/unity/issues/guid/1409417))
- Fixed warnings about setting velocities of a kinematic body when updating an XR Grab Interactable with Movement Type set to Kinematic.
- Fixed `UIInputModule` so it will use the new Main Camera if the previous one is disabled when `UIInputModule.uiCamera` is not set.
- Fixed warning in the Inspector window for interactors missing the XR Controller component when the GameObject is deactivated by changing the find method to include inactive GameObjects.
- Fixed XR Interactor Line Visual so it will instantiate the Reticle GameObject when it is a Prefab asset so it does not modify the asset on disk.
- Fixed `UIInputModule` to support EventSystem `IPointerMoveHandler` for Unity 2021.1 and newer. Also added the corresponding `pointerMove` event to `UIInputModule` to allow the pointer move events to be globally handled.

Author: Unity Technologies

CHANGELOG.md

@@ -5,6 +5,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- Headers should be listed in this order: Added, Changed, Deprecated, Removed, Fixed, Security -->
+## [2.0.3] - 2022-07-26
+
+### Fixed
+- Fixed the simulated HMD and controllers so they no longer reset to origin after switching focus away and back to the Unity Editor. ([1409417](https://issuetracker.unity3d.com/product/unity/issues/guid/1409417))
+- Fixed warnings about setting velocities of a kinematic body when updating an XR Grab Interactable with Movement Type set to Kinematic.
+- Fixed `UIInputModule` so it will use the new Main Camera if the previous one is disabled when `UIInputModule.uiCamera` is not set.
+- Fixed warning in the Inspector window for interactors missing the XR Controller component when the GameObject is deactivated by changing the find method to include inactive GameObjects.
+- Fixed XR Interactor Line Visual so it will instantiate the Reticle GameObject when it is a Prefab asset so it does not modify the asset on disk.
+- Fixed `UIInputModule` to support EventSystem `IPointerMoveHandler` for Unity 2021.1 and newer. Also added the corresponding `pointerMove` event to `UIInputModule` to allow the pointer move events to be globally handled.
+
 ## [2.0.2] - 2022-04-29
 
 ### Fixed

Documentation~/installation.md

@@ -4,16 +4,22 @@ To install this package, refer to the instructions that match your Unity Editor
 
 ## Version 2022.1 and later
 
-To install this package, follow the [installation instructions in the Unity User Manual](https://docs.unity3d.com/Documentation/Manual/upm-ui-install.html).
+To install this package, follow the [installation instructions in the Unity User Manual](https://docs.unity3d.com/2022.1/Documentation/Manual/upm-ui-install.html).
 
 ## Version 2021.3
 
+### 2021.3.8f1 and later
+
+To install this package, follow the [installation instructions in the Unity User Manual](https://docs.unity3d.com/2021.3/Documentation/Manual/upm-ui-install.html).
+
+### 2021.3.7f1 and earlier
+
 To install this package, follow the instructions for [adding a package by name](https://docs.unity3d.com/2021.3/Documentation/Manual/upm-ui-quick.html) in the Unity Editor.
 
 |Text Field|Value|
 |---|---|
 |**Name**|`com.unity.xr.interaction.toolkit`|
-|**Version (optional)**|`2.0.2`|
+|**Version (optional)**|`2.0.3`|
 
 ## Version 2020.3
 

Documentation~/xr-grab-interactable.md

@@ -30,7 +30,7 @@ Interactable component that hooks into the interaction system (via [XRInteractio
 | **Tighten Rotation** | Reduces the maximum follow rotation difference when using smoothing.<br />Fractional amount of how close the smoothed rotation should remain to the rotation of the Interactor when using smoothing. The value ranges from 0 meaning no bias in the smoothed follow rotation, to 1 meaning effectively no smoothing at all. |
 | **Angular Velocity Damping** | Scale factor of how much Unity dampens the existing angular velocity when tracking the rotation of the Interactor. The smaller the value, the longer it takes for the angular velocity to decay.<br />Only applies when **Movement Type** is in _VelocityTracking_ mode. |
 | **Angular Velocity Scale** | Scale factor Unity applies to the tracked angular velocity while updating the `Rigidbody` when tracking the rotation of the Interactor.<br />Only applies when **Movement Type** is in _Velocity Tracking_ mode. |
-| **Throw On Detach** | Enable to have this object inherit the velocity of the Interactor when released. |
+| **Throw On Detach** | Enable to have this object inherit the velocity of the Interactor when released. This is not supported for a kinematic Rigidbody. |
 | **Throw Smoothing Duration** | Time period to average thrown velocity over. |
 | **Throw Smoothing Curve** | The curve to use to weight thrown velocity smoothing (most recent frames to the right). |
 | **Throw Velocity Scale** | Scale factor Unity applies to this object's velocity inherited from the Interactor when released. |

Editor/Interaction/Interactables/XRGrabInteractableEditor.cs

@@ -98,7 +98,7 @@ protected static class Contents
             /// <summary><see cref="GUIContent"/> for <see cref="XRGrabInteractable.tightenRotation"/>.</summary>
             public static readonly GUIContent tightenRotation = EditorGUIUtility.TrTextContent("Tighten Rotation", "Reduces the maximum follow rotation difference when using smoothing. The value ranges from 0 meaning no bias in the smoothed follow rotation, to 1 meaning effectively no smoothing at all.");
             /// <summary><see cref="GUIContent"/> for <see cref="XRGrabInteractable.throwOnDetach"/>.</summary>
-            public static readonly GUIContent throwOnDetach = EditorGUIUtility.TrTextContent("Throw On Detach", "Whether this object inherits the velocity of the Interactor when released.");
+            public static readonly GUIContent throwOnDetach = EditorGUIUtility.TrTextContent("Throw On Detach", "Whether this object inherits the velocity of the Interactor when released. This is not supported for a kinematic Rigidbody.");
             /// <summary><see cref="GUIContent"/> for <see cref="XRGrabInteractable.throwSmoothingDuration"/>.</summary>
             public static readonly GUIContent throwSmoothingDuration = EditorGUIUtility.TrTextContent("Throw Smoothing Duration", "Time period to average thrown velocity over.");
             /// <summary><see cref="GUIContent"/> for <see cref="XRGrabInteractable.throwSmoothingCurve"/>.</summary>
@@ -116,7 +116,7 @@ protected static class Contents
 
             /// <summary>Message for non-uniformly scaled parent.</summary>
             public static readonly string nonUniformScaledParentWarning = "When a child object has a non-uniformly scaled parent and is rotated relative to that parent, it may appear skewed. To avoid this, use uniform scale in all parents' Transform of this object.";
-            
+
             /// <summary>Array of type <see cref="GUIContent"/> for the options shown in the popup for <see cref="XRGrabInteractable.attachPointCompatibilityMode"/>.</summary>
             public static readonly GUIContent[] attachPointCompatibilityModeOptions =
             {

Editor/Interaction/Interactors/XRBaseControllerInteractorEditor.cs

@@ -242,7 +242,7 @@ protected virtual void VerifyControllerPresent()
             foreach (var targetObject in serializedObject.targetObjects)
             {
                 var interactor = (XRBaseControllerInteractor)targetObject;
-                if (interactor.GetComponentInParent<XRBaseController>() == null)
+                if (interactor.FindControllerComponent() == null)
                 {
                     EditorGUILayout.HelpBox(BaseControllerContents.missingRequiredController, MessageType.Warning, true);
                     break;

Runtime/Inputs/Simulation/XRDeviceSimulator.cs

@@ -1959,5 +1959,31 @@ static InputAction GetInputAction(InputActionReference actionReference)
             return actionReference != null ? actionReference.action : null;
 #pragma warning restore IDE0031
         }
+
+        internal static unsafe bool TryExecuteCommand(InputDeviceCommand* commandPtr, out long result)
+        {
+            // This is a utility method called by XRSimulatedHMD and XRSimulatedController
+            // since both devices share the same command handling.
+            // This replicates the logic in XRToISXDevice::IOCTL (XRInputToISX.cpp).
+            var type = commandPtr->type;
+            if (type == RequestSyncCommand.Type)
+            {
+                // The state is maintained by XRDeviceSimulator, so no need for any change
+                // when focus is regained. Returning success instructs Input System to not
+                // reset the device.
+                result = InputDeviceCommand.GenericSuccess;
+                return true;
+            }
+
+            if (type == QueryCanRunInBackground.Type)
+            {
+                ((QueryCanRunInBackground*)commandPtr)->canRunInBackground = true;
+                result = InputDeviceCommand.GenericSuccess;
+                return true;
+            }
+
+            result = default;
+            return false;
+        }
     }
 }

Runtime/Inputs/Simulation/XRSimulatedController.cs

@@ -1,5 +1,6 @@
 using UnityEngine.InputSystem.Controls;
 using UnityEngine.InputSystem.Layouts;
+using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.Scripting;
 
 namespace UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation
@@ -120,5 +121,13 @@ protected override void FinishSetup()
             batteryLevel = GetChildControl<AxisControl>(nameof(batteryLevel));
             userPresence = GetChildControl<ButtonControl>(nameof(userPresence));
         }
+
+        /// <inheritdoc />
+        protected override unsafe long ExecuteCommand(InputDeviceCommand* commandPtr)
+        {
+            return XRDeviceSimulator.TryExecuteCommand(commandPtr, out var result)
+                ? result
+                : base.ExecuteCommand(commandPtr);
+        }
     }
 }

Runtime/Inputs/Simulation/XRSimulatedHMD.cs

@@ -1,4 +1,5 @@
 using UnityEngine.InputSystem.Layouts;
+using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.XR;
 using UnityEngine.Scripting;
 
@@ -11,5 +12,12 @@ namespace UnityEngine.XR.Interaction.Toolkit.Inputs.Simulation
     [Preserve]
     public class XRSimulatedHMD : XRHMD
     {
+        /// <inheritdoc />
+        protected override unsafe long ExecuteCommand(InputDeviceCommand* commandPtr)
+        {
+            return XRDeviceSimulator.TryExecuteCommand(commandPtr, out var result)
+                ? result
+                : base.ExecuteCommand(commandPtr);
+        }
     }
 }

Runtime/Interaction/Interactables/XRGrabInteractable.cs

@@ -618,13 +618,11 @@ void PerformKinematicUpdate(XRInteractionUpdateOrder.UpdatePhase updatePhase)
                     var position = m_AttachPointCompatibilityMode == AttachPointCompatibilityMode.Default
                         ? m_TargetWorldPosition
                         : m_TargetWorldPosition - m_Rigidbody.worldCenterOfMass + m_Rigidbody.position;
-                    m_Rigidbody.velocity = Vector3.zero;
                     m_Rigidbody.MovePosition(position);
                 }
 
                 if (m_TrackRotation)
                 {
-                    m_Rigidbody.angularVelocity = Vector3.zero;
                     m_Rigidbody.MoveRotation(m_TargetWorldRotation);
                 }
             }
@@ -736,7 +734,7 @@ protected virtual void Grab()
             var thisTransform = transform;
             m_OriginalSceneParent = thisTransform.parent;
             thisTransform.SetParent(null);
-            
+
             UpdateCurrentMovementType();
             SetupRigidbodyGrab(m_Rigidbody);
 
@@ -797,6 +795,12 @@ protected virtual void Detach()
         {
             if (m_ThrowOnDetach)
             {
+                if (m_Rigidbody.isKinematic)
+                {
+                    Debug.LogWarning("Cannot throw a kinematic Rigidbody since updating the velocity and angular velocity of a kinematic Rigidbody is not supported. Disable Throw On Detach or Is Kinematic to fix this issue.", this);
+                    return;
+                }
+
                 m_Rigidbody.velocity = m_DetachVelocity;
                 m_Rigidbody.angularVelocity = m_DetachAngularVelocity;
             }
@@ -836,7 +840,7 @@ protected virtual void SetupRigidbodyDrop(Rigidbody rigidbody)
             rigidbody.useGravity = m_UsedGravity;
             rigidbody.drag = m_OldDrag;
             rigidbody.angularDrag = m_OldAngularDrag;
-            
+
             if (!isSelected)
                 m_Rigidbody.useGravity |= m_ForceGravityOnDetach;
         }

Runtime/Interaction/Interactors/Visual/XRInteractorLineVisual.cs

@@ -175,10 +175,18 @@ public float snapThresholdDistance
         /// <summary>
         /// Stores the reticle that appears at the end of the line when it is valid.
         /// </summary>
+        /// <remarks>
+        /// Unity will instantiate it while playing when it is a Prefab asset.
+        /// </remarks>
         public GameObject reticle
         {
             get => m_Reticle;
-            set => m_Reticle = value;
+            set
+            {
+                m_Reticle = value;
+                if (Application.isPlaying)
+                    SetupReticle();
+            }
         }
 
         [SerializeField]
@@ -251,9 +259,7 @@ protected void Awake()
         {
             m_LineRenderable = GetComponent<ILineRenderable>();
 
-            if (m_Reticle != null)
-                m_Reticle.SetActive(false);
-
+            SetupReticle();
             ClearLineRenderer();
             UpdateSettings();
         }
@@ -514,6 +520,18 @@ bool TryFindLineRenderer()
             return true;
         }
 
+        void SetupReticle()
+        {
+            if (m_Reticle == null)
+                return;
+
+            // Instantiate if the reticle is a Prefab asset rather than a scene GameObject
+            if (!m_Reticle.scene.IsValid())
+                m_Reticle = Instantiate(m_Reticle);
+
+            m_Reticle.SetActive(false);
+        }
+
         /// <inheritdoc />
         public bool AttachCustomReticle(GameObject reticleInstance)
         {