[email protected]

## [2.5.4] - 2024-04-05

### Fixed
- Fixed compilation errors on tvOS platform where `ENABLE_VR` is not defined when AR Foundation is installed. Also fixed when XR Hands is installed in the Hands Interaction Demo sample. (Backport from 3.0.0)
- Fixed `TrackedGraphicRaycaster` to clear poke interaction data when disabled. ([XRIT-142](https://issuetracker.unity3d.com/product/unity/issues/guid/XRIT-142)) (Backport from 3.0.0)
- Fixed warning about use of deprecated `VersionsInfo.verified` by replacing with `VersionsInfo.recommended` in the Hands Interaction Demo sample in Unity 2022.2 and newer. (Backport from 3.0.0)
- Fixed the XR Interactor Line Visual from bending towards an XR Interactable Snap Volume behind UI when the valid UI hit is closest. (Backport from 3.0.2)
- Fixed tap gesture detection for selecting and spawning interactable objects in AR scenes. ([XRIT-145](https://issuetracker.unity3d.com/product/unity/issues/guid/XRIT-145)) (Backport from 3.0.2)
  - Changed the Tap Start Position input action to remove the Tap interaction from the `tapStartPosition` binding in the Starter Assets sample `XRI Default Input Actions` asset. The sample will need to be reimported to remove the Tap interaction from the binding for taps to be functional. This change along with changes to the `XRScreenSpaceController` also fixes the selected object from staying selected and movable with the mobile device orientation for 0.2 seconds after a tap was released.

Author: Unity Technologies

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- Headers should be listed in this order: Added, Changed, Deprecated, Removed, Fixed, Security -->
 
+## [2.5.4] - 2024-04-05
+
+### Fixed
+- Fixed compilation errors on tvOS platform where `ENABLE_VR` is not defined when AR Foundation is installed. Also fixed when XR Hands is installed in the Hands Interaction Demo sample. (Backport from 3.0.0)
+- Fixed `TrackedGraphicRaycaster` to clear poke interaction data when disabled. ([XRIT-142](https://issuetracker.unity3d.com/product/unity/issues/guid/XRIT-142)) (Backport from 3.0.0)
+- Fixed warning about use of deprecated `VersionsInfo.verified` by replacing with `VersionsInfo.recommended` in the Hands Interaction Demo sample in Unity 2022.2 and newer. (Backport from 3.0.0)
+- Fixed the XR Interactor Line Visual from bending towards an XR Interactable Snap Volume behind UI when the valid UI hit is closest. (Backport from 3.0.2)
+- Fixed tap gesture detection for selecting and spawning interactable objects in AR scenes. ([XRIT-145](https://issuetracker.unity3d.com/product/unity/issues/guid/XRIT-145)) (Backport from 3.0.2)
+  - Changed the Tap Start Position input action to remove the Tap interaction from the `tapStartPosition` binding in the Starter Assets sample `XRI Default Input Actions` asset. The sample will need to be reimported to remove the Tap interaction from the binding for taps to be functional. This change along with changes to the `XRScreenSpaceController` also fixes the selected object from staying selected and movable with the mobile device orientation for 0.2 seconds after a tap was released.
+
 ## [2.5.3] - 2024-02-28
 
 ### Fixed

Documentation~/includes/version.md

@@ -1 +1 @@
-2.5.3
+2.5.4

Documentation~/installation.md

@@ -18,7 +18,7 @@ To install this package (minimum version: 2.0.4), follow the [installation instr
 This package was not listed in the Editor manifest in earlier versions of Unity 2021. Due to this, installation is a manual process. To install this package:
 1. Open the project that you plan to use.
 1. Click the following link to bring up the **Add package by name** window in Package Manager: 
-[com.unity.xr.interaction.toolkit](com.unity3d.kharma:upmpackage/[email protected].3) 
+[com.unity.xr.interaction.toolkit](com.unity3d.kharma:upmpackage/[email protected].4) 
 
    ![installation-add-package-by-name](images/installation-add-package-by-name.png)
 

Documentation~/interactor-events.md

@@ -4,7 +4,7 @@ These are events that can be hooked into in the editor the same way you would re
 
 | **Property** | **Description** |
 |---|---|
-| **Hover Entered** | The event that is called when this Interactor begins hovering over an Interactable.<br />The `HoverEnterEventArgs` passed to each listener is only valid while the event is invoked, do not hold a reference to it. |
-| **Hover Exited** | The event that is called when this Interactor ends hovering over an Interactable.<br />The `HoverExitEventArgs` passed to each listener is only valid while the event is invoked, do not hold a reference to it. |
-| **Select Entered** | The event that is called when this Interactor begins selecting an Interactable.<br />The `SelectEnterEventArgs` passed to each listener is only valid while the event is invoked, do not hold a reference to it. |
-| **Select Exited** | The event that is called when this Interactor ends selecting an Interactable.<br />The `SelectEnterEventArgs` passed to each listener is only valid while the event is invoked, do not hold a reference to it. |
+| **Hover Entered** | The event that is called when this Interactor begins hovering over an Interactable.<br />The `HoverEnterEventArgs` passed to each listener is only valid while the event is invoked, don't hold a reference to it. |
+| **Hover Exited** | The event that is called when this Interactor ends hovering over an Interactable.<br />The `HoverExitEventArgs` passed to each listener is only valid while the event is invoked, don't hold a reference to it. |
+| **Select Entered** | The event that is called when this Interactor begins selecting an Interactable.<br />The `SelectEnterEventArgs` passed to each listener is only valid while the event is invoked, don't hold a reference to it. |
+| **Select Exited** | The event that is called when this Interactor ends selecting an Interactable.<br />The `SelectExitEventArgs` passed to each listener is only valid while the event is invoked, don't hold a reference to it. |

Runtime/AR/TouchscreenGestureInputController.cs

@@ -1,4 +1,6 @@
-#if AR_FOUNDATION_PRESENT || PACKAGE_DOCS_GENERATION
+// ENABLE_VR is not defined on Game Core but the assembly is available with limited features when the XR module is enabled.
+// These are the guards that Input System uses in GenericXRDevice.cs to define the XRController and XRHMD classes.
+#if ((ENABLE_VR || UNITY_GAMECORE) && AR_FOUNDATION_PRESENT) || PACKAGE_DOCS_GENERATION
 using System.Text;
 using UnityEngine.InputSystem.Controls;
 using UnityEngine.InputSystem.EnhancedTouch;
@@ -11,7 +13,7 @@ namespace UnityEngine.XR.Interaction.Toolkit.AR.Inputs
     /// <summary>
     /// An input device representing mobile 2D screen gestures.
     /// </summary>
-    [InputControlLayout(stateType = typeof(TouchscreenGestureInputControllerState), displayName = "Touchscreen Gesture Input Controller", isGenericTypeOfDevice = true, updateBeforeRender = true)]
+    [InputControlLayout(stateType = typeof(TouchscreenGestureInputControllerState), displayName = "Touchscreen Gesture Input Controller", isGenericTypeOfDevice = true, updateBeforeRender = false)]
     [Preserve]
     public class TouchscreenGestureInputController : InputSystem.XR.XRController, IInputUpdateCallbackReceiver
     {
@@ -168,22 +170,33 @@ public void OnUpdate()
             if (m_ControllerState.fingerCount != updatedTouchCount)
             {
                 m_ControllerState.fingerCount = updatedTouchCount;
-                InputState.Change(this, m_ControllerState);
+                InputSystem.InputSystem.QueueStateEvent(this, m_ControllerState);
             }
         }
 
         void OnGestureStarted<T>(Gesture<T> gesture) where T : Gesture<T>
         {   
             gesture.onUpdated += OnGestureUpdated;
             gesture.onFinished += OnGestureFinished;
+
+            switch (gesture)
+            {
+                case TapGesture tapGesture:
+                    m_ControllerState.tapStartPosition = Vector2.zero;
+                    break;
+            }
+
+            InputSystem.InputSystem.QueueStateEvent(this, m_ControllerState);
         }
 
         void OnGestureUpdated<T>(Gesture<T> gesture) where T : Gesture<T>
         {   
             switch (gesture)
             {
                 case TapGesture tapGesture:
-                    m_ControllerState.tapStartPosition = tapGesture.startPosition;
+                    // Don't set the tapStartPosition since it should only be set when the gesture is successfully finished.
+                    // We don't have another control to indicate tap status, so we have to use the position control
+                    // for both status and position, so we must wait to set until the gesture is finished.
                     break;
                 case DragGesture dragGesture:
                     m_ControllerState.dragStartPosition = dragGesture.startPosition;
@@ -209,15 +222,15 @@ void OnGestureUpdated<T>(Gesture<T> gesture) where T : Gesture<T>
                     break;
             }
 
-            InputState.Change(this, m_ControllerState);
+            InputSystem.InputSystem.QueueStateEvent(this, m_ControllerState);
         }
 
         void OnGestureFinished<T>(Gesture<T> gesture) where T : Gesture<T>
         {   
            switch (gesture)
             {
-                 case TapGesture tapGesture:
-                    m_ControllerState.tapStartPosition = Vector2.zero;
+                case TapGesture tapGesture:
+                    m_ControllerState.tapStartPosition = !tapGesture.isCanceled ? tapGesture.startPosition : Vector2.zero;
                     break;
                 case DragGesture dragGesture:
                     m_ControllerState.dragStartPosition = Vector2.zero;
@@ -243,7 +256,7 @@ void OnGestureFinished<T>(Gesture<T> gesture) where T : Gesture<T>
                     break;
             }
 
-            InputState.Change(this, m_ControllerState);
+            InputSystem.InputSystem.QueueStateEvent(this, m_ControllerState);
         }
 
         /// <summary>

Runtime/AR/TouchscreenGestureInputLayoutLoader.cs

@@ -1,4 +1,9 @@
-#if AR_FOUNDATION_PRESENT || PACKAGE_DOCS_GENERATION
+// These are the guards in TouchscreenGestureInputController.cs
+#if ((ENABLE_VR || UNITY_GAMECORE) && AR_FOUNDATION_PRESENT) || PACKAGE_DOCS_GENERATION
+#define TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
+#endif
+
+#if TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
 using UnityEditor;
 using UnityEngine.InputSystem.Layouts;
 using UnityEngine.Scripting;

Runtime/Interaction/Controllers/XRScreenSpaceController.cs

@@ -1,11 +1,16 @@
+// These are the guards in TouchscreenGestureInputController.cs
+#if ((ENABLE_VR || UNITY_GAMECORE) && AR_FOUNDATION_PRESENT) || PACKAGE_DOCS_GENERATION
+#define TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
+#endif
+
 using UnityEngine.EventSystems;
 using UnityEngine.InputSystem;
 using UnityEngine.InputSystem.Controls;
 using UnityEngine.Serialization;
 using UnityEngine.XR.Interaction.Toolkit.Inputs;
 using UnityEngine.XR.Interaction.Toolkit.UI;
 
-#if AR_FOUNDATION_PRESENT || PACKAGE_DOCS_GENERATION
+#if TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
 using UnityEngine.XR.Interaction.Toolkit.AR.Inputs;
 #endif
 
@@ -191,7 +196,7 @@ public bool blockInteractionsWithScreenSpaceUI
         /// </remarks>
         public float scaleDelta { get; private set; }
 
-#if AR_FOUNDATION_PRESENT
+#if TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
         TouchscreenGestureInputController m_GestureInputController;
 #endif
         bool m_HasCheckedDisabledTrackingInputReferenceActions;
@@ -258,8 +263,7 @@ protected override void UpdateTrackingInput(XRControllerState controllerState)
             }
 
             var currentTouchCount = m_ScreenTouchCountAction.action?.ReadValue<int>() ?? 0;
-            controllerState.isTracked = currentTouchCount > 0;
-
+            
             if (TryGetCurrentPositionAction(currentTouchCount, out var posAction))
             {
                 var screenPos =  posAction.ReadValue<Vector2>();
@@ -268,10 +272,12 @@ protected override void UpdateTrackingInput(XRControllerState controllerState)
                 controllerState.position = transform.parent != null ? transform.parent.InverseTransformPoint(screenToWorldPoint) : screenToWorldPoint;
                 controllerState.rotation = Quaternion.LookRotation(directionVector);
                 controllerState.inputTrackingState = InputTrackingState.Position | InputTrackingState.Rotation;
+                controllerState.isTracked = currentTouchCount > 0;
             }
             else
             {
                 controllerState.inputTrackingState = InputTrackingState.None;
+                controllerState.isTracked = false;
             }
         }
 
@@ -304,11 +310,11 @@ protected override void UpdateInput(XRControllerState controllerState)
 
             if (TryGetCurrentTwoInputSelectAction(out var twoInputSelectAction))
             {
-                controllerState.selectInteractionState.SetFrameState(twoInputSelectAction.phase.IsInProgress(), twoInputSelectAction.ReadValue<float>());
+                controllerState.selectInteractionState.SetFrameState(true, twoInputSelectAction.ReadValue<float>());
             }
             else if (TryGetCurrentOneInputSelectAction(out var oneInputSelectAction))
             {
-                controllerState.selectInteractionState.SetFrameState(oneInputSelectAction.phase == InputActionPhase.Started, oneInputSelectAction.ReadValue<Vector2>().magnitude);
+                controllerState.selectInteractionState.SetFrameState(true, oneInputSelectAction.ReadValue<Vector2>().magnitude);
             }
             else
             {
@@ -323,14 +329,14 @@ bool TryGetCurrentPositionAction(int touchCount, out InputAction action)
             if (touchCount <= 1)
             {
                 if (m_DragCurrentPositionAction.action != null &&
-                    m_DragCurrentPositionAction.action.phase == InputActionPhase.Started)
+                    m_DragCurrentPositionAction.action.IsInProgress())
                 {
                     action = m_DragCurrentPositionAction.action;
                     return true;
                 }
 
                 if (m_TapStartPositionAction.action != null &&
-                    m_TapStartPositionAction.action.phase == InputActionPhase.Started)
+                    m_TapStartPositionAction.action.WasPerformedThisFrame())
                 {
                     action = m_TapStartPositionAction.action;
                     return true;
@@ -344,14 +350,14 @@ bool TryGetCurrentPositionAction(int touchCount, out InputAction action)
         bool TryGetCurrentOneInputSelectAction(out InputAction action)
         {
             if (m_DragCurrentPositionAction.action != null &&
-                m_DragCurrentPositionAction.action.phase == InputActionPhase.Started)
+                m_DragCurrentPositionAction.action.IsInProgress())
             {
                 action = m_DragCurrentPositionAction.action;
                 return true;
             }
 
             if (m_TapStartPositionAction.action != null &&
-                m_TapStartPositionAction.action.phase == InputActionPhase.Started)
+                m_TapStartPositionAction.action.WasPerformedThisFrame())
             {
                 action = m_TapStartPositionAction.action;
                 return true;
@@ -364,21 +370,21 @@ bool TryGetCurrentOneInputSelectAction(out InputAction action)
         bool TryGetCurrentTwoInputSelectAction(out InputAction action)
         {
             if (m_PinchGapAction.action != null &&
-                m_PinchGapAction.action.phase.IsInProgress())
+                m_PinchGapAction.action.IsInProgress())
             {
                 action = m_PinchGapAction.action;
                 return true;
             }
 
             if (m_PinchGapDeltaAction.action != null &&
-                m_PinchGapDeltaAction.action.phase.IsInProgress())
+                m_PinchGapDeltaAction.action.IsInProgress())
             {
                 action = m_PinchGapDeltaAction.action;
                 return true;
             }
 
             if (m_TwistDeltaRotationAction.action != null &&
-                m_TwistDeltaRotationAction.action.phase.IsInProgress())
+                m_TwistDeltaRotationAction.action.IsInProgress())
             {
                 action = m_TwistDeltaRotationAction.action;
                 return true;
@@ -419,7 +425,7 @@ bool IsPointerOverScreenSpaceCanvas()
 
         void InitializeTouchscreenGestureController()
         {
-#if AR_FOUNDATION_PRESENT
+#if TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
             if (!m_EnableTouchscreenGestureInputController)
                 return;
 
@@ -436,7 +442,7 @@ void InitializeTouchscreenGestureController()
 
         void DestroyTouchscreenGestureController()
         {
-#if AR_FOUNDATION_PRESENT
+#if TOUCHSCREEN_GESTURE_INPUT_CONTROLLER_AVAILABLE
             if (m_GestureInputController != null && m_GestureInputController.added)
             {
                 InputSystem.InputSystem.RemoveDevice(m_GestureInputController);

Runtime/Interaction/Interactors/Visual/XRInteractorLineVisual.cs

@@ -1038,11 +1038,14 @@ bool ExtractHitInformation(ref NativeArray<Vector3> targetPoints, int numTargetP
             {
                 targetEndPoint = m_CurrentHitPoint;
 
-                if (validHit && m_SnapEndpointIfAvailable && m_HasRayInteractor)
+                // Since any UI hit is considered a valid hit, we need to skip snap volume logic if the UI hit is closer than the snap volume hit
+                if (validHit && m_SnapEndpointIfAvailable && m_HasRayInteractor &&
+                    m_LineRenderableAsRayInteractor.TryGetCurrentRaycast(out var raycastHit, out _, out _, out _, out var isUIHitClosest) &&
+                    !isUIHitClosest)
                 {
                     // When hovering a new collider, check if it has a specified snapping volume, if it does then get the closest point on it
-                    if (m_LineRenderableAsRayInteractor.TryGetCurrent3DRaycastHit(out var raycastHit, out _))
-                        hitCollider = raycastHit.collider;
+                    if (raycastHit.HasValue)
+                        hitCollider = raycastHit.Value.collider;
 
                     if (hitCollider != m_PreviousCollider && hitCollider != null)
                         m_LineRenderableAsBaseInteractor.interactionManager.TryGetInteractableForCollider(hitCollider, out _, out m_XRInteractableSnapVolume);
@@ -1053,7 +1056,7 @@ bool ExtractHitInformation(ref NativeArray<Vector3> targetPoints, int numTargetP
                         targetEndPoint = m_LineRenderableAsRayInteractor.hasSelection
                             ? m_XRInteractableSnapVolume.GetClosestPointOfAttachTransform(m_LineRenderableAsRayInteractor)
                             : m_XRInteractableSnapVolume.GetClosestPoint(targetEndPoint);
-                        
+
                         m_EndPositionInLine = k_NumberOfSegmentsForBendableLine - 1; // Override hit index because we're going to use a custom line where the hit point is the end
                         hitSnapVolume = true;
                     }

Runtime/Interaction/Interactors/XRPokeInteractor.cs

@@ -251,7 +251,6 @@ public override void PreprocessInteractor(XRInteractionUpdateOrder.UpdatePhase u
 
             if (updatePhase == XRInteractionUpdateOrder.UpdatePhase.Dynamic)
             {
-                TrackedDeviceGraphicRaycaster.ValidatePokeInteractionData(this);
                 isInteractingWithUI = TrackedDeviceGraphicRaycaster.IsPokeInteractingWithUI(this);
                 RegisterValidTargets(out m_CurrentPokeTarget, out m_CurrentPokeFilter);
                 ProcessPokeStateData();