Adjust MRTK scene content and experience across AR/VR/different experience scales (#9428)

* initial push for incorporating floor height into mrtk

* added unit tests for floor height

* made sure that the changes we made to a profile were reset after the test was complete

* removed extraneous log messages

* updated teleport tests to account for floor height

* initial addition of a MixedRealitySceneContent component

* removing floor height variables out of the camera system

* cleaning remaining camera system changes

* initial push of an experience settings profile rework

* updated some tests, experience settings profile now visible in editor

* fixed several tests and profiles to accomodate new experience setting, more to come

* addressed comments, fixed some unit tests

* moved experience setting profile, added header

* updated summaries, moved the inspector helpbox to the bottom to represent a high level summary of the current experience settings

* fixed spatial awareness tests to only init mrtk once

* provided a way for MRTK to explcitly control the floor height

* added test case for floor height

* pointer test changes

* added null check for camera system, made experience settings profile required

* added obsolete attribute to old variable

* removed experience settings platform

* floor height now changes during XR events on device

* fixed tests, base camera settings now adjust the floor height

* change to fix buildign on hololens issues

* fixed issues with the camera being offset unexpectedly

* Reverted api change and reserialized profiles

* reserializing remaining files

* removing remaining align camera references

* removing last align to floor height variable

* fixed formatting error

* attempting to reconcile floor height based on experience returned by XR device

* removing attempts to adjust the camera height due to the available solutions being incompatible with HL2 scenarios

* added cases to allow scene content to scale appropriately in editor

* PR adjustments, pipeline fix

* Update Assets/MRTK/Examples/Demos/EyeTracking/General/Profiles/EyeTrackingDemoConfigurationProfile.asset

Co-authored-by: Kurtis <[email protected]>

* reserialized teleport profile

* cased xrsdk code by unity version

* fixed typo

* reserialized settings profile properly

* cased on unity version

* Demo Profile reserialization

* small test utility QoL

* debugging unit tests

* more debugging

* debug aaa

* debuuggging

* debuuggging

* more debugging

* fixing debugger complaints

* PR debugging final hopefully

* fixing debugger complaints

* all the deub messages

* debugging the awake()/start() lifecycle

* removed debug statements, fixed frame wait call preventing coroutine from running in batch mode, removed manual camera offsetting

* removed extraneous warning message

* Update Assets/MRTK/Tests/TestUtilities/TestUtilities.cs

Co-authored-by: MaxWang-MS <[email protected]>

* Update Assets/MRTK/Core/Providers/BaseCameraSettingsProvider.cs

Co-authored-by: MaxWang-MS <[email protected]>

* Update Assets/MRTK/Core/Utilities/MixedRealitySceneContent.cs

Co-authored-by: MaxWang-MS <[email protected]>

* updated function documentation, removed outdated link from other class summary

* added tools in the inspector to assist with migration due to profile changes

* Fixing the apply modified properties call and some cleanup

* modified description for clarity

* added check for null container object

* refactored floor height as user height

* refactored again to content offset

Co-authored-by: Kurtis <[email protected]>
Co-authored-by: MaxWang-MS <[email protected]>

Author: 3 people

Assets/MRTK/Core/Definitions/MixedRealityExperienceSettingsProfile.cs

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.MixedReality.Toolkit.Utilities;
+using System;
+using System.Runtime.CompilerServices;
+using UnityEngine;
+using UnityEngine.Serialization;
+
+[assembly: InternalsVisibleTo("Microsoft.MixedReality.Toolkit.Tests.EditModeTests")]
+[assembly: InternalsVisibleTo("Microsoft.MixedReality.Toolkit.Tests.PlayModeTests")]
+namespace Microsoft.MixedReality.Toolkit
+{
+    /// <summary>
+    /// Experience settings profile for the Mixed Reality Toolkit.
+    /// </summary>
+    [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Profiles/Mixed Reality Toolkit Experience Settings Profile", fileName = "MixedRealityToolkitExperienceSettingsProfile", order = (int)CreateProfileMenuItemIndices.Configuration)]
+    [HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/configuration/mixed-reality-configuration-guide")]
+    public class MixedRealityExperienceSettingsProfile : BaseMixedRealityProfile
+    {
+        [SerializeField]
+        [Tooltip("The scale of the Mixed Reality experience.")]
+        private ExperienceScale targetExperienceScale = ExperienceScale.Room;
+
+        /// <summary>
+        /// The desired the scale of the experience.
+        /// </summary>
+        public ExperienceScale TargetExperienceScale
+        {
+            get { return targetExperienceScale; }
+            set { targetExperienceScale = value; }
+        }
+
+        [SerializeField]
+        [Tooltip("The amount to offset the MixedRealitySceneContent for the target experience. 1 unit = 1 meter")]
+        private float contentOffset = 0.0f;
+
+        /// <summary>
+        /// The height above the floor for the Mixed Reality Experience. 1 unit = 1 meter
+        /// </summary>
+        public float ContentOffset
+        {
+            get { return contentOffset; }
+            set { contentOffset = value; }
+        }
+    }
+}

Assets/MRTK/Core/Definitions/MixedRealityExperienceSettingsProfile.cs.meta

@@ -27,13 +27,34 @@ public class MixedRealityToolkitConfigurationProfile : BaseMixedRealityProfile
     {
         #region Mixed Reality Toolkit configurable properties
 
+        [SerializeField]
+        [Tooltip("Experience Settings profile.")]
+        private MixedRealityExperienceSettingsProfile experienceSettingsProfile;
+
+        /// <summary>
+        /// Profile for configuring the experience settings of your project.
+        /// Determines whether your project targers AR/VR, the scale of your experience, and the height of the user where applicable
+        /// </summary>
+        public MixedRealityExperienceSettingsProfile ExperienceSettingsProfile
+        {
+            get { return experienceSettingsProfile; }
+            internal set { experienceSettingsProfile = value; }
+        }
+
+
         [SerializeField]
         [Tooltip("The scale of the Mixed Reality experience.")]
         private ExperienceScale targetExperienceScale = ExperienceScale.Room;
 
         /// <summary>
         /// The desired the scale of the experience.
+        /// Profile for configuring the experience settings of your project.
+        /// Determines whether your project targers AR/VR, the scale of your experience, and the height of the user where applicable
         /// </summary>
+        /// <remarks>
+        /// The target experience scale is now configured via ExperienceSettingsProfile
+        /// </remarks>
+        [Obsolete("The target experience scale is now configured via ExperienceSettingsProfile, please use the ExperienceSettingsProfile.TargetExperienceScale instead")]
         public ExperienceScale TargetExperienceScale
         {
             get { return targetExperienceScale; }

Assets/MRTK/Core/Definitions/MixedRealityToolkitConfigurationProfile.cs

@@ -73,10 +73,11 @@ public static void RenderReadOnlyProfile(SerializedProperty property)
         /// <param name="showCloneButton">If true, draw the clone button, if false, don't</param>
         /// <param name="renderProfileInBox">if true, render box around profile content, if false, don't</param>
         /// <param name="serviceType">Optional service type to limit available profile types.</param>
+        /// <param name="profileRequiredOverride">Optional parameter to used to specify that a profile must be selected</param>
         /// <returns>True, if the profile changed.</returns>
-        protected static bool RenderProfile(SerializedProperty property, Type profileType, bool showCloneButton = true, bool renderProfileInBox = false, Type serviceType = null)
+        protected static bool RenderProfile(SerializedProperty property, Type profileType, bool showCloneButton = true, bool renderProfileInBox = false, Type serviceType = null, bool profileRequiredOverride = false)
         {
-            return RenderProfileInternal(property, profileType, showCloneButton, renderProfileInBox, serviceType);
+            return RenderProfileInternal(property, profileType, showCloneButton, renderProfileInBox, serviceType, profileRequiredOverride);
         }
 
         /// <summary>
@@ -86,9 +87,10 @@ protected static bool RenderProfile(SerializedProperty property, Type profileTyp
         /// <param name="showCloneButton">If true, draw the clone button, if false, don't</param>
         /// <param name="renderProfileInBox">if true, render box around profile content, if false, don't</param>
         /// <param name="serviceType">Optional service type to limit available profile types.</param>
+        /// <param name="profileRequiredOverride">Optional parameter to used to specify that a profile must be selected</param>
         /// <returns>True, if the profile changed.</returns>
         private static bool RenderProfileInternal(SerializedProperty property, Type profileType,
-            bool showCloneButton, bool renderProfileInBox, Type serviceType = null)
+            bool showCloneButton, bool renderProfileInBox, Type serviceType = null, bool profileRequiredOverride = false)
         {
             var profile = property.serializedObject.targetObject as BaseMixedRealityProfile;
             bool changed = false;
@@ -112,7 +114,7 @@ private static bool RenderProfileInternal(SerializedProperty property, Type prof
 
             Type[] profileTypes = new Type[] { };
 
-            bool requiresProfile = IsProfileRequired(serviceType) ;
+            bool requiresProfile = IsProfileRequired(serviceType) || profileRequiredOverride;
             if (profileType == null)
             {
                 // Find the profile type so we can limit the available object field options

Assets/MRTK/Core/Inspectors/Profiles/BaseMixedRealityProfileInspector.cs

@@ -21,7 +21,12 @@ public class MixedRealityToolkitConfigurationProfileInspector : BaseMixedReality
         private static readonly GUIContent TargetScaleContent = new GUIContent("Target Scale:");
 
         // Experience properties
-        private SerializedProperty targetExperienceScale;
+        private SerializedProperty experienceSettingsType;
+        private SerializedProperty experienceSettingsProfile;
+
+        // Tracking the old experience scale property for compatibility
+        private SerializedProperty experienceScaleMigration;
+
         // Camera properties
         private SerializedProperty enableCameraSystem;
         private SerializedProperty cameraSystemType;
@@ -61,6 +66,7 @@ public class MixedRealityToolkitConfigurationProfileInspector : BaseMixedReality
         private Func<bool>[] renderProfileFuncs;
 
         private static readonly string[] ProfileTabTitles = {
+            "Experience Settings",
             "Camera",
             "Input",
             "Boundary",
@@ -88,7 +94,10 @@ protected override void OnEnable()
             MixedRealityToolkitConfigurationProfile mrtkConfigProfile = target as MixedRealityToolkitConfigurationProfile;
 
             // Experience configuration
-            targetExperienceScale = serializedObject.FindProperty("targetExperienceScale");
+            experienceSettingsType = serializedObject.FindProperty("experienceSettingsType");
+            experienceSettingsProfile = serializedObject.FindProperty("experienceSettingsProfile");
+            experienceScaleMigration = serializedObject.FindProperty("targetExperienceScale");
+
             // Camera configuration
             enableCameraSystem = serializedObject.FindProperty("enableCameraSystem");
             cameraSystemType = serializedObject.FindProperty("cameraSystemType");
@@ -131,6 +140,56 @@ protected override void OnEnable()
             {
                 renderProfileFuncs = new Func<bool>[]
                 {
+                    () => {
+                        bool changed = false;
+                        using (var c = new EditorGUI.ChangeCheckScope())
+                        {
+                            // Reconciling old Experience Scale property with the Experience Settings Profile
+                            var oldExperienceSettigsScale = (experienceSettingsProfile.objectReferenceValue as MixedRealityExperienceSettingsProfile)?.TargetExperienceScale;
+
+                            changed |= RenderProfile(experienceSettingsProfile, typeof(MixedRealityExperienceSettingsProfile), true, false,  null, true);
+
+                            // Experience configuration
+                            if(!mrtkConfigProfile.ExperienceSettingsProfile.IsNull())
+                            {                            
+                                // If the Experience Scale property changed, make sure we also alter the configuration profile's target experience scale property for compatibility
+                                var newExperienceSettigs = (experienceSettingsProfile.objectReferenceValue as MixedRealityExperienceSettingsProfile)?.TargetExperienceScale;
+                                if(oldExperienceSettigsScale.HasValue && newExperienceSettigs.HasValue && oldExperienceSettigsScale != newExperienceSettigs)
+                                {
+                                    experienceScaleMigration.intValue = (int)newExperienceSettigs;
+                                    experienceScaleMigration.serializedObject.ApplyModifiedProperties();
+                                }
+                                // If we have not changed the Experience Settings profile and it's value is out of sync with the top level configuration profile, display a migration prompt
+                                else if ((ExperienceScale)experienceScaleMigration.intValue != mrtkConfigProfile.ExperienceSettingsProfile.TargetExperienceScale)
+                                {
+                                    Color errorColor = Color.Lerp(Color.white, Color.red, 0.5f);
+                                    Color defaultColor = GUI.color;
+
+                                    GUI.color = errorColor;
+                                    EditorGUILayout.HelpBox("A previous version of this profile has a different Experience Scale, displayed below. Please modify the Experience Setting Profile's Target Experience Scale or select your desired scale below", MessageType.Warning);
+                                    var oldValue = experienceScaleMigration.intValue;
+                                    EditorGUILayout.PropertyField(experienceScaleMigration);
+                                    if (oldValue != experienceScaleMigration.intValue)
+                                    {
+                                        mrtkConfigProfile.ExperienceSettingsProfile.TargetExperienceScale = (ExperienceScale)experienceScaleMigration.intValue;
+                                    }
+                                    GUI.color = defaultColor;
+                                }
+
+
+                                ExperienceScale experienceScale = mrtkConfigProfile.ExperienceSettingsProfile.TargetExperienceScale;
+                                string targetExperienceSummary = GetExperienceDescription(experienceScale);
+                                if (!string.IsNullOrEmpty(targetExperienceSummary))
+                                {
+                                    EditorGUILayout.HelpBox(targetExperienceSummary, MessageType.None);
+                                    EditorGUILayout.Space();
+                                }
+                            }
+
+                            changed |= c.changed;
+                        }
+                        return changed;
+                    },
                     () => {
                         bool changed = false;
                         using (var c = new EditorGUI.ChangeCheckScope())
@@ -180,7 +239,7 @@ protected override void OnEnable()
                         return changed;
                     },
                     () => {
-                        var experienceScale = (ExperienceScale)targetExperienceScale.intValue;
+                        var experienceScale = mrtkConfigProfile.ExperienceSettingsProfile.TargetExperienceScale;
                         if (experienceScale != ExperienceScale.Room)
                         {
                             // Alert the user if the experience scale does not support boundary features.
@@ -299,7 +358,6 @@ protected override void OnEnable()
 
                                 changed |= RenderProfile(sceneSystemProfile, typeof(MixedRealitySceneSystemProfile), true, true, typeof(IMixedRealitySceneSystem));
                             }
-
                             changed |= c.changed;
                         }
                         return changed;
@@ -395,22 +453,7 @@ public override void OnInspectorGUI()
             bool isGUIEnabled = !IsProfileLock((BaseMixedRealityProfile)target) && GUI.enabled;
             GUI.enabled = isGUIEnabled;
 
-            EditorGUI.BeginChangeCheck();
             bool changed = false;
-
-            // Experience configuration
-            ExperienceScale experienceScale = (ExperienceScale)targetExperienceScale.intValue;
-            EditorGUILayout.PropertyField(targetExperienceScale, TargetScaleContent);
-
-            string scaleDescription = GetExperienceDescription(experienceScale);
-            if (!string.IsNullOrEmpty(scaleDescription))
-            {
-                EditorGUILayout.HelpBox(scaleDescription, MessageType.None);
-                EditorGUILayout.Space();
-            }
-
-            changed |= EditorGUI.EndChangeCheck();
-
             EditorGUILayout.BeginHorizontal();
 
             EditorGUILayout.BeginVertical(EditorStyles.helpBox, GUILayout.Width(100));

Assets/MRTK/Core/Inspectors/Profiles/MixedRealityToolkitConfigurationProfileInspector.cs

@@ -87,14 +87,16 @@ public static bool CheckMixedRealityConfigured(bool renderEditorElements = false
         /// <summary>
         /// If MRTK is not initialized in scene, adds and initializes instance to current scene
         /// </summary>
-        public static void AddMixedRealityToolkitToScene(MixedRealityToolkitConfigurationProfile configProfile = null)
+        public static void AddMixedRealityToolkitToScene(MixedRealityToolkitConfigurationProfile configProfile = null, bool inPlayMode = false)
         {
             if (!MixedRealityToolkit.IsInitialized)
             {
                 MixedRealityToolkit newInstance = new GameObject("MixedRealityToolkit").AddComponent<MixedRealityToolkit>();
                 MixedRealityToolkit.SetActiveInstance(newInstance);
                 Selection.activeObject = newInstance;
 
+                MixedRealityToolkit.ConfirmInitialized();
+
                 if (configProfile == null)
                 {
                     // if we don't have a profile set we get the default profile
@@ -104,7 +106,17 @@ public static void AddMixedRealityToolkitToScene(MixedRealityToolkitConfiguratio
                 {
                     newInstance.ActiveProfile = configProfile;
                 }
-                EditorSceneManager.MarkSceneDirty(EditorSceneManager.GetActiveScene());
+
+                if(!newInstance.ActiveProfile.ExperienceSettingsProfile.IsNull())
+                {
+                    // Add a MixedRealitySceneContent object to a scene. Children of this object will scale appropriately dependent on MR platform
+                    MixedRealitySceneContent contentAdjuster = new GameObject("MixedRealitySceneContent").AddComponent<MixedRealitySceneContent>();
+                }
+
+                if (!inPlayMode)
+                {
+                    EditorSceneManager.MarkSceneDirty(EditorSceneManager.GetActiveScene());
+                }
             }
         }
 

Assets/MRTK/Core/Inspectors/Utilities/MixedRealityInspectorUtility.cs

@@ -51,4 +51,4 @@ public virtual void ApplyConfiguration()
             }
         }
     }
-}
+}

Assets/MRTK/Core/Providers/BaseCameraSettingsProvider.cs

@@ -470,10 +470,10 @@ private void InitializeServiceLocator()
             }
 
             // If the Boundary system has been selected for initialization in the Active profile, enable it in the project
-            if (ActiveProfile.IsBoundarySystemEnabled)
+            if (ActiveProfile.IsBoundarySystemEnabled && !ActiveProfile.ExperienceSettingsProfile.IsNull())
             {
                 DebugUtilities.LogVerbose("Begin registration of the boundary system");
-                object[] args = { ActiveProfile.BoundaryVisualizationProfile, ActiveProfile.TargetExperienceScale };
+                object[] args = { ActiveProfile.BoundaryVisualizationProfile, ActiveProfile.ExperienceSettingsProfile.TargetExperienceScale };
                 if (!RegisterService<IMixedRealityBoundarySystem>(ActiveProfile.BoundarySystemSystemType, args: args) || CoreServices.BoundarySystem == null)
                 {
                     Debug.LogError("Failed to start the Boundary System!");