Fix speech command dropdown and update commands in ET example (#10197)

* Add custom attribute and property drawer for rendering a dropdown of speech keywords

* Update inspectors to use new utility

* Change voice command from start/stop recording

to "record eye gaze" and "end recording" to not clash with system keywords

* Also check if availableKeywords is empty for valid keywords

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

* Add summary

and minor optimization

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

Author: keveleigh

Assets/MRTK/Core/Attributes/SpeechKeywordAttribute.cs

@@ -0,0 +1,14 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System;
+using UnityEngine;
+
+namespace Microsoft.MixedReality.Toolkit
+{
+    /// <summary>
+    /// Attribute used to display a dropdown of registered keywords from the speech profile.
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Field)]
+    public sealed class SpeechKeywordAttribute : PropertyAttribute { }
+}

Assets/MRTK/Core/Attributes/SpeechKeywordAttribute.cs.meta

@@ -26,6 +26,7 @@ public KeywordAndResponse(string keyword, UnityEvent response)
 
         [SerializeField]
         [Tooltip("The keyword to listen for.")]
+        [SpeechKeyword]
         private string keyword;
 
         /// <summary>

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

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.MixedReality.Toolkit.Utilities.Editor;
+using UnityEditor;
+using UnityEngine;
+
+namespace Microsoft.MixedReality.Toolkit.Input.Editor
+{
+    [CustomPropertyDrawer(typeof(SpeechKeywordAttribute))]
+    public class SpeechKeywordPropertyDrawer : PropertyDrawer
+    {
+        public override void OnGUI(Rect rect, SerializedProperty property, GUIContent content) => SpeechKeywordUtility.RenderKeywords(property, rect, content);
+    }
+}

Assets/MRTK/Core/Inspectors/PropertyDrawers/SpeechKeywordPropertyDrawer.cs

@@ -6,7 +6,6 @@
 using System.Linq;
 using System.Reflection;
 using UnityEditor;
-using UnityEditor.Experimental.SceneManagement;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Utilities.Editor

Assets/MRTK/Core/Inspectors/PropertyDrawers/SpeechKeywordPropertyDrawer.cs.meta

@@ -0,0 +1,110 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using System.Collections.Generic;
+using System.Linq;
+using UnityEditor;
+using UnityEngine;
+
+namespace Microsoft.MixedReality.Toolkit.Utilities.Editor
+{
+    /// <summary>
+    /// Provides helpers for rendering speech keyword dropdowns populated from the MRTK speech profile.
+    /// </summary>
+    public static class SpeechKeywordUtility
+    {
+        private static readonly GUIContent SpeechCommandsLabel = new GUIContent("Speech Command", "Speech keyword to use, pulled from MRTK/Input/Speech Commands Profile");
+
+        /// <summary>
+        /// Renders a dropdown with all keywords in the active <see cref="Input.MixedRealitySpeechCommandsProfile"/>.
+        /// </summary>
+        /// <param name="property">The string property representing the selected keyword.</param>
+        public static void RenderKeywords(SerializedProperty property, Rect rect = default(Rect), GUIContent content = null) => RenderKeywordsExcept(null, property, rect, content);
+
+        /// <summary>
+        /// Renders a dropdown with all keywords in the active <see cref="Input.MixedRealitySpeechCommandsProfile"/> except those passed in.
+        /// </summary>
+        /// <param name="keywordsInUse">The keywords the component is currently using.</param>
+        /// <param name="property">The string property representing the selected keyword.</param>
+        public static void RenderKeywordsExcept(string[] keywordsInUse, SerializedProperty property, Rect rect = default(Rect), GUIContent content = null)
+        {
+            IEnumerable<string> availableKeywords = GetDistinctRegisteredKeywords();
+
+            if (keywordsInUse != null && availableKeywords != null)
+            {
+                availableKeywords = availableKeywords.Except(keywordsInUse.Select(keyword => keyword));
+            }
+
+            bool validSpeechKeywords = availableKeywords != null && availableKeywords.Count() > 0;
+
+            if (rect == default(Rect))
+            {
+                rect = EditorGUILayout.GetControlRect();
+            }
+
+            if (content == null)
+            {
+                content = SpeechCommandsLabel;
+            }
+
+            using (new EditorGUI.DisabledScope(!validSpeechKeywords))
+            using (new EditorGUI.PropertyScope(rect, content, property))
+            {
+                string[] keywordOptions;
+                if (validSpeechKeywords)
+                {
+                    if (string.IsNullOrWhiteSpace(property.stringValue) || availableKeywords.Contains(property.stringValue))
+                    {
+                        keywordOptions = availableKeywords.OrderBy(keyword => keyword).ToArray();
+                    }
+                    else
+                    {
+                        // if the currently selected option is not whitespace, ensure it's included in the dropdown
+                        keywordOptions = availableKeywords.Concat(new[] { property.stringValue }).OrderBy(keyword => keyword).ToArray();
+                    }
+                }
+                else
+                {
+                    keywordOptions = new string[] { "Missing Speech Commands" };
+                }
+
+                int previousSelection = Mathf.Clamp(ArrayUtility.IndexOf(keywordOptions, property.stringValue), 0, int.MaxValue);
+                int currentSelection = EditorGUI.Popup(rect, content.text, previousSelection, keywordOptions);
+
+                if (validSpeechKeywords && currentSelection != previousSelection)
+                {
+                    property.stringValue = currentSelection > 0 ? keywordOptions[currentSelection] : string.Empty; // Don't serialize the "(No Selection)" entry
+                }
+            }
+        }
+
+        /// <summary>
+        /// Look for speech commands in the MRTK speech command profile.
+        /// Adds a "(No Selection)" value at index zero and filters out duplicate values.
+        /// </summary>
+        public static IEnumerable<string> GetDistinctRegisteredKeywords()
+        {
+            if (!MixedRealityToolkit.ConfirmInitialized() ||
+                !MixedRealityToolkit.Instance.HasActiveProfile ||
+                !MixedRealityToolkit.Instance.ActiveProfile.IsInputSystemEnabled ||
+                MixedRealityToolkit.Instance.ActiveProfile.InputSystemProfile.SpeechCommandsProfile == null ||
+                MixedRealityToolkit.Instance.ActiveProfile.InputSystemProfile.SpeechCommandsProfile.SpeechCommands.Length == 0)
+            {
+                return null;
+            }
+
+            List<string> keywords = new List<string>
+            {
+                "(No Selection)"
+            };
+
+            Input.SpeechCommands[] speechCommands = MixedRealityToolkit.Instance.ActiveProfile.InputSystemProfile.SpeechCommandsProfile.SpeechCommands;
+            for (var i = 0; i < speechCommands.Length; i++)
+            {
+                keywords.Add(speechCommands[i].Keyword);
+            }
+
+            return keywords.Distinct();
+        }
+    }
+}

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

@@ -914,9 +914,7 @@ MonoBehaviour:
   m_OnCullStateChanged:
     m_PersistentCalls:
       m_Calls: []
-    m_TypeName: UnityEngine.UI.MaskableGraphic+CullStateChangedEvent, UnityEngine.UI,
-      Version=1.0.0.0, Culture=neutral, PublicKeyToken=null
-  m_text: Start Recording
+  m_text: Record Eye Gaze
   m_isRightToLeft: 0
   m_fontAsset: {fileID: 11400000, guid: 8f586378b4e144a9851e7b34d9b748ee, type: 2}
   m_sharedMaterial: {fileID: 2180264, guid: 8f586378b4e144a9851e7b34d9b748ee, type: 2}
@@ -952,7 +950,6 @@ MonoBehaviour:
   m_fontSizeMax: 72
   m_fontStyle: 0
   m_textAlignment: 514
-  m_isAlignmentEnumConverted: 1
   m_characterSpacing: 3
   m_wordSpacing: 0
   m_lineSpacing: 0
@@ -979,26 +976,24 @@ MonoBehaviour:
   m_verticalMapping: 0
   m_uvLineOffset: 0
   m_geometrySortingOrder: 0
+  m_VertexBufferAutoSizeReduction: 1
   m_firstVisibleCharacter: 0
   m_useMaxVisibleDescender: 1
   m_pageToDisplay: 1
   m_margin: {x: 0, y: 0, z: 0, w: 0}
   m_textInfo:
-    textComponent: {fileID: 0}
+    textComponent: {fileID: 4533479808247404460}
     characterCount: 15
     spriteCount: 0
-    spaceCount: 1
-    wordCount: 2
+    spaceCount: 2
+    wordCount: 3
     linkCount: 0
     lineCount: 1
     pageCount: 1
     materialCount: 1
-  m_havePropertiesChanged: 0
   m_isUsingLegacyAnimationComponent: 0
   m_isVolumetricText: 0
   m_spriteAnimator: {fileID: 0}
-  m_isInputParsingRequired: 0
-  m_inputSource: 0
   m_hasFontAssetChanged: 0
   m_renderer: {fileID: 4533479808247404465}
   m_subTextObjects:
@@ -1307,7 +1302,7 @@ MonoBehaviour:
   startDimensionIndex: 0
   CanSelect: 1
   CanDeselect: 1
-  VoiceCommand: Select
+  voiceCommand: Select
   voiceRequiresFocus: 1
   profiles:
   - Target: {fileID: 4533479809219024895}
@@ -1352,8 +1347,6 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 0
         m_CallState: 2
-    m_TypeName: UnityEngine.Events.UnityEvent, UnityEngine.CoreModule, Version=0.0.0.0,
-      Culture=neutral, PublicKeyToken=null
   Events: []
   resetOnDestroy: 0
   enabledOnStart: 1
@@ -1378,8 +1371,6 @@ MonoBehaviour:
   onLookAtStart:
     m_PersistentCalls:
       m_Calls: []
-    m_TypeName: UnityEngine.Events.UnityEvent, UnityEngine.CoreModule, Version=0.0.0.0,
-      Culture=neutral, PublicKeyToken=null
   whileLookingAtTarget:
     m_PersistentCalls:
       m_Calls:
@@ -1394,8 +1385,6 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 0
         m_CallState: 2
-    m_TypeName: UnityEngine.Events.UnityEvent, UnityEngine.CoreModule, Version=0.0.0.0,
-      Culture=neutral, PublicKeyToken=null
   onLookAway:
     m_PersistentCalls:
       m_Calls:
@@ -1410,18 +1399,18 @@ MonoBehaviour:
           m_StringArgument: 
           m_BoolArgument: 0
         m_CallState: 2
-    m_TypeName: UnityEngine.Events.UnityEvent, UnityEngine.CoreModule, Version=0.0.0.0,
-      Culture=neutral, PublicKeyToken=null
   onDwell:
     m_PersistentCalls:
       m_Calls: []
-    m_TypeName: UnityEngine.Events.UnityEvent, UnityEngine.CoreModule, Version=0.0.0.0,
-      Culture=neutral, PublicKeyToken=null
   onSelected:
     m_PersistentCalls:
       m_Calls: []
-    m_TypeName: UnityEngine.Events.UnityEvent, UnityEngine.CoreModule, Version=0.0.0.0,
-      Culture=neutral, PublicKeyToken=null
+  onTapDown:
+    m_PersistentCalls:
+      m_Calls: []
+  onTapUp:
+    m_PersistentCalls:
+      m_Calls: []
   eyeCursorSnapToTargetCenter: 0
 --- !u!82 &4533479808906774274
 AudioSource:

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

@@ -87,14 +87,14 @@ MonoBehaviour:
       description: ZoomOut
       axisConstraint: 0
   - localizationKey: 
-    keyword: Start recording
+    keyword: Record eye gaze
     keyCode: 107
     action:
       id: 20
       description: StartRecordingData
       axisConstraint: 0
   - localizationKey: 
-    keyword: Stop recording
+    keyword: End recording
     keyCode: 108
     action:
       id: 21