Merge pull request #2643 from Microsoft/mrtk_development

merge mrtk_development -> mrdevsummit_2018_08

Author: David Kline

Assets/MixedRealityToolkit-SDK/Features/Input/MixedRealityInputManager.cs

@@ -70,6 +70,21 @@ public class MixedRealityInputManager : MixedRealityEventManager, IMixedRealityI
 
 #endif // UNITY_STANDALONE_WIN || UNITY_WSA || UNITY_EDITOR_WIN
 
+        /// <summary>
+        /// Current Speech Input Source.
+        /// </summary>
+        public SpeechInputSource SpeechInputSource { get; private set; }
+
+        /// <summary>
+        /// Current Dictation Input Source.
+        /// </summary>
+        public DictationInputSource DictationInputSource { get; private set; }
+
+        /// <summary>
+        /// Current Touch Screen Input Source.
+        /// </summary>
+        public TouchscreenInputSource TouchscreenInputSource { get; private set; }
+
         #region IMixedRealityManager Implementation
 
         /// <summary>
@@ -188,6 +203,26 @@ private void InitializeInternal()
             dictationEventData = new DictationEventData(EventSystem.current);
 
 #endif // UNITY_STANDALONE_WIN || UNITY_WSA || UNITY_EDITOR_WIN
+
+            if (MixedRealityManager.Instance.ActiveProfile.IsSpeechCommandsEnabled)
+            {
+                SpeechInputSource = new SpeechInputSource(
+                    MixedRealityManager.Instance.ActiveProfile.SpeechCommandsProfile.SpeechCommands
+#if UNITY_STANDALONE_WIN || UNITY_WSA || UNITY_EDITOR_WIN
+                    , (UnityEngine.Windows.Speech.ConfidenceLevel)MixedRealityManager.Instance.ActiveProfile.SpeechRecognitionConfidenceLevel
+#endif
+                );
+            }
+
+            if (MixedRealityManager.Instance.ActiveProfile.IsDictationEnabled)
+            {
+                DictationInputSource = new DictationInputSource();
+            }
+
+            if (MixedRealityManager.Instance.ActiveProfile.IsTouchScreenInputEnabled)
+            {
+                TouchscreenInputSource = new TouchscreenInputSource();
+            }
         }
 
         /// <inheritdoc />
@@ -246,6 +281,9 @@ public override void Destroy()
                 UnityEngine.Object.Destroy(gazeProvider);
             }
 
+            SpeechInputSource?.Dispose();
+            DictationInputSource?.Dispose();
+            TouchscreenInputSource?.Dispose();
             base.Destroy();
         }
 
@@ -1444,10 +1482,10 @@ public void RaiseSpeechCommandRecognized(IMixedRealityInputSource source, MixedR
             };
 
         /// <inheritdoc />
-        public void RaiseDictationHypothesis(IMixedRealityInputSource source, MixedRealityInputAction inputAction, string dictationHypothesis, AudioClip dictationAudioClip = null)
+        public void RaiseDictationHypothesis(IMixedRealityInputSource source, string dictationHypothesis, AudioClip dictationAudioClip = null)
         {
             // Create input event
-            dictationEventData.Initialize(source, inputAction, dictationHypothesis, dictationAudioClip);
+            dictationEventData.Initialize(source, dictationHypothesis, dictationAudioClip);
 
             // Pass handler through HandleEvent to perform modal/fallback logic
             HandleEvent(dictationEventData, OnDictationHypothesisEventHandler);
@@ -1461,10 +1499,10 @@ public void RaiseDictationHypothesis(IMixedRealityInputSource source, MixedReali
             };
 
         /// <inheritdoc />
-        public void RaiseDictationResult(IMixedRealityInputSource source, MixedRealityInputAction inputAction, string dictationResult, AudioClip dictationAudioClip = null)
+        public void RaiseDictationResult(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)
         {
             // Create input event
-            dictationEventData.Initialize(source, inputAction, dictationResult, dictationAudioClip);
+            dictationEventData.Initialize(source, dictationResult, dictationAudioClip);
 
             // Pass handler through HandleEvent to perform modal/fallback logic
             HandleEvent(dictationEventData, OnDictationResultEventHandler);
@@ -1478,10 +1516,10 @@ public void RaiseDictationResult(IMixedRealityInputSource source, MixedRealityIn
             };
 
         /// <inheritdoc />
-        public void RaiseDictationComplete(IMixedRealityInputSource source, MixedRealityInputAction inputAction, string dictationResult, AudioClip dictationAudioClip)
+        public void RaiseDictationComplete(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip)
         {
             // Create input event
-            dictationEventData.Initialize(source, inputAction, dictationResult, dictationAudioClip);
+            dictationEventData.Initialize(source, dictationResult, dictationAudioClip);
 
             // Pass handler through HandleEvent to perform modal/fallback logic
             HandleEvent(dictationEventData, OnDictationCompleteEventHandler);
@@ -1495,10 +1533,10 @@ public void RaiseDictationComplete(IMixedRealityInputSource source, MixedReality
             };
 
         /// <inheritdoc />
-        public void RaiseDictationError(IMixedRealityInputSource source, MixedRealityInputAction inputAction, string dictationResult, AudioClip dictationAudioClip = null)
+        public void RaiseDictationError(IMixedRealityInputSource source, string dictationResult, AudioClip dictationAudioClip = null)
         {
             // Create input event
-            dictationEventData.Initialize(source, inputAction, dictationResult, dictationAudioClip);
+            dictationEventData.Initialize(source, dictationResult, dictationAudioClip);
 
             // Pass handler through HandleEvent to perform modal/fallback logic
             HandleEvent(dictationEventData, OnDictationErrorEventHandler);
@@ -1509,6 +1547,5 @@ public void RaiseDictationError(IMixedRealityInputSource source, MixedRealityInp
 #endif // UNITY_STANDALONE_WIN || UNITY_WSA || UNITY_EDITOR_WIN
 
         #endregion Input Events
-
     }
 }

Assets/MixedRealityToolkit-SDK/Profiles/DefaultMixedRealityConfigurationProfile.asset

@@ -29,6 +29,11 @@ MonoBehaviour:
   enableSpeechCommands: 1
   speechCommandsProfile: {fileID: 11400000, guid: e8d0393e66374dae9646851a57dc6bc1,
     type: 2}
+  enableDictation: 1
+  recognitionConfidenceLevel: 1
+  enableTouchScreenInput: 1
+  touchScreenInputProfile: {fileID: 11400000, guid: efe3718cb67cffa46a5f6361a522baba,
+    type: 2}
   enableControllerMapping: 1
   controllerMappingProfile: {fileID: 11400000, guid: 3b591b9f56584e888f557aa29796cbf8,
     type: 2}

Assets/MixedRealityToolkit-SDK/Profiles/DefaultMixedRealitySpeechCommandsProfile.asset

@@ -12,15 +12,9 @@ MonoBehaviour:
   m_Name: DefaultMixedRealitySpeechCommandsProfile
   m_EditorClassIdentifier: 
   speechCommands:
-  - keyword: Select
-    keyCode: 32
-    action:
-      id: 1
-      description: Menu
-      axisConstraint: 2
   - keyword: Menu
     keyCode: 9
     action:
       id: 2
-      description: Grip
-      axisConstraint: 7
+      description: Menu
+      axisConstraint: 2

Assets/MixedRealityToolkit-SDK/Profiles/DefaultMixedRealityTouchInputProfile.asset

@@ -0,0 +1,21 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &11400000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_PrefabParentObject: {fileID: 0}
+  m_PrefabInternal: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 76606fa160e04c018d09c679f16c94c8, type: 3}
+  m_Name: DefaultMixedRealityTouchInputProfile
+  m_EditorClassIdentifier: 
+  pointerAction:
+    id: 1
+    description: Select
+    axisConstraint: 2
+  holdAction:
+    id: 0
+    description: 
+    axisConstraint: 0

Assets/MixedRealityToolkit-SDK/Profiles/DefaultMixedRealityTouchInputProfile.asset.meta

@@ -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 System;
 using Microsoft.MixedReality.Toolkit.Internal.Interfaces.InputSystem;
 using Microsoft.MixedReality.Toolkit.Internal.Managers;
 using System.Collections;
@@ -12,7 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.InputSystem.Sources
     /// <remarks>This base class does not support adding or removing pointers, because many will never
     /// pass pointers in their constructors and will fall back to either the Gaze or Mouse Pointer.</remarks>
     /// </summary>
-    public class BaseGenericInputSource : IMixedRealityInputSource
+    public class BaseGenericInputSource : IMixedRealityInputSource, IDisposable
     {
         /// <summary>
         /// The Current Input System for this Input Source.
@@ -87,6 +88,11 @@ public override int GetHashCode()
             }
         }
 
+        /// <summary>
+        /// Dispose.
+        /// </summary>
+        public virtual void Dispose() { }
+
         #endregion IEquality Implementation
     }
 }

Assets/MixedRealityToolkit/InputSystem/Sources/BaseGenericInputSource.cs

@@ -4,6 +4,7 @@
 using Microsoft.MixedReality.Toolkit.Internal.Definitions.InputSystem;
 using Microsoft.MixedReality.Toolkit.Internal.Interfaces.InputSystem;
 using Microsoft.MixedReality.Toolkit.Internal.Utilities.Async;
+using Microsoft.MixedReality.Toolkit.Internal.Utilities.Async.AwaitYieldInstructions;
 using System.Threading.Tasks;
 using UnityEngine;
 
@@ -25,49 +26,18 @@ public class DictationInputSource : BaseGenericInputSource
         /// </summary>
         public static bool IsListening { get; private set; } = false;
 
-        /// <summary>
-        /// Action that will be associated with a dictation hypothesis input event.
-        /// </summary>
-        public static MixedRealityInputAction HypothesisAction { get; set; }
-
-        /// <summary>
-        /// Action that will be associated with a dictation result input event.
-        /// </summary>
-        public static MixedRealityInputAction ResultAction { get; set; }
-
-        /// <summary>
-        /// Action that will be associated with a dictation complete input event.
-        /// </summary>
-        public static MixedRealityInputAction CompleteAction { get; set; }
-
-        /// <summary>
-        /// Action that will be associated with a dictation error input event.
-        /// </summary>
-        public static MixedRealityInputAction ErrorAction { get; set; }
-
 #if UNITY_STANDALONE_WIN || UNITY_WSA || UNITY_EDITOR_WIN
 
         /// <summary>
         /// Constructor.
         /// </summary>
-        /// <param name="hypothesisAction">Action that will be associated with a dictation hypothesis input event</param>
-        /// <param name="resultAction">Action that will be associated with a dictation result input event</param>
-        /// <param name="completeAction">Action that will be associated with a dictation complete input event</param>
-        /// <param name="errorAction">Action that will be associated with a dictation error input event.</param>
-        public DictationInputSource(MixedRealityInputAction hypothesisAction,
-                                    MixedRealityInputAction resultAction,
-                                    MixedRealityInputAction completeAction,
-                                    MixedRealityInputAction errorAction)
-                : base("Dictation")
+        public DictationInputSource() : base("Dictation")
         {
+            if (!Application.isPlaying) { return; }
+
             source = this;
             dictationResult = string.Empty;
 
-            HypothesisAction = hypothesisAction;
-            ResultAction = resultAction;
-            CompleteAction = completeAction;
-            ErrorAction = errorAction;
-
             dictationRecognizer = new DictationRecognizer();
             dictationRecognizer.DictationHypothesis += DictationRecognizer_DictationHypothesis;
             dictationRecognizer.DictationResult += DictationRecognizer_DictationResult;
@@ -81,16 +51,17 @@ public DictationInputSource(MixedRealityInputAction hypothesisAction,
             Run();
         }
 
-        /// <summary>
-        /// Destructor.
-        /// </summary>
-        ~DictationInputSource()
+        /// <inheritdoc />
+        public override void Dispose()
         {
-            dictationRecognizer.DictationHypothesis -= DictationRecognizer_DictationHypothesis;
-            dictationRecognizer.DictationResult -= DictationRecognizer_DictationResult;
-            dictationRecognizer.DictationComplete -= DictationRecognizer_DictationComplete;
-            dictationRecognizer.DictationError -= DictationRecognizer_DictationError;
-            dictationRecognizer.Dispose();
+            if (dictationRecognizer != null)
+            {
+                dictationRecognizer.DictationHypothesis -= DictationRecognizer_DictationHypothesis;
+                dictationRecognizer.DictationResult -= DictationRecognizer_DictationResult;
+                dictationRecognizer.DictationComplete -= DictationRecognizer_DictationComplete;
+                dictationRecognizer.DictationError -= DictationRecognizer_DictationError;
+                dictationRecognizer?.Dispose();
+            }
         }
 
         private static IMixedRealityInputSource source;
@@ -126,7 +97,7 @@ public DictationInputSource(MixedRealityInputAction hypothesisAction,
         /// </summary>
         private static AudioClip dictationAudioClip;
 
-        private static readonly WaitForFixedUpdate nextUpdate = new WaitForFixedUpdate();
+        private static readonly WaitForUpdate NextUpdate = new WaitForUpdate();
 
         private static async void Run()
         {
@@ -141,10 +112,10 @@ private static async void Run()
                 if (!hasFailed && dictationRecognizer.Status == SpeechSystemStatus.Failed)
                 {
                     hasFailed = true;
-                    InputSystem.RaiseDictationError(source, ErrorAction, "Dictation recognizer has failed!");
+                    InputSystem.RaiseDictationError(source, "Dictation recognizer has failed!");
                 }
 
-                await nextUpdate;
+                await NextUpdate;
             }
         }
 
@@ -192,7 +163,7 @@ public static async Task StartRecordingAsync(GameObject listener = null, float i
 
             if (dictationRecognizer.Status == SpeechSystemStatus.Failed)
             {
-                InputSystem.RaiseDictationError(source, ErrorAction, "Dictation recognizer failed to start!");
+                InputSystem.RaiseDictationError(source, "Dictation recognizer failed to start!");
                 return;
             }
 
@@ -201,7 +172,8 @@ public static async Task StartRecordingAsync(GameObject listener = null, float i
             textSoFar = new StringBuilder();
             isTransitioning = false;
 #else
-            throw new NotImplementedException("Unable to start recording!  Dictation is unsupported for this platform.");
+
+            Debug.LogError("Unable to start recording!  Dictation is unsupported for this platform.");
 #endif // UNITY_STANDALONE_WIN || UNITY_WSA || UNITY_EDITOR_WIN
         }
 
@@ -256,7 +228,7 @@ private static void DictationRecognizer_DictationHypothesis(string text)
             // We don't want to append to textSoFar yet, because the hypothesis may have changed on the next event.
             dictationResult = $"{textSoFar} {text}...";
 
-            InputSystem.RaiseDictationHypothesis(source, HypothesisAction, dictationResult);
+            InputSystem.RaiseDictationHypothesis(source, dictationResult);
         }
 
         /// <summary>
@@ -270,7 +242,7 @@ private static void DictationRecognizer_DictationResult(string text, ConfidenceL
 
             dictationResult = textSoFar.ToString();
 
-            InputSystem.RaiseDictationResult(source, ResultAction, dictationResult);
+            InputSystem.RaiseDictationResult(source, dictationResult);
         }
 
         /// <summary>
@@ -288,7 +260,7 @@ private static void DictationRecognizer_DictationComplete(DictationCompletionCau
                 dictationResult = "Dictation has timed out. Please try again.";
             }
 
-            InputSystem.RaiseDictationComplete(source, CompleteAction, dictationResult, dictationAudioClip);
+            InputSystem.RaiseDictationComplete(source, dictationResult, dictationAudioClip);
             textSoFar = null;
             dictationResult = string.Empty;
         }
@@ -302,7 +274,7 @@ private static void DictationRecognizer_DictationError(string error, int hresult
         {
             dictationResult = $"{error}\nHRESULT: {hresult}";
 
-            InputSystem.RaiseDictationError(source, ErrorAction, dictationResult);
+            InputSystem.RaiseDictationError(source, dictationResult);
             textSoFar = null;
             dictationResult = string.Empty;
         }