Don't provide hand joints or input viz when unfocused (outside the editor)

Author: keveleigh

org.mixedrealitytoolkit.core/Subsystems/MRTKLifecycleManager.cs

@@ -27,7 +27,7 @@ public class MRTKLifecycleManager :
         /// <summary>
         /// The list of <see cref="IMRTKManagedSubsystem"/> objects being managed by this class.
         /// </summary>
-        protected  List<IMRTKManagedSubsystem> ManagedSubsystems
+        protected List<IMRTKManagedSubsystem> ManagedSubsystems
         {
             get => managedSubsystems;
             set => managedSubsystems = value;
@@ -180,6 +180,7 @@ private void LateUpdate()
             }
         }
 
+#if !UNITY_EDITOR
         /// <summary>
         /// Sent to all GameObjects when the player gets or loses focus.
         /// </summary>
@@ -203,6 +204,7 @@ protected void OnApplicationFocus(bool focus)
                 }
             }
         }
+#endif // !UNITY_EDITOR
 
         #endregion MonoBehaviour
 

org.mixedrealitytoolkit.input/Controllers/HandModel.cs

@@ -60,15 +60,31 @@ public Transform ModelPrefab
 
         #endregion Associated hand select values
 
+        /// <summary>
+        /// See <see cref="MonoBehaviour"/>.
+        /// </summary>
+        protected virtual void Awake()
+        {
+            // Create empty container transform for the model if none specified.
+            // This is not strictly necessary to create since this GameObject could be used
+            // as the parent for the instantiated prefab, but doing so anyway for backwards compatibility.
+            if (modelParent == null)
+            {
+                modelParent = new GameObject($"[{gameObject.name}] Model Parent").transform;
+                modelParent.SetParent(transform, false);
+                modelParent.SetLocalPositionAndRotation(Vector3.zero, Quaternion.identity);
+            }
+        }
+
         /// <summary>
         /// A Unity event function that is called on the frame when a script is enabled just before any of the update methods are called the first time.
         /// </summary>
         protected virtual void Start()
         {
             // Instantiate the model prefab if it is set
-            if (ModelPrefab != null)
+            if (modelPrefab != null)
             {
-                model = Instantiate(ModelPrefab, ModelParent);
+                model = Instantiate(modelPrefab, modelParent);
 
                 Debug.Assert(selectInput != null, $"The Select Input reader for {name} is not set and will not be used with the instantiated hand model.");
 
@@ -80,20 +96,23 @@ protected virtual void Start()
             }
         }
 
+#if !UNITY_EDITOR
         /// <summary>
-        /// See <see cref="MonoBehaviour"/>.
+        /// Sent to all GameObjects when the player gets or loses focus.
         /// </summary>
-        protected virtual void Awake()
+        /// <param name="focus"><see langword="true"/> if the GameObjects have focus, else <see langword="false"/>.</param>
+        protected void OnApplicationFocus(bool focus)
         {
-            // Create empty container transform for the model if none specified.
-            // This is not strictly necessary to create since this GameObject could be used
-            // as the parent for the instantiated prefab, but doing so anyway for backwards compatibility.
-            if (modelParent == null)
+            // We want to ensure we're focused for input visualization, as some runtimes continue reporting "tracked" while pose updates are paused.
+            // This is allowed, per-spec, as a "should": "Runtimes should make input actions inactive while the application is unfocused,
+            // and applications should react to an inactive input action by skipping rendering of that action's input avatar
+            // (depictions of hands or other tracked objects controlled by the user)."
+
+            if (modelParent != null)
             {
-                modelParent = new GameObject($"[{gameObject.name}] Model Parent").transform;
-                modelParent.SetParent(transform, false);
-                modelParent.SetLocalPositionAndRotation(Vector3.zero, Quaternion.identity);
+                modelParent.gameObject.SetActive(focus);
             }
         }
+#endif // !UNITY_EDITOR
     }
 }

org.mixedrealitytoolkit.input/Subsystems/Hands/HandsProvider.cs

@@ -60,13 +60,31 @@ private void ResetHands()
         public override bool TryGetEntireHand(XRNode handNode, out IReadOnlyList<HandJointPose> jointPoses)
         {
             Debug.Assert(handNode == XRNode.LeftHand || handNode == XRNode.RightHand, "Non-hand XRNode used in TryGetEntireHand query.");
+
+#if !UNITY_EDITOR
+            if (!Application.isFocused)
+            {
+                jointPoses = Array.Empty<HandJointPose>();
+                return false;
+            }
+#endif // !UNITY_EDITOR
+
             return hands[handNode].TryGetEntireHand(out jointPoses);
         }
 
         /// <inheritdoc/>
         public override bool TryGetJoint(TrackedHandJoint joint, XRNode handNode, out HandJointPose jointPose)
         {
             Debug.Assert(handNode == XRNode.LeftHand || handNode == XRNode.RightHand, "Non-hand XRNode used in TryGetJoint query.");
+
+#if !UNITY_EDITOR
+            if (!Application.isFocused)
+            {
+                jointPose = default;
+                return false;
+            }
+#endif // !UNITY_EDITOR
+
             return hands[handNode].TryGetJoint(joint, out jointPose);
         }
 

org.mixedrealitytoolkit.input/Tracking/HandPoseDriver.cs

@@ -125,7 +125,6 @@ private bool IsTrackingNone()
         private bool TryGetPolyfillDevicePose(out Pose devicePose)
         {
             bool poseRetrieved = false;
-            Handedness handedness = HandNode.ToHandedness();
 
             // palmPose retrieved in global space.
             if (XRSubsystemHelpers.HandsAggregator != null &&
@@ -135,6 +134,7 @@ private bool TryGetPolyfillDevicePose(out Pose devicePose)
                 // our global palm pose back into scene-origin-space.
                 devicePose = PlayspaceUtilities.InverseTransformPose(palmPose.Pose);
 
+                Handedness handedness = HandNode.ToHandedness();
                 switch (handedness)
                 {
                     case Handedness.Left:

org.mixedrealitytoolkit.input/Utilities/HandDataContainer.cs

@@ -22,7 +22,7 @@ public abstract class HandDataContainer
         public bool AlreadyFullQueried { get; protected set; }
 
         /// <summary>
-        /// Will be <see langword="true"/> if the the hand joint query as successful.
+        /// Will be <see langword="true"/> if the hand joint query as successful.
         /// </summary>
         public bool FullQueryValid { get; protected set; }
 
@@ -41,24 +41,23 @@ public HandDataContainer(XRNode handNode)
         }
 
         /// <summary>
-        /// Reset the hand data query status
+        /// Reset the hand data query status.
         /// </summary>
         public void Reset()
         {
             AlreadyFullQueried = false;
             FullQueryValid = false;
         }
 
-
-        /// <summary>   
-        /// Implemented in derived classes.  This method gets all of the joint poses for the hand.
+        /// <summary>
+        /// Implemented in derived classes. This method gets all of the joint poses for the hand.
         /// </summary>
         /// <param name="joints"> The returned list of HandJointPoses</param>
         /// <returns><see langword="true"/> if the query was successful, otherwise <see langword="false"/>.</returns>
         public abstract bool TryGetEntireHand(out IReadOnlyList<HandJointPose> joints);
 
-        /// <summary>   
-        /// Implemented in derived classes.  This method gets the specified joint pose.
+        /// <summary>
+        /// Implemented in derived classes. This method gets the specified joint pose.
         /// </summary>
         /// <param name="joint">The TrackedHandJoint to retrieve the post for.</param>
         /// <param name="pose">The returned HandJointPose.</param>

org.mixedrealitytoolkit.input/Visualizers/ControllerVisualizer/ControllerVisualizer.cs

@@ -2,7 +2,6 @@
 // Licensed under the BSD 3-Clause
 
 using MixedReality.Toolkit.Input.Simulation;
-using MixedReality.Toolkit.Subsystems;
 using System;
 using System.Threading.Tasks;
 using UnityEngine;