Merge pull request #7016 from julenka/poke3

PokePointer ignore colliders that are not visible

Author: Julia Schwarz

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Pointers/PokePointer.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Microsoft.MixedReality.Toolkit.Physics;
+using Microsoft.MixedReality.Toolkit.Utilities;
 using UnityEngine;
 
 namespace Microsoft.MixedReality.Toolkit.Input
@@ -51,6 +52,25 @@ public class PokePointer : BaseControllerPointer, IMixedRealityNearPointer
         /// </summary>
         public int SceneQueryBufferSize => sceneQueryBufferSize;
 
+        [SerializeField]
+        [Tooltip("Whether to ignore colliders that may be near the pointer, but not actually in the visual FOV. " +
+            "This can prevent accidental touches, and will allow hand rays to turn on when you may be near a " +
+            "touchable but cannot see it. Visual FOV is defined by cone centered about display center, " +
+            "radius equal to half display height.")]
+        private bool ignoreCollidersNotInFOV = true;
+       
+        /// <summary>
+        /// Whether to ignore colliders that may be near the pointer, but not actually in the visual FOV.
+        /// This can prevent accidental touches, and will allow hand rays to turn on when you may be near 
+        /// a touchable but cannot see it. Visual FOV is defined by cone centered about display center, 
+        /// radius equal to half display height.
+        /// </summary>
+        public bool IgnoreCollidersNotInFOV
+        {
+            get => ignoreCollidersNotInFOV;
+            set => ignoreCollidersNotInFOV = value;
+        }
+
         [SerializeField]
         [Tooltip("The LayerMasks, in prioritized order, that are used to determine the touchable objects.")]
         private LayerMask[] pokeLayerMasks = { UnityEngine.Physics.DefaultRaycastLayers };
@@ -183,11 +203,17 @@ private bool FindClosestTouchableForLayerMask(LayerMask layerMask, out BaseNearI
                 Debug.LogWarning($"Maximum number of {numColliders} colliders found in PokePointer overlap query. Consider increasing the query buffer size in the input system settings.");
             }
 
+            Camera mainCam = CameraCache.Main;
             for (int i = 0; i < numColliders; ++i)
             {
-                var touchable = queryBuffer[i].GetComponent<BaseNearInteractionTouchable>();
+                var collider = queryBuffer[i];
+                var touchable = collider.GetComponent<BaseNearInteractionTouchable>();
                 if (touchable)
                 {
+                    if (IgnoreCollidersNotInFOV && !mainCam.IsInFOVConeCached(collider))
+                    {
+                        continue;
+                    }
                     float distance = touchable.DistanceToTouchable(Position, out Vector3 normal);
                     if (distance < closestDistance)
                     {

Assets/MixedRealityToolkit.SDK/Features/UX/Scripts/Pointers/SpherePointer.cs

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using System.Collections.Generic;
+using Microsoft.MixedReality.Toolkit;
 using Microsoft.MixedReality.Toolkit.Physics;
 using Microsoft.MixedReality.Toolkit.Utilities;
 using UnityEngine;
@@ -228,15 +228,6 @@ public bool TryGetNormalToNearestSurface(out Vector3 normal)
         /// </summary>
         private class SpherePointerQueryInfo
         {
-            // List of corners shared across all sphere pointer query instances --
-            // used to store list of corners for a bounds. Shared and static
-            // to avoid allocating memory each frame
-            private static List<Vector3> corners = new List<Vector3>();
-            // Help to clear caches when new frame runs
-            static private int lastCalculatedFrame = -1;
-            // Map from grabbable => is the grabbable in FOV for this frame. Cleared every frame
-            private static Dictionary<Collider, bool> colliderCache = new Dictionary<Collider, bool>();
-
             /// <summary>
             /// How many colliders are near the point from the latest call to TryUpdateQueryBufferForLayerMask 
             /// </summary>
@@ -290,6 +281,7 @@ public bool TryUpdateQueryBufferForLayerMask(LayerMask layerMask, Vector3 pointe
                     Debug.LogWarning($"Maximum number of {numColliders} colliders found in SpherePointer overlap query. Consider increasing the query buffer size in the pointer profile.");
                 }
 
+                Camera mainCam = CameraCache.Main;
                 for (int i = 0; i < numColliders; i++)
                 {
                     Collider collider = queryBuffer[i];
@@ -298,7 +290,7 @@ public bool TryUpdateQueryBufferForLayerMask(LayerMask layerMask, Vector3 pointe
                     {
                         if (ignoreCollidersNotInFOV)
                         {
-                            if (!isInFOVConeCached(collider))
+                            if (!mainCam.IsInFOVConeCached(collider))
                             {
                                 // Additional check: is grabbable in the camera frustrum
                                 // We do this so that if grabbable is not visible it is not accidentally grabbed
@@ -316,60 +308,6 @@ public bool TryUpdateQueryBufferForLayerMask(LayerMask layerMask, Vector3 pointe
                 return false;
             }
 
-
-            /// <summary>
-            /// Returns true if a collider's bounds is within the camera FOV. 
-            /// Utilizes a cache to test if this collider has been seen before and returns current frame's calculated result.
-            /// </summary>
-            /// <param name="myCollider">The collider to test</param>
-            private bool isInFOVConeCached(Collider myCollider)
-            {
-                if (lastCalculatedFrame != Time.frameCount)
-                {
-                    colliderCache.Clear();
-                    lastCalculatedFrame = Time.frameCount;
-                }
-
-                if (colliderCache.TryGetValue(myCollider, out bool result))
-                {
-                    return result;
-                }
-
-                var cam = CameraCache.Main;
-                corners.Clear();
-                BoundsExtensions.GetColliderBoundsPoints(myCollider, corners, 0);
-
-                float xMin = float.MaxValue, yMin = float.MaxValue, zMin = float.MaxValue;
-                float xMax = float.MinValue, yMax = float.MinValue, zMax = float.MinValue;
-                for (int i = 0; i < corners.Count; i++)
-                {
-                    var corner = corners[i];
-                    if (cam.IsInFOVCone(corner, 0))
-                    {
-                        colliderCache.Add(myCollider, true);
-                        return true;
-                    }
-
-                    xMin = Mathf.Min(xMin, corner.x);
-                    yMin = Mathf.Min(yMin, corner.y);
-                    zMin = Mathf.Min(zMin, corner.z);
-                    xMax = Mathf.Max(xMax, corner.x);
-                    yMax = Mathf.Max(yMax, corner.y);
-                    zMax = Mathf.Max(zMax, corner.z);
-                }
-
-                // edge case: check if camera is inside the entire bounds of the collider;
-                // Consider simplifying to myCollider.bounds.Contains(CameraCache.main.transform.position)
-                var cameraPos = cam.transform.position;
-                result = xMin <= cameraPos.x && cameraPos.x <= xMax 
-                    && yMin <= cameraPos.y && cameraPos.y <= yMax
-                    && zMin <= cameraPos.z && cameraPos.z <= zMax;
-
-                colliderCache.Add(myCollider, result);
-
-                return result;
-            }
-
             /// <summary>
             /// Returns true if any of the objects inside QueryBuffer contain a grabbable
             /// </summary>

Assets/MixedRealityToolkit.Tests/EditModeTests/Core/Extensions/CameraExtensionTests.cs

@@ -10,6 +10,7 @@ namespace Microsoft.MixedReality.Toolkit.Tests.Extensions
     public class CameraExtensionTests
     {
         private static Camera testCamera = null;
+        private static Camera testCamera2 = null;
         private const float MarginTolerance = 0.005f;
 
         private class TestPoint
@@ -23,7 +24,27 @@ public TestPoint(Vector3 point, bool isInFOV)
             }
         }
 
+        private class TestCollider
+        {
+            public bool ShouldBeInFOVCamera1, ShouldBeInFOVCamera2;
+            public Vector3 Position { get; private set; }
+            public Vector3 Bounds { get; private set; }
+            public Collider Collider { get; private set; }
+            public TestCollider(Vector3 point, Vector3 bounds, bool isInFOVCamera1, bool isInFOVCamera2)
+            {
+                ShouldBeInFOVCamera1 = isInFOVCamera1;
+                ShouldBeInFOVCamera2 = isInFOVCamera2;
+                Position = point;
+                Bounds = bounds;
+                GameObject obj = GameObject.CreatePrimitive(PrimitiveType.Cube);
+                obj.transform.position = Position;
+                obj.transform.localScale = bounds;
+                Collider = obj.GetComponent<BoxCollider>();
+            }
+        }
+
         private static List<TestPoint> TestPoints = new List<TestPoint>();
+        private List<TestCollider> TestColliders = new List<TestCollider>();
 
         [SetUp]
         public void SetUp()
@@ -36,6 +57,14 @@ public void SetUp()
             testCamera.orthographic = false;
             testCamera.transform.SetPositionAndRotation(Vector3.zero, Quaternion.identity);
 
+            var obj2 = new GameObject("TestCamera2");
+            testCamera2 = obj2.AddComponent<Camera>();
+            testCamera2.nearClipPlane = 0.3f;
+            testCamera2.farClipPlane = 1000.0f;
+            testCamera2.fieldOfView = 60.0f;
+            testCamera2.orthographic = false;
+            testCamera2.transform.SetPositionAndRotation(Vector3.zero, Quaternion.Euler(0f, 180f, 0f));
+
             // Create test data with pre-determined points.
             // This data expects the same results for both IsInFOVCone and IsInFOV
             TestPoints = new List<TestPoint>()
@@ -54,6 +83,26 @@ public void SetUp()
                 new TestPoint(2.0f * Vector3.right, false),
                 new TestPoint(2.0f * Vector3.up, false),
             };
+
+            Vector3 smallCubeSize = Vector3.one * 0.01f;
+            Vector3 largeCubeSize = Vector3.one;
+            Vector3 zeroCubeSize = Vector3.zero;
+            TestColliders = new List<TestCollider>()
+            {
+                new TestCollider(-Vector3.forward, smallCubeSize, false, true),
+                new TestCollider(-Vector3.forward - Vector3.right, largeCubeSize, false, true),
+                new TestCollider(Vector3.forward, smallCubeSize, true, false),
+                new TestCollider(Vector3.forward, smallCubeSize, true, false),
+                new TestCollider(Vector3.zero, Vector3.zero, false, false),
+                new TestCollider(Vector3.zero, largeCubeSize, true, true),
+                new TestCollider(new Vector3(0.0f, 0.0f, testCamera.nearClipPlane), smallCubeSize, true, false),
+                new TestCollider(new Vector3(0.0f, 0.0f, testCamera.farClipPlane), smallCubeSize, true, false),
+                new TestCollider(new Vector3(0.0f, 0.0f, -testCamera.nearClipPlane), smallCubeSize, false, true),
+                new TestCollider(new Vector3(0.0f, 0.0f, -testCamera.farClipPlane), smallCubeSize, false, true),
+                new TestCollider(2.0f * Vector3.right, smallCubeSize, false, false),
+                new TestCollider(2.0f * Vector3.up, smallCubeSize, false, false),
+            };
+
         }
 
         [TearDown]
@@ -62,14 +111,43 @@ public void TearDown()
             GameObjectExtensions.DestroyGameObject(testCamera.gameObject);
         }
 
+
+        /// <summary>
+        /// Test that the Camera extension method IsInFOVConeCached returns valid results for colliders whose bounds are renderable to the camera
+        /// </summary>
+        [Test]
+        public void TestIsInFOVConeCached()
+        {
+            for (int i = 0; i < TestColliders.Count; i++)
+            {
+                var test = TestColliders[i];
+                Assert.AreEqual(test.ShouldBeInFOVCamera1, testCamera.IsInFOVConeCached(test.Collider), $"TestCollider[{i}] did not match");
+            }
+        }
+
+        /// <summary>
+        /// Test that extension method IsInFOVConeCached gives expected results when called from multiple cameras
+        /// facing different directions.
+        /// </summary>
+        [Test]
+        public void TestIsInFOVConeCachedSecondCamera()
+        {
+            for (int i = 0; i < TestColliders.Count; i++)
+            {
+                var test = TestColliders[i];
+                Assert.AreEqual(test.ShouldBeInFOVCamera1, testCamera.IsInFOVConeCached(test.Collider), $"TestCollider[{i}] did not match");
+                Assert.AreEqual(test.ShouldBeInFOVCamera2, testCamera2.IsInFOVConeCached(test.Collider), $"TestColliderSecondCamera[{i}] did not match");
+            }
+        }
+
         /// <summary>
         /// Test that the Camera extension method IsInFov returns valid points that would be renderable on the camera
         /// </summary>
         [Test]
         public void TestIsInFOV()
         {
             for (int i = 0; i < TestPoints.Count; i++)
-            { 
+            {
                 var test = TestPoints[i];
                 Assert.AreEqual(test.ShouldBeInFOV, testCamera.IsInFOV(test.Point), $"TestPoint[{i}] at {test.Point} did not match");
             }