Move input subsystem implementations to the input package.

microsoft · Jun 22, 2023 · 570be7a · 570be7a
1 parent 14ba625
commit 570be7a
Show file tree

Hide file tree

Showing 28 changed files with 32 additions and 18 deletions.
diff --git a/UnityProjects/MRTKDevTemplate/Packages/packages-lock.json b/UnityProjects/MRTKDevTemplate/Packages/packages-lock.json
@@ -188,6 +188,7 @@
       "source": "local",
       "dependencies": {
         "com.microsoft.mrtk.core": "3.0.0",
+        "com.microsoft.mrtk.input": "3.0.0",
         "com.microsoft.mrtk.tts.windows": "1.0.1"
       }
     },

diff --git a/com.microsoft.mrtk.core/Subsystems/Hands/IHandsAggregatorSubsystem.cs b/com.microsoft.mrtk.core/Subsystems/Hands/IHandsAggregatorSubsystem.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using UnityEngine;
 using UnityEngine.XR;
 
 namespace Microsoft.MixedReality.Toolkit.Subsystems
@@ -20,7 +21,7 @@ namespace Microsoft.MixedReality.Toolkit.Subsystems
     /// See <see cref="MRTKHandsAggregatorSubsystem"> for the MRTK implementation.
     /// </remarks>
     /// </summary>
-    public interface IHandsAggregatorSubsystem
+    public interface IHandsAggregatorSubsystem : ISubsystem
     {
         /// <summary>
         /// The playspace-local pose of the near interaction point.

diff --git a/com.microsoft.mrtk.core/Subsystems/Speech/IDictationSubsystem.cs b/com.microsoft.mrtk.core/Subsystems/Speech/IDictationSubsystem.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Subsystems
 {
@@ -11,7 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.Subsystems
     /// MUST implement this interface, preferably with a direct 1:1 mapping
     /// between the provider surface and the subsystem surface.
     /// </summary>
-    public interface IDictationSubsystem
+    public interface IDictationSubsystem : ISubsystem
     {
         /// <summary>
         /// Start dictation with default configurations.

diff --git a/com.microsoft.mrtk.core/Subsystems/Speech/IKeywordRecognitionSubsystem.cs b/com.microsoft.mrtk.core/Subsystems/Speech/IKeywordRecognitionSubsystem.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
+using UnityEngine;
 using UnityEngine.Events;
 
 namespace Microsoft.MixedReality.Toolkit.Subsystems
@@ -12,7 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.Subsystems
     /// MUST implement this interface, preferably with a direct 1:1 mapping
     /// between the provider surface and the subsystem surface.
     /// </summary>
-    public interface IKeywordRecognitionSubsystem
+    public interface IKeywordRecognitionSubsystem : ISubsystem
     {
         /// <summary>
         /// Add or update a keyword to recognize.

diff --git a/com.microsoft.mrtk.core/Utilities/HandsUtils.cs b/com.microsoft.mrtk.core/Utilities/HandsUtils.cs
@@ -20,7 +20,7 @@ public static class HandsUtils
         /// The first running <see cref="HandsAggregatorSubsystem"/> instance, or null.
         /// </returns>
         [Obsolete("Deprecated, please use XRSubsystemHelpers.HandsAggregator")]
-        public static HandsAggregatorSubsystem GetSubsystem() => XRSubsystemHelpers.HandsAggregator;
+        public static IHandsAggregatorSubsystem GetSubsystem() => XRSubsystemHelpers.HandsAggregator;
 
         internal static readonly HandFinger[] HandFingers = Enum.GetValues(typeof(HandFinger)) as HandFinger[];
 

diff --git a/com.microsoft.mrtk.core/Utilities/XRSubsystemHelpers.cs b/com.microsoft.mrtk.core/Utilities/XRSubsystemHelpers.cs
@@ -152,52 +152,52 @@ public static XRDisplaySubsystem DisplaySubsystem
             }
         }
 
-        private static HandsAggregatorSubsystem handsAggregator = null;
+        private static IHandsAggregatorSubsystem handsAggregator = null;
 
         /// <summary>
         /// The currently loaded and running hands aggregator, if any.
         /// </summary>
-        public static HandsAggregatorSubsystem HandsAggregator
+        public static IHandsAggregatorSubsystem HandsAggregator
         {
             get
             {
                 if (handsAggregator == null || !handsAggregator.running)
                 {
-                    handsAggregator = GetFirstRunningSubsystem<HandsAggregatorSubsystem>();
+                    handsAggregator = GetFirstRunningSubsystem<IHandsAggregatorSubsystem>();
                 }
                 return handsAggregator;
             }
         }
 
-        private static DictationSubsystem dictationSubsystem = null;
+        private static IDictationSubsystem dictationSubsystem = null;
 
         /// <summary>
         /// The currently loaded and running dictation subsystem, if any.
         /// </summary>
-        public static DictationSubsystem DictationSubsystem
+        public static IDictationSubsystem DictationSubsystem
         {
             get
             {
                 if (dictationSubsystem == null || !dictationSubsystem.running)
                 {
-                    dictationSubsystem = GetFirstRunningSubsystem<DictationSubsystem>();
+                    dictationSubsystem = GetFirstRunningSubsystem<IDictationSubsystem>();
                 }
                 return dictationSubsystem;
             }
         }
 
-        private static KeywordRecognitionSubsystem keywordRecognitionSubsystem = null;
+        private static IKeywordRecognitionSubsystem keywordRecognitionSubsystem = null;
 
         /// <summary>
         /// The currently loaded and running keyword recognition subsystem, if any.
         /// </summary>
-        public static KeywordRecognitionSubsystem KeywordRecognitionSubsystem
+        public static IKeywordRecognitionSubsystem KeywordRecognitionSubsystem
         {
             get
             {
                 if (keywordRecognitionSubsystem == null || !keywordRecognitionSubsystem.running)
                 {
-                    keywordRecognitionSubsystem = GetFirstRunningSubsystem<KeywordRecognitionSubsystem>();
+                    keywordRecognitionSubsystem = GetFirstRunningSubsystem<IKeywordRecognitionSubsystem>();
                 }
                 return keywordRecognitionSubsystem;
             }

diff --git a/com.microsoft.mrtk.input/Controllers/ArticulatedHandController.cs b/com.microsoft.mrtk.input/Controllers/ArticulatedHandController.cs
@@ -40,7 +40,7 @@ public class ArticulatedHandController : ActionBasedController
         #region Properties
 
         [Obsolete("Deprecated, please use XRSubsystemHelpers.HandsAggregator instead.")]
-        protected HandsAggregatorSubsystem HandsAggregator => XRSubsystemHelpers.HandsAggregator;
+        protected HandsAggregatorSubsystem HandsAggregator => (HandsAggregatorSubsystem)XRSubsystemHelpers.HandsAggregator;
 
         #endregion Properties
 

diff --git a/com.microsoft.mrtk.input/Interactors/Ray/MRTKRayInteractor.cs b/com.microsoft.mrtk.input/Interactors/Ray/MRTKRayInteractor.cs
@@ -51,7 +51,7 @@ public class MRTKRayInteractor :
         /// Cached reference to hands aggregator for efficient per-frame use.
         /// </summary>
         [Obsolete("Deprecated, please use XRSubsystemHelpers.HandsAggregator instead.")]
-        protected HandsAggregatorSubsystem HandsAggregator => XRSubsystemHelpers.HandsAggregator;
+        protected HandsAggregatorSubsystem HandsAggregator => (HandsAggregatorSubsystem)XRSubsystemHelpers.HandsAggregator;
 
         /// <summary>
         /// How unselected the interactor must be to initiate a new hover or selection on a new target.

diff --git a/...systems/Hands/HandsAggregatorSubsystem.cs → ...systems/Hands/HandsAggregatorSubsystem.cs b/...systems/Hands/HandsAggregatorSubsystem.cs → ...systems/Hands/HandsAggregatorSubsystem.cs
diff --git a/...ms/Hands/HandsAggregatorSubsystem.cs.meta → ...ms/Hands/HandsAggregatorSubsystem.cs.meta b/...ms/Hands/HandsAggregatorSubsystem.cs.meta → ...ms/Hands/HandsAggregatorSubsystem.cs.meta
diff --git a/...k.core/Subsystems/Hands/HandsSubsystem.cs → ....input/Subsystems/Hands/HandsSubsystem.cs b/...k.core/Subsystems/Hands/HandsSubsystem.cs → ....input/Subsystems/Hands/HandsSubsystem.cs
diff --git a/...e/Subsystems/Hands/HandsSubsystem.cs.meta → ...t/Subsystems/Hands/HandsSubsystem.cs.meta b/...e/Subsystems/Hands/HandsSubsystem.cs.meta → ...t/Subsystems/Hands/HandsSubsystem.cs.meta
diff --git a/...systems/Hands/HandsSubsystemDescriptor.cs → ...systems/Hands/HandsSubsystemDescriptor.cs b/...systems/Hands/HandsSubsystemDescriptor.cs → ...systems/Hands/HandsSubsystemDescriptor.cs
diff --git a/...ms/Hands/HandsSubsystemDescriptor.cs.meta → ...ms/Hands/HandsSubsystemDescriptor.cs.meta b/...ms/Hands/HandsSubsystemDescriptor.cs.meta → ...ms/Hands/HandsSubsystemDescriptor.cs.meta
diff --git a/com.microsoft.mrtk.input/Subsystems/Speech.meta b/com.microsoft.mrtk.input/Subsystems/Speech.meta
diff --git a/...e/Subsystems/Speech/DictationSubsystem.cs → ...t/Subsystems/Speech/DictationSubsystem.cs b/...e/Subsystems/Speech/DictationSubsystem.cs → ...t/Subsystems/Speech/DictationSubsystem.cs
diff --git a/...systems/Speech/DictationSubsystem.cs.meta → ...systems/Speech/DictationSubsystem.cs.meta b/...systems/Speech/DictationSubsystem.cs.meta → ...systems/Speech/DictationSubsystem.cs.meta
diff --git a/...ms/Speech/DictationSubsystemDescriptor.cs → ...ms/Speech/DictationSubsystemDescriptor.cs b/...ms/Speech/DictationSubsystemDescriptor.cs → ...ms/Speech/DictationSubsystemDescriptor.cs
diff --git a/...eech/DictationSubsystemDescriptor.cs.meta → ...eech/DictationSubsystemDescriptor.cs.meta b/...eech/DictationSubsystemDescriptor.cs.meta → ...eech/DictationSubsystemDescriptor.cs.meta
diff --git a/...ems/Speech/KeywordRecognitionSubsystem.cs → ...ems/Speech/KeywordRecognitionSubsystem.cs b/...ems/Speech/KeywordRecognitionSubsystem.cs → ...ems/Speech/KeywordRecognitionSubsystem.cs
diff --git a/...peech/KeywordRecognitionSubsystem.cs.meta → ...peech/KeywordRecognitionSubsystem.cs.meta b/...peech/KeywordRecognitionSubsystem.cs.meta → ...peech/KeywordRecognitionSubsystem.cs.meta
diff --git a/.../KeywordRecognitionSubsystemDescriptor.cs → .../KeywordRecognitionSubsystemDescriptor.cs b/.../KeywordRecognitionSubsystemDescriptor.cs → .../KeywordRecognitionSubsystemDescriptor.cs
diff --git a/...ordRecognitionSubsystemDescriptor.cs.meta → ...ordRecognitionSubsystemDescriptor.cs.meta b/...ordRecognitionSubsystemDescriptor.cs.meta → ...ordRecognitionSubsystemDescriptor.cs.meta
diff --git a/com.microsoft.mrtk.input/Utilities/PoseSource/HandBasedPoseSource.cs b/com.microsoft.mrtk.input/Utilities/PoseSource/HandBasedPoseSource.cs
@@ -16,7 +16,7 @@ public abstract class HandBasedPoseSource : IPoseSource
         /// Cached reference to hands aggregator for efficient per-frame use.
         /// </summary>
         [Obsolete("Deprecated, please use XRSubsystemHelpers.HandsAggregator instead.")]
-        protected HandsAggregatorSubsystem HandsAggregator => XRSubsystemHelpers.HandsAggregator;
+        protected HandsAggregatorSubsystem HandsAggregator => (HandsAggregatorSubsystem)XRSubsystemHelpers.HandsAggregator;
 
         [SerializeField]
         [Tooltip("The hand on which to track the joint.")]

diff --git a/com.microsoft.mrtk.input/Visualizers/ControllerVisualizer/ControllerVisualizer.cs b/com.microsoft.mrtk.input/Visualizers/ControllerVisualizer/ControllerVisualizer.cs
@@ -48,7 +48,7 @@ public class ControllerVisualizer : MonoBehaviour
         /// Cached reference to hands aggregator for efficient per-frame use.
         /// </summary>
         [Obsolete("Deprecated, please use XRSubsystemHelpers.HandsAggregator instead.")]
-        protected HandsAggregatorSubsystem HandsAggregator => XRSubsystemHelpers.HandsAggregator;
+        protected HandsAggregatorSubsystem HandsAggregator => (HandsAggregatorSubsystem)XRSubsystemHelpers.HandsAggregator;
 
         [SerializeField]
         [Tooltip("The input action we key into to determine whether this controller is tracked or not")]

diff --git a/com.microsoft.mrtk.uxcore/Experimental/NonNativeKeyboard/NonNativeKeyboard.cs b/com.microsoft.mrtk.uxcore/Experimental/NonNativeKeyboard/NonNativeKeyboard.cs
@@ -236,7 +236,7 @@ private set
         /// <summary>
         /// The keyword recognition subsystem that was stopped by this component.
         /// </summary>
-        private KeywordRecognitionSubsystem keywordRecognitionSubsystem = null;
+        private IKeywordRecognitionSubsystem keywordRecognitionSubsystem = null;
 
         /// <summary>
         /// The inner text value set via the `Text` property

diff --git a/com.microsoft.mrtk.windowsspeech/MRTK.Speech.Windows.asmdef b/com.microsoft.mrtk.windowsspeech/MRTK.Speech.Windows.asmdef
@@ -3,6 +3,7 @@
     "rootNamespace": "Microsoft.MixedReality.Toolkit.Speech.Windows",
     "references": [
         "Microsoft.MixedReality.Toolkit.Core",
+        "Microsoft.MixedReality.Toolkit.Input",
         "Microsoft.MixedReality.OpenXR",
         "Microsoft.MixedReality.Toolkit.TextToSpeech.Windows"
     ],

diff --git a/com.microsoft.mrtk.windowsspeech/package.json b/com.microsoft.mrtk.windowsspeech/package.json
@@ -16,6 +16,7 @@
   "unity": "2021.3",
   "dependencies": {
     "com.microsoft.mrtk.core": "3.0.0",
+    "com.microsoft.mrtk.input": "3.0.0",
     "com.microsoft.mrtk.tts.windows": "1.0.1"
   }
 }