com.unity.xr.interaction.toolkit@2.3.2

## [2.3.2] - 2023-04-28

### Changed
- Changed XRI project validation to only log errors to the console, not warnings.
- Updated `XRPokeFollowAffordance` smoothing property default from 8 to 16 to make it feel more responsive.

### Fixed
- Added additional checks against AR Foundation 5.0 and newer so deprecation messages and the use of the newer XR Origin (AR) is hidden when using AR Foundation 4.2 and older.
- Fixed GC allocations produced each frame by `XRPokeInteractor.UpdateUIModel`.
- Fixed frame-timing for Locomotion Input Tests when running in batch mode.
- `XRInteractableAffordanceStateProvider` Fixes:
    - Activated state was lower priority than selected, which because select is not exited, this was causing issues with it not appearing.
    - There were some racing coroutines between select and activate, and now trigger a new animation blocks previous animations
    - Leaving the select state cancels select animations that might not have completed
    - Leaving activated state cancels activate animations that might not have completed
- Fixed repeat audio issue in the `AudioAffordanceReceiver` by adding extra conditions which treat select as a modifier to hover, and activated as a modifier to select. Doing this prevents triggering repeat audio clips that shouldn't fire, like releasing the activate trigger, or releasing the select trigger while still hovering.
- Fixed `XRPokeLogic` issue where poking from behind objects would sometimes trigger select incorrectly.
- Fixed `XRPokeLogic` issue where depth percent was incorrectly calculated using an exponential value which would result in poke buttons feeling disconnected from the poke interactor position.

Author: Unity Technologies

CHANGELOG.md

@@ -5,6 +5,25 @@ 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.3.2] - 2023-04-28
+
+### Changed
+- Changed XRI project validation to only log errors to the console, not warnings.
+- Updated `XRPokeFollowAffordance` smoothing property default from 8 to 16 to make it feel more responsive.
+
+### Fixed
+- Added additional checks against AR Foundation 5.0 and newer so deprecation messages and the use of the newer XR Origin (AR) is hidden when using AR Foundation 4.2 and older.
+- Fixed GC allocations produced each frame by `XRPokeInteractor.UpdateUIModel`.
+- Fixed frame-timing for Locomotion Input Tests when running in batch mode.
+- `XRInteractableAffordanceStateProvider` Fixes:
+    - Activated state was lower priority than selected, which because select is not exited, this was causing issues with it not appearing.
+    - There were some racing coroutines between select and activate, and now trigger a new animation blocks previous animations
+    - Leaving the select state cancels select animations that might not have completed
+    - Leaving activated state cancels activate animations that might not have completed
+- Fixed repeat audio issue in the `AudioAffordanceReceiver` by adding extra conditions which treat select as a modifier to hover, and activated as a modifier to select. Doing this prevents triggering repeat audio clips that shouldn't fire, like releasing the activate trigger, or releasing the select trigger while still hovering.
+- Fixed `XRPokeLogic` issue where poking from behind objects would sometimes trigger select incorrectly.
+- Fixed `XRPokeLogic` issue where depth percent was incorrectly calculated using an exponential value which would result in poke buttons feeling disconnected from the poke interactor position.
+
 ## [2.3.1] - 2023-03-27
 
 ### Added

Documentation~/affordance-system.md

@@ -8,6 +8,8 @@ The XR Interaction Toolkit package provides an affordance system which enables u
 
 The [XR Interactable Affordance State Provider](xr-interactable-affordance-state-provider.md) connects to an interactable component and reads the interaction state as it changes (Hover, Select, or Activate) to determine and provide the appropriate [Affordance State](xref:UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.State.AffordanceStateShortcuts) to any affordance receivers subscribed to this particular provider. It is also possible to update an affordance state directly from a script without the need for checking the state of an interactable, such as through a network synchronization script. Writing a custom provider is also possible, extended the possibilities to use the affordance system for non-interactable objects as well.
 
+Note that if you are using click animations for Selected or Activated states, affordance transitions won't be propagated until after the animation is completed.
+
 ## Affordance receivers
 
 Affordance receivers are components that receive `Affordance State` change events and then perform specific effects using the referenced theme or configuration. Many affordance receivers handle animating tweens to achieve specific visual effects. There are various affordance receiver components for different primitive data types, such as `Color` or `Vector3` or `Float`. Custom affordance receivers can also be built to achieve a variety of effects depending on the properties you wish to enhance on or around a given object.
@@ -36,6 +38,17 @@ From here we will be able to add affordance receivers to add effects to the inte
 
 ![affordance-receiver](images/affordance-receiver.png)
 
+### Audio Affordance Receiver
+
+It is possible to add audio effects when transitionning between affordance states using the Audio Affordance Receiver.
+Like other affordance receivers, you simply add a theme and connect the affordance state provider reference, but unlike other themes, audio has one shot clips that play when transitionning between states. Because target values are not smoothly blended like with other receivers, the Audio Affordance Receiver has extra considerations on which states are being entered and exited, to avoid playing clips that shouldn't be played.
+
+In practice, when moving from hover to select, select is considered a "modifier" to hover. This means that if releasing select, when holding an object for instance, the hover entered sound effect won't play again if the object previously select is still hovered on release. Similarly, when triggering the activated state from select, the select exited sound effect won't play, as it is considered a "modifier" to activated.
+
+Finally, as mentionned in the Affordance State Provider section, if you are using click animations for Selected or Activated states, repeated activation of activated trigger, faster than the click animation duration, won't trigger affordance audio clips until after the animation is completed. Feel free to disable activated click animations if this is a concern.
+
+![audio-affordance-receiver](audio-affordance-receiver.png)
+
 ### Adding a theme
 
 Next we will create and setup the theme asset. In the Project window, navigate to a folder you wish to store your themes in. Open the **Assets** menu and navigate to **Create** > **Affordance Theme** > **Color Affordance Theme** to create the new [ScriptableObject](https://docs.unity3d.com/Manual/class-ScriptableObject.html) asset. Click on the newly created theme to bring up the Inspector window. By default, all colors will be set to black and transparent. Feel free to set the colors to match the aesthetic you are looking for. Below is an image of a fully configured theme included with the Starter Assets.

Documentation~/images/audio-affordance-receiver.png

@@ -1 +1 @@
-2.3.1
+2.3.2

Documentation~/includes/version.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/com.unity.xr.interaction.toolkit@2.3.1) 
+[com.unity.xr.interaction.toolkit](com.unity3d.kharma:upmpackage/com.unity.xr.interaction.toolkit@2.3.2) 
 
    ![installation-add-package-by-name](images/installation-add-package-by-name.png)
 

Documentation~/installation.md

@@ -46,13 +46,19 @@ protected override void OnEnable()
         protected override void DrawProperties()
         {
             base.DrawProperties();
+
+#if AR_FOUNDATION_5_0_OR_NEWER
             EditorGUILayout.PropertyField(m_XROrigin, BaseGestureContents.xrOrigin);
             using (new EditorGUI.IndentLevelScope())
             {
                 if (m_ARSessionOrigin.objectReferenceValue != null)
                     EditorGUILayout.HelpBox(BaseGestureContents.arSessionOriginDeprecated.text, MessageType.Warning);
+
                 EditorGUILayout.PropertyField(m_ARSessionOrigin, BaseGestureContents.arSessionOrigin);
             }
+#else
+            EditorGUILayout.PropertyField(m_ARSessionOrigin, BaseGestureContents.arSessionOrigin);
+#endif
 
             EditorGUILayout.PropertyField(m_ExcludeUITouches, BaseGestureContents.excludeUITouches);
         }

Editor/AR/Interactables/ARBaseGestureInteractableEditor.cs

@@ -41,13 +41,18 @@ protected override void OnEnable()
         protected override void DrawProperties()
         {
             base.DrawProperties();
+#if AR_FOUNDATION_5_0_OR_NEWER
             EditorGUILayout.PropertyField(m_XROrigin, Contents.xrOrigin);
             using (new EditorGUI.IndentLevelScope())
             {
                 if (m_ARSessionOrigin.objectReferenceValue != null)
                     EditorGUILayout.HelpBox(Contents.arSessionOriginDeprecated.text, MessageType.Warning);
+
                 EditorGUILayout.PropertyField(m_ARSessionOrigin, Contents.arSessionOrigin);
             }
+#else
+            EditorGUILayout.PropertyField(m_ARSessionOrigin, Contents.arSessionOrigin);
+#endif
         }
     }
 }

Editor/AR/Interactors/ARGestureInteractorEditor.cs

@@ -655,13 +655,15 @@ static float GetScaledRadius(SphereCollider collider, float radius)
         }
 
 #if AR_FOUNDATION_PRESENT
+#if AR_FOUNDATION_5_0_OR_NEWER
         [MenuItem("GameObject/XR/XR Origin (AR)", false, 10), UsedImplicitly]
 #pragma warning disable IDE0051 // Remove unused private members -- Editor Menu Item
         static void CreateXROriginForAR(MenuCommand menuCommand)
 #pragma warning restore IDE0051
         {
             Finalize(CreateXROriginWithParent(menuCommand?.GetContextTransform(), HardwareTarget.AR, InputType.ActionBased));
         }
+#endif
 
         [MenuItem("GameObject/XR/AR Gesture Interactor", false, 10), UsedImplicitly]
 #pragma warning disable IDE0051 // Remove unused private members -- Editor Menu Item

Editor/CreateUtils.cs

@@ -69,7 +69,8 @@ public static void GetCurrentValidationIssues(List<BuildValidationRule> issues)
         /// Logs validation issues to console.
         /// </summary>
         /// <returns>Returns <see langword="true"/> if there were any errors that should stop the build.</returns>
-        internal static bool LogBuildValidationIssues()
+        /// <remarks>Only errors are logged to the console. Warnings are not.</remarks>
+        internal static bool LogBuildValidationErrors()
         {
             var issues = new List<BuildValidationRule>();
             GetCurrentValidationIssues(issues);
@@ -82,8 +83,6 @@ internal static bool LogBuildValidationIssues()
             {
                 if (result.Error)
                     Debug.LogError(result.Message);
-                else
-                    Debug.LogWarning(result.Message);
 
                 anyErrors |= result.Error;
             }
@@ -96,4 +95,4 @@ internal static bool LogBuildValidationIssues()
             return anyErrors;
         }
     }
-}
+}

Editor/ProjectValidation/XRInteractionProjectValidation.cs

@@ -31,7 +31,7 @@ static XRInteractionProjectValidationRulesSetup()
             {
                 if (playModeState == PlayModeStateChange.EnteredPlayMode)
                 {
-                    var playmodeIssues = XRInteractionProjectValidation.LogBuildValidationIssues();
+                    var playmodeIssues = XRInteractionProjectValidation.LogBuildValidationErrors();
                     if (playmodeIssues)
                     {
                         EditorApplication.ExitPlaymode();
@@ -304,8 +304,8 @@ static bool ConsoleErrorDoubleClicked(int instanceId, int line)
 
         public void OnPreprocessBuild(BuildReport report)
         {
-            if (XRInteractionProjectValidation.LogBuildValidationIssues())
+            if (XRInteractionProjectValidation.LogBuildValidationErrors())
                 throw new BuildFailedException("Build Failed - XR Interaction Validation issue.");
         }
     }
-}
+}