Merge pull request #7199 from Troy-Ferrell/users/trferrel/configurator-buildtarget-fix

Harden MRTK Project Configurator

Author: Troy-Ferrell

Assets/MixedRealityToolkit/Inspectors/Setup/MixedRealityProjectConfiguratorWindow.cs

@@ -92,17 +92,32 @@ private void OnGUI()
         {
             MixedRealityInspectorUtility.RenderMixedRealityToolkitLogo();
 
-            RenderChoiceDialog();
+            if (!MixedRealityProjectConfigurator.IsProjectConfigured())
+            {
+                RenderChoiceDialog();
 
-            EditorGUILayout.Space();
+                EditorGUILayout.Space();
 
-            showConfigurations = EditorGUILayout.Foldout(showConfigurations, "Modify Configurations", true);
-            if (showConfigurations)
+                showConfigurations = EditorGUILayout.Foldout(showConfigurations, "Modify Configurations", true);
+                if (showConfigurations)
+                {
+                    RenderConfigurations();
+                }
+            }
+            else
             {
-                RenderConfigurations();
+                RenderConfiguredConfirmation();
             }
         }
 
+        private void RenderConfiguredConfirmation()
+        {
+            const string dialogTitle = "Project Configuration Complete";
+            const string dialogContent = "This Unity project is properly configured for the Mixed Reality Toolkit.";
+            EditorGUILayout.LabelField(dialogTitle, EditorStyles.boldLabel);
+            EditorGUILayout.LabelField(dialogContent);
+        }
+
         private void RenderChoiceDialog()
         {
             const string dialogTitle = "Apply Default Settings?";

Assets/MixedRealityToolkit/Utilities/Editor/Setup/MixedRealityProjectConfigurator.cs

@@ -52,46 +52,91 @@ public enum Configurations
             IOSCameraUsageDescription,
         };
 
+        private class ConfigGetter
+        {
+            /// <summary>
+            /// Array of build targets where the get action is valid
+            /// </summary>
+            public BuildTarget[] ValidTargets;
+
+            /// <summary>
+            /// Action to perform to determine if the current configuration is correctly enabled
+            /// </summary>
+            public Func<bool> GetAction;
+
+            public ConfigGetter(Func<bool> get, BuildTarget target = BuildTarget.NoTarget)
+            {
+                GetAction = get;
+                ValidTargets = new BuildTarget[] { target };
+            }
+
+            public ConfigGetter(Func<bool> get, BuildTarget[] targets)
+            {
+                GetAction = get;
+                ValidTargets = targets;
+            }
+
+            /// <summary>
+            /// Returns true if the active build target is contained in the ValidTargets list or the list contains a BuildTarget.NoTarget entry, false otherwise
+            /// </summary>
+            public bool IsActiveBuildTargetValid()
+            {
+                foreach (var buildTarget in ValidTargets)
+                {
+                    if (buildTarget == BuildTarget.NoTarget || buildTarget == EditorUserBuildSettings.activeBuildTarget)
+                    {
+                        return true;
+                    }
+                }
+
+                return false;
+            }
+        }
+
         // The check functions for each type of setting
-        private static readonly Dictionary<Configurations, Func<bool>> ConfigurationGetters = new Dictionary<Configurations, Func<bool>>()
+        private static readonly Dictionary<Configurations, ConfigGetter> ConfigurationGetters = new Dictionary<Configurations, ConfigGetter>()
         {
-            { Configurations.LatestScriptingRuntime,  () => { return IsLatestScriptingRuntime(); } },
-            { Configurations.ForceTextSerialization,  () => { return IsForceTextSerialization(); } },
-            { Configurations.VisibleMetaFiles,  () => { return IsVisibleMetaFiles(); } },
+            { Configurations.LatestScriptingRuntime, new ConfigGetter(() => { return IsLatestScriptingRuntime(); }) },
+            { Configurations.ForceTextSerialization, new ConfigGetter(() => { return IsForceTextSerialization(); }) },
+            { Configurations.VisibleMetaFiles, new ConfigGetter(() => { return IsVisibleMetaFiles(); }) },
             // Ensure compatibility with the pre-2019.3 XR architecture for customers / platforms
             // with legacy requirements.
 #pragma warning disable 0618
-            { Configurations.VirtualRealitySupported,  () => { return PlayerSettings.virtualRealitySupported; } },
+            { Configurations.VirtualRealitySupported, new ConfigGetter(() => { return PlayerSettings.virtualRealitySupported; }) },
 #pragma warning restore 0618
-            { Configurations.SinglePassInstancing,  () => { return MixedRealityOptimizeUtils.IsSinglePassInstanced(); } },
-            { Configurations.SpatialAwarenessLayer,  () => { return HasSpatialAwarenessLayer(); } },
-            { Configurations.EnableMSBuildForUnity, () => { return IsMSBuildForUnityEnabled(); } },
+            { Configurations.SinglePassInstancing, new ConfigGetter(() => { return MixedRealityOptimizeUtils.IsSinglePassInstanced(); }) },
+            { Configurations.SpatialAwarenessLayer, new ConfigGetter(() => { return HasSpatialAwarenessLayer(); }) },
+            { Configurations.EnableMSBuildForUnity, new ConfigGetter(() => { return IsMSBuildForUnityEnabled(); }) },
 
             // UWP Capabilities
-            { Configurations.SpatialPerceptionCapability,  () => { return PlayerSettings.WSA.GetCapability(PlayerSettings.WSACapability.SpatialPerception); } },
-            { Configurations.MicrophoneCapability,  () => { return PlayerSettings.WSA.GetCapability(PlayerSettings.WSACapability.Microphone); } },
-            { Configurations.InternetClientCapability,  () => { return PlayerSettings.WSA.GetCapability(PlayerSettings.WSACapability.InternetClient); } },
+            { Configurations.SpatialPerceptionCapability, new ConfigGetter(() => { return GetCapability(PlayerSettings.WSACapability.SpatialPerception); }, BuildTarget.WSAPlayer) },
+            { Configurations.MicrophoneCapability, new ConfigGetter(() => { return GetCapability(PlayerSettings.WSACapability.Microphone); }, BuildTarget.WSAPlayer) },
+            { Configurations.InternetClientCapability, new ConfigGetter(() => { return GetCapability(PlayerSettings.WSACapability.InternetClient); }, BuildTarget.WSAPlayer) },
 #if UNITY_2019_3_OR_NEWER
-            { Configurations.EyeTrackingCapability,  () => { return PlayerSettings.WSA.GetCapability(PlayerSettings.WSACapability.GazeInput); } },
+            { Configurations.EyeTrackingCapability, new ConfigGetter(() => { return GetCapability(PlayerSettings.WSACapability.GazeInput); }, BuildTarget.WSAPlayer) },
 #endif // UNITY_2019_3_OR_NEWER
 
             // Android Settings
-            { Configurations.AndroidMultiThreadedRendering, () => { return PlayerSettings.GetMobileMTRendering(BuildTargetGroup.Android) == false; } },
-            { Configurations.AndroidMinSdkVersion, () => { return PlayerSettings.Android.minSdkVersion >= MinAndroidSdk; } },
+            { Configurations.AndroidMultiThreadedRendering, 
+                new ConfigGetter(() => { return PlayerSettings.GetMobileMTRendering(BuildTargetGroup.Android) == false; }, BuildTarget.Android) },
+            { Configurations.AndroidMinSdkVersion,
+                new ConfigGetter(() => { return PlayerSettings.Android.minSdkVersion >= MinAndroidSdk; }, BuildTarget.Android) },
 
             // iOS Settings
-            { Configurations.IOSMinOSVersion, () => {
+            { Configurations.IOSMinOSVersion, new ConfigGetter(() => {
                     float version;
                     if (!float.TryParse(PlayerSettings.iOS.targetOSVersionString, out version)) { return false; }
-                    return version >= iOSMinOsVersion; } },
-            { Configurations.IOSArchitecture, () => { return PlayerSettings.GetArchitecture(BuildTargetGroup.iOS) == RequirediOSArchitecture; } },
-            { Configurations.IOSCameraUsageDescription, () => { return !string.IsNullOrWhiteSpace(PlayerSettings.iOS.cameraUsageDescription); } },
+                    return version >= iOSMinOsVersion; }, BuildTarget.iOS) },
+            { Configurations.IOSArchitecture, 
+                new ConfigGetter(() => { return PlayerSettings.GetArchitecture(BuildTargetGroup.iOS) == RequirediOSArchitecture; }, BuildTarget.iOS) },
+            { Configurations.IOSCameraUsageDescription, 
+                new ConfigGetter(() => { return !string.IsNullOrWhiteSpace(PlayerSettings.iOS.cameraUsageDescription); }, BuildTarget.iOS) },
         };
 
         // The configure functions for each type of setting
         private static Dictionary<Configurations, Action> ConfigurationSetters = new Dictionary<Configurations, Action>()
         {
-            { Configurations.LatestScriptingRuntime,  () => { SetLatestScriptingRuntime(); } },
+            { Configurations.LatestScriptingRuntime, () => { SetLatestScriptingRuntime(); } },
             { Configurations.ForceTextSerialization,  () => { SetForceTextSerialization(); } },
             { Configurations.VisibleMetaFiles,  () => { SetVisibleMetaFiles(); } },
             // Ensure compatibility with the pre-2019.3 XR architecture for customers / platforms
@@ -130,7 +175,11 @@ public static bool IsConfigured(Configurations config)
         {
             if (ConfigurationGetters.ContainsKey(config))
             {
-                return ConfigurationGetters[config].Invoke();
+                var configGetter = ConfigurationGetters[config];
+                if (configGetter.IsActiveBuildTargetValid())
+                {
+                    return configGetter.GetAction.Invoke();
+                }
             }
 
             return false;
@@ -154,9 +203,9 @@ public static void Configure(Configurations config)
         /// <returns>true if entire project is configured as recommended, false otherwise</returns>
         public static bool IsProjectConfigured()
         {
-            foreach (var getter in ConfigurationGetters)
+            foreach (var configGetter in ConfigurationGetters)
             {
-                if (!getter.Value.Invoke())
+                if (configGetter.Value.IsActiveBuildTargetValid() && !configGetter.Value.GetAction.Invoke())
                 {
                     return false;
                 }
@@ -326,5 +375,10 @@ public static void ApplyXRSettings()
             }
 #pragma warning restore 0618
         }
+
+        private static bool GetCapability(PlayerSettings.WSACapability capability)
+        {
+            return MixedRealityOptimizeUtils.IsBuildTargetUWP() ? PlayerSettings.WSA.GetCapability(capability) : true;
+        }
     }
 }