Merge pull request #3586 from Railboy/mrtk_inspector_upgrade_pt3

David Kline · web-flow · commit 2da0bb70bc82 · 2019-03-13T11:40:58.000-07:00
Mrtk Inspector Upgrade (Part 3)
diff --git a/Assets/MixedRealityToolkit/Attributes/MixedRealityServiceProfileAttribute.cs b/Assets/MixedRealityToolkit/Attributes/MixedRealityServiceProfileAttribute.cs
@@ -0,0 +1,20 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using Microsoft.MixedReality.Toolkit.Core.Interfaces;
+using System;
+
+namespace Microsoft.MixedReality.Toolkit.Core.Attributes
+{
+    /// <summary>
+    /// Attribute that defines which service a profile is meant to be consumed by.
+    /// Only applies to profiles that are consumed by types implementing IMixedRealityService.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
+    public class MixedRealityServiceProfileAttribute : Attribute
+    {
+        public MixedRealityServiceProfileAttribute(Type serviceType) { ServiceType = serviceType; }
+
+        public Type ServiceType { get; private set; }
+    }
+}
diff --git a/Assets/MixedRealityToolkit/Attributes/MixedRealityServiceProfileAttribute.cs.meta b/Assets/MixedRealityToolkit/Attributes/MixedRealityServiceProfileAttribute.cs.meta
diff --git a/Assets/MixedRealityToolkit/Definitions/BoundarySystem/MixedRealityBoundaryVisualizationProfile.cs b/Assets/MixedRealityToolkit/Definitions/BoundarySystem/MixedRealityBoundaryVisualizationProfile.cs
@@ -3,6 +3,7 @@
 
 using Microsoft.MixedReality.Toolkit.Core.Attributes;
 using Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities;
+using Microsoft.MixedReality.Toolkit.Core.Interfaces.BoundarySystem;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Core.Definitions.BoundarySystem
@@ -11,6 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.Core.Definitions.BoundarySystem
     /// Configuration profile settings for setting up boundary visualizations.
     /// </summary>
     [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Boundary Visualization Profile", fileName = "MixedRealityBoundaryVisualizationProfile", order = (int)CreateProfileMenuItemIndices.BoundaryVisualization)]
+    [MixedRealityServiceProfile(typeof(IMixedRealityBoundarySystem))]
     public class MixedRealityBoundaryVisualizationProfile : BaseMixedRealityProfile
     {
         [SerializeField]
diff --git a/Assets/MixedRealityToolkit/Definitions/Devices/MixedRealityControllerVisualizationProfile.cs b/Assets/MixedRealityToolkit/Definitions/Devices/MixedRealityControllerVisualizationProfile.cs
@@ -10,6 +10,7 @@
 namespace Microsoft.MixedReality.Toolkit.Core.Definitions.Devices
 {
     [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Controller Visualization Profile", fileName = "MixedRealityControllerVisualizationProfile", order = (int)CreateProfileMenuItemIndices.ControllerVisualization)]
+    [MixedRealityServiceProfile(typeof(IMixedRealityControllerVisualizer))]
     public class MixedRealityControllerVisualizationProfile : BaseMixedRealityProfile
     {
         [SerializeField]
diff --git a/Assets/MixedRealityToolkit/Definitions/Diagnostics/MixedRealityDiagnosticsProfile.cs b/Assets/MixedRealityToolkit/Definitions/Diagnostics/MixedRealityDiagnosticsProfile.cs
@@ -1,7 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
+using Microsoft.MixedReality.Toolkit.Core.Attributes;
 using Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities;
+using Microsoft.MixedReality.Toolkit.Core.Interfaces.Diagnostics;
 using UnityEngine;
 using UnityEngine.Serialization;
 
@@ -11,6 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.Core.Definitions.Diagnostics
     /// Configuration profile settings for setting up diagnostics.
     /// </summary>
     [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Diagnostics Profile", fileName = "MixedRealityDiagnosticsProfile", order = (int)CreateProfileMenuItemIndices.Diagnostics)]
+    [MixedRealityServiceProfile(typeof(IMixedRealityDiagnosticsSystem))]
     public class MixedRealityDiagnosticsProfile : BaseMixedRealityProfile
     {
         [SerializeField]
diff --git a/Assets/MixedRealityToolkit/Definitions/InputSystem/MixedRealityInputSystemProfile.cs b/Assets/MixedRealityToolkit/Definitions/InputSystem/MixedRealityInputSystemProfile.cs
@@ -17,6 +17,7 @@ namespace Microsoft.MixedReality.Toolkit.Core.Definitions.InputSystem
     /// Configuration profile settings for setting up controller pointers.
     /// </summary>
     [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Input System Profile", fileName = "MixedRealityInputSystemProfile", order = (int)CreateProfileMenuItemIndices.Input)]
+    [MixedRealityServiceProfile(typeof(IMixedRealityInputSystem))]
     public class MixedRealityInputSystemProfile : BaseMixedRealityProfile
     {
         [SerializeField]
diff --git a/Assets/MixedRealityToolkit/Definitions/MixedRealityRegisteredServiceProvidersProfile.cs b/Assets/MixedRealityToolkit/Definitions/MixedRealityRegisteredServiceProvidersProfile.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.﻿
 
+using Microsoft.MixedReality.Toolkit.Core.Attributes;
 using Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities;
 using UnityEngine;
 
diff --git a/Assets/MixedRealityToolkit/Definitions/SpatialAwareness/MixedRealitySpatialAwarenessMeshObserverProfile.cs b/Assets/MixedRealityToolkit/Definitions/SpatialAwareness/MixedRealitySpatialAwarenessMeshObserverProfile.cs
@@ -3,6 +3,7 @@
 
 using Microsoft.MixedReality.Toolkit.Core.Attributes;
 using Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities;
+using Microsoft.MixedReality.Toolkit.Core.Interfaces.SpatialAwarenessSystem.Observers;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem
@@ -11,6 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.Core.Definitions.SpatialAwarenessSystem
     /// Configuration profile settings for spatial awareness mesh observers.
     /// </summary>
     [CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Spatial Awareness Mesh Observer Profile", fileName = "MixedRealitySpatialAwarenessMeshObserverProfile", order = (int)CreateProfileMenuItemIndices.SpatialAwarenessMeshObserver)]
+    [MixedRealityServiceProfile(typeof(IMixedRealitySpatialAwarenessMeshObserver))]
     public class MixedRealitySpatialAwarenessMeshObserverProfile : BaseMixedRealityProfile 
     {
         #region IMixedRealitySpatialAwarenessObserver settings
diff --git a/Assets/MixedRealityToolkit/Inspectors/Profiles/BaseMixedRealityProfileInspector.cs b/Assets/MixedRealityToolkit/Inspectors/Profiles/BaseMixedRealityProfileInspector.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.﻿
 
+using Microsoft.MixedReality.Toolkit.Core.Attributes;
 using Microsoft.MixedReality.Toolkit.Core.Definitions;
 using Microsoft.MixedReality.Toolkit.Core.Extensions.EditorClassExtensions;
 using Microsoft.MixedReality.Toolkit.Core.Services;
@@ -44,9 +45,9 @@ public static bool CheckMixedRealityConfigured(bool flag = true)
         /// <param name="guiContent">The GUIContent for the field.</param>
         /// <param name="showAddButton">Optional flag to hide the create button.</param>
         /// <returns>True, if the profile changed.</returns>
-        protected static bool RenderProfile(SerializedProperty property, GUIContent guiContent, bool showAddButton = true)
+        protected static bool RenderProfile(SerializedProperty property, GUIContent guiContent, bool showAddButton = true, Type serviceType = null)
         {
-            return RenderProfileInternal(property, guiContent, showAddButton);
+            return RenderProfileInternal(property, guiContent, showAddButton, serviceType);
         }
 
         /// <summary>
@@ -55,18 +56,40 @@ protected static bool RenderProfile(SerializedProperty property, GUIContent guiC
         /// <param name="property">the <see cref="Microsoft.MixedReality.Toolkit.Core.Definitions.BaseMixedRealityProfile"/> property.</param>
         /// <param name="showAddButton">Optional flag to hide the create button.</param>
         /// <returns>True, if the profile changed.</returns>
-        protected static bool RenderProfile(SerializedProperty property, bool showAddButton = true)
+        protected static bool RenderProfile(SerializedProperty property, bool showAddButton = true, Type serviceType = null)
         {
-            return RenderProfileInternal(property, null, showAddButton);
+            return RenderProfileInternal(property, null, showAddButton, serviceType);
         }
 
-        private static bool RenderProfileInternal(SerializedProperty property, GUIContent guiContent, bool showAddButton)
+        private static bool RenderProfileInternal(SerializedProperty property, GUIContent guiContent, bool showAddButton, Type serviceType = null)
         {
             bool changed = false;
-            EditorGUILayout.BeginHorizontal();
 
             var oldObject = property.objectReferenceValue;
 
+            // If we're constraining this to a service type, check whether the profile is valid
+            // If it isn't, issue a warning.
+            if (serviceType != null && oldObject != null)
+            {
+                bool profileTypeIsValid = false;
+
+                foreach (MixedRealityServiceProfileAttribute serviceProfileAttribute in oldObject.GetType().GetCustomAttributes(typeof(MixedRealityServiceProfileAttribute), true))
+                {
+                    if (serviceProfileAttribute.ServiceType.IsAssignableFrom(serviceType))
+                    {
+                        profileTypeIsValid = true;
+                        break;
+                    }
+                }
+
+                if (!profileTypeIsValid)
+                {
+                    EditorGUILayout.HelpBox("This profile is not supported for " + serviceType.Name + ". Using an unsupported service may result in unexpected behavior.", MessageType.Warning);
+                }
+            }
+
+            EditorGUILayout.BeginHorizontal();
+           
             if (guiContent == null)
             {
                 EditorGUILayout.PropertyField(property);
@@ -101,7 +124,7 @@ private static bool RenderProfileInternal(SerializedProperty property, GUIConten
 
                 if (!renderedProfile.IsCustomProfile && profile.IsCustomProfile)
                 {
-                    if (GUILayout.Button(new GUIContent("</>", "Replace with a copy of the default profile."), EditorStyles.miniButton, GUILayout.Width(32f)))
+                    if (GUILayout.Button(new GUIContent("Clone", "Replace with a copy of the default profile."), EditorStyles.miniButton, GUILayout.Width(42f)))
                     {
                         profileToCopy = renderedProfile;
                         var profileTypeName = property.objectReferenceValue.GetType().Name;
@@ -116,12 +139,7 @@ private static bool RenderProfileInternal(SerializedProperty property, GUIConten
                     }
                 }
             }
-
-            if (oldObject != property.objectReferenceValue)
-            {
-                changed = true;
-            }
-
+            
             EditorGUILayout.EndHorizontal();
 
             // Check fields within profile for other nested profiles
@@ -133,7 +151,7 @@ private static bool RenderProfileInternal(SerializedProperty property, GUIConten
                 {
                     string showFoldoutKey = GetSubProfileDropdownKey(property);
                     bool showFoldout = SessionState.GetBool(showFoldoutKey, false);
-                    showFoldout = EditorGUILayout.Foldout(showFoldout, showFoldout ? "Hide " + property.displayName + " contents" : "Show " + property.displayName + " contents");
+                    showFoldout = EditorGUILayout.Foldout(showFoldout, showFoldout ? "Hide " + property.displayName + " contents" : "Show " + property.displayName + " contents", true);
 
                     if (showFoldout)
                     {
@@ -146,11 +164,15 @@ private static bool RenderProfileInternal(SerializedProperty property, GUIConten
                             configProfile.RenderAsSubProfile = true;
                         }
 
-                        EditorGUILayout.BeginVertical(EditorStyles.helpBox);
                         EditorGUI.indentLevel++;
+                        EditorGUILayout.BeginVertical(EditorStyles.helpBox);
                         subProfileEditor.OnInspectorGUI();
-                        EditorGUI.indentLevel--;
+
+                        EditorGUILayout.Space();
+                        EditorGUILayout.Space();
+
                         EditorGUILayout.EndVertical();
+                        EditorGUI.indentLevel--;
                     }
 
                     SessionState.SetBool(showFoldoutKey, showFoldout);
diff --git a/Assets/MixedRealityToolkit/Inspectors/Profiles/BaseMixedRealityToolkitConfigurationProfileInspector.cs b/Assets/MixedRealityToolkit/Inspectors/Profiles/BaseMixedRealityToolkitConfigurationProfileInspector.cs
@@ -19,19 +19,14 @@ public abstract class MixedRealityBaseConfigurationProfileInspector { }
     /// </summary>
     public abstract class BaseMixedRealityToolkitConfigurationProfileInspector : BaseMixedRealityProfileInspector
     {
-        public bool RenderAsSubProfile
-        {
-            set { renderAsSubProfile = value; }
-        }
+        public bool RenderAsSubProfile { get; set; }
 
         [SerializeField]
         private Texture2D logoLightTheme = null;
 
         [SerializeField]
         private Texture2D logoDarkTheme = null;
-
-        private bool renderAsSubProfile = false;
-
+        
         protected virtual void Awake()
         {
             string assetPath = $"{MixedRealityEditorSettings.MixedRealityToolkit_RelativeFolderPath}/StandardAssets/Textures";
@@ -53,7 +48,7 @@ protected virtual void Awake()
         protected void RenderMixedRealityToolkitLogo()
         {
             // If we're being rendered as a sub profile, don't show the logo
-            if (renderAsSubProfile)
+            if (RenderAsSubProfile)
                 return;
 
             GUILayout.BeginHorizontal();
@@ -73,7 +68,7 @@ protected void RenderMixedRealityToolkitLogo()
         protected bool DrawBacktrackProfileButton(string message, UnityEngine.Object activeObject)
         {
             // If we're being rendered as a sub profile, don't show the button
-            if (renderAsSubProfile)
+            if (RenderAsSubProfile)
                 return false;
 
             if (GUILayout.Button(message))
diff --git a/Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityInputSystemProfileInspector.cs b/Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityInputSystemProfileInspector.cs
@@ -3,6 +3,7 @@
 
 using Microsoft.MixedReality.Toolkit.Core.Definitions.InputSystem;
 using Microsoft.MixedReality.Toolkit.Core.Inspectors.Utilities;
+using Microsoft.MixedReality.Toolkit.Core.Interfaces.Devices;
 using Microsoft.MixedReality.Toolkit.Core.Services;
 using UnityEditor;
 using UnityEngine;
@@ -118,7 +119,7 @@ public override void OnInspectorGUI()
                 {
                     EditorGUILayout.PropertyField(enableControllerMapping);
                     changed |= RenderProfile(controllerMappingProfile);
-                    changed |= RenderProfile(controllerVisualizationProfile);
+                    changed |= RenderProfile(controllerVisualizationProfile, true, typeof(IMixedRealityControllerVisualizer));
                 }
             }
 
diff --git a/Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityRegisteredServiceProviderProfileInspector.cs b/Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityRegisteredServiceProviderProfileInspector.cs
@@ -3,9 +3,9 @@
 
 using Microsoft.MixedReality.Toolkit.Core.Attributes;
 using Microsoft.MixedReality.Toolkit.Core.Definitions;
-using Microsoft.MixedReality.Toolkit.Core.Definitions.Utilities;
 using Microsoft.MixedReality.Toolkit.Core.Inspectors.Utilities;
 using Microsoft.MixedReality.Toolkit.Core.Services;
+using System;
 using UnityEditor;
 using UnityEngine;
 
@@ -125,7 +125,7 @@ private void RenderList(SerializedProperty list)
 
                 EditorGUILayout.EndHorizontal();
 
-                if (configFoldouts[i])
+                if (configFoldouts[i] || RenderAsSubProfile)
                 {
                     EditorGUI.indentLevel++;
 
@@ -152,7 +152,13 @@ private void RenderList(SerializedProperty list)
 
                     changed |= EditorGUI.EndChangeCheck();
 
-                    changed |= RenderProfile(configurationProfile);
+                    Type serviceType = null;
+                    if (configurationProfile.objectReferenceValue != null)
+                    {
+                        serviceType = (target as MixedRealityRegisteredServiceProvidersProfile).Configurations[i].ComponentType;
+                    }
+
+                    changed |= RenderProfile(configurationProfile, true, serviceType);
 
                     EditorGUI.indentLevel--;
 

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`namespace Microsoft.MixedReality.Toolkit.Core.Definitions.Devices`
`11`	`11`	`{`
`12`	`12`	`[CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Controller Visualization Profile", fileName = "MixedRealityControllerVisualizationProfile", order = (int)CreateProfileMenuItemIndices.ControllerVisualization)]`
	`13`	`+ [MixedRealityServiceProfile(typeof(IMixedRealityControllerVisualizer))]`
`13`	`14`	`public class MixedRealityControllerVisualizationProfile : BaseMixedRealityProfile`
`14`	`15`	`{`
`15`	`16`	`[SerializeField]`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ namespace Microsoft.MixedReality.Toolkit.Core.Definitions.InputSystem`
`17`	`17`	`/// Configuration profile settings for setting up controller pointers.`
`18`	`18`	`/// </summary>`
`19`	`19`	`[CreateAssetMenu(menuName = "Mixed Reality Toolkit/Mixed Reality Input System Profile", fileName = "MixedRealityInputSystemProfile", order = (int)CreateProfileMenuItemIndices.Input)]`
	`20`	`+ [MixedRealityServiceProfile(typeof(IMixedRealityInputSystem))]`
`20`	`21`	`public class MixedRealityInputSystemProfile : BaseMixedRealityProfile`
`21`	`22`	`{`
`22`	`23`	`[SerializeField]`