SeeItSayItLabel improvements (#593) (#792)

* Add SeeItSayItLabel automatic update when changing button's keyword, allow translation for the pattern (#593)

* Fix tests compilation without speech package (#593) (#792)

* Fix SeeItSayItLabelEnabler not unsubscribing on destroy (#593) (#792)

* Fix tests for unsupported machine (#593) (#792)

* Update org.mixedrealitytoolkit.uxcore/SeeItSayIt/SeeItSayItLabelEnabler.cs

Co-authored-by: Kurtis <[email protected]>
Signed-off-by: David Kline <[email protected]>

* Update CHANGELOG.md

* Formatting and typo updates

* Remove space from scene name

* Update SeeItSayItLabelEnabler.cs

* Always fall back to pattern if localizedPattern is empty

Even with the Localization package installed, some prefabs may need the fallback behavior (even if just temporarily)

* Add custom editor

---------

Signed-off-by: David Kline <[email protected]>
Signed-off-by: Kurtis <[email protected]>
Co-authored-by: Anonymous <[email protected]>
Co-authored-by: David Kline <[email protected]>
Co-authored-by: Kurtis <[email protected]>
Co-authored-by: Kurtis <[email protected]>

Author: 4 people

UnityProjects/MRTKDevTemplate/Assets/Scenes/SeeItSayIt Example.unity renamed to UnityProjects/MRTKDevTemplate/Assets/Scenes/SeeItSayItExample.unity

@@ -431,7 +431,7 @@
       "source": "local",
       "dependencies": {
         "com.microsoft.mrtk.graphicstools.unity": "0.5.12",
-        "org.mixedrealitytoolkit.core": "3.2.0",
+        "org.mixedrealitytoolkit.core": "3.3.0",
         "com.unity.inputsystem": "1.6.1",
         "com.unity.textmeshpro": "3.0.6",
         "com.unity.xr.interaction.toolkit": "2.3.0"

UnityProjects/MRTKDevTemplate/Assets/Scenes/SeeItSayIt Example.unity.meta renamed to UnityProjects/MRTKDevTemplate/Assets/Scenes/SeeItSayItExample.unity.meta

@@ -117,7 +117,7 @@ EditorBuildSettings:
     path: Assets/Scenes/Experimental/ScrollingExample.unity
     guid: 77e21ebc978cbc84f9ebe061742ae42d
   - enabled: 1
-    path: Assets/Scenes/SeeItSayIt Example.unity
+    path: Assets/Scenes/SeeItSayItExample.unity
     guid: cb7d2aaea1c5a4d469a6408ee9ddc5fc
   - enabled: 1
     path: Assets/Scenes/SlateDrawingExample.unity

UnityProjects/MRTKDevTemplate/Packages/packages-lock.json

@@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 * Updated tests to follow existing MRTK test patterns. [PR #1046](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/1046)
 
+### Added
+
+* Added event `OnSpeechRecognitionKeywordChanged` to allow UI updates when the speech recognition keyword has changed. [PR #792](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/792/)
+
 ### Fixed
 
 * Fixed broken project validation help link, for item 'MRTK3 profile may need to be assigned for the Standalone build target' (Issue #882) [PR #886](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/886)

UnityProjects/MRTKDevTemplate/ProjectSettings/EditorBuildSettings.asset

@@ -23,6 +23,7 @@ public class StatefulInteractableEditor : BaseInteractableEditor
         private SerializedProperty allowSelectByVoice;
         private SerializedProperty SelectRequiresHover;
         private SerializedProperty speechRecognitionKeyword;
+        private SerializedProperty OnSpeechRecognitionKeywordChanged;
         private SerializedProperty VoiceRequiresFocus;
         private SerializedProperty UseGazeDwell;
         private SerializedProperty GazeDwellTime;
@@ -34,6 +35,7 @@ public class StatefulInteractableEditor : BaseInteractableEditor
         private SerializedProperty OnEnabled;
         private SerializedProperty OnDisabled;
         private static bool advancedFoldout = false;
+        private static bool speechRecognitionKeywordEventFoldout = false;
         private static bool enabledEventsFoldout = false;
 
         /// <summary>
@@ -57,6 +59,7 @@ protected override void OnEnable()
 
             allowSelectByVoice = SetUpProperty(nameof(allowSelectByVoice));
             speechRecognitionKeyword = SetUpProperty(nameof(speechRecognitionKeyword));
+            OnSpeechRecognitionKeywordChanged = SetUpAutoProperty(nameof(OnSpeechRecognitionKeywordChanged));
             VoiceRequiresFocus = SetUpAutoProperty(nameof(VoiceRequiresFocus));
 
             SelectRequiresHover = SetUpAutoProperty(nameof(SelectRequiresHover));
@@ -166,8 +169,13 @@ protected void DrawProperties(bool showToggleMode)
                     {
                         using (new EditorGUI.IndentLevelScope())
                         {
-                            EditorGUILayout.PropertyField(speechRecognitionKeyword);
                             EditorGUILayout.PropertyField(VoiceRequiresFocus);
+                            EditorGUILayout.PropertyField(speechRecognitionKeyword);
+                            speechRecognitionKeywordEventFoldout = EditorGUILayout.Foldout(speechRecognitionKeywordEventFoldout, EditorGUIUtility.TrTempContent("Speech Recognition Keyword event"), true);
+                            if (speechRecognitionKeywordEventFoldout)
+                            {
+                                EditorGUILayout.PropertyField(OnSpeechRecognitionKeywordChanged);
+                            }
                         }
                     }
 

org.mixedrealitytoolkit.core/CHANGELOG.md

@@ -148,10 +148,17 @@ public string SpeechRecognitionKeyword
                     {
                         interactionManager.RegisterInteractable(this as IXRInteractable);
                     }
+                    OnSpeechRecognitionKeywordChanged.Invoke(speechRecognitionKeyword);
                 }
             }
         }
-        
+
+        /// <summary>
+        /// Fired when the <see cref="SpeechRecognitionKeyword"/> has changed.
+        /// </summary>
+        [field: SerializeField, Tooltip("Fired when the Speech Recognition Keyword has changed.")]
+        public UnityEvent<string> OnSpeechRecognitionKeywordChanged { get; private set; } = new UnityEvent<string>();
+
         /// <summary>
         /// Does the voice command require this to have focus?
         /// If true, then the voice command will only respond to voice commands while this Interactable has focus.

org.mixedrealitytoolkit.core/Editor/Editors/StatefulInteractableEditor.cs

@@ -1,6 +1,6 @@
 {
   "name": "org.mixedrealitytoolkit.core",
-  "version": "3.2.3-development",
+  "version": "3.3.0-development",
   "description": "A limited collection of common interfaces and utilities that most MRTK packages share. Most implementations of these interfaces are contained in other packages in the MRTK ecosystem.",
   "displayName": "MRTK Core Definitions",
   "msftFeatureCategory": "MRTK3",

org.mixedrealitytoolkit.core/Interactables/StatefulInteractable.cs

@@ -4,6 +4,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ## Unreleased
 
+### Added
+
+* Added automatic update for the `See It Say It Label` when the `SpeechRecognitionKeyword` of a `StatefulInteractable` has changed. Added ability to change the pattern, from inspector or code. [PR #792](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/792)
+* When Unity Localization package is installed, a `LocalizedString` is used as pattern. [PR #792](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/792)
+
 ### Changed
 
 * StateVisualizer: Modified access modifiers of State, stateContainers and UpdateStateValue to protected internal to allow adding states through subclassing. [PR #926](https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity/pull/926)