Fix pose unlock smooths in wrong coordinate space (#145)

* Define IinputRig

* Introduce IController.TryGetPose

* Remove a few camera.main references to test

Author: FejZa

Runtime/Input/Controllers/BaseController.cs

@@ -196,8 +196,7 @@ public void TryRenderControllerModel()
                 return;
             }
 
-            var rigTransform = Camera.main.transform.parent;
-
+            var rigTransform = InputService.InputRig.RigTransform;
             var controllerObject = Object.Instantiate(controllerPrefab, rigTransform);
             controllerObject.name = GetType().Name;
             Visualizer = controllerObject.GetComponent<IControllerVisualizer>();
@@ -242,5 +241,27 @@ public void TryRenderControllerModel()
                 Debug.LogError($"{GetType().Name} prefab must have a {nameof(IControllerVisualizer)} component attached.");
             }
         }
+
+        /// <inheritdoc />
+        public bool TryGetPose(Space space, out Pose pose)
+        {
+            if (!IsPositionAvailable || !IsRotationAvailable)
+            {
+                pose = default;
+                return false;
+            }
+
+            if (space == Space.Self)
+            {
+                pose = Pose;
+                return true;
+            }
+
+            pose = new Pose(
+                InputService.InputRig.RigTransform.TransformPoint(Pose.position),
+                InputService.InputRig.RigTransform.rotation * Pose.rotation);
+
+            return true;
+        }
     }
 }

Runtime/Input/Controllers/BaseControllerVisualizer.cs

@@ -21,9 +21,6 @@ public abstract class BaseControllerVisualizer : ControllerPoseSynchronizer, ICo
         /// <inheritdoc />
         public GameObject GameObject => gameObject;
 
-        /// <inheritdoc />
-        public Pose SourcePose { get; private set; }
-
         /// <inheritdoc />
         public bool OverrideSourcePose { get; set; }
 
@@ -44,11 +41,6 @@ public Transform GripPose
         /// <inheritdoc />
         public override void OnSourcePoseChanged(SourcePoseEventData<Pose> eventData)
         {
-            if (eventData.SourceId == Controller?.InputSource.SourceId)
-            {
-                SourcePose = eventData.SourceData;
-            }
-
             if (OverrideSourcePose)
             {
                 return;
@@ -60,11 +52,6 @@ public override void OnSourcePoseChanged(SourcePoseEventData<Pose> eventData)
         /// <inheritdoc />
         public override void OnSourcePoseChanged(SourcePoseEventData<Quaternion> eventData)
         {
-            if (eventData.SourceId == Controller?.InputSource.SourceId)
-            {
-                SourcePose = new Pose(SourcePose.position, eventData.SourceData);
-            }
-
             if (OverrideSourcePose)
             {
                 return;
@@ -76,11 +63,6 @@ public override void OnSourcePoseChanged(SourcePoseEventData<Quaternion> eventDa
         /// <inheritdoc />
         public override void OnSourcePoseChanged(SourcePoseEventData<Vector2> eventData)
         {
-            if (eventData.SourceId == Controller?.InputSource.SourceId)
-            {
-                SourcePose = new Pose(eventData.SourceData, SourcePose.rotation);
-            }
-
             if (OverrideSourcePose)
             {
                 return;
@@ -92,11 +74,6 @@ public override void OnSourcePoseChanged(SourcePoseEventData<Vector2> eventData)
         /// <inheritdoc />
         public override void OnSourcePoseChanged(SourcePoseEventData<Vector3> eventData)
         {
-            if (eventData.SourceId == Controller?.InputSource.SourceId)
-            {
-                SourcePose = new Pose(eventData.SourceData, SourcePose.rotation);
-            }
-
             if (OverrideSourcePose)
             {
                 return;

Runtime/Input/Controllers/IController.cs

@@ -108,5 +108,14 @@ public interface IController
         /// Updates the <see cref="IController"/>'s state.
         /// </summary>
         void UpdateController();
+
+        /// <summary>
+        /// Attempts to retrieve the <see cref="IController"/>'s pose in the scene in either the local space,
+        /// that is in the <see cref="IInputRig.RigTransform"/> space or in world space.
+        /// </summary>
+        /// <param name="space">The space to get the <see cref="UnityEngine.Pose"/> in.</param>
+        /// <param name="pose">The pose.</param>
+        /// <returns><c>true</c>, if found Will return <c>false</c>, if not <see cref="IsPositionAvailable"/> or <see cref="IsRotationAvailable"/>.</returns>
+        bool TryGetPose(Space space, out Pose pose);
     }
 }

Runtime/Input/Controllers/IControllerVisualizer.cs

@@ -18,12 +18,6 @@ public interface IControllerVisualizer : IControllerPoseSynchronizer
         /// </remarks>
         GameObject GameObject { get; }
 
-        /// <summary>
-        /// This is the actual pose of this controller, regardless of <see cref="OverrideSourcePose"/>
-        /// and the <see cref="IControllerPoseSynchronizer.PoseDriver"/> pose.
-        /// </summary>
-        Pose SourcePose { get; }
-
         /// <summary>
         /// If set, the <see cref="IControllerPoseSynchronizer.PoseDriver"/>'s pose in the scene
         /// is override and the actual <see cref="IController.InputSource"/> pose is ignored.

Runtime/Input/Cursors/MeshCursor.cs

@@ -62,11 +62,11 @@ private void LateUpdate()
             if (targetRenderer == null) { return; }
 
             var targetTransform = targetRenderer.transform;
-            var targetCamera = Camera.main;
+            var targetCamera = InputService.InputRig.CameraTransform;
 
             var cameraPosition = targetCamera.transform.position;
             var distance = (cameraPosition - targetTransform.position).magnitude;
-            var size = distance * fixedSize * targetCamera.fieldOfView;
+            var size = distance * fixedSize * InputService.InputRig.RigCamera.fieldOfView;
 
             targetTransform.localScale = Vector3.one * size;
             targetTransform.localPosition = new Vector3(fixedSizeOffset.x * size, fixedSizeOffset.y * size, fixedSizeOffset.z * size);

Runtime/Input/Hands/HandController.cs

@@ -788,10 +788,10 @@ public bool TryGetJointPose(HandJoint joint, out Pose pose, Space relativeTo = S
                 };
 
                 // Translate to world space.
-                if (Camera.main.transform.parent.IsNotNull())
+                if (InputService.InputRig.RigTransform.IsNotNull())
                 {
-                    pose.position = Camera.main.transform.parent.TransformPoint(pose.position);
-                    pose.rotation = Camera.main.transform.parent.rotation * pose.rotation;
+                    pose.position = InputService.InputRig.RigTransform.TransformPoint(pose.position);
+                    pose.rotation = InputService.InputRig.RigTransform.rotation * pose.rotation;
                 }
 
                 return lastHandRootPose != Pose.identity;

Runtime/Input/Hands/HandDataPostProcessor.cs

@@ -1,10 +1,12 @@
 // Copyright (c) Reality Collective. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
+using RealityCollective.ServiceFramework.Services;
 using RealityCollective.Utilities.Extensions;
 using RealityToolkit.Definitions.Devices;
 using RealityToolkit.Input.Definitions;
 using RealityToolkit.Input.Hands.Poses;
+using RealityToolkit.Input.Interfaces;
 using System.Collections.Generic;
 using UnityEngine;
 
@@ -38,9 +40,9 @@ private static Camera PlayerCamera
         {
             get
             {
-                if (playerCamera == null)
+                if (playerCamera.IsNull())
                 {
-                    playerCamera = Camera.main;
+                    playerCamera = ServiceManager.Instance.GetService<IInputService>().InputRig.RigCamera;
                 }
 
                 return playerCamera;

Runtime/Input/InputService.cs

@@ -70,6 +70,9 @@ public InputService(string name, uint priority, InputServiceProfile profile)
         /// <inheritdoc/>
         public bool FarInteractionEnabled { get; set; }
 
+        /// <inheritdoc/>
+        public IInputRig InputRig { get; set; }
+
         private readonly HashSet<IInputSource> detectedInputSources = new HashSet<IInputSource>();
 
         /// <inheritdoc />

Runtime/Input/InteractionBehaviours/LockControllerVisualizerBehaviour.cs

@@ -60,10 +60,12 @@ protected override void Update()
                         continue;
                     }
 
-                    var unlockPose = visualizer.SourcePose;
-                    unlockPose.position = Vector3.Slerp(smoothingStartPose[visualizer].position, unlockPose.position, smoothingProgress[visualizer]);
-                    unlockPose.rotation = Quaternion.Slerp(smoothingStartPose[visualizer].rotation, unlockPose.rotation, smoothingProgress[visualizer]);
-                    visualizer.PoseDriver.SetPositionAndRotation(unlockPose.position, unlockPose.rotation);
+                    if (visualizer.Controller.TryGetPose(Space.World, out var unlockPose))
+                    {
+                        unlockPose.position = Vector3.Slerp(smoothingStartPose[visualizer].position, unlockPose.position, smoothingProgress[visualizer]);
+                        unlockPose.rotation = Quaternion.Slerp(smoothingStartPose[visualizer].rotation, unlockPose.rotation, smoothingProgress[visualizer]);
+                        visualizer.PoseDriver.SetPositionAndRotation(unlockPose.position, unlockPose.rotation);
+                    }
                 }
                 else
                 {

Runtime/Input/Interfaces/IInputRig.cs

@@ -0,0 +1,29 @@
+// Copyright (c) Reality Collective. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using UnityEngine;
+
+namespace RealityToolkit.Input.Interfaces
+{
+    /// <summary>
+    /// The <see cref="IInputRig"/> defines the coordinate space in which <see cref="IInputService"/> objects, such as
+    /// <see cref="IInputSource"/>s live. It is used to perform pose transformations for controllers, visualizers and interactors.
+    /// </summary>
+    public interface IInputRig
+    {
+        /// <summary>
+        /// The root rig <see cref="Transform"/>.
+        /// </summary>
+        Transform RigTransform { get; }
+
+        /// <summary>
+        /// The <see cref="Transform"/> where the <see cref="Camera"/> component is located.
+        /// </summary>
+        Transform CameraTransform { get; }
+
+        /// <summary>
+        /// The rig's <see cref="Camera"/> reference.
+        /// </summary>
+        Camera RigCamera { get; }
+    }
+}

Runtime/Input/Interfaces/IInputRig.cs.meta

@@ -40,6 +40,11 @@ public interface IInputService : IEventService, IRealityToolkitService
         /// </summary>
         bool FarInteractionEnabled { get; set; }
 
+        /// <summary>
+        /// The active <see cref="IInputRig"/> the <see cref="IInputService"/> is using.
+        /// </summary>
+        IInputRig InputRig { get; set; }
+
         /// <summary>
         /// List of the Interaction Input Sources as detected by the input manager like hands or motion controllers.
         /// </summary>