Merge pull request #1350 from StephenHodgson/MRTK-uiRaycastHotfix

Added check for valid uiRaycastResults and fixed pointer registration

Author: StephenHodgson

Assets/HoloToolkit/Input/Scripts/Focus/FocusManager.cs

@@ -51,19 +51,7 @@ protected override void Awake()
 
         private void Start()
         {
-            if (gazeManagerPointingData == null)
-            {
-                if (GazeManager.IsInitialized)
-                {
-                    gazeManagerPointingData = new PointerData(GazeManager.Instance);
-                }
-            }
-            else
-            {
-                Debug.Assert(ReferenceEquals(gazeManagerPointingData.PointingSource, GazeManager.Instance));
-            }
-
-            if ((pointers.Count == 0) && autoRegisterGazePointerIfNoPointersRegistered && GazeManager.IsInitialized)
+            if (pointers.Count == 0 && autoRegisterGazePointerIfNoPointersRegistered && GazeManager.IsInitialized)
             {
                 RegisterPointer(GazeManager.Instance);
             }
@@ -75,18 +63,6 @@ private void Update()
             UpdateFocusedObjects();
         }
 
-        /// <summary>
-        /// It's assumed that if you're using the MRTK's input system you'll
-        /// need to update your canvases to use the proper raycast camera for input.
-        /// </summary>
-        private void OnValidate()
-        {
-            if (UIRaycastCamera != null)
-            {
-                UpdateCanvasEventSystems();
-            }
-        }
-
         #endregion
 
         #region Settings
@@ -273,27 +249,33 @@ public Camera UIRaycastCamera
 
         public void RegisterPointer(IPointingSource pointingSource)
         {
-            Debug.Assert(pointingSource != null);
+            Debug.Assert(pointingSource != null, "Can't register a pointer if you give us one.");
+
+            int pointerIndex;
+            PointerData pointer;
 
-            if (TryGetPointerIndex(pointingSource) != null)
+            if (TryGetPointerIndex(pointingSource, out pointerIndex))
             {
                 // This pointing source is already registered and active.
                 return;
             }
 
-            PointerData pointer;
-
             if (pointingSource is GazeManager)
             {
                 if (gazeManagerPointingData == null)
                 {
-                    gazeManagerPointingData = new PointerData(pointingSource);
+                    if (GazeManager.IsInitialized)
+                    {
+                        gazeManagerPointingData = new PointerData(GazeManager.Instance);
+                    }
                 }
                 else
                 {
+                    Debug.Assert(ReferenceEquals(gazeManagerPointingData.PointingSource, GazeManager.Instance));
                     gazeManagerPointingData.ResetFocusedObjects();
                 }
 
+                Debug.Assert(gazeManagerPointingData != null);
                 pointer = gazeManagerPointingData;
             }
             else
@@ -306,14 +288,19 @@ public void RegisterPointer(IPointingSource pointingSource)
 
         public void UnregisterPointer(IPointingSource pointingSource)
         {
-            Debug.Assert(pointingSource != null);
+            Debug.Assert(pointingSource != null, "Can't unregister a pointer if you give us one.");
 
-            int? iPointer = TryGetPointerIndex(pointingSource);
-            Debug.Assert(iPointer != null);
+            int pointerIndex;
+            TryGetPointerIndex(pointingSource, out pointerIndex);
+            Debug.Assert(pointerIndex > 0, "Invalid pointer index!");
 
-            PointerData pointer = pointers[iPointer.Value];
+            PointerData pointer;
+            GetPointerData(pointingSource, out pointer);
+            Debug.Assert(pointer != null, "Attempting to unregister a pointer that was never registered!");
 
-            pointers.RemoveAt(iPointer.Value);
+            // Should we be protecting against unregistering the GazeManager?
+
+            pointers.RemoveAt(pointerIndex);
 
             // Raise focus events if needed:
 
@@ -343,13 +330,11 @@ public void UnregisterPointer(IPointingSource pointingSource)
 
         public FocusDetails? TryGetFocusDetails(BaseEventData eventData)
         {
-            for (int iPointer = 0; iPointer < pointers.Count; iPointer++)
+            for (int i = 0; i < pointers.Count; i++)
             {
-                PointerData pointer = pointers[iPointer];
-
-                if (pointer.PointingSource.OwnsInput(eventData))
+                if (pointers[i].PointingSource.OwnsInput(eventData))
                 {
-                    return pointer.End;
+                    return pointers[i].End;
                 }
             }
 
@@ -368,20 +353,20 @@ public GameObject TryGetFocusedObject(BaseEventData eventData)
             IPointingSource pointingSource;
             TryGetPointingSource(eventData, out pointingSource);
             PointerInputEventData pointerInputEventData = GetSpecificPointerEventData(pointingSource);
+
+            Debug.Assert(pointerInputEventData != null);
             pointerInputEventData.selectedObject = details.Value.Object;
 
             return details.Value.Object;
         }
 
         public bool TryGetPointingSource(BaseEventData eventData, out IPointingSource pointingSource)
         {
-            for (int iPointer = 0; iPointer < pointers.Count; iPointer++)
+            for (int i = 0; i < pointers.Count; i++)
             {
-                PointerData pointer = pointers[iPointer];
-
-                if (pointer.PointingSource.OwnsInput(eventData))
+                if (pointers[i].PointingSource.OwnsInput(eventData))
                 {
-                    pointingSource = pointer.PointingSource;
+                    pointingSource = pointers[i].PointingSource;
                     return true;
                 }
             }
@@ -392,12 +377,28 @@ public bool TryGetPointingSource(BaseEventData eventData, out IPointingSource po
 
         public FocusDetails GetFocusDetails(IPointingSource pointingSource)
         {
-            return GetPointer(pointingSource).End;
+            PointerData pointerData;
+            FocusDetails details = default(FocusDetails);
+
+            if (GetPointerData(pointingSource, out pointerData))
+            {
+                details = pointerData.End;
+            }
+
+            return details;
         }
 
         public GameObject GetFocusedObject(IPointingSource pointingSource)
         {
-            return GetPointer(pointingSource).End.Object;
+            PointerData pointerData;
+            GameObject focusedObject = null;
+
+            if (GetPointerData(pointingSource, out pointerData))
+            {
+                focusedObject = pointerData.End.Object;
+            }
+
+            return focusedObject;
         }
 
         /// <summary>
@@ -438,12 +439,13 @@ public PointerInputEventData GetGazePointerEventData()
 
         public PointerInputEventData GetSpecificPointerEventData(IPointingSource pointer)
         {
-            return GetPointer(pointer).UnityUIPointerData;
+            PointerData pointerEventData;
+            return GetPointerData(pointer, out pointerEventData) ? pointerEventData.UnityUIPointerData : null;
         }
 
         public float GetPointingExtent(IPointingSource pointingSource)
         {
-            return GetPointingExtent(GetPointer(pointingSource));
+            return pointingSource.ExtentOverride ?? pointingExtent;
         }
 
         #endregion
@@ -537,10 +539,13 @@ private void UpdatePointer(PointerData pointer)
         /// </summary>
         private void RaycastPhysics(PointerData pointer, LayerMask[] prioritizedLayerMasks)
         {
-            RaycastHit physicsHit = default(RaycastHit);
-            RayStep rayStep = default(RayStep);
             bool isHit = false;
             int rayStepIndex = 0;
+            RayStep rayStep = default(RayStep);
+            RaycastHit physicsHit = default(RaycastHit);
+
+            Debug.Assert(pointer.PointingSource.Rays != null, "No valid rays for " + pointer.GetType());
+            Debug.Assert(pointer.PointingSource.Rays.Length > 0, "No valid rays for " + pointer.GetType());
 
             // Check raycast for each step in the pointing source
             for (int i = 0; i < pointer.PointingSource.Rays.Length; i++)
@@ -562,7 +567,7 @@ private void RaycastPhysics(PointerData pointer, LayerMask[] prioritizedLayerMas
             }
             else
             {
-                pointer.UpdateHit(GetPointingExtent(pointer));
+                pointer.UpdateHit(GetPointingExtent(pointer.PointingSource));
             }
         }
 
@@ -601,6 +606,9 @@ private void RaycastUnityUI(PointerData pointer, LayerMask[] prioritizedLayerMas
             RayStep rayStep = default(RayStep);
             int rayStepIndex = 0;
 
+            Debug.Assert(pointer.PointingSource.Rays != null, "No valid rays for " + pointer.GetType());
+            Debug.Assert(pointer.PointingSource.Rays.Length > 0, "No valid rays for " + pointer.GetType());
+
             // Cast rays for every step until we score a hit
             for (int i = 0; i < pointer.PointingSource.Rays.Length; i++)
             {
@@ -613,7 +621,7 @@ private void RaycastUnityUI(PointerData pointer, LayerMask[] prioritizedLayerMas
             }
 
             // Check if we need to overwrite the physics raycast info
-            if ((pointer.End.Object == null || overridePhysicsRaycast) && uiRaycastResult.module.eventCamera == UIRaycastCamera)
+            if ((pointer.End.Object == null || overridePhysicsRaycast) && uiRaycastResult.isValid && uiRaycastResult.module.eventCamera == UIRaycastCamera)
             {
                 newUiRaycastPosition.x = uiRaycastResult.screenPosition.x;
                 newUiRaycastPosition.y = uiRaycastResult.screenPosition.y;
@@ -783,32 +791,33 @@ private void RaisePointerSpecificFocusChangedEvents(IPointingSource pointer, Gam
             }
         }
 
-        private PointerData GetPointer(IPointingSource pointingSource)
+        private bool GetPointerData(IPointingSource pointingSource, out PointerData pointerData)
         {
-            int? iPointer = TryGetPointerIndex(pointingSource);
-            Debug.Assert(iPointer != null);
-            return pointers[iPointer.Value];
+            int pointerIndex;
+
+            if (TryGetPointerIndex(pointingSource, out pointerIndex))
+            {
+                pointerData = pointers[pointerIndex];
+                return true;
+            }
+
+            pointerData = null;
+            return false;
         }
 
-        private int? TryGetPointerIndex(IPointingSource pointingSource)
+        private bool TryGetPointerIndex(IPointingSource pointingSource, out int pointerIndex)
         {
-            int? found = null;
-
             for (int i = 0; i < pointers.Count; i++)
             {
-                if (pointers[i].PointingSource == pointingSource)
+                if (pointingSource == pointers[i].PointingSource)
                 {
-                    found = i;
-                    break;
+                    pointerIndex = i;
+                    return true;
                 }
             }
 
-            return found;
-        }
-
-        private float GetPointingExtent(PointerData pointer)
-        {
-            return (pointer.PointingSource.ExtentOverride ?? pointingExtent);
+            pointerIndex = -1;
+            return false;
         }
 
         private RaycastHit? PrioritizeHits(RaycastHit[] hits, LayerMask[] layerMasks)

Assets/HoloToolkit/Input/Scripts/Focus/InputSourcePointer.cs

@@ -51,7 +51,6 @@ public bool InteractionEnabled
         [Obsolete("Will be removed in a later version. Use OnPreRaycast / OnPostRaycast instead.")]
         public void UpdatePointer()
         {
-
         }
 
         public virtual void OnPreRaycast()
@@ -62,9 +61,9 @@ public virtual void OnPreRaycast()
             }
             else
             {
-                Debug.Assert(InputSource.SupportsInputInfo(InputSourceId, SupportedInputInfo.Pointing));
+                Debug.Assert(InputSource.SupportsInputInfo(InputSourceId, SupportedInputInfo.Pointing), string.Format("{0} with id {1} does not support pointing!", InputSource, InputSourceId));
 
-                Ray pointingRay = default(Ray);
+                Ray pointingRay;
                 if (InputSource.TryGetPointingRay(InputSourceId, out pointingRay))
                 {
                     rays[0].CopyRay(pointingRay, FocusManager.Instance.GetPointingExtent(this));

Assets/HoloToolkit/Input/Scripts/Focus/SimpleSinglePointerSelector.cs

@@ -45,14 +45,12 @@ private void Start()
             started = true;
 
             InputManager.AssertIsInitialized();
-            GazeManager.AssertIsInitialized();
             FocusManager.AssertIsInitialized();
+            GazeManager.AssertIsInitialized();
 
             AddInputManagerListenerIfNeeded();
             FindCursorIfNeeded();
             ConnectBestAvailablePointer();
-
-            Debug.Assert(currentPointer != null, this);
         }
 
         private void OnEnable()
@@ -173,6 +171,8 @@ private void SetPointer(IPointingSource newPointer)
                     Cursor.Pointer = newPointer;
                 }
             }
+
+            Debug.Assert(currentPointer != null, "No Pointer Set!");
         }
 
         private void ConnectBestAvailablePointer()
@@ -228,7 +228,6 @@ private void HandleInputAction(InputEventData eventData)
                     // TODO: robertes: see if we can treat voice separately from the other simple committers,
                     //       so voice doesn't steal from a pointing controller. I think input Kind would need
                     //       to come through with the event data.
-
                     SetPointer(GazeManager.Instance);
                     pointerWasChanged = true;
                 }

Assets/HoloToolkit/Input/Scripts/Gaze/GazeManager.cs

@@ -113,14 +113,14 @@ public Vector3 GazeNormal
         [Tooltip("True to draw a debug view of the ray.")]
         public bool DebugDrawRay;
         public PointerResult Result { get; set; }
-        
+
         [Obsolete("Will be removed in a later version. Use Rays instead.")]
         public Ray Ray { get { return Rays[0]; } }
-        
+
         public RayStep[] Rays { get { return rays; } }
 
         private RayStep[] rays = new RayStep[1] { new RayStep(Vector3.zero, Vector3.zero) };
- 
+
         public float? ExtentOverride
         {
             get { return MaxGazeCollisionDistance; }
@@ -133,10 +133,7 @@ public LayerMask[] PrioritizedLayerMasksOverride
 
         public bool InteractionEnabled
         {
-            get
-            {
-                return true;
-            }
+            get { return true; }
         }
 
         private float lastHitDistance = 2.0f;
@@ -203,7 +200,7 @@ private void UpdateGazeInfo()
                     newGazeNormal = Stabilizer.StableRay.direction;
                 }
 
-                Rays[0].UpdateRayStep(newGazeOrigin, newGazeOrigin + (newGazeNormal * FocusManager.Instance.GetPointingExtent (this)));
+                Rays[0].UpdateRayStep(newGazeOrigin, newGazeOrigin + (newGazeNormal * FocusManager.Instance.GetPointingExtent(this)));
             }
 
             UpdateHitPosition();
@@ -212,7 +209,6 @@ private void UpdateGazeInfo()
         [Obsolete("Will be removed in a later version. Use OnPreRaycast / OnPostRaycast instead.")]
         public void UpdatePointer()
         {
-
         }
 
         public virtual void OnPreRaycast()

Assets/HoloToolkit/Input/Scripts/Utilities/Interactions/CustomInputSelector.cs

@@ -54,9 +54,9 @@ private void Awake()
             bool spawnControllers = false;
 
 #if UNITY_2017_2_OR_NEWER
-            spawnControllers = (!XRDevice.isPresent && XRSettings.enabled || Application.isEditor) && simulateHandsInEditor;
+            spawnControllers = !XRDevice.isPresent && XRSettings.enabled && simulateHandsInEditor;
 #else
-            spawnControllers = !VRDevice.isPresent;
+            spawnControllers = simulateHandsInEditor;
 #endif
             if (spawnControllers)
             {