Merge pull request #29 from keveleigh/CursorVisibilityFix

Update cursor visibility based on source detection

Author: StephenHodgson

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/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>
@@ -130,10 +132,9 @@ public virtual void OnSourceDetected(SourceStateEventData eventData)
                     {
                         visibleSourcesCount++;
 
-                        if (visibleSourcesCount == 1 &&
-                            InputSystem.GazeProvider.GazePointer.PointerId != Pointer.PointerId)
+                        if (SetVisibilityOnSourceDetected && visibleSourcesCount == 1)
                         {
-                            SetVisibility(isVisible);
+                            SetVisibility(true);
                         }
 
                         return;
@@ -171,7 +172,7 @@ public virtual void OnSourceLost(SourceStateEventData eventData)
             {
                 IsPointerDown = false;
 
-                if (InputSystem.GazeProvider.GazePointer.PointerId != Pointer.PointerId)
+                if (SetVisibilityOnSourceDetected)
                 {
                     SetVisibility(false);
                 }

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

@@ -33,6 +33,9 @@ public abstract class BaseControllerPointer : ControllerPoseSynchronizer, IMixed
         [SerializeField]
         private bool disableCursorOnStart = false;
 
+        [SerializeField]
+        private bool setCursorVisibilityOnSourceDetected = false;
+
         private GameObject cursorInstance = null;
 
         [SerializeField]
@@ -107,6 +110,7 @@ public virtual void SetCursor(GameObject newCursor = null)
                 {
                     BaseCursor.DefaultCursorDistance = PointerExtent;
                     BaseCursor.Pointer = this;
+                    BaseCursor.SetVisibilityOnSourceDetected = setCursorVisibilityOnSourceDetected;
 
                     if (disableCursorOnStart)
                     {

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

@@ -12,6 +12,7 @@ public class BaseControllerPointerInspector : ControllerPoseSynchronizerInspecto
     {
         private SerializedProperty cursorPrefab;
         private SerializedProperty disableCursorOnStart;
+        private SerializedProperty setCursorVisibilityOnSourceDetected;
         private SerializedProperty raycastOrigin;
         private SerializedProperty pointerExtent;
         private SerializedProperty activeHoldAction;
@@ -29,6 +30,7 @@ protected override void 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");
@@ -51,6 +53,7 @@ public override void OnInspectorGUI()
             {
                 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>