update diagnostic defaults, add frame rate duration

Author: David Kline (ANALOG)

Assets/MixedRealityToolkit.SDK/Profiles/DefaultMixedRealityDiagnosticsProfile.asset

@@ -13,5 +13,6 @@ MonoBehaviour:
   m_Name: DefaultMixedRealityDiagnosticsProfile
   m_EditorClassIdentifier: 
   isCustomProfile: 0
-  showDiagnostics: 0
+  showDiagnostics: 1
   showProfiler: 1
+  frameRateDuration: 0.1

Assets/MixedRealityToolkit.Services/DiagnosticsSystem/MixedRealityDiagnosticsSystem.cs

@@ -119,6 +119,31 @@ public bool ShowProfiler
             }
         }
 
+        private float frameRateDuration = 0.1f;
+        private readonly float minFrameRateDuration = 0.01f;
+        private readonly float maxFrameRateDuration = 1.0f;
+
+        /// <inheritdoc />
+        public float FrameRateDuration
+        {
+            get
+            {
+                return frameRateDuration;
+            }
+
+            set
+            {
+                if (!Mathf.Approximately(frameRateDuration, value))
+                {
+                    frameRateDuration = Mathf.Clamp(value, minFrameRateDuration, maxFrameRateDuration);
+                    if (visualProfiler != null)
+                    {
+                        visualProfiler.FrameSampleRate = frameRateDuration;
+                    }
+                }
+            }
+        }
+
         #endregion IMixedRealityDiagnosticsSystem
 
         #region IMixedRealityEventSource

Assets/MixedRealityToolkit.Services/DiagnosticsSystem/MixedRealityToolkitVisualProfiler.cs

@@ -42,6 +42,12 @@ public bool IsVisible
         [Range(0.0f, 1.0f)]
         private float frameSampleRate = 0.1f;
 
+        public float FrameSampleRate
+        {
+            get { return frameSampleRate; }
+            set { frameSampleRate = Mathf.Clamp(value, 0.0f, 1.0f); }
+        }
+
         [Header("UI Settings")]
         [SerializeField]
         [Range(0.0f, 100.0f)]

Assets/MixedRealityToolkit/Definitions/Diagnostics/MixedRealityDiagnosticsProfile.cs

@@ -16,20 +16,30 @@ public class MixedRealityDiagnosticsProfile : BaseMixedRealityProfile
         [SerializeField]
         [FormerlySerializedAs("visible")]
         [Tooltip("Display all enabled diagnostics")]
-        private bool showDiagnostics = false;
+        private bool showDiagnostics = true;
 
         /// <summary>
-        /// Show or hide diagnostic visualizations
+        /// Show or hide diagnostic visualizations.
         /// </summary>
         public bool ShowDiagnostics => showDiagnostics;
 
         [SerializeField]
         [Tooltip("Display profiler")]
-        private bool showProfiler = false;
+        private bool showProfiler = true;
 
         /// <summary>
-        /// Show or hide the profiler UI
+        /// Show or hide the profiler UI.
         /// </summary>
         public bool ShowProfiler => showProfiler;
+
+        [SerializeField]
+        [Tooltip("The amount of time, in seconds, to collect frames for frame rate calculation.")]
+        [Range(0.01f, 1.0f)]
+        private float frameRateDuration = 0.1f;
+
+        /// <summary>
+        /// The amount of time, in seconds, to collect frames for frame rate calculation.
+        /// </summary>
+        public float FrameRateDuration => frameRateDuration;
     }
 }

Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityDiagnosticsSystemProfileInspector.cs

@@ -14,8 +14,13 @@ public class MixedRealityDiagnosticsSystemProfileInspector : BaseMixedRealityToo
     {
         private static bool showGeneralSettings = true;
         private SerializedProperty showDiagnostics;
+
+        private static bool showProfilerSettings = true;
         private SerializedProperty showProfiler;
+        private SerializedProperty frameRateDuration;
+
         // todo: coming soon
+        // private static bool showDebugPanelSettings = true;
         // private SerializedProperty isDebugPanelVisible;
 
         protected override void OnEnable()
@@ -29,6 +34,7 @@ protected override void OnEnable()
 
             showDiagnostics = serializedObject.FindProperty("showDiagnostics");
             showProfiler = serializedObject.FindProperty("showProfiler");
+            frameRateDuration = serializedObject.FindProperty("frameRateDuration");
         }
 
         public override void OnInspectorGUI()
@@ -65,8 +71,17 @@ public override void OnInspectorGUI()
                         EditorGUILayout.HelpBox("Diagnostic visualizations have been globally disabled.", MessageType.Info);
                         EditorGUILayout.Space();
                     }
+                }
+            }
 
+            EditorGUILayout.Space();
+            showProfilerSettings = EditorGUILayout.Foldout(showProfilerSettings, "Profiler Settings", true);
+            if (showProfilerSettings)
+            {
+                using (new EditorGUI.IndentLevelScope())
+                {
                     EditorGUILayout.PropertyField(showProfiler);
+                    EditorGUILayout.PropertyField(frameRateDuration);
                 }
             }
 

Assets/MixedRealityToolkit/Inspectors/Profiles/MixedRealityToolkitConfigurationProfileInspector.cs

@@ -285,6 +285,7 @@ public override void OnInspectorGUI()
             {
                 using (new EditorGUI.IndentLevelScope())
                 {
+                    EditorGUILayout.HelpBox("It is recommended to enable the Diagnostics system during development. Be sure to disable prior to building your shipping product.", MessageType.Warning);
                     EditorGUILayout.PropertyField(enableDiagnosticsSystem);
                     EditorGUILayout.PropertyField(diagnosticsSystemType);
                     changed |= RenderProfile(diagnosticsSystemProfile);

Assets/MixedRealityToolkit/Interfaces/Diagnostics/IMixedRealityDiagnosticsSystem.cs

@@ -22,8 +22,13 @@ public interface IMixedRealityDiagnosticsSystem : IMixedRealityEventSystem, IMix
         bool ShowDiagnostics { get; set; }
 
         /// <summary>
-        /// Enable / disable the profiler display
+        /// Enable / disable the profiler display.
         /// </summary>
         bool ShowProfiler { get; set; }
+
+        /// <summary>
+        /// The amount of time, in seconds, to collect frames for frame rate calculation.
+        /// </summary>
+        float FrameRateDuration { get; }
     }
 }