Merge pull request #9681 from microsoft/feature/uber-profile

Update profiles to support both legacy XR and XR SDK

Author: keveleigh

Assets/MRTK/Core/Attributes/MixedRealityControllerAttribute.cs

@@ -44,7 +44,7 @@ public class MixedRealityControllerAttribute : Attribute
         public SupportedUnityXRPipelines SupportedUnityXRPipelines { get; }
 
         /// <summary>
-        /// 
+        /// Constructor.
         /// </summary>
         public MixedRealityControllerAttribute(
             SupportedControllerType supportedControllerType,

Assets/MRTK/Core/Attributes/MixedRealityExtensionServiceAttribute.cs

@@ -102,17 +102,12 @@ public MixedRealityExtensionServiceAttribute(
             RequiresProfile = requiresProfile;
         }
 
-#if UNITY_EDITOR
         /// <summary>
         /// Convenience function for retrieving the attribute given a certain class type.
         /// </summary>
-        /// <remarks>
-        /// This function is only available in a UnityEditor context.
-        /// </remarks>
         public static MixedRealityExtensionServiceAttribute Find(Type type)
         {
             return type.GetCustomAttributes(typeof(MixedRealityExtensionServiceAttribute), true).FirstOrDefault() as MixedRealityExtensionServiceAttribute;
         }
-#endif // UNITY_EDITOR
     }
 }

Assets/MRTK/Core/Definitions/InputSystem/MixedRealityInputSystemProfile.cs

@@ -155,13 +155,7 @@ public MixedRealityGesturesProfile GesturesProfile
         /// <summary>
         /// Returns whether speech is supported for the current language or not
         /// </summary>
-        public bool IsSpeechSupported
-        {
-            get
-            {
-                return supportedVoiceCultures.Contains(CultureInfo.CurrentUICulture);
-            }
-        }
+        public bool IsSpeechSupported => supportedVoiceCultures.Contains(CultureInfo.CurrentUICulture);
 
         [SerializeField]
         [Tooltip("Speech Command profile for wiring up Voice Input to Actions.")]

Assets/MRTK/Core/Definitions/MixedRealityToolkitConfigurationProfile.cs

@@ -157,25 +157,26 @@ public bool IsBoundarySystemEnabled
         }
 
         [SerializeField]
-        [Tooltip("Boundary System class to instantiate at runtime.")]
+        [Tooltip("Boundary system class to instantiate at runtime for legacy XR.")]
         [Implements(typeof(IMixedRealityBoundarySystem), TypeGrouping.ByNamespaceFlat)]
-        private SystemType boundarySystemType;
+        private SystemType boundarySystemType = null;
+
+        [SerializeField]
+        [Tooltip("Boundary system class to instantiate at runtime for XR SDK.")]
+        [Implements(typeof(IMixedRealityBoundarySystem), TypeGrouping.ByNamespaceFlat)]
+        private SystemType xrsdkBoundarySystemType = null;
 
         /// <summary>
-        /// Boundary System class to instantiate at runtime.
+        /// Boundary system class to instantiate at runtime.
         /// </summary>
-        public SystemType BoundarySystemSystemType
-        {
-            get { return boundarySystemType; }
-            internal set { boundarySystemType = value; }
-        }
+        public SystemType BoundarySystemSystemType => (!XRSettingsUtilities.LegacyXRAvailable && xrsdkBoundarySystemType?.Type != null) ? xrsdkBoundarySystemType : boundarySystemType;
 
         [SerializeField]
         [Tooltip("Profile for wiring up boundary visualization assets.")]
         private MixedRealityBoundaryVisualizationProfile boundaryVisualizationProfile;
 
         /// <summary>
-        /// Active profile for boundary visualization
+        /// Active profile for boundary visualization.
         /// </summary>
         public MixedRealityBoundaryVisualizationProfile BoundaryVisualizationProfile
         {

Assets/MRTK/Core/Definitions/Utilities/SupportedPlatforms.cs

@@ -30,6 +30,9 @@ public enum SupportedPlatforms
     [Flags]
     public enum SupportedUnityXRPipelines
     {
+#if UNITY_2020_1_OR_NEWER
+        [Obsolete("The legacy XR pipeline has been removed in Unity 2020 or newer. Please migrate to XR SDK.")]
+#endif // UNITY_2020_1_OR_NEWER
         LegacyXR = 1 << 0,
         XRSDK = 1 << 1,
     }

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

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using Microsoft.MixedReality.Toolkit.Utilities;
 using Microsoft.MixedReality.Toolkit.Utilities.Editor;
 using System;
 using System.Collections.Generic;
@@ -10,7 +11,7 @@
 namespace Microsoft.MixedReality.Toolkit.Editor
 {
     /// <summary>
-    /// Abstract class providing base functionality for data provider management in inspector. Useful for core systems that follow dataprovider access model.
+    /// Abstract class providing base functionality for data provider management in inspector. Useful for core systems that follow data provider access model.
     /// Designed to target ScriptableObject profile classes that configure services who support data providers. 
     /// These profile ScriptableObject classes should contain an array of IMixedRealityServiceConfigurations that configure a list of data providers for this service configuration
     /// </summary>
@@ -28,8 +29,9 @@ protected class ServiceConfigurationProperties
         }
 
         /// <summary>
-        /// Returns SerializedProperty object that wraps references to array of <see cref="IMixedRealityServiceConfiguration"/> stored on the inspected target object
+        /// Allows implementations of a IMixedRealityDataProviderAccess system's inspector to provide custom data provider representations for data providers.
         /// </summary>
+        /// <returns>SerializedProperty object that wraps references to array of <see cref="IMixedRealityServiceConfiguration"/> stored on the inspected target object.</returns>
         protected abstract SerializedProperty GetDataProviderConfigurationList();
 
         /// <summary>
@@ -46,6 +48,13 @@ protected class ServiceConfigurationProperties
         private SerializedProperty providerConfigurations;
         private List<bool> providerFoldouts = new List<bool>();
 
+#if UNITY_2019
+        private static readonly GUIContent GeneralProvidersLabel = new GUIContent("General Providers");
+#endif // UNITY_2019
+
+        private readonly XRPipelineUtility xrPipelineUtility = new XRPipelineUtility();
+        private readonly List<SystemType> delayedDisplayProviders = new List<SystemType>();
+
         private static readonly GUIContent ComponentTypeLabel = new GUIContent("Type");
         private static readonly GUIContent SupportedPlatformsLabel = new GUIContent("Supported Platform(s)");
 
@@ -56,6 +65,10 @@ protected override void OnEnable()
         {
             base.OnEnable();
 
+#if UNITY_2019
+            xrPipelineUtility.Enable();
+#endif // UNITY_2019
+
             providerConfigurations = GetDataProviderConfigurationList();
 
             if (providerFoldouts == null || providerFoldouts.Count != providerConfigurations.arraySize)
@@ -80,7 +93,7 @@ protected virtual void AddDataProvider()
 
             serializedObject.ApplyModifiedProperties();
 
-            var providerType = GetDataProviderConfiguration(providerConfigurations.arraySize - 1).ComponentType;
+            SystemType providerType = GetDataProviderConfiguration(providerConfigurations.arraySize - 1).ComponentType;
             providerType.Type = null;
 
             providerFoldouts.Add(false);
@@ -99,15 +112,15 @@ protected virtual void RemoveDataProvider(int index)
         }
 
         /// <summary>
-        /// Applies the given concrete dataprovider type properties to the provided <see cref="IMixedRealityServiceConfiguration"/> instance (as represented by <see cref="ServiceConfigurationProperties"/>).
+        /// Applies the given concrete data provider type properties to the provided <see cref="IMixedRealityServiceConfiguration"/> instance (as represented by <see cref="ServiceConfigurationProperties"/>).
         /// Requires <see cref="MixedRealityDataProviderAttribute"/> on concrete type class to pull initial values 
         /// that will be applied to the <see cref="ServiceConfigurationProperties"/> container SerializedProperties
         /// </summary>
         protected virtual void ApplyProviderConfiguration(Type dataProviderType, ServiceConfigurationProperties providerProperties)
         {
             if (dataProviderType != null)
             {
-                if (MixedRealityDataProviderAttribute.Find(dataProviderType) is MixedRealityDataProviderAttribute providerAttribute)
+                if (MixedRealityExtensionServiceAttribute.Find(dataProviderType) is MixedRealityDataProviderAttribute providerAttribute)
                 {
                     providerProperties.componentName.stringValue = !string.IsNullOrWhiteSpace(providerAttribute.Name) ? providerAttribute.Name : dataProviderType.Name;
                     providerProperties.providerProfile.objectReferenceValue = providerAttribute.DefaultProfile;
@@ -143,9 +156,53 @@ protected bool RenderDataProviderList(GUIContent addContentLabel, GUIContent rem
                     return true;
                 }
 
+#if UNITY_2019
+                xrPipelineUtility.RenderXRPipelineTabs();
+#endif // UNITY_2019
+
+                delayedDisplayProviders.Clear();
+
                 for (int i = 0; i < providerConfigurations.arraySize; i++)
                 {
-                    changed |= RenderDataProviderEntry(i, removeContentLabel, dataProviderProfileType);
+                    SystemType serviceType = GetDataProviderConfiguration(i).ComponentType;
+
+                    if (serviceType.Type != null && MixedRealityExtensionServiceAttribute.Find(serviceType.Type) is MixedRealityDataProviderAttribute providerAttribute)
+                    {
+                        // Using == here to compare flags because we want to know if this is the only supported pipeline
+                        // Providers that support multiple pipelines are rendered below the tabbed section
+                        if (providerAttribute.SupportedUnityXRPipelines == xrPipelineUtility.SelectedPipeline)
+                        {
+                            changed |= RenderDataProviderEntry(i, removeContentLabel, serviceType, dataProviderProfileType);
+                            delayedDisplayProviders.Add(null);
+                        }
+                        else if (providerAttribute.SupportedUnityXRPipelines == (SupportedUnityXRPipelines)(-1))
+                        {
+                            delayedDisplayProviders.Add(serviceType);
+                        }
+                        else
+                        {
+                            // Add null to ensure the delayedDisplayProviders list has an identical size to providerConfigurations.arraySize
+                            // This is so we can iterate through without keeping track of i separately
+                            delayedDisplayProviders.Add(null);
+                        }
+                    }
+                    else
+                    {
+                        delayedDisplayProviders.Add(serviceType);
+                    }
+                }
+
+#if UNITY_2019
+                EditorGUILayout.LabelField(GeneralProvidersLabel, EditorStyles.boldLabel);
+#endif // UNITY_2019
+
+                for (int i = 0; i < delayedDisplayProviders.Count; i++)
+                {
+                    SystemType service = delayedDisplayProviders[i];
+                    if (service != null)
+                    {
+                        changed |= RenderDataProviderEntry(i, removeContentLabel, service, dataProviderProfileType);
+                    }
                 }
 
                 return changed;
@@ -156,14 +213,12 @@ protected bool RenderDataProviderList(GUIContent addContentLabel, GUIContent rem
         /// Renders properties of <see cref="IMixedRealityServiceConfiguration"/> instance at provided index in inspector.
         /// Also renders inspector view of data provider's profile object and its contents if applicable and foldout is expanded.
         /// </summary>
-        protected bool RenderDataProviderEntry(int index, GUIContent removeContent, System.Type dataProviderProfileType = null)
+        private bool RenderDataProviderEntry(int index, GUIContent removeContent, SystemType serviceType, Type dataProviderProfileType = null)
         {
             bool changed = false;
             SerializedProperty provider = providerConfigurations.GetArrayElementAtIndex(index);
             ServiceConfigurationProperties providerProperties = GetDataProviderConfigurationProperties(provider);
 
-            var serviceType = GetDataProviderConfiguration(index).ComponentType;
-
             // Don't hide new data providers added via the UI, otherwise there's no easy way to change their type
             if (serviceType?.Type == null && !MixedRealityProjectPreferences.ShowNullDataProviders && !providerProperties.componentName.stringValue.StartsWith(NewDataProvider))
             {

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

@@ -35,10 +35,11 @@ public class MixedRealityControllerVisualizationProfileInspector : BaseMixedReal
         private static bool showControllerDefinitions = true;
         private SerializedProperty controllerVisualizationSettings;
 
+        private readonly XRPipelineUtility xrPipelineUtility = new XRPipelineUtility();
+
         private MixedRealityControllerVisualizationProfile thisProfile;
 
         private float defaultLabelWidth;
-        private float defaultFieldWidth;
 
         private const string ProfileTitle = "Controller Visualization Settings";
         private const string ProfileDescription = "Define all the custom controller visualizations you'd like to use for each controller type when they're rendered in the scene.\n\n" +
@@ -49,7 +50,10 @@ protected override void OnEnable()
             base.OnEnable();
 
             defaultLabelWidth = EditorGUIUtility.labelWidth;
-            defaultFieldWidth = EditorGUIUtility.fieldWidth;
+
+#if UNITY_2019
+            xrPipelineUtility.Enable();
+#endif // UNITY_2019
 
             thisProfile = target as MixedRealityControllerVisualizationProfile;
 
@@ -173,32 +177,50 @@ private void RenderControllerList(SerializedProperty controllerList)
                 return;
             }
 
+#if UNITY_2019
+            xrPipelineUtility.RenderXRPipelineTabs();
+#endif // UNITY_2019
+
             for (int i = 0; i < controllerList.arraySize; i++)
             {
-                EditorGUILayout.Space();
-                EditorGUILayout.BeginHorizontal();
-
                 var controllerSetting = controllerList.GetArrayElementAtIndex(i);
                 var mixedRealityControllerMappingDescription = controllerSetting.FindPropertyRelative("description");
-                bool hasValidType = thisProfile.ControllerVisualizationSettings[i].ControllerType != null &&
-                                    thisProfile.ControllerVisualizationSettings[i].ControllerType.Type != null;
+                SystemType controllerType = thisProfile.ControllerVisualizationSettings[i].ControllerType;
+                bool hasValidType = controllerType != null &&
+                                    controllerType.Type != null;
+
+                if (hasValidType)
+                {
+                    MixedRealityControllerAttribute controllerAttribute = MixedRealityControllerAttribute.Find(controllerType.Type);
+                    if (controllerAttribute != null && !controllerAttribute.SupportedUnityXRPipelines.HasFlag(xrPipelineUtility.SelectedPipeline))
+                    {
+                        continue;
+                    }
+                }
+                else if (!MixedRealityProjectPreferences.ShowNullDataProviders)
+                {
+                    continue;
+                }
+
+                EditorGUILayout.Space();
 
                 mixedRealityControllerMappingDescription.stringValue = hasValidType
-                    ? thisProfile.ControllerVisualizationSettings[i].ControllerType.Type.Name.ToProperCase()
+                    ? controllerType.Type.Name.ToProperCase()
                     : "Undefined Controller";
 
                 serializedObject.ApplyModifiedProperties();
-                var mixedRealityControllerHandedness = controllerSetting.FindPropertyRelative("handedness");
-                EditorGUILayout.LabelField($"{mixedRealityControllerMappingDescription.stringValue} {((Handedness)mixedRealityControllerHandedness.intValue).ToString().ToProperCase()} Hand", EditorStyles.boldLabel);
+                SerializedProperty mixedRealityControllerHandedness = controllerSetting.FindPropertyRelative("handedness");
 
-                if (GUILayout.Button(ControllerMinusButtonContent, EditorStyles.miniButtonRight, GUILayout.Width(24f)))
+                using (new EditorGUILayout.HorizontalScope())
                 {
-                    controllerList.DeleteArrayElementAtIndex(i);
-                    EditorGUILayout.EndHorizontal();
-                    return;
-                }
+                    EditorGUILayout.LabelField($"{mixedRealityControllerMappingDescription.stringValue} {((Handedness)mixedRealityControllerHandedness.intValue).ToString().ToProperCase()} Hand", EditorStyles.boldLabel);
 
-                EditorGUILayout.EndHorizontal();
+                    if (GUILayout.Button(ControllerMinusButtonContent, EditorStyles.miniButtonRight, GUILayout.Width(24f)))
+                    {
+                        controllerList.DeleteArrayElementAtIndex(i);
+                        return;
+                    }
+                }
 
                 EditorGUILayout.PropertyField(controllerSetting.FindPropertyRelative("controllerType"));
                 EditorGUILayout.PropertyField(controllerSetting.FindPropertyRelative("controllerVisualizationType"));
@@ -207,11 +229,14 @@ private void RenderControllerList(SerializedProperty controllerList)
                 {
                     EditorGUILayout.HelpBox("A controller type must be defined!", MessageType.Error);
                 }
-
-                bool isOculusType = thisProfile.ControllerVisualizationSettings[i].ControllerType.Type.FullName.Contains("OculusXRSDKTouchController");
-                if (isOculusType)
+                else
                 {
-                    EditorGUILayout.HelpBox("Oculus Touch controller model visualization is not managed by MRTK, refer to the Oculus XRSDK Device Manager to configure controller visualization settings", MessageType.Error);
+                    // Only check for Oculus if we already know the type is valid (otherwise, null ref)
+                    bool isOculusType = controllerType.Type.FullName.Contains("OculusXRSDKTouchController");
+                    if (isOculusType)
+                    {
+                        EditorGUILayout.HelpBox("Oculus Touch controller model visualization is not managed by MRTK, refer to the Oculus XRSDK Device Manager to configure controller visualization settings", MessageType.Error);
+                    }
                 }
 
                 var handednessValue = mixedRealityControllerHandedness.intValue - 1;

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

@@ -211,14 +211,11 @@ protected override ServiceConfigurationProperties GetDataProviderConfigurationPr
         /// <inheritdoc/>
         protected override IMixedRealityServiceConfiguration GetDataProviderConfiguration(int index)
         {
-            MixedRealityInputSystemProfile targetProfile = target as MixedRealityInputSystemProfile;
-            if (targetProfile != null)
+            MixedRealityInputSystemProfile profile = target as MixedRealityInputSystemProfile;
+            var configurations = (profile != null) ? profile.DataProviderConfigurations : null;
+            if (configurations != null && index >= 0 && index < configurations.Length)
             {
-                var configurations = targetProfile.DataProviderConfigurations;
-                if (configurations != null && index >= 0 && index < configurations.Length)
-                {
-                    return configurations[index];
-                }
+                return configurations[index];
             }
 
             return null;