Deprecate IHandedInteractor (#1042)

* Style update

* Update InteractablePulse.cs

* Add migration path for handedness

* Actually, this is assigned at runtime, so not usable at serialization time

* Update interface lists

* Improve fallback logic

* Update changelogs and package preview versions

* Update GazePinchInteractor.cs

Author: keveleigh

org.mixedrealitytoolkit.core/CHANGELOG.md

@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 ### Added
 
 * Added input action focus handling to disable controller/hand tracked state when the application goes out of focus. [PR #1039](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1039)
+* Added ToInteractorHandedness extension for XRNode. [PR #1042](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1042)
 
 ### Changed
 
@@ -17,6 +18,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 * Removed ITrackedInteractor, as it was supporting an unused codepath and there are better ways to get this data (like querying the attach transform). [PR #1044](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1044)
 
+### Deprecated
+
+* Deprecated IHandedInteractor, as its info is now queryable directly from IXRInteractor's handedness property. [PR #1042](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1042)
+
 ## [4.0.0-development.pre.1] - 2024-07-09
 
 ### Added

org.mixedrealitytoolkit.core/Interactors/IHandedInteractor.cs

@@ -1,18 +1,21 @@
 // Copyright (c) Mixed Reality Toolkit Contributors
 // Licensed under the BSD 3-Clause
 
+using System;
 using UnityEngine.XR.Interaction.Toolkit.Interactors;
 
 namespace MixedReality.Toolkit
 {
     /// <summary>
     /// An interface that all interactors with the concept of handedness implement.
     /// </summary>
+    [Obsolete("Use handedness from IXRInteractor instead.")]
     public interface IHandedInteractor : IXRInteractor
     {
         /// <summary>
         /// Returns the Handedness of this interactor.
         /// </summary>
+        [Obsolete("Use handedness from IXRInteractor instead.")]
         public Handedness Handedness { get; }
     }
 }

org.mixedrealitytoolkit.core/Utilities/Extensions/HandednessExtensions.cs

@@ -17,21 +17,12 @@ public static class HandednessExtensions
         /// If Left, returns Right, if Right, returns Left otherwise returns None.
         /// Otherwise, returns None
         /// </remarks>
-        public static Handedness GetOppositeHandedness(this Handedness current)
+        public static Handedness GetOppositeHandedness(this Handedness current) => current switch
         {
-            if (current == Handedness.Left)
-            {
-                return Handedness.Right;
-            }
-            else if (current == Handedness.Right)
-            {
-                return Handedness.Left;
-            }
-            else
-            {
-                return Handedness.None;
-            }
-        }
+            Handedness.Left => Handedness.Right,
+            Handedness.Right => Handedness.Left,
+            _ => Handedness.None
+        };
 
         /// <summary>
         /// Checks whether or not the current <see cref="Handedness"/> value matches the specified value.
@@ -53,11 +44,11 @@ public static bool IsMatch(this Handedness current, Handedness compare)
         /// <returns>
         /// <see cref="XRNode"/> representing the specified <see cref="Handedness"/>, or <see langword="null"/>.
         /// </returns>
-        public static XRNode? ToXRNode(this Handedness hand)
+        public static XRNode? ToXRNode(this Handedness hand) => hand switch
         {
-            if (hand == Handedness.Left) { return XRNode.LeftHand; }
-            if (hand == Handedness.Right) { return XRNode.RightHand; }
-            return null;
-        }
+            Handedness.Left => XRNode.LeftHand,
+            Handedness.Right => XRNode.RightHand,
+            _ => null
+        };
     }
 }

org.mixedrealitytoolkit.core/Utilities/Extensions/InteractorHandednessExtensions.cs

@@ -26,18 +26,12 @@ public static class InteractorHandednessExtensions
         /// <summary>
         /// Gets the <see cref="XRNode"/> representing the specified <see cref="InteractorHandedness"/>. If the <see cref="InteractorHandedness"/>
         /// </summary>
-        public static XRNode ToXRNode(this InteractorHandedness hand, XRNode defaultValue = XRNode.RightHand)
+        public static XRNode ToXRNode(this InteractorHandedness hand, XRNode defaultValue = XRNode.RightHand) => hand switch
         {
-            switch (hand)
-            {
-                case InteractorHandedness.Left:
-                    return XRNode.LeftHand;
-                case InteractorHandedness.Right:
-                    return XRNode.RightHand;
-                default:
-                    return defaultValue;
-            }
-        }
+            InteractorHandedness.Left => XRNode.LeftHand,
+            InteractorHandedness.Right => XRNode.RightHand,
+            _ => defaultValue,
+        };
 
         /// <summary>
         /// Converts the <see cref="InteractorHandedness"/> to <see cref="Handedness"/>. If the <see cref="InteractorHandedness"/>
@@ -46,17 +40,11 @@ public static XRNode ToXRNode(this InteractorHandedness hand, XRNode defaultValu
         /// <param name="hand">The <see cref="InteractorHandedness"/> value for
         /// which the <see cref="Handedness"/> is requested.</param>
         /// <returns><see cref="Handedness"/> representing the specified <see cref="InteractorHandedness"/>.</returns>
-        public static Handedness ToHandedness(this InteractorHandedness hand)
+        public static Handedness ToHandedness(this InteractorHandedness hand) => hand switch
         {
-            switch (hand)
-            {
-                case InteractorHandedness.Left:
-                    return Handedness.Left;
-                case InteractorHandedness.Right:
-                    return Handedness.Right;
-                default:
-                    return Handedness.None;
-            }
-        }
+            InteractorHandedness.Left => Handedness.Left,
+            InteractorHandedness.Right => Handedness.Right,
+            _ => Handedness.None,
+        };
     }
 }

org.mixedrealitytoolkit.core/Utilities/Extensions/XRNodeExtensions.cs

@@ -2,6 +2,7 @@
 // Licensed under the BSD 3-Clause
 
 using UnityEngine.XR;
+using UnityEngine.XR.Interaction.Toolkit.Interactors;
 
 namespace MixedReality.Toolkit
 {
@@ -21,20 +22,30 @@ public static class XRNodeExtensions
         /// This will return <see cref="Handedness.None"/> for XRNode values other than
         /// LeftHand or RightHand.
         /// </remarks>
-        public static Handedness ToHandedness(this XRNode node)
+        public static Handedness ToHandedness(this XRNode node) => node switch
         {
-            switch (node)
-            {
-                case XRNode.LeftHand:
-                    return Handedness.Left;
+            XRNode.LeftHand => Handedness.Left,
+            XRNode.RightHand => Handedness.Right,
+            _ => Handedness.None,
+        };
 
-                case XRNode.RightHand:
-                    return Handedness.Right;
-
-                default:
-                    return Handedness.None;
-            }
-        }
+        /// <summary>
+        /// Returns the <see cref="InteractorHandedness"/> of the specified XRNode.
+        /// </summary>
+        /// <param name="node">The XRNode for which the <see cref="InteractorHandedness"/> is requested.</param>
+        /// <returns>
+        /// <see cref="InteractorHandedness"/> value representing the XRNode.
+        /// </returns>
+        /// <remarks>
+        /// This will return <see cref="InteractorHandedness.None"/> for XRNode values other than
+        /// LeftHand or RightHand.
+        /// </remarks>
+        public static InteractorHandedness ToInteractorHandedness(this XRNode node) => node switch
+        {
+            XRNode.LeftHand => InteractorHandedness.Left,
+            XRNode.RightHand => InteractorHandedness.Right,
+            _ => InteractorHandedness.None,
+        };
 
         /// <summary>
         /// Determine if the specified XRNode represents a hand.
@@ -72,4 +83,4 @@ public static bool IsRightHand(this XRNode node)
             return (node == XRNode.RightHand);
         }
     }
-}
+}

org.mixedrealitytoolkit.input/CHANGELOG.md

@@ -18,6 +18,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 * Updated the minimum editor version to 2022.3.6f1 [PR #1003](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1003)
 
+### Deprecated
+
+* Deprecated IHandedInteractor across the interactor implementations, as its info is now queryable directly from IXRInteractor's handedness property. [PR #1042](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1042)
+
 ## [4.0.0-development.pre.1] - 2024-07-16
 
 ### Added

org.mixedrealitytoolkit.input/Controllers/ArticulatedHandController.cs

@@ -17,7 +17,7 @@ namespace MixedReality.Toolkit.Input
     /// This is able to support variable pinch select through the use of <see cref="HandsAggregatorSubsystem"/>.
     /// </remarks>
     [AddComponentMenu("MRTK/Input/XR Controller (Articulated Hand)")]
-    [Obsolete]
+    [Obsolete("ArticulatedHandController has been deprecated in version 4.0.0. Its functionality has been distributed into different components.")]
     public class ArticulatedHandController : ActionBasedController
     {
         #region Associated hand select values

org.mixedrealitytoolkit.input/InteractionModes/InteractionModeManager.cs

@@ -561,7 +561,7 @@ private GameObject FindInteractorGroupObject(XRBaseInteractor interactor)
             GameObject interactorGroupObject = null;
 
             // For backwards compatibility, we will continue to support the obsolete "controller-based" interactors,
-            // and group based on "controller" partents.
+            // and group based on "controller" parents.
 #pragma warning disable CS0618 // xrController is obsolete
             if (interactor is XRBaseInputInteractor controllerInteractor &&
                 controllerInteractor.xrController != null)

org.mixedrealitytoolkit.input/Interactors/Gaze/GazeInteractor.cs

@@ -39,14 +39,7 @@ public GameObject GetModeManagedController()
         {
             // Legacy controller-based interactors should return null, so the legacy controller-based logic in the
             // interaction mode manager is used instead.
-#pragma warning disable CS0618 // forceDeprecatedInput is obsolete
-            if (forceDeprecatedInput)
-            {
-                return null;
-            }
-#pragma warning restore CS0618 // forceDeprecatedInput is obsolete
-
-            return ModeManagedRoot;
+            return forceDeprecatedInput ? null : ModeManagedRoot;
         }
     }
 }

org.mixedrealitytoolkit.input/Interactors/GazePinch/GazePinchInteractor.cs

@@ -21,8 +21,10 @@ namespace MixedReality.Toolkit.Input
     public class GazePinchInteractor :
         XRBaseInputInteractor,
         IGazePinchInteractor,
-        IHandedInteractor,
-        IModeManagedInteractor
+        IModeManagedInteractor,
+#pragma warning disable CS0618 // Type or member is obsolete
+        IHandedInteractor
+#pragma warning restore CS0618 // Type or member is obsolete
     {
         #region GazePinchInteractor
 
@@ -68,7 +70,7 @@ public GameObject ModeManagedRoot
         /// represents whether the hand is in a pinching pose,
         /// within the FOV set by the aggregator config.
         /// </summary>
-        protected bool PinchReady { get => pinchReady; }
+        protected bool PinchReady => pinchReady;
 
         /// <summary>
         /// The world-space pose of the hand pinching point.
@@ -194,22 +196,17 @@ private bool IsTracked
         #region IHandedInteractor
 
         /// <inheritdoc />
+        [Obsolete("Use handedness from IXRInteractor instead.")]
         Handedness IHandedInteractor.Handedness
         {
             get
             {
-#pragma warning disable CS0618 // Type or member is obsolete
                 if (forceDeprecatedInput)
                 {
-#pragma warning disable CS0612 // Type or member is obsolete
                     return handController.HandNode.ToHandedness();
-#pragma warning restore CS0612 // Type or member is obsolete
-                }
-#pragma warning restore CS0618 // Type or member is obsolete
-                else
-                {
-                    return handedness.ToHandedness();
                 }
+
+                return handedness.ToHandedness();
             }
         }
 
@@ -225,9 +222,7 @@ public float SelectProgress
 #pragma warning disable CS0618 // Type or member is obsolete
                 if (forceDeprecatedInput)
                 {
-#pragma warning disable CS0612 // Type or member is obsolete
                     return handController.selectInteractionState.value;
-#pragma warning restore CS0612 // Type or member is obsolete
                 }
 #pragma warning restore CS0618 // Type or member is obsolete
                 else if (selectInput != null)
@@ -326,11 +321,11 @@ public override void ProcessInteractor(XRInteractionUpdateOrder.UpdatePhase upda
 
         /// <summary>
         /// Given the specified interactable, this computes and applies the relevant
-        /// position and rotation to the attach transform. 
+        /// position and rotation to the attach transform.
         /// </summary>
         /// <remarks>
-        /// If there is currently an active selection, the attach transform is computed 
-        /// as an offset from selected object, where the offset vector is a function of 
+        /// If there is currently an active selection, the attach transform is computed
+        /// as an offset from selected object, where the offset vector is a function of
         /// the centroid between all currently participating <see cref="GazePinchInteractor"/>
         /// objects. This models ray-like manipulations, but with virtual attach offsets
         /// from object, modeled from the relationship between each participating hand.
@@ -344,8 +339,7 @@ private void ComputeAttachTransform(IXRSelectInteractable interactable)
             if (!AimPoseSource.TryGetPose(out Pose aimPose)) { return; }
 
             // Separate vars for fused position/rotation setting.
-            Quaternion rotationToApply = attachTransform.rotation;
-            Vector3 positionToApply = attachTransform.position;
+            attachTransform.GetPositionAndRotation(out Vector3 positionToApply, out Quaternion rotationToApply);
 
             // Compute the ratio from the current hand-body distance to the distance
             // we recorded on selection. Used to linearly scale the attach transform's
@@ -484,7 +478,7 @@ private void ResetManipulationLogic(IXRSelectInteractable interactable)
             interactorLocalAttachPoint = Quaternion.Inverse(noRollRay) * (virtualAttachTransform - aimPose.position);
 
             // Record the distance from the controller to the body of the user, to use as reference for subsequent
-            // distance measurements. 
+            // distance measurements.
             bodyDistanceOnSelect = PoseUtilities.GetDistanceToBody(aimPose);
         }
 
@@ -562,24 +556,20 @@ protected override void OnSelectExited(SelectExitEventArgs args)
         #endregion XRBaseInteractor
 
         #region IModeManagedInteractor
+
         /// <inheritdoc/>
         [Obsolete("This function is obsolete and will be removed in the next major release. Use ModeManagedRoot instead.")]
         public GameObject GetModeManagedController()
         {
             // Legacy controller-based interactors should return null, so the legacy controller-based logic in the
             // interaction mode manager is used instead.
-#pragma warning disable CS0618 // Type or member is obsolete 
-            if (forceDeprecatedInput)
-            {
-                return null;
-            }
-#pragma warning restore CS0618 // Type or member is obsolete
-
-            return ModeManagedRoot;
+            return forceDeprecatedInput ? null : ModeManagedRoot;
         }
+
         #endregion IModeManagedInteractor
 
         #region Private Methods
+
         /// <summary>
         /// Updates the pinch state of the GazePinchInteractor.
         /// If handedness is not set then it defaults to right hand.
@@ -613,6 +603,7 @@ private void UpdatePinchState()
                 pinchReady = isPinchReady;
             }
         }
+
         #endregion Private Methods
     }
 }