Merge pull request #6482 from Troy-Ferrell/users/trferrel/profile-inspector-reduce

Improve profile inspector code

Author: keveleigh

Assets/MixedRealityToolkit/Definitions/BaseMixedRealityProfile.cs

@@ -1,10 +1,16 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
+using System;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit
 {
+    /// <summary>
+    /// Base abstract class for all Mixed Reality profile configurations. 
+    /// Extends ScriptableObject and used as a property container to initialize MRTK services.
+    /// </summary>
+    [Serializable]
     public abstract class BaseMixedRealityProfile : ScriptableObject
     {
         [SerializeField]

Assets/MixedRealityToolkit/Definitions/CameraSystem/BaseCameraSettingsProfile.cs

@@ -1,16 +1,14 @@
 // 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.Utilities;
 using System;
-using UnityEngine;
-using UnityEngine.Serialization;
 
 namespace Microsoft.MixedReality.Toolkit.CameraSystem
 {
     /// <summary>
     /// Base class used to derive custom camera settings profiles.
     /// </summary>
+    [Serializable]
     public class BaseCameraSettingsProfile : BaseMixedRealityProfile
     {
         // This class is intentionally blank. It exists for future expansion of common functionality.

Assets/MixedRealityToolkit/Definitions/CameraSystem/MixedRealityCameraSettingsConfiguration.cs

@@ -46,6 +46,9 @@ public struct MixedRealityCameraSettingsConfiguration : IMixedRealityServiceConf
         [SerializeField]
         private BaseCameraSettingsProfile settingsProfile;
 
+        /// <inheritdoc />
+        public BaseMixedRealityProfile Profile => settingsProfile;
+
         /// <summary>
         /// Camera settings specific configuration profile.
         /// </summary>

Assets/MixedRealityToolkit/Definitions/MixedRealityInputDataProviderConfiguration.cs

@@ -39,12 +39,14 @@ public struct MixedRealityInputDataProviderConfiguration : IMixedRealityServiceC
         [SerializeField]
         private BaseMixedRealityProfile deviceManagerProfile;
 
+        /// <inheritdoc />
+        public BaseMixedRealityProfile Profile => deviceManagerProfile;
+
         /// <summary>
         /// Device manager specific configuration profile.
         /// </summary>
         public BaseMixedRealityProfile DeviceManagerProfile => deviceManagerProfile;
 
-
         /// <summary>
         /// Constructor.
         /// </summary>

Assets/MixedRealityToolkit/Definitions/MixedRealityServiceConfiguration.cs

@@ -64,9 +64,13 @@ public MixedRealityServiceConfiguration(
         [SerializeField]
         private BaseMixedRealityProfile configurationProfile;
 
+        /// <inheritdoc />
+        public BaseMixedRealityProfile Profile => configurationProfile;
+
         /// <summary>
         /// The configuration profile for the service.
         /// </summary>
+        [Obsolete("Use Profile property instead")]
         public BaseMixedRealityProfile ConfigurationProfile => configurationProfile;
     }
 }

Assets/MixedRealityToolkit/Definitions/MixedRealitySpatialObserverConfiguration.cs

@@ -39,6 +39,9 @@ public struct MixedRealitySpatialObserverConfiguration : IMixedRealityServiceCon
         [SerializeField]
         private BaseSpatialAwarenessObserverProfile observerProfile;
 
+        /// <inheritdoc />
+        public BaseMixedRealityProfile Profile => observerProfile;
+
         /// <summary>
         /// Spatial Observer specific configuration profile.
         /// </summary>

Assets/MixedRealityToolkit/Definitions/SpatialAwareness/BaseSpatialAwarenessObserverProfile.cs

@@ -2,10 +2,15 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.MixedReality.Toolkit.Utilities;
+using System;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.SpatialAwareness
 {
+    /// <summary>
+    /// Abstract class that provides base profile information for Spatial Awareness Observers and their configuration
+    /// </summary>
+    [Serializable]
     public abstract class BaseSpatialAwarenessObserverProfile : BaseMixedRealityProfile
     {
         [SerializeField]

Assets/MixedRealityToolkit/Inspectors/Profiles/DataProviderAccessServiceInspector.cs

@@ -0,0 +1,204 @@
+// 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.Utilities.Editor;
+using System;
+using System.Collections.Generic;
+using UnityEditor;
+using UnityEngine;
+
+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.
+    /// 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>
+    public abstract class BaseDataProviderServiceInspector : BaseMixedRealityToolkitConfigurationProfileInspector
+    {
+        /// <summary>
+        /// Container class used to store references to serialized properties on a <see cref="IMixedRealityServiceConfiguration"/> target
+        /// </summary>
+        protected class ServiceConfigurationProperties
+        {
+            internal SerializedProperty componentName;
+            internal SerializedProperty componentType;
+            internal SerializedProperty providerProfile;
+            internal SerializedProperty runtimePlatform;
+        }
+
+        /// <summary>
+        /// Returns SerializedProperty object that wraps references to array of <see cref="IMixedRealityServiceConfiguration"/> stored on the inspected target object
+        /// </summary>
+        protected abstract SerializedProperty GetDataProviderConfigurationList();
+
+        /// <summary>
+        /// Builds <see cref="ServiceConfigurationProperties"/> container object with SerializedProperty references to associated properties on the supplied <see cref="IMixedRealityServiceConfiguration"/> reference
+        /// </summary>
+        /// <param name="providerEntry">SerializedProperty reference pointing to <see cref="IMixedRealityServiceConfiguration"/> instance</param>
+        protected abstract ServiceConfigurationProperties GetDataProviderConfigurationProperties(SerializedProperty providerEntry);
+
+        /// <summary>
+        /// Returns direct <see cref="IMixedRealityServiceConfiguration"/> instance at provided index in target object's array of <see cref="IMixedRealityServiceConfiguration"/> configurations
+        /// </summary>
+        protected abstract IMixedRealityServiceConfiguration GetDataProviderConfiguration(int index);
+
+        private SerializedProperty providerConfigurations;
+        private List<bool> providerFoldouts = new List<bool>();
+
+        private static readonly GUIContent ComponentTypeLabel = new GUIContent("Type");
+        private static readonly GUIContent SupportedPlatformsLabel = new GUIContent("Supported Platform(s)");
+
+        /// <inheritdoc/>
+        protected override void OnEnable()
+        {
+            base.OnEnable();
+
+            providerConfigurations = GetDataProviderConfigurationList();
+
+            if (providerFoldouts == null || providerFoldouts.Count != providerConfigurations.arraySize)
+            {
+                providerFoldouts = new List<bool>(new bool[providerConfigurations.arraySize]);
+            }
+        }
+
+        /// <summary>
+        /// Adds a new data provider profile entry (i.e <see cref="IMixedRealityServiceConfiguration"/>) to array list of target object
+        /// Utilizes GetDataProviderConfigurationList() to get SerializedProperty object that represents array to insert against
+        /// </summary>
+        protected virtual void AddDataProvider()
+        {
+            providerConfigurations.InsertArrayElementAtIndex(providerConfigurations.arraySize);
+            SerializedProperty provider = providerConfigurations.GetArrayElementAtIndex(providerConfigurations.arraySize - 1);
+
+            var providerProperties = GetDataProviderConfigurationProperties(provider);
+            providerProperties.componentName.stringValue = $"New data provider {providerConfigurations.arraySize - 1}";
+            providerProperties.runtimePlatform.intValue = -1;
+            providerProperties.providerProfile.objectReferenceValue = null;
+
+            serializedObject.ApplyModifiedProperties();
+
+            var providerType = GetDataProviderConfiguration(providerConfigurations.arraySize - 1).ComponentType;
+            providerType.Type = null;
+
+            providerFoldouts.Add(false);
+        }
+
+        /// <summary>
+        /// Removed given index item from <see cref="IMixedRealityServiceConfiguration"/> array list.
+        /// Utilizes GetDataProviderConfigurationList() to get SerializedProperty object that represents array to delete against.
+        /// </summary>
+        protected virtual void RemoveDataProvider(int index)
+        {
+            providerConfigurations.DeleteArrayElementAtIndex(index);
+            serializedObject.ApplyModifiedProperties();
+
+            providerFoldouts.RemoveAt(index);
+        }
+
+        /// <summary>
+        /// Applies the given concrete dataprovider 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)
+            {
+                MixedRealityDataProviderAttribute providerAttribute = MixedRealityDataProviderAttribute.Find(dataProviderType) as MixedRealityDataProviderAttribute;
+                if (providerAttribute != null)
+                {
+                    providerProperties.componentName.stringValue = !string.IsNullOrWhiteSpace(providerAttribute.Name) ? providerAttribute.Name : dataProviderType.Name;
+                    providerProperties.providerProfile.objectReferenceValue = providerAttribute.DefaultProfile;
+                    providerProperties.runtimePlatform.intValue = (int)providerAttribute.RuntimePlatforms;
+                }
+                else
+                {
+                    providerProperties.componentName.stringValue = dataProviderType.Name;
+                }
+
+                serializedObject.ApplyModifiedProperties();
+            }
+        }
+
+        /// <summary>
+        /// Render list of data provider configuration profiles in inspector. Use provided add and remove content labels for the insert/remove buttons
+        /// Returns true if any property has changed in this render pass, false otherwise
+        /// </summary>
+        protected bool RenderDataProviderList(GUIContent addContentLabel, GUIContent removeContentLabel, string errorMsg, Type dataProviderProfileType = null)
+        {
+            bool changed = false;
+
+            using (new EditorGUILayout.VerticalScope())
+            {
+                if (providerConfigurations == null || providerConfigurations.arraySize == 0)
+                {
+                    EditorGUILayout.HelpBox(errorMsg, MessageType.Info);
+                }
+
+                if (InspectorUIUtility.RenderIndentedButton(addContentLabel, EditorStyles.miniButton))
+                {
+                    AddDataProvider();
+                    return true;
+                }
+
+                for (int i = 0; i < providerConfigurations.arraySize; i++)
+                {
+                    changed |= RenderDataProviderEntry(i, removeContentLabel, dataProviderProfileType);
+                }
+
+                return changed;
+            }
+        }
+
+        /// <summary>
+        /// Renders properties of <see cref="IMixedRealityServiceConfiguration"/> instance at provided index in inspector.
+        /// Also renders inspector view of data provider's profile object and it's contents if applicable and foldout is expanded.
+        /// </summary>
+        protected bool RenderDataProviderEntry(int index, GUIContent removeContent, System.Type dataProviderProfileType = null)
+        {
+            bool changed = false;
+            SerializedProperty provider = providerConfigurations.GetArrayElementAtIndex(index);
+            ServiceConfigurationProperties providerProperties = GetDataProviderConfigurationProperties(provider);
+
+            using (new EditorGUILayout.VerticalScope(EditorStyles.helpBox))
+            {
+                using (new EditorGUILayout.HorizontalScope())
+                {
+                    providerFoldouts[index] = EditorGUILayout.Foldout(providerFoldouts[index], providerProperties.componentName.stringValue, true);
+
+                    if (GUILayout.Button(removeContent, EditorStyles.miniButtonRight, GUILayout.Width(24f)))
+                    {
+                        RemoveDataProvider(index);
+                        return true;
+                    }
+                }
+
+                if (providerFoldouts[index])
+                {
+                    var serviceType = GetDataProviderConfiguration(index).ComponentType;
+
+                    using (var c = new EditorGUI.ChangeCheckScope())
+                    {
+                        EditorGUILayout.PropertyField(providerProperties.componentType, ComponentTypeLabel);
+                        if (c.changed)
+                        {
+                            serializedObject.ApplyModifiedProperties();
+                            ApplyProviderConfiguration(serviceType.Type, providerProperties);
+                            return true;
+                        }
+
+                        EditorGUILayout.PropertyField(providerProperties.runtimePlatform, SupportedPlatformsLabel);
+                        changed = c.changed;
+                    }
+
+                    changed |= RenderProfile(providerProperties.providerProfile, dataProviderProfileType, true, false, serviceType);
+
+                    serializedObject.ApplyModifiedProperties();
+                }
+            }
+
+            return changed;
+        }
+    }
+}