Additional feedback for pr611 (#659)

* Improving Hover-Proximity event behavior as per PR 611 feedback.

Author: ms-RistoRK

org.mixedrealitytoolkit.input/InteractionModes/BaseProximityEventArgs.cs

@@ -1,40 +1,27 @@
+// Copyright (c) Mixed Reality Toolkit Contributors
+// Licensed under the BSD 3-Clause
+
 using System;
-using UnityEngine;
-using UnityEngine.XR.Interaction.Toolkit;
 
 namespace MixedReality.Toolkit.Input
 {
     /// <summary>
-    /// Event data associated with proximity events triggered by a Collider and an Interactor combo.
+    /// Event data associated with proximity events triggered by a NearInteractionModeDetector.
     /// </summary>
-    public abstract partial class BaseProximityEventArgs : EventArgs
+    public abstract class BaseProximityEventArgs : EventArgs
     {
         /// <summary>
         /// Constructor for BaseProximityEventArgs.
         /// </summary>
-        /// <param name="sender">Source of event.</param>
-        /// <param name="collider">Collider that triggers proximity event.</param>
-        /// <param name="interactor">XRBaseInteractor that triggers proximity event.</param>
-        public BaseProximityEventArgs(object sender, Collider collider, XRBaseInteractor interactor)
+        /// <param name="nearInteractionModeDetector">NearInteractionModeDetector that triggers proximity event.</param>
+        public BaseProximityEventArgs(NearInteractionModeDetector nearInteractionModeDetector)
         {
-            this.sender = sender;
-            this.collider = collider;
-            this.interactor = interactor;
+            NearInteractionModeDetector = nearInteractionModeDetector;
         }
 
         /// <summary>
-        /// The object that triggered the proximity event.
-        /// </summary>
-        public object sender { get; private set; }
-
-        /// <summary>
-        /// The collider associated with the interaction event.
-        /// </summary>
-        public Collider collider { get; private set; }
-
-        /// <summary>
-        /// The interactor associated with the interaction event.
+        /// The NearInteractionModeDetector associated with the proximity interaction event.
         /// </summary>
-        public XRBaseInteractor interactor { get; private set; }
+        public NearInteractionModeDetector NearInteractionModeDetector { get; private set; }
     }
 }

org.mixedrealitytoolkit.input/InteractionModes/BaseProximityEventArgs.cs.meta

@@ -16,17 +16,15 @@ namespace MixedReality.Toolkit.Input
     public interface IXRProximityInteractable
     {
         /// <summary>
-        /// Registers the duple Collider + XRBaseInteractor as triggering proximity.
+        /// Registers the Detector as triggering proximity.
         /// </summary>
-        /// <param name="collider">Collider triggering proximity.</param>
-        /// <param name="xrBaseInteractor">Interactor triggering proximity.</param>
+        /// <param name="args">ProximityEnteredEventArgs that has the Detector triggering the proximity event.</param>
         void OnProximityEntered(ProximityEnteredEventArgs args);
 
         /// <summary>
-        /// Unregisters the duple Collider + XRBaseInteractor as triggering proximity.
+        /// Unregisters the Detector as triggering proximity.
         /// </summary>
-        /// <param name="collider">Collider that in combination with the interactor was triggering proximity.</param>
-        /// <param name="xrBaseInteractor">Interactor that in combination with the collider was triggering proximity.</param>
+        /// <param name="args">ProximityExitedEventArgs that has the Detector triggering the proximity event.</param>
         void OnProximityExited(ProximityExitedEventArgs args);
     }
 }

org.mixedrealitytoolkit.input/InteractionModes/IXRProximityInteractable.cs

@@ -16,58 +16,104 @@ namespace MixedReality.Toolkit.Input
     [AddComponentMenu("MRTK/Input/Near Interaction Mode Detector")]
     public class NearInteractionModeDetector : ProximityDetector
     {
+        /// <summary>
+        /// The set of near interactors that belongs to near interaction
+        /// </summary>
         [SerializeField]
         [Tooltip("The set of near interactors that belongs to near interaction")]
         private List<XRBaseInteractor> nearInteractors;
 
         /// <summary>
-        /// Used to keep track of the previously detected colliders so that we can know which
-        /// colliders stopped being detected and update their buttons front plate and rounded
-        /// rect if they are labeled as dynamic (based on proximity).
+        /// Keeps track of the previously detected interactables so that we can know which
+        /// interactable stopped being detected and trigger corresponding event.
+        /// </summary>
+        private readonly HashSet<IXRProximityInteractable> previouslyDetectedInteractables = new();
+
+        /// <summary>
+        /// Stores the currently detected interactables (updated every frame).
         /// </summary>
-        List<Collider> previouslyDetectedColliders = new List<Collider>();
+        private readonly List<IXRProximityInteractable> currentlyDetectedInteractables = new();
+
+        /// <summary>
+        /// Stores the interactables that are no longer detected (updated every frame).
+        /// </summary>
+        private readonly List<IXRProximityInteractable> noLongerDetectedInteractables = new();
 
         /// <inheritdoc />
         public override bool IsModeDetected()
         {
             bool result = base.IsModeDetected() || IsNearInteractorSelecting();
             if (result)
             {
-                for (int i = 0; i < previouslyDetectedColliders.Count; i++)
+                UpdateCurrentlyDetectedInteractables();
+                UpdateProximityExited();
+                UpdateProximityEntered();
+            }
+            return result;
+        }
+
+        /// <summary>
+        /// Calls OnProximityExited for all interactables that were previously ProximityHover detected but are no longer detected.
+        /// </summary>
+        private void UpdateProximityExited()
+        {
+            noLongerDetectedInteractables.Clear();
+
+            foreach (IXRProximityInteractable previouslyDetectedInteractable in previouslyDetectedInteractables)
+            {
+                if (!currentlyDetectedInteractables.Contains(previouslyDetectedInteractable))
                 {
-                    Collider previouslyDetectedCollider = previouslyDetectedColliders[i];
-                    if (!DetectedColliders.Contains(previouslyDetectedCollider) && previouslyDetectedCollider != null)
-                    {
-                        IXRProximityInteractable nearInteractionMode = previouslyDetectedCollider.GetComponent<IXRProximityInteractable>();
-                        if (nearInteractionMode != null)
-                        {
-                            foreach (XRBaseInteractor xrBaseInteractor in nearInteractors)
-                            {
-                                previouslyDetectedCollider.GetComponent<IXRProximityInteractable>().OnProximityExited(new ProximityExitedEventArgs(this, previouslyDetectedCollider, xrBaseInteractor));
-                            }
-                        }
-                        previouslyDetectedColliders.Remove(previouslyDetectedCollider);
-                    }
+                    noLongerDetectedInteractables.Add(previouslyDetectedInteractable);
                 }
-                foreach (Collider collider in DetectedColliders)
+            }
+
+            foreach (IXRProximityInteractable noLongerDetectedInteractable in noLongerDetectedInteractables)
+            {
+                if (noLongerDetectedInteractable != null)
                 {
-                    if (!previouslyDetectedColliders.Contains(collider))
-                    {
-                        IXRProximityInteractable nearInteractionMode = collider.GetComponent<IXRProximityInteractable>();
-                        if (nearInteractionMode != null)
-                        {
-                            foreach (XRBaseInteractor xrBaseInteractor in nearInteractors)
-                            {
-                                collider.GetComponent<IXRProximityInteractable>().OnProximityEntered(new ProximityEnteredEventArgs(this, collider, xrBaseInteractor));
-                            }
-                        }
-                        previouslyDetectedColliders.Add(collider);
-                    }
+                    noLongerDetectedInteractable.OnProximityExited(new ProximityExitedEventArgs(this));
                 }
+                previouslyDetectedInteractables.Remove(noLongerDetectedInteractable);
             }
-            return result;
         }
 
+        /// <summary>
+        /// Call OnProximityEntered for all interactables that are currently detected but were not detected previously.
+        /// </summary>
+        private void UpdateProximityEntered()
+        {
+            foreach (IXRProximityInteractable currentlyDetectedInteractable in currentlyDetectedInteractables)
+            {
+                if (previouslyDetectedInteractables.Add(currentlyDetectedInteractable))
+                {
+                    currentlyDetectedInteractable.OnProximityEntered(new ProximityEnteredEventArgs(this));
+                }
+            }
+        }
+
+        /// <summary>
+        /// Returns a hashset of all unique interactables that are currently detected.
+        /// </summary>
+        /// <returns>Hashset with unique interactables currently detected</returns>
+        private void UpdateCurrentlyDetectedInteractables()
+        {
+            currentlyDetectedInteractables.Clear();
+
+            foreach (Collider collider in DetectedColliders)
+            {
+                if (InteractionManager.TryGetInteractableForCollider(collider, out IXRInteractable xrInteractable) &&
+                    xrInteractable is IXRProximityInteractable xrProximityInteractable &&
+                    !currentlyDetectedInteractables.Contains(xrProximityInteractable))
+                {
+                    currentlyDetectedInteractables.Add(xrProximityInteractable);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Indicates if there is an interactor with selection.
+        /// </summary>
+        /// <returns>True if an interactor has selection, false otherwise.</returns>
         private bool IsNearInteractorSelecting()
         {
             foreach (XRBaseInteractor nearInteractor in nearInteractors)

org.mixedrealitytoolkit.input/InteractionModes/NearInteractionModeDetector.cs

@@ -59,6 +59,24 @@ public class ProximityDetector : MonoBehaviour, IInteractionModeDetector
         /// </summary>
         public HashSet<Collider> DetectedColliders => colliders;
 
+        /// <summary>
+        /// The interaction manager to use to query interactors and their registration events.
+        /// Currently protected internal, may be exposed in a future update.
+        /// </summary>
+        internal protected XRInteractionManager InteractionManager
+        {
+            get
+            {
+                if (interactionManager == null)
+                {
+                    interactionManager = ComponentCache<XRInteractionManager>.FindFirstActiveInstance();
+                }
+
+                return interactionManager;
+            }
+            set => interactionManager = value;
+        }
+
         /// <summary>
         /// A Unity event function that is called when an enabled script instance is being loaded.
         /// </summary>

org.mixedrealitytoolkit.input/InteractionModes/ProximityDetector.cs

@@ -1,29 +1,19 @@
+// Copyright (c) Mixed Reality Toolkit Contributors
+// Licensed under the BSD 3-Clause
+
 using UnityEngine;
-using UnityEngine.XR.Interaction.Toolkit;
 
 namespace MixedReality.Toolkit.Input
 {
     public class ProximityEnteredEventArgs : BaseProximityEventArgs
     {
         /// <summary>
-        /// Constructor for ProximityEnteredArgs.
+        /// Constructor for ProximityEnteredEventArgs.
         /// </summary>
-        /// <param name="sender">Source of event.</param>
-        /// <param name="collider">Collider associated with the Proximity Entered event.</param>
-        /// <param name="interactor">Interactor associated with the Proximity Entered event.</param>
-        public ProximityEnteredEventArgs(object sender, Collider collider, XRBaseInteractor interactor) : base(sender, collider, interactor)
+        /// <param name="nearInteractionModeDetector">NearInteractionModeDetector that triggers proximity entered event.</param>
+        public ProximityEnteredEventArgs(NearInteractionModeDetector nearInteractionModeDetector) : base(nearInteractionModeDetector)
         {
             //Empty on purpose
         }
-
-        /// <summary>
-        /// The collider associated with the proximity entered event.
-        /// </summary>
-        public new Collider collider => base.collider;
-
-        /// <summary>
-        /// The Interactor associated with the proximity entered event.
-        /// </summary>
-        public new XRBaseInteractor interactor => base.interactor;
     }
 }

org.mixedrealitytoolkit.input/InteractionModes/ProximityEnteredEventArgs.cs

@@ -1,29 +1,19 @@
+// Copyright (c) Mixed Reality Toolkit Contributors
+// Licensed under the BSD 3-Clause
+
 using UnityEngine;
-using UnityEngine.XR.Interaction.Toolkit;
 
 namespace MixedReality.Toolkit.Input
 {
     public class ProximityExitedEventArgs : BaseProximityEventArgs
     {
         /// <summary>
-        /// Constructor for ProximityExitedArgs.
+        /// Constructor for ProximityExitedEventArgs.
         /// </summary>
-        /// <param name="sender">Source of event.</param>
-        /// <param name="collider">Collider associated with the Proximity Exited event.</param>
-        /// <param name="interactor">Interactor associated with the Proximity Exited event.</param>
-        public ProximityExitedEventArgs(object sender, Collider collider, XRBaseInteractor interactor) : base(sender, collider, interactor)
+        /// <param name="nearInteractionModeDetector">NearInteractionModeDetector that triggers proximity exited event.</param>
+        public ProximityExitedEventArgs(NearInteractionModeDetector nearInteractionModeDetector) : base(nearInteractionModeDetector)
         {
             //Empty on purpose
         }
-
-        /// <summary>
-        /// The Collider associated with the proximity exited event.
-        /// </summary>
-        public new Collider collider => base.collider;
-
-        /// <summary>
-        /// The Interactor associated with the proximity exited event.
-        /// </summary>
-        public new XRBaseInteractor interactor => base.interactor;
     }
 }

org.mixedrealitytoolkit.input/InteractionModes/ProximityEnteredEventArgs.cs.meta

@@ -855,16 +855,16 @@ public IEnumerator ChangeSpeechSettingsDisabled([ValueSource(nameof(PressableBut
         }
 
         /// <summary>
-        /// Test the PressableButton script has the activeCollidersWithInteractor hashset.
+        /// Test the PressableButton script has the activeDetectors hashset.
         /// </summary>
         [UnityTest]
-        public IEnumerator TestPressableButtonHasActiveCollidersWithInteractorHashset()
+        public IEnumerator TestPressableButtonHasActiveDetectorsWithInteractorHashset()
         {
             FieldInfo[] fieldInfos;
-            System.Type pressableButtonType = typeof(PressableButton);
+            Type pressableButtonType = typeof(PressableButton);
 
             fieldInfos = pressableButtonType.GetFields(BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Public);
-            var result = fieldInfos.Where(fieldInfo => fieldInfo.Name.Equals("activeCollidersWithInteractor")).ToArray();
+            var result = fieldInfos.Where(fieldInfo => fieldInfo.Name.Equals("activeDetectors")).ToArray();
 
             Assert.AreEqual(1, result.Length);