Ensure we set CurrentTrackedHandedness to Handedness.None if the hand isn't tracked

Author: keveleigh

org.mixedrealitytoolkit.spatialmanipulation/Solvers/SolverHandler.cs

@@ -1,7 +1,6 @@
 // Copyright (c) Mixed Reality Toolkit Contributors
 // Licensed under the BSD 3-Clause
 
-using MixedReality.Toolkit.Subsystems;
 using System.Collections.Generic;
 using System.Linq;
 using Unity.Profiling;
@@ -251,16 +250,13 @@ public Transform TransformTarget
             }
         }
 
-        // Stores currently attached hand if valid (only possible values Left, Right, or None)
-        private Handedness currentTrackedHandedness = Handedness.None;
-
         /// <summary>
         /// Currently tracked hand or motion controller, if applicable.
         /// </summary>
         /// <remarks>
-        /// The allowable <see cref="Handedness"/> values are Left, Right, or None
+        /// The allowable <see cref="Handedness"/> values are Left, Right, or None.
         /// </remarks>
-        public Handedness CurrentTrackedHandedness => currentTrackedHandedness;
+        public Handedness CurrentTrackedHandedness { get; private set; } = Handedness.None;
 
         // Stores controller side to favor if TrackedHandedness is set to both left and right.
         private Handedness preferredTrackedHandedness = Handedness.Left;
@@ -424,7 +420,7 @@ internal void UnregisterSolver(Solver solver)
         }
 
         /// <summary>
-        /// Clear the parent of the internally created tracking-target game object. 
+        /// Clear the parent of the internally created tracking-target game object.
         /// </summary>
         /// <remarks>
         /// A tracking-target is created when <see cref="AttachToNewTrackedObject"/> is called, and
@@ -452,7 +448,7 @@ protected virtual void AttachToNewTrackedObject()
         {
             using (AttachToNewTrackedObjectPerfMarker.Auto())
             {
-                currentTrackedHandedness = Handedness.None;
+                CurrentTrackedHandedness = Handedness.None;
                 controllerInteractor = null;
 
                 Transform target = null;
@@ -462,54 +458,52 @@ protected virtual void AttachToNewTrackedObject()
                 }
                 else if (TrackedTargetType == TrackedObjectType.ControllerRay)
                 {
-                    currentTrackedHandedness = TrackedHandedness;
-                    if ((currentTrackedHandedness & Handedness.Both) == Handedness.Both)
+                    CurrentTrackedHandedness = TrackedHandedness;
+                    if ((CurrentTrackedHandedness & Handedness.Both) == Handedness.Both)
                     {
-                        currentTrackedHandedness = PreferredTrackedHandedness;
-                        controllerInteractor = GetControllerInteractor(currentTrackedHandedness);
+                        CurrentTrackedHandedness = PreferredTrackedHandedness;
+                        controllerInteractor = GetControllerInteractor(CurrentTrackedHandedness);
 
                         if (controllerInteractor == null || !controllerInteractor.isHoverActive)
                         {
                             // If no interactor found, try again on the opposite hand
-                            currentTrackedHandedness = currentTrackedHandedness.GetOppositeHandedness();
-                            controllerInteractor = GetControllerInteractor(currentTrackedHandedness);
+                            CurrentTrackedHandedness = PreferredTrackedHandedness.GetOppositeHandedness();
+                            controllerInteractor = GetControllerInteractor(CurrentTrackedHandedness);
                         }
                     }
                     else
                     {
-                        controllerInteractor = GetControllerInteractor(currentTrackedHandedness);
+                        controllerInteractor = GetControllerInteractor(CurrentTrackedHandedness);
                     }
 
-                    if (controllerInteractor != null)
+                    if (controllerInteractor != null && controllerInteractor.isHoverActive)
                     {
                         target = controllerInteractor.transform;
                     }
                     else
                     {
-                        currentTrackedHandedness = Handedness.None;
+                        CurrentTrackedHandedness = Handedness.None;
                     }
                 }
                 else if (TrackedTargetType == TrackedObjectType.HandJoint)
                 {
                     if (XRSubsystemHelpers.HandsAggregator != null)
                     {
-                        currentTrackedHandedness = TrackedHandedness;
-                        if ((currentTrackedHandedness & Handedness.Both) == Handedness.Both)
+                        CurrentTrackedHandedness = TrackedHandedness;
+                        if ((CurrentTrackedHandedness & Handedness.Both) == Handedness.Both)
                         {
-                            if (IsHandTracked(PreferredTrackedHandedness))
-                            {
-                                currentTrackedHandedness = PreferredTrackedHandedness;
-                            }
-                            else if (IsHandTracked(PreferredTrackedHandedness.GetOppositeHandedness()))
-                            {
-                                currentTrackedHandedness = PreferredTrackedHandedness.GetOppositeHandedness();
-                            }
-                            else
+                            CurrentTrackedHandedness = PreferredTrackedHandedness;
+                            if (!IsHandTracked(CurrentTrackedHandedness))
                             {
-                                currentTrackedHandedness = Handedness.None;
+                                CurrentTrackedHandedness = PreferredTrackedHandedness.GetOppositeHandedness();
                             }
                         }
 
+                        if (!IsHandTracked(CurrentTrackedHandedness))
+                        {
+                            CurrentTrackedHandedness = Handedness.None;
+                        }
+
                         if (UpdateCachedHandJointTransform())
                         {
                             target = cachedHandJointTransform;
@@ -518,7 +512,7 @@ protected virtual void AttachToNewTrackedObject()
                 }
                 else if (TrackedTargetType == TrackedObjectType.CustomOverride)
                 {
-                    target = this.transformOverride;
+                    target = transformOverride;
                 }
 
                 TrackTransform(target);
@@ -529,7 +523,7 @@ protected virtual void AttachToNewTrackedObject()
             new ProfilerMarker("[MRTK] SolverHandler.UpdateCachedHandJointTransform");
 
         /// <summary>
-        /// Update the cached transform's position to match that of the current track joint. 
+        /// Update the cached transform's position to match that of the current track joint.
         /// </summary>
         /// <returns>
         /// <see langword="true"/> if the tracked joint is found and cached transform is updated, <see langword="false"/> otherwise.
@@ -539,7 +533,7 @@ private bool UpdateCachedHandJointTransform()
             bool updated = false;
             using (UpdateCachedHandJointTransformPerfMarker.Auto())
             {
-                XRNode? handNode = currentTrackedHandedness.ToXRNode();
+                XRNode? handNode = CurrentTrackedHandedness.ToXRNode();
 
                 if (handNode.HasValue &&
                     XRSubsystemHelpers.HandsAggregator != null &&
@@ -571,7 +565,6 @@ private void TrackTransform(Transform target)
                 trackingTarget.transform.localPosition = Vector3.Scale(AdditionalOffset, trackingTarget.transform.localScale);
                 trackingTarget.transform.localRotation = Quaternion.Euler(AdditionalRotation);
             }
-
         }
 
         /// <summary>
@@ -613,10 +606,10 @@ private bool IsInvalidTracking()
             }
 
             // If we were tracking a particular hand, check that our transform is still valid
-            if (TrackedTargetType == TrackedObjectType.HandJoint && currentTrackedHandedness != Handedness.None)
+            if (TrackedTargetType == TrackedObjectType.HandJoint && CurrentTrackedHandedness != Handedness.None)
             {
-                bool trackingLeft = currentTrackedHandedness.IsMatch(Handedness.Left) && IsHandTracked(Handedness.Left);
-                bool trackingRight = currentTrackedHandedness.IsMatch(Handedness.Right) && IsHandTracked(Handedness.Right);
+                bool trackingLeft = CurrentTrackedHandedness.IsMatch(Handedness.Left) && IsHandTracked(Handedness.Left);
+                bool trackingRight = CurrentTrackedHandedness.IsMatch(Handedness.Right) && IsHandTracked(Handedness.Right);
                 return !trackingLeft && !trackingRight;
             }
 
@@ -630,14 +623,14 @@ private bool IsInvalidTracking()
         /// <returns>
         /// <see langword="true"/> if the hand is tracked, or <see langword="false"/>.
         /// </returns>
-        public static bool IsHandTracked(Handedness hand)
+        private static bool IsHandTracked(Handedness hand)
         {
             // Early out if the hand isn't a valid XRNode
             // (i.e., Handedness.None or Handedness.Both)
             XRNode? node = hand.ToXRNode();
-            if (!node.HasValue) { return false; }
-            return XRSubsystemHelpers.HandsAggregator != null &&
-                   XRSubsystemHelpers.HandsAggregator.TryGetJoint(TrackedHandJoint.Palm, node.Value, out HandJointPose pose);
+            return node.HasValue &&
+                   XRSubsystemHelpers.HandsAggregator != null &&
+                   XRSubsystemHelpers.HandsAggregator.TryGetJoint(TrackedHandJoint.Palm, node.Value, out _);
         }
 
         /// <summary>