Add MRTKFocusFeature

Author: keveleigh

UnityProjects/MRTKDevTemplate/Assets/XR/Settings/OpenXR Package Settings.asset

@@ -363,6 +363,26 @@ MonoBehaviour:
   company: Unity
   priority: 0
   required: 0
+--- !u!114 &-5000202051992085229
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 30587bb28b5390644ae70f801841a073, type: 3}
+  m_Name: MRTKFocusFeature Android
+  m_EditorClassIdentifier: 
+  m_enabled: 1
+  nameUi: MRTK3 Session Focus
+  version: 4.0.0
+  featureIdInternal: org.mixedreality.toolkit.input.focus
+  openxrExtensionStrings: 
+  company: Mixed Reality Toolkit Contributors
+  priority: 0
+  required: 0
 --- !u!114 &-4989097037534641705
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -394,6 +414,7 @@ MonoBehaviour:
   - {fileID: -5492763381520605560}
   - {fileID: 720212866400260749}
   - {fileID: -2783824018031006640}
+  - {fileID: -4614918767838866102}
   - {fileID: 4334429337943452973}
   - {fileID: -5448262054166454653}
   - {fileID: -9173909432611776730}
@@ -429,6 +450,26 @@ MonoBehaviour:
   company: Unity
   priority: 0
   required: 0
+--- !u!114 &-4614918767838866102
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 30587bb28b5390644ae70f801841a073, type: 3}
+  m_Name: MRTKFocusFeature Standalone
+  m_EditorClassIdentifier: 
+  m_enabled: 1
+  nameUi: MRTK3 Session Focus
+  version: 4.0.0
+  featureIdInternal: org.mixedreality.toolkit.input.focus
+  openxrExtensionStrings: 
+  company: Mixed Reality Toolkit Contributors
+  priority: 0
+  required: 0
 --- !u!114 &-3765664599707111037
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -536,6 +577,7 @@ MonoBehaviour:
   - {fileID: -7229825001273466666}
   - {fileID: 4508051287823359615}
   - {fileID: 2835676197965704550}
+  - {fileID: -5000202051992085229}
   - {fileID: -7431403579802858517}
   - {fileID: -3273436338079595365}
   - {fileID: 8773911662759437579}
@@ -651,6 +693,26 @@ MonoBehaviour:
   company: Unity
   priority: 0
   required: 0
+--- !u!114 &-1685409458817180080
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 30587bb28b5390644ae70f801841a073, type: 3}
+  m_Name: MRTKFocusFeature Metro
+  m_EditorClassIdentifier: 
+  m_enabled: 1
+  nameUi: MRTK3 Session Focus
+  version: 4.0.0
+  featureIdInternal: org.mixedreality.toolkit.input.focus
+  openxrExtensionStrings: 
+  company: Mixed Reality Toolkit Contributors
+  priority: 0
+  required: 0
 --- !u!114 &-1310172892294911860
 MonoBehaviour:
   m_ObjectHideFlags: 0
@@ -934,6 +996,7 @@ MonoBehaviour:
   - {fileID: 8785654261743502636}
   - {fileID: 2622006578924267534}
   - {fileID: -6733472631637007722}
+  - {fileID: -1685409458817180080}
   - {fileID: 4575689165844638740}
   - {fileID: 6698335440458243644}
   - {fileID: -2219742231848666541}

org.mixedrealitytoolkit.input/Editor/InputValidation.cs

@@ -27,29 +27,40 @@ private static void AddInputValidationRule()
         {
             foreach (var buildTargetGroup in MRTKProjectValidation.BuildTargetGroups)
             {
-                MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() { GenerateSpeechInteractorRule(buildTargetGroup) }, buildTargetGroup);
+                MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() {
+                    GenerateSpeechInteractorRule(buildTargetGroup)
+                }, buildTargetGroup);
 
 #if UNITY_OPENXR_PRESENT
                 // Skip the standalone target as the hand subsystem rule for it is already present for all build targets
                 if (buildTargetGroup != BuildTargetGroup.Standalone)
                 {
-                    MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() { GenerateUnityHandsRule(buildTargetGroup) }, buildTargetGroup);
+                    MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() {
+                        GenerateUnityHandsRule(buildTargetGroup),
+                        GenerateMRTKFocusFeatureRule(buildTargetGroup)
+                    }, buildTargetGroup);
                 }
 #endif
             }
-            MRTKProjectValidation.AddTargetIndependentRules(new List<BuildValidationRule>() { GenerateSkinWeightsRule(), GenerateGLTFastRule(),
+            MRTKProjectValidation.AddTargetIndependentRules(new List<BuildValidationRule>() {
+                GenerateSkinWeightsRule(),
+                GenerateGLTFastRule(),
 #if UNITY_OPENXR_PRESENT
                 GenerateUnityHandsRule(BuildTargetGroup.Standalone),
 #endif
             });
 
             // Only generate the KTX rule for platforms related to Meta
-            MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() { GenerateKTXRule(),
+            MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() {
+                GenerateKTXRule(),
 #if UNITY_OPENXR_PRESENT
                 GenerateAndroidHandsRule(),
 #endif
             }, BuildTargetGroup.Android);
-            MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() { GenerateKTXRule() }, BuildTargetGroup.Standalone);
+
+            MRTKProjectValidation.AddTargetDependentRules(new List<BuildValidationRule>() {
+                GenerateKTXRule()
+            }, BuildTargetGroup.Standalone);
         }
 
         private static BuildValidationRule GenerateSpeechInteractorRule(BuildTargetGroup buildTargetGroup)
@@ -197,6 +208,43 @@ private static BuildValidationRule GenerateAndroidHandsRule()
             };
 #pragma warning restore CS0618 // Type or member is obsolete
         }
+
+        private static BuildValidationRule GenerateMRTKFocusFeatureRule(BuildTargetGroup buildTargetGroup)
+        {
+            return new BuildValidationRule()
+            {
+                Category = "MRTK3",
+                Message = $"For MRTK3 input to work correctly on OpenXR, enable {MRTKFocusFeature.FriendlyName} in the OpenXR Settings.",
+                CheckPredicate = () =>
+                {
+                    OpenXRSettings settings = OpenXRSettings.GetSettingsForBuildTargetGroup(buildTargetGroup);
+                    if (settings == null)
+                    {
+                        return false;
+                    }
+
+                    MRTKFocusFeature focusFeature = settings.GetFeature<MRTKFocusFeature>();
+                    return focusFeature != null && focusFeature.enabled;
+                },
+                FixIt = () =>
+                {
+                    OpenXRSettings settings = OpenXRSettings.GetSettingsForBuildTargetGroup(buildTargetGroup);
+                    if (settings == null)
+                    {
+                        return;
+                    }
+
+                    MRTKFocusFeature focusFeature = settings.GetFeature<MRTKFocusFeature>();
+                    if (focusFeature != null)
+                    {
+                        focusFeature.enabled = true;
+                        EditorUtility.SetDirty(settings);
+                    }
+                },
+                FixItMessage = $"Enable {nameof(MRTKFocusFeature)} in the OpenXR settings.",
+                Error = true
+            };
+        }
 #endif
     }
 }

org.mixedrealitytoolkit.input/Features.meta

@@ -0,0 +1,59 @@
+// Copyright (c) Mixed Reality Toolkit Contributors
+// Licensed under the BSD 3-Clause
+
+using Unity.XR.CoreUtils.Bindings.Variables;
+using UnityEngine;
+using UnityEngine.XR.OpenXR.Features;
+
+#if UNITY_EDITOR
+using UnityEditor;
+using UnityEditor.XR.OpenXR.Features;
+#endif
+
+namespace MixedReality.Toolkit.Input
+{
+    /// <summary>
+    /// Provides focus data based on XrSession state.
+    /// </summary>
+#if UNITY_EDITOR
+    [OpenXRFeature(
+        UiName = FriendlyName,
+        Desc = "Provides focus data based on XrSession state.",
+        Company = "Mixed Reality Toolkit Contributors",
+        Version = "4.0.0",
+        BuildTargetGroups = new[] { BuildTargetGroup.Standalone, BuildTargetGroup.WSA, BuildTargetGroup.Android },
+        Category = FeatureCategory.Feature,
+        FeatureId = "org.mixedreality.toolkit.input.focus")]
+#endif
+    public sealed class MRTKFocusFeature : OpenXRFeature
+    {
+        /// <summary>
+        /// The "friendly" name for this feature.
+        /// </summary>
+        public const string FriendlyName = "MRTK3 Session Focus";
+
+        /// <summary>
+        /// Whether the current XrSession has focus or not, stored as a bindable variable that can be subscribed to for value changes.
+        /// </summary>
+        /// <remarks>Always <see langword="true"/> in the editor.</remarks>
+        public static IReadOnlyBindableVariable<bool> XrSessionFocused => xrSessionFocused;
+        private static readonly BindableVariable<bool> xrSessionFocused = new(Application.isEditor);
+
+        /// <inheritdoc/>
+        protected override void OnSessionStateChange(int oldState, int newState)
+        {
+            // If we've lost focus...
+            // XR_SESSION_STATE_FOCUSED = 5
+            if (oldState == 5)
+            {
+                xrSessionFocused.Value = false;
+            }
+            // ...or if we've gained focus
+            // XR_SESSION_STATE_FOCUSED = 5
+            else if (newState == 5)
+            {
+                xrSessionFocused.Value = true;
+            }
+        }
+    }
+}