Merge pull request #2750 from StephenHodgson/vNEXT-TeleportCursorFix

Teleport Cursor Fix

Author: David Kline

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

@@ -278,6 +278,7 @@ protected override void Start()
                 var cursorObj = Instantiate(cursorPrefab, transform.parent);
                 GazePointer.BaseCursor = cursorObj.GetComponent<IMixedRealityCursor>();
                 Debug.Assert(GazePointer.BaseCursor != null, "Failed to load cursor");
+                GazePointer.BaseCursor.SetVisibilityOnSourceDetected = false;
                 GazePointer.BaseCursor.Pointer = GazePointer;
             }
 

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/Prefabs/Pointers/TouchPointer.prefab

@@ -104,6 +104,8 @@ MonoBehaviour:
     axisConstraint: 0
   cursorPrefab: {fileID: 1000012072213228, guid: 5b3e2856904e43c680f84f326861032a,
     type: 2}
+  disableCursorOnStart: 1
+  setCursorVisibilityOnSourceDetected: 1
   raycastOrigin: {fileID: 0}
   activeHoldAction:
     id: 0

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

@@ -18,6 +18,8 @@ public class BaseCursor : InputSystemGlobalListener, IMixedRealityCursor
     {
         public CursorStateEnum CursorState { get; private set; } = CursorStateEnum.None;
 
+        public bool SetVisibilityOnSourceDetected { get; set; } = false;
+
         /// <summary>
         /// Surface distance to place the cursor off of the surface at
         /// </summary>
@@ -65,18 +67,6 @@ public class BaseCursor : InputSystemGlobalListener, IMixedRealityCursor
         private Vector3 targetScale;
         private Quaternion targetRotation;
 
-        /// <summary>
-        /// Indicates if the cursor should be visible
-        /// </summary>
-        public bool IsVisible
-        {
-            get { return isVisible; }
-            set
-            {
-                SetVisibility(isVisible);
-            }
-        }
-
         #region IMixedRealityCursor Implementation
 
         /// <inheritdoc />
@@ -113,10 +103,10 @@ public float DefaultCursorDistance
         /// <inheritdoc />
         public virtual Vector3 LocalScale => transform.localScale;
 
-        /// <inheritdoc />
         public virtual void SetVisibility(bool visible)
         {
-            if (PrimaryCursorVisual != null)
+            if (PrimaryCursorVisual != null &&
+                PrimaryCursorVisual.gameObject.activeInHierarchy != visible)
             {
                 PrimaryCursorVisual.gameObject.SetActive(visible);
                 isVisible = visible;
@@ -141,7 +131,12 @@ public virtual void OnSourceDetected(SourceStateEventData eventData)
                     if (eventData.InputSource.Pointers[i].PointerId == Pointer.PointerId)
                     {
                         visibleSourcesCount++;
-                        SetVisibility(true);
+
+                        if (SetVisibilityOnSourceDetected && visibleSourcesCount == 1)
+                        {
+                            SetVisibility(true);
+                        }
+
                         return;
                     }
                 }
@@ -173,10 +168,14 @@ public virtual void OnSourceLost(SourceStateEventData eventData)
                 }
             }
 
-            if (visibleSourcesCount == 0)
+            if (!IsSourceDetected)
             {
                 IsPointerDown = false;
-                SetVisibility(false);
+
+                if (SetVisibilityOnSourceDetected)
+                {
+                    SetVisibility(false);
+                }
             }
         }
 
@@ -231,13 +230,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,12 @@ public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixed
         [SerializeField]
         private GameObject cursorPrefab = null;
 
+        [SerializeField]
+        private bool disableCursorOnStart = false;
+
+        [SerializeField]
+        private bool setCursorVisibilityOnSourceDetected = false;
+
         private GameObject cursorInstance = null;
 
         [SerializeField]
@@ -73,7 +79,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 +110,12 @@ public virtual void SetCursor(GameObject newCursor = null)
                 {
                     BaseCursor.DefaultCursorDistance = PointerExtent;
                     BaseCursor.Pointer = this;
+                    BaseCursor.SetVisibilityOnSourceDetected = setCursorVisibilityOnSourceDetected;
+
+                    if (disableCursorOnStart)
+                    {
+                        BaseCursor.SetVisibility(false);
+                    }
                 }
                 else
                 {
@@ -118,7 +130,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,8 @@ namespace Microsoft.MixedReality.Toolkit.SDK.Inspectors.UX.Pointers
     public class BaseControllerPointerInspector : ControllerPoseSynchronizerInspector
     {
         private SerializedProperty cursorPrefab;
+        private SerializedProperty disableCursorOnStart;
+        private SerializedProperty setCursorVisibilityOnSourceDetected;
         private SerializedProperty raycastOrigin;
         private SerializedProperty pointerExtent;
         private SerializedProperty activeHoldAction;
@@ -27,6 +29,8 @@ protected override void OnEnable()
             base.OnEnable();
 
             cursorPrefab = serializedObject.FindProperty("cursorPrefab");
+            disableCursorOnStart = serializedObject.FindProperty("disableCursorOnStart");
+            setCursorVisibilityOnSourceDetected = serializedObject.FindProperty("setCursorVisibilityOnSourceDetected");
             raycastOrigin = serializedObject.FindProperty("raycastOrigin");
             pointerExtent = serializedObject.FindProperty("pointerExtent");
             activeHoldAction = serializedObject.FindProperty("activeHoldAction");
@@ -48,6 +52,8 @@ public override void OnInspectorGUI()
             if (basePointerFoldout)
             {
                 EditorGUILayout.PropertyField(cursorPrefab);
+                EditorGUILayout.PropertyField(disableCursorOnStart);
+                EditorGUILayout.PropertyField(setCursorVisibilityOnSourceDetected);
                 EditorGUILayout.PropertyField(raycastOrigin);
                 EditorGUILayout.PropertyField(pointerExtent);
                 EditorGUILayout.PropertyField(pointerOrientation);

Assets/MixedRealityToolkit/_Core/Interfaces/InputSystem/IMixedRealityCursor.cs

@@ -42,6 +42,8 @@ public interface IMixedRealityCursor : IMixedRealityFocusChangedHandler, IMixedR
         /// <param name="visible">True if cursor should be visible, false if not.</param>
         void SetVisibility(bool visible);
 
+        bool SetVisibilityOnSourceDetected { get; set; }
+
         /// <summary>
         /// Returns the <see cref="IMixedRealityCursor"/>'s <see cref="GameObject"/> reference.
         /// </summary>