Merge pull request #2559 from StephenHodgson/vNEXT-ControllerRendering

Refactored Controller Viz

Author: David Kline

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

@@ -3,7 +3,7 @@
 
 using Microsoft.MixedReality.Toolkit.InputSystem.Pointers;
 using Microsoft.MixedReality.Toolkit.InputSystem.Sources;
-using Microsoft.MixedReality.Toolkit.Internal.Interfaces;
+using Microsoft.MixedReality.Toolkit.Internal.Interfaces.Devices;
 using Microsoft.MixedReality.Toolkit.Internal.Interfaces.InputSystem;
 using Microsoft.MixedReality.Toolkit.Internal.Utilities;
 using Microsoft.MixedReality.Toolkit.Internal.Utilities.Physics;

Assets/MixedRealityToolkit-SDK/Features/Input/Handlers/ControllerPoseSynchronizer.cs

@@ -2,10 +2,10 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.MixedReality.Toolkit.Internal.Definitions.Devices;
+using Microsoft.MixedReality.Toolkit.Internal.Definitions.InputSystem;
 using Microsoft.MixedReality.Toolkit.Internal.Definitions.Utilities;
 using Microsoft.MixedReality.Toolkit.Internal.EventDatum.Input;
-using Microsoft.MixedReality.Toolkit.Internal.Extensions;
-using Microsoft.MixedReality.Toolkit.Internal.Interfaces;
+using Microsoft.MixedReality.Toolkit.Internal.Interfaces.Devices;
 using Microsoft.MixedReality.Toolkit.Internal.Interfaces.InputSystem.Handlers;
 using UnityEngine;
 
@@ -14,37 +14,22 @@ namespace Microsoft.MixedReality.Toolkit.SDK.Input.Handlers
     /// <summary>
     /// Waits for a controller to be initialized, then synchronizes its transform position to a specified handedness.
     /// </summary>
-    public class ControllerPoseSynchronizer : InputSystemGlobalListener, IMixedRealitySourcePoseHandler
+    public class ControllerPoseSynchronizer : InputSystemGlobalListener, IMixedRealitySourcePoseHandler, IMixedRealityControllerPoseSynchronizer
     {
+        #region IMixedRealityControllerPoseSynchronizer Implementation
+
         [SerializeField]
         [Tooltip("The handedness this controller should synchronize with.")]
         private Handedness handedness = Handedness.Left;
 
-        /// <summary>
-        /// The handedness this controller should synchronize with.
-        /// </summary>
+        /// <inheritdoc />
         public Handedness Handedness => handedness;
 
         [SerializeField]
-        [Tooltip("Disables child GameObjects when the controller source is lost.")]
-        private bool disableChildren = true;
-
-        /// <summary>
-        ///Disables child <see cref="GameObject"/>s the controller source is lost.
-        /// </summary>
-        public bool DisableChildren
-        {
-            get { return disableChildren; }
-            set { disableChildren = value; }
-        }
-
-        [SerializeField]
-        [Tooltip("Should this GameObject clean itself up after source is lost?")]
+        [Tooltip("Should this GameObject clean itself up when it's controller is lost?")]
         private bool destroyOnSourceLost = true;
 
-        /// <summary>
-        /// Should this GameObject clean itself up after source is lost?
-        /// </summary>
+        /// <inheritdoc />
         public bool DestroyOnSourceLost
         {
             get { return destroyOnSourceLost; }
@@ -61,44 +46,49 @@ public bool DestroyOnSourceLost
         /// </summary>
         protected TrackingState TrackingState = TrackingState.NotTracked;
 
-        /// <summary>
-        /// The currently assigned Controller.
-        /// </summary>
+        private IMixedRealityController controller;
+
+        /// <inheritdoc />
         public virtual IMixedRealityController Controller
         {
             get { return controller; }
             set
             {
                 handedness = value.ControllerHandedness;
                 controller = value;
+                gameObject.name = $"{handedness}_{gameObject.name}";
             }
         }
 
-        private IMixedRealityController controller;
-
-        #region IMixedRealitySourcePoseHandler Implementation
+        [SerializeField]
+        [Tooltip("Should the Transform's position be driven from the source pose or from input handler?")]
+        private bool useSourcePoseData = true;
 
         /// <inheritdoc />
-        public virtual void OnSourceDetected(SourceStateEventData eventData)
+        public bool UseSourcePoseData
         {
-            if (Controller == null ||
-                eventData.Controller == null ||
-                eventData.Controller.InputSource.SourceId != Controller.InputSource.SourceId)
-            {
-                return;
-            }
+            get { return useSourcePoseData; }
+            set { useSourcePoseData = value; }
+        }
 
-            if (eventData.Controller.ControllerHandedness == Handedness &&
-                eventData.Controller.InputSource.SourceId == Controller.InputSource.SourceId)
-            {
+        [SerializeField]
+        [Tooltip("The input action that will drive the Transform's pose, position, or rotation.")]
+        private MixedRealityInputAction poseAction = MixedRealityInputAction.None;
 
-                if (disableChildren)
-                {
-                    gameObject.SetChildrenActive(true);
-                }
-            }
+        /// <inheritdoc />
+        public MixedRealityInputAction PoseAction
+        {
+            get { return poseAction; }
+            set { poseAction = value; }
         }
 
+        #endregion IMixedRealityControllerPoseSynchronizer Implementation
+
+        #region IMixedRealitySourcePoseHandler Implementation
+
+        /// <inheritdoc />
+        public virtual void OnSourceDetected(SourceStateEventData eventData) { }
+
         /// <inheritdoc />
         public virtual void OnSourceLost(SourceStateEventData eventData)
         {
@@ -114,11 +104,6 @@ public virtual void OnSourceLost(SourceStateEventData eventData)
                 IsTracked = false;
                 TrackingState = TrackingState.NotTracked;
 
-                if (disableChildren)
-                {
-                    gameObject.SetChildrenActive(false);
-                }
-
                 if (destroyOnSourceLost)
                 {
                     if (Application.isEditor)
@@ -149,13 +134,75 @@ public virtual void OnSourcePoseChanged(SourcePoseEventData eventData)
                 TrackingState = eventData.TrackingState;
             }
 
-            if (TrackingState == TrackingState.Tracked)
+            if (UseSourcePoseData && TrackingState == TrackingState.Tracked)
             {
                 transform.localPosition = eventData.MixedRealityPose.Position;
                 transform.localRotation = eventData.MixedRealityPose.Rotation;
             }
         }
 
         #endregion IMixedRealitySourcePoseHandler Implementation
+
+        #region IMixedRealityInputHandler Implementation
+
+        public virtual void OnInputUp(InputEventData eventData) { }
+
+        public virtual void OnInputDown(InputEventData eventData) { }
+
+        public virtual void OnInputPressed(InputEventData<float> eventData) { }
+
+        public virtual void OnPositionInputChanged(InputEventData<Vector2> eventData) { }
+
+        #endregion  IMixedRealityInputHandler Implementation
+
+        #region IMixedRealitySpatialInputHandler Implementation
+
+        /// <inheritdoc />
+        public virtual void OnPositionChanged(InputEventData<Vector3> eventData)
+        {
+            if (eventData.SourceId == Controller?.InputSource.SourceId)
+            {
+                if (!UseSourcePoseData &&
+                    PoseAction == eventData.MixedRealityInputAction)
+                {
+                    IsTracked = true;
+                    TrackingState = TrackingState.Tracked;
+                    transform.localPosition = eventData.InputData;
+                }
+            }
+        }
+
+        /// <inheritdoc />
+        public virtual void OnRotationChanged(InputEventData<Quaternion> eventData)
+        {
+            if (eventData.SourceId == Controller?.InputSource.SourceId)
+            {
+                if (!UseSourcePoseData &&
+                    PoseAction == eventData.MixedRealityInputAction)
+                {
+                    IsTracked = true;
+                    TrackingState = TrackingState.Tracked;
+                    transform.localRotation = eventData.InputData;
+                }
+            }
+        }
+
+        /// <inheritdoc />
+        public virtual void OnPoseInputChanged(InputEventData<MixedRealityPose> eventData)
+        {
+            if (eventData.SourceId == Controller?.InputSource.SourceId)
+            {
+                if (!UseSourcePoseData &&
+                    PoseAction == eventData.MixedRealityInputAction)
+                {
+                    IsTracked = true;
+                    TrackingState = TrackingState.Tracked;
+                    transform.localPosition = eventData.InputData.Position;
+                    transform.localRotation = eventData.InputData.Rotation;
+                }
+            }
+        }
+
+        #endregion IMixedRealitySpatialInputHandler Implementation 
     }
 }

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

@@ -7,7 +7,7 @@
 using Microsoft.MixedReality.Toolkit.Internal.Definitions.Utilities;
 using Microsoft.MixedReality.Toolkit.Internal.EventDatum.Input;
 using Microsoft.MixedReality.Toolkit.Internal.Extensions;
-using Microsoft.MixedReality.Toolkit.Internal.Interfaces;
+using Microsoft.MixedReality.Toolkit.Internal.Interfaces.Devices;
 using Microsoft.MixedReality.Toolkit.Internal.Interfaces.InputSystem;
 using Microsoft.MixedReality.Toolkit.Internal.Interfaces.InputSystem.Handlers;
 using Microsoft.MixedReality.Toolkit.Internal.Managers;

Assets/MixedRealityToolkit-SDK/Features/UX/Prefabs/Pointers/DefaultControllerPointer.prefab

@@ -96,15 +96,15 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   handedness: 1
-  disableChildren: 1
-  cursorPrefab: {fileID: 1000012072213228, guid: 5b3e2856904e43c680f84f326861032a,
-    type: 2}
-  raycastOrigin: {fileID: 0}
+  destroyOnSourceLost: 1
   useSourcePoseData: 0
-  inputSourceAction:
+  poseAction:
     id: 4
     description: Pointer Pose
     axisConstraint: 7
+  cursorPrefab: {fileID: 1000012072213228, guid: 5b3e2856904e43c680f84f326861032a,
+    type: 2}
+  raycastOrigin: {fileID: 0}
   activeHoldAction:
     id: 0
     description: None

Assets/MixedRealityToolkit-SDK/Features/UX/Prefabs/Pointers/ParabolicPointer.prefab

@@ -259,16 +259,15 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   handedness: 1
-  disableChildren: 1
   destroyOnSourceLost: 1
-  cursorPrefab: {fileID: 1554777696564956, guid: ae2b3fffb00f464287cda86f49109b47,
-    type: 2}
-  raycastOrigin: {fileID: 0}
   useSourcePoseData: 0
-  inputSourceAction:
+  poseAction:
     id: 4
     description: Pointer Pose
     axisConstraint: 7
+  cursorPrefab: {fileID: 1554777696564956, guid: ae2b3fffb00f464287cda86f49109b47,
+    type: 2}
+  raycastOrigin: {fileID: 0}
   activeHoldAction:
     id: 0
     description: None