Teleport Cursor Fix

Author: StephenHodgson

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

@@ -267,6 +267,7 @@ MonoBehaviour:
     axisConstraint: 7
   cursorPrefab: {fileID: 1554777696564956, guid: ae2b3fffb00f464287cda86f49109b47,
     type: 2}
+  disableCursorOnStart: 1
   raycastOrigin: {fileID: 0}
   activeHoldAction:
     id: 0

Assets/MixedRealityToolkit-SDK/Features/UX/Scripts/Cursors/BaseCursor.cs

@@ -141,7 +141,13 @@ public virtual void OnSourceDetected(SourceStateEventData eventData)
                     if (eventData.InputSource.Pointers[i].PointerId == Pointer.PointerId)
                     {
                         visibleSourcesCount++;
-                        SetVisibility(true);
+
+                        if (visibleSourcesCount == 1 &&
+                            InputSystem.GazeProvider.GazePointer.PointerId != Pointer.PointerId)
+                        {
+                            SetVisibility(isVisible);
+                        }
+
                         return;
                     }
                 }
@@ -173,10 +179,14 @@ public virtual void OnSourceLost(SourceStateEventData eventData)
                 }
             }
 
-            if (visibleSourcesCount == 0)
+            if (!IsSourceDetected)
             {
                 IsPointerDown = false;
-                SetVisibility(false);
+
+                if (InputSystem.GazeProvider.GazePointer.PointerId != Pointer.PointerId)
+                {
+                    SetVisibility(false);
+                }
             }
         }
 
@@ -231,13 +241,6 @@ public virtual void OnPointerUp(MixedRealityPointerEventData eventData)
 
         #region MonoBehaviour Implementation
 
-        private void Awake()
-        {
-            // Use the setter to update visibility of the cursor at startup based on user preferences
-            IsVisible = isVisible;
-            SetVisibility(isVisible);
-        }
-
         private void Update()
         {
             UpdateCursorState();

Assets/MixedRealityToolkit-SDK/Features/UX/Scripts/Cursors/TeleportCursor.cs

@@ -83,6 +83,7 @@ protected override void UpdateCursorTransform()
             if (Pointer == null)
             {
                 Debug.LogError($"[TeleportCursor.{name}] No Pointer has been assigned!");
+                SetVisibility(false);
                 return;
             }
 
@@ -93,6 +94,7 @@ protected override void UpdateCursorTransform()
                 Debug.LogError(InputSystem.FocusProvider.IsPointerRegistered(Pointer)
                     ? $"{gameObject.name}: Unable to get focus details for {pointer.GetType().Name}!"
                     : $"{pointer.GetType().Name} has not been registered!");
+                SetVisibility(false);
                 return;
             }
 

Assets/MixedRealityToolkit-SDK/Features/UX/Scripts/Pointers/BaseControllerPointer.cs

@@ -30,6 +30,9 @@ public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixed
         [SerializeField]
         private GameObject cursorPrefab = null;
 
+        [SerializeField]
+        private bool disableCursorOnStart = false;
+
         private GameObject cursorInstance = null;
 
         [SerializeField]
@@ -73,7 +76,7 @@ public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixed
         /// Set a new cursor for this <see cref="IMixedRealityPointer"/>
         /// </summary>
         /// <remarks>This <see cref="GameObject"/> must have a <see cref="IMixedRealityCursor"/> attached to it.</remarks>
-        /// <param name="newCursor"></param>
+        /// <param name="newCursor">The new cursor</param>
         public virtual void SetCursor(GameObject newCursor = null)
         {
             if (cursorInstance != null)
@@ -104,6 +107,11 @@ public virtual void SetCursor(GameObject newCursor = null)
                 {
                     BaseCursor.DefaultCursorDistance = PointerExtent;
                     BaseCursor.Pointer = this;
+
+                    if (disableCursorOnStart)
+                    {
+                        BaseCursor.SetVisibility(false);
+                    }
                 }
                 else
                 {
@@ -118,7 +126,6 @@ protected override void OnEnable()
         {
             base.OnEnable();
             SetCursor();
-            BaseCursor?.SetVisibility(true);
 
             if (MixedRealityManager.IsInitialized && TeleportSystem != null && !lateRegisterTeleport)
             {

Assets/MixedRealityToolkit-SDK/Features/UX/Scripts/Pointers/TeleportPointer.cs

@@ -97,19 +97,6 @@ protected Gradient GetLineGradient(TeleportSurfaceResult targetResult)
             }
         }
 
-        protected override void OnEnable()
-        {
-            base.OnEnable();
-            BaseCursor?.SetVisibility(false);
-        }
-
-        /// <inheritdoc />
-        public override void SetCursor(GameObject newCursor = null)
-        {
-            base.SetCursor(newCursor);
-            BaseCursor?.SetVisibility(false);
-        }
-
         #region IMixedRealityPointer Implementation
 
         /// <inheritdoc />
@@ -180,7 +167,6 @@ public override void OnPostRaycast()
                 // If we hit something
                 if (Result.CurrentPointerTarget != null)
                 {
-                    BaseCursor?.SetVisibility(true);
                     // Check if it's in our valid layers
                     if (((1 << Result.CurrentPointerTarget.layer) & ValidLayers.value) != 0)
                     {
@@ -236,6 +222,7 @@ public override void OnPostRaycast()
 
                     // Clamp the end of the parabola to the result hit's point
                     LineBase.LineEndClamp = LineBase.GetNormalizedLengthFromWorldLength(clearWorldLength, LineCastResolution);
+                    BaseCursor?.SetVisibility(TeleportSurfaceResult == TeleportSurfaceResult.Valid || TeleportSurfaceResult == TeleportSurfaceResult.HotSpot);
                 }
                 else
                 {

Assets/MixedRealityToolkit-SDK/Inspectors/UX/Pointers/BaseControllerPointerInspector.cs

@@ -11,6 +11,7 @@ namespace Microsoft.MixedReality.Toolkit.SDK.Inspectors.UX.Pointers
     public class BaseControllerPointerInspector : ControllerPoseSynchronizerInspector
     {
         private SerializedProperty cursorPrefab;
+        private SerializedProperty disableCursorOnStart;
         private SerializedProperty raycastOrigin;
         private SerializedProperty pointerExtent;
         private SerializedProperty activeHoldAction;
@@ -27,6 +28,7 @@ protected override void OnEnable()
             base.OnEnable();
 
             cursorPrefab = serializedObject.FindProperty("cursorPrefab");
+            disableCursorOnStart = serializedObject.FindProperty("disableCursorOnStart");
             raycastOrigin = serializedObject.FindProperty("raycastOrigin");
             pointerExtent = serializedObject.FindProperty("pointerExtent");
             activeHoldAction = serializedObject.FindProperty("activeHoldAction");
@@ -48,6 +50,7 @@ public override void OnInspectorGUI()
             if (basePointerFoldout)
             {
                 EditorGUILayout.PropertyField(cursorPrefab);
+                EditorGUILayout.PropertyField(disableCursorOnStart);
                 EditorGUILayout.PropertyField(raycastOrigin);
                 EditorGUILayout.PropertyField(pointerExtent);
                 EditorGUILayout.PropertyField(pointerOrientation);