Merge pull request #7059 from thalbern/user/bethalha/gazetarget

Added support for Unity UI when setting a gaze target in FocusProvider

Author: thalbern

Assets/MixedRealityToolkit.Services/InputSystem/FocusProvider.cs

@@ -255,6 +255,12 @@ public void Set(MixedRealityRaycastHit hit, RayStep ray, int rayStepIndex, float
             public void Set(RaycastResult result, Vector3 hitPointOnObject, Vector4 hitNormalOnObject, RayStep ray, int rayStepIndex, float rayDistance)
             {
                 raycastHit = default(MixedRealityRaycastHit);
+                raycastHit.point = hitPointOnObject;
+                raycastHit.normal = hitNormalOnObject;
+                raycastHit.distance = rayDistance;
+                raycastHit.transform = result.gameObject.transform;
+                raycastHit.raycastValid = true;
+
                 graphicsRaycastResult = result;
 
                 this.hitObject = result.gameObject;
@@ -552,12 +558,19 @@ private void UpdateGazeProvider()
             // another raycast if it's not populated
             if (gazeHitResult == null)
             {
+                // get 3d hit
                 hitResult3d.Clear();
                 var raycastProvider = CoreServices.InputSystem.RaycastProvider;
                 LayerMask[] prioritizedLayerMasks = (gazeProviderPointingData.Pointer.PrioritizedLayerMasksOverride ?? FocusLayerMasks);
                 QueryScene(gazeProviderPointingData.Pointer, raycastProvider, prioritizedLayerMasks,
                     hitResult3d, maxQuerySceneResults, focusIndividualCompoundCollider);
-                gazeHitResult = hitResult3d;
+
+                // get ui hit
+                hitResultUi.Clear();
+                RaycastGraphics(gazeProviderPointingData.Pointer, gazeProviderPointingData.GraphicEventData, prioritizedLayerMasks, hitResultUi);
+
+                // set gaze hit according to distance and priorization layer mask
+                gazeHitResult = GetPrioritizedHitResult(hitResult3d, hitResultUi, prioritizedLayerMasks);
             }
 
             CoreServices.InputSystem.GazeProvider.UpdateGazeInfoFromHit(gazeHitResult.raycastHit);
@@ -957,11 +970,6 @@ private void UpdatePointer(PointerData pointerData)
                     hitResult3d.Clear();
                     QueryScene(pointerData.Pointer, raycastProvider, prioritizedLayerMasks, hitResult3d, maxQuerySceneResults, focusIndividualCompoundCollider);
 
-                    if (pointerData.Pointer.PointerId == gazeProviderPointingData.Pointer.PointerId)
-                    {
-                        gazeHitResult = hitResult3d;
-                    }
-
                     int hitResult3dLayer = hitResult3d.hitObject != null ? hitResult3d.hitObject.layer : -1;
                     if (hitResult3dLayer == 0)
                     {
@@ -997,6 +1005,12 @@ private void UpdatePointer(PointerData pointerData)
                     // Apply the hit result only now so changes in the current target are detected only once per frame.
                     pointerData.UpdateHit(hit);
 
+                    // set gaze hit result - make sure to include unity ui hits
+                    if (pointerData.Pointer.PointerId == gazeProviderPointingData.Pointer.PointerId)
+                    {
+                        gazeHitResult = hit;
+                    }
+
                     // Set the pointer's result last
                     pointerData.Pointer.Result = pointerData;
                 }

Assets/MixedRealityToolkit.Tests/PlayModeTests/FocusProviderTests.cs

@@ -92,6 +92,40 @@ public IEnumerator TestGazeProviderTargetNotNull()
             Assert.NotNull(CoreServices.InputSystem.GazeProvider.GazeTarget, "GazeProvider target is null when looking at an object with hand raised");
         }
 
+        [UnityTest]
+        public IEnumerator TestGazeProviderTargetUnityUi()
+        {
+            TestUtilities.PlayspaceToOriginLookingForward();
+
+            // spawn 3d object 
+            var cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
+            cube.transform.position = Vector3.forward;
+            cube.transform.localScale = Vector3.one * 0.5f;
+            yield return null;
+
+            // make sure we get the 3d object as a gaze target
+            Assert.AreEqual(CoreServices.InputSystem.GazeProvider.GazeTarget, cube, "GazeProvider target is not set to 3d object (cube)");
+
+            // spawn 2d unity ui
+            var canvas = UnityUiUtilities.CreateCanvas(0.002f);
+            var toggle = UnityUiUtilities.CreateToggle(Color.gray, Color.blue, Color.green);
+            toggle.transform.SetParent(canvas.transform, false);
+            canvas.transform.position = Vector3.forward * 0.5f;
+            yield return null;
+
+            // check if gaze target has changed to unity ui
+            Assert.AreEqual(CoreServices.InputSystem.GazeProvider.GazeTarget, toggle.gameObject, "GazeProvider target is not set to toggle unity ui");
+
+            // destroy unity ui
+            Object.DestroyImmediate(canvas.gameObject);
+            yield return null;
+
+            // make sure gaze is back at 3d object
+            Assert.AreEqual(CoreServices.InputSystem.GazeProvider.GazeTarget, cube, "GazeProvider target is not set to 3d object (cube)");
+
+            yield return null;
+        }
+
         /// <summary>
         /// Ensure FocusProvider's FocusDetails can be overridden.
         /// </summary>