Merge from HoloToolkit/master to matthejo/master

Author: matthejo

Assets/HoloToolkit-Examples/SharingWithUNET/Scripts/PlayerController.cs

@@ -78,6 +78,14 @@ private void Start()
             transform.SetParent(sharedWorldAnchorTransform);
         }
 
+        private void OnDestroy()
+        {
+            if (isLocalPlayer)
+            {
+                InputManager.Instance.RemoveGlobalListener(gameObject);
+            }
+        }
+
         private void Update()
         {
             // If we aren't the local player, we just need to make sure that the position of this object is set properly

Assets/HoloToolkit-Examples/SpatialUnderstanding/SpatialUnderstanding-FeatureOverview/Scripts/AppState.cs

@@ -5,6 +5,7 @@
 using HoloToolkit.Unity;
 using System;
 using HoloToolkit.Unity.InputModule;
+using HoloToolkit.Unity.SpatialMapping;
 
 namespace HoloToolkit.Examples.SpatialUnderstandingFeatureOverview
 {
@@ -199,13 +200,18 @@ private void Start()
             InputManager.Instance.AddGlobalListener(gameObject);
         }
 
-        private void Update_DebugDisplay(float deltaTime)
+    protected override void OnDestroy()
+    {
+        InputManager.Instance.RemoveGlobalListener(gameObject);
+    }
+
+    private void Update_DebugDisplay(float deltaTime)
+    {
+        // Basic checks
+        if (DebugDisplay == null)
         {
-            // Basic checks
-            if (DebugDisplay == null)
-            {
-                return;
-            }
+            return;
+        }
 
             // Update display text
             DebugDisplay.text = PrimaryText;

Assets/HoloToolkit/Input/Animations/Cursor/CursorSimple.controller

@@ -81,7 +81,7 @@ AnimatorStateTransition:
   m_ExitTime: 0.33066684
   m_HasExitTime: 0
   m_HasFixedDuration: 1
-  m_InterruptionSource: 0
+  m_InterruptionSource: 2
   m_OrderedInterruption: 1
   m_CanTransitionToSelf: 1
 --- !u!1101 &1101000011538347200
@@ -156,7 +156,7 @@ AnimatorStateTransition:
   m_ExitTime: 0.17148435
   m_HasExitTime: 0
   m_HasFixedDuration: 1
-  m_InterruptionSource: 0
+  m_InterruptionSource: 2
   m_OrderedInterruption: 1
   m_CanTransitionToSelf: 1
 --- !u!1101 &1101000011705696456

Assets/HoloToolkit/Input/README.md

@@ -17,6 +17,7 @@ Game objects that want to consume input events can implement one or many **input
 - **IManipulationHandler** for the Windows manipulation gesture.
 - **INavigationnHandler** for the Windows navigation gesture.
 - **ISourceStateHandler** for the source detected and source lost events.
+- **ISpeechHandler** for voice commands.
 
 The **input manager** listens to the various events coming from the input sources, and also takes into account the gaze. Currently, that gaze is always coming from the GazeManager class, but this could be extended to support multiple gaze sources if the need arises.
 
@@ -189,16 +190,30 @@ or in your Visual Studio Package.appxmanifest capabilities.
 **RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
 
 #### Voice
-##### KeywordManager.cs
-Allows you to specify keywords and methods in the Unity Inspector, instead of registering them explicitly in code.  
-**IMPORTANT**: Please make sure to add the microphone capability in your app, in Unity under  
+
+**IMPORTANT**: Please make sure to add the Microphone capabilities in your app, in Unity under  
 Edit -> Project Settings -> Player -> Settings for Windows Store -> Publishing Settings -> Capabilities  
 or in your Visual Studio Package.appxmanifest capabilities.
 
+##### KeywordManager.cs
+Allows you to specify keywords and methods in the Unity Inspector, instead of registering them explicitly in code.  
+
 **_KeywordsAndResponses_** Set the size as the number of keywords you'd like to listen for, then specify the keywords and method responses to complete the array.
 
 **RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
 
+##### SpeechInputSource.cs
+Allows you to specify keywords and keyboard shortcuts in the Unity Inspector, instead of registering them explicitly in code. Keywords are handled by scripts that implement ISpeechHandler.cs.
+
+Check out Assets/HoloToolkit/Input/Tests/Scripts/SphereKeywords.cs and Assets/HoloToolkit/Input/Tests/Scripts/SphereGlobalKeywords.cs for an example of implementing these features, which is used in the demo scene at Assets/HoloToolkit/Input/Tests/SpeechInputSource.unity.
+
+**_KeywordsAndKeys_** Set the size as the number of keywords you'd like to listen for, then specify the keywords to complete the array.
+
+**RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
+
+##### ISpeechHandler.cs
+Interface that a game object can implement to react to speech keywords.
+
 ### [Test Prefabs](TestPrefabs)
 
 Prefabs used in the various test scenes, which you can use as inspiration to build your own.
@@ -276,6 +291,19 @@ Gazing on an object and saying "Select Object" will persistently select that obj
 after which the user can also adjust object size with "Make Smaller" and "Make Bigger" voice commands and finally clear
 currently selected object by saying "Clear Selection".
 
+#### SpeechInputSource.unity
+
+Shows how to use the SpeechInputSource.cs script to add keywords to your scene.
+
+1. Select whether you want the recognizer to start automatically or when you manually start it.
+2. Specify the number of keywords you want.
+3. Type the word or phrase you'd like to register as the keyword and, if you want, set a key code to use in the Editor. You can also use an attached microphone with the Editor.
+4. Attach a script that implements ISpeechHandler.cs to the object in the scene that will require the gaze focus to execute the command. You should register this script with the InputManager.cs as a global listener to handle keywords that don't require a focused object.
+
+When you start the scene, your keywords will automatically be registered on a KeywordRecognizer, and the recognizer will be started (or not) based on your Recognizer Start setting.
+
+#### 
+
 ---
 ##### [Go back up to the table of contents.](../../../README.md)
 ---

Assets/HoloToolkit/Input/Scripts/Cursor/Cursor.cs

@@ -23,11 +23,11 @@ public enum CursorStateEnum
             /// <summary>
             /// Not IsHandVisible
             /// </summary>
-            Observe, 
+            Observe,
             /// <summary>
             /// Not IsHandVisible AND not IsInputSourceDown AND TargetedObject exists
             /// </summary>
-            ObserveHover, 
+            ObserveHover,
             /// <summary>
             /// IsHandVisible AND not IsInputSourceDown AND TargetedObject is NULL
             /// </summary>
@@ -73,10 +73,13 @@ public enum CursorStateEnum
         [Tooltip("The distance from the hit surface to place the cursor")]
         public float SurfaceCursorDistance = 0.02f;
 
+        [Header("Motion")]
+        [Tooltip("When lerping, use unscaled time. This is useful for games that have a pause mechanism or otherwise adjust the game timescale.")]
+        public bool UseUnscaledTime = true;
+
         /// <summary>
         /// Blend value for surface normal to user facing lerp
         /// </summary>
-        [Header("Motion")]
         public float PositionLerpTime = 0.01f;
 
         /// <summary>
@@ -105,7 +108,7 @@ public Vector3 Position
         {
             get { return transform.position; }
         }
-        
+
         public Quaternion Rotation
         {
             get { return transform.rotation; }
@@ -153,7 +156,7 @@ public bool IsVisible
             }
         }
 
-#region MonoBehaviour Functions
+        #region MonoBehaviour Functions
 
         private void Awake()
         {
@@ -177,7 +180,7 @@ private void Update()
         /// <summary>
         /// Override for enable functions
         /// </summary>
-        protected virtual void OnEnable(){}
+        protected virtual void OnEnable() { }
 
         /// <summary>
         /// Override for disable functions
@@ -194,7 +197,7 @@ private void OnDestroy()
             UnregisterManagers();
         }
 
-#endregion
+        #endregion
 
         /// <summary>
         /// Register to events from the managers the cursor needs.
@@ -302,17 +305,21 @@ protected virtual void UpdateCursorTransform()
                 }
             }
 
+            float deltaTime = UseUnscaledTime
+                ? Time.unscaledDeltaTime
+                : Time.deltaTime;
+
             // Use the lerp times to blend the position to the target position
-            transform.position = Vector3.Lerp(transform.position, targetPosition, Time.deltaTime / PositionLerpTime);
-            transform.localScale = Vector3.Lerp(transform.localScale, targetScale, Time.deltaTime / ScaleLerpTime);
-            transform.rotation = Quaternion.Lerp(transform.rotation, targetRotation, Time.deltaTime / RotationLerpTime);
+            transform.position = Vector3.Lerp(transform.position, targetPosition, deltaTime / PositionLerpTime);
+            transform.localScale = Vector3.Lerp(transform.localScale, targetScale, deltaTime / ScaleLerpTime);
+            transform.rotation = Quaternion.Lerp(transform.rotation, targetRotation, deltaTime / RotationLerpTime);
         }
 
         /// <summary>
         /// Updates the visual representation of the cursor.
         /// </summary>
         public void SetVisiblity(bool visible)
-        { 
+        {
             if (PrimaryCursorVisual != null)
             {
                 PrimaryCursorVisual.gameObject.SetActive(visible);
@@ -414,7 +421,7 @@ public virtual CursorStateEnum CheckCursorState()
                 {
                     return CursorStateEnum.Select;
                 }
-                else if(cursorState == CursorStateEnum.Select)
+                else if (cursorState == CursorStateEnum.Select)
                 {
                     return CursorStateEnum.Release;
                 }

Assets/HoloToolkit/Input/Scripts/Cursor/ObjectCursor.cs

@@ -37,6 +37,12 @@ protected override void OnEnable()
             {
                 ParentTransform = transform;
             }
+
+            for (int i = 0; i < ParentTransform.childCount; i++)
+            {
+                ParentTransform.GetChild(i).gameObject.SetActive(false);
+            }
+
             base.OnEnable();
         }
 
@@ -48,23 +54,42 @@ protected override void OnEnable()
         public override void OnCursorStateChange(CursorStateEnum state)
         {
             base.OnCursorStateChange(state);
-
             if (state != CursorStateEnum.Contextual)
             {
-                // Hide all children first
-                for(int i = 0; i < ParentTransform.childCount; i++)
+
+                // First, try to find a cursor for the current state
+                var newActive = new ObjectCursorDatum();
+                for(int cursorIndex = 0; cursorIndex < CursorStateData.Length; cursorIndex++)
                 {
-                    ParentTransform.GetChild(i).gameObject.SetActive(false);
+                    ObjectCursorDatum cursor = CursorStateData[cursorIndex];
+                    if (cursor.CursorState == state)
+                    {
+                        newActive = cursor;
+                        break;
+                    }
+                }
+
+                // If no cursor for current state is found, let the last active cursor be
+                // (any cursor is better than an invisible cursor)
+                if (newActive.Name == null)
+                {
+                    return;
                 }
 
-                // Set active any that match the current state
-                for (int i = 0; i < CursorStateData.Length; i++)
+                // If we come here, there is a cursor for the new state, 
+                // so de-activate a possible earlier active cursor
+                for(int cursorIndex = 0; cursorIndex < CursorStateData.Length; cursorIndex++)
                 {
-                    if (CursorStateData[i].CursorState == state)
+                    ObjectCursorDatum cursor = CursorStateData[cursorIndex];
+                    if (cursor.CursorObject.activeSelf)
                     {
-                        CursorStateData[i].CursorObject.SetActive(true);
+                        cursor.CursorObject.SetActive(false);
+                        break;
                     }
                 }
+
+                // ... and set the cursor for the new state active.
+                newActive.CursorObject.SetActive(true);
             }
         }
     }

Assets/HoloToolkit/Input/Scripts/InputEvents/ISpeechHandler.cs

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using UnityEngine.EventSystems;
+
+namespace HoloToolkit.Unity.InputModule
+{
+    /// <summary>
+    /// Interface to implement to react to speech recognition.
+    /// </summary>
+    public interface ISpeechHandler : IEventSystemHandler
+    {
+        void OnSpeechKeywordRecognized(SpeechKeywordRecognizedEventData eventData);
+    }
+}

Assets/HoloToolkit/Input/Scripts/InputEvents/ISpeechHandler.cs.meta

@@ -0,0 +1,55 @@
+// 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;
+using UnityEngine.EventSystems;
+using UnityEngine.Windows.Speech;
+
+namespace HoloToolkit.Unity.InputModule
+{
+    /// <summary>
+    /// Describes an input event that involves keyword recognition.
+    /// </summary>
+    public class SpeechKeywordRecognizedEventData : InputEventData
+    {
+        /// <summary>
+        /// A measure of correct recognition certainty.
+        /// </summary>
+        public ConfidenceLevel Confidence { get; private set; }
+
+        /// <summary>
+        /// The time it took for the phrase to be uttered.
+        /// </summary>
+        public TimeSpan PhraseDuration { get; private set; }
+
+        /// <summary>
+        /// The moment in time when uttering of the phrase began.
+        /// </summary>
+        public DateTime PhraseStartTime { get; private set; }
+
+        /// <summary>
+        /// A semantic meaning of recognized phrase.
+        /// </summary>
+        public SemanticMeaning[] SemanticMeanings { get; private set; }
+
+        /// <summary>
+        /// The text that was recognized.
+        /// </summary>
+        public string RecognizedText { get; private set; }
+
+        public SpeechKeywordRecognizedEventData(EventSystem eventSystem) : base(eventSystem)
+        {
+        }
+
+        public void Initialize(IInputSource inputSource, uint sourceId, ConfidenceLevel confidence, TimeSpan phraseDuration, DateTime phraseStartTime, SemanticMeaning[] semanticMeanings, string recognizedText)
+        {
+            BaseInitialize(inputSource, sourceId);
+            Confidence = confidence;
+            PhraseDuration = phraseDuration;
+            PhraseStartTime = phraseStartTime;
+            SemanticMeanings = semanticMeanings;
+            RecognizedText = recognizedText;
+        }
+    }
+}