Merge pull request #2920 from StephenHodgson/vNEXT-FocusFixes

Fixed issue getting focused GameObject(s) when handling input event

Author: David Kline

Assets/MixedRealityToolkit-SDK/Features/Input/FocusProvider.cs

@@ -252,52 +252,6 @@ private void Update()
 
         #endregion MonoBehaviour Implementation
 
-        #region Focus Details by EventData
-
-        /// <inheritdoc />
-        public GameObject GetFocusedObject(BaseInputEventData eventData)
-        {
-            Debug.Assert(eventData != null);
-            if (OverrideFocusedObject != null) { return OverrideFocusedObject; }
-
-            IMixedRealityPointer pointer;
-            return TryGetPointingSource(eventData, out pointer) ? GetFocusedObject(pointer) : null;
-        }
-
-        /// <inheritdoc />
-        public bool TryGetFocusDetails(BaseInputEventData eventData, out FocusDetails focusDetails)
-        {
-            foreach (var pointerData in pointers)
-            {
-                if (pointerData.Pointer.InputSourceParent.SourceId == eventData.SourceId)
-                {
-                    focusDetails = pointerData.Details;
-                    return true;
-                }
-            }
-
-            focusDetails = default(FocusDetails);
-            return false;
-        }
-
-        /// <inheritdoc />
-        public bool TryGetPointingSource(BaseInputEventData eventData, out IMixedRealityPointer pointer)
-        {
-            foreach (var pointerData in pointers)
-            {
-                if (pointerData.Pointer.InputSourceParent.SourceId == eventData.SourceId)
-                {
-                    pointer = pointerData.Pointer;
-                    return true;
-                }
-            }
-
-            pointer = null;
-            return false;
-        }
-
-        #endregion Focus Details by EventData
-
         #region Focus Details by IMixedRealityPointer
 
         /// <inheritdoc />

Assets/MixedRealityToolkit-SDK/Features/Input/Handlers/DragAndDropHandler.cs

@@ -135,7 +135,7 @@ void IMixedRealityPointerHandler.OnPointerDown(MixedRealityPointerEventData even
             currentPointer = eventData.Pointer;
 
             FocusDetails focusDetails;
-            Vector3 initialDraggingPosition = MixedRealityManager.InputSystem.FocusProvider.TryGetFocusDetails(eventData, out focusDetails)
+            Vector3 initialDraggingPosition = MixedRealityManager.InputSystem.FocusProvider.TryGetFocusDetails(currentPointer, out focusDetails)
                     ? focusDetails.Point
                     : hostTransform.position;
 

Assets/MixedRealityToolkit-SDK/Features/Input/MixedRealityInputManager.cs

@@ -259,50 +259,77 @@ public override void HandleEvent<T>(BaseEventData eventData, ExecuteEvents.Event
             Debug.Assert(eventData != null);
             var baseInputEventData = ExecuteEvents.ValidateEventData<BaseInputEventData>(eventData);
             Debug.Assert(baseInputEventData != null);
-            Debug.Assert(baseInputEventData.InputSource != null, $"Failed to find an input source for {baseInputEventData}");
             Debug.Assert(!baseInputEventData.used);
 
+            if (baseInputEventData.InputSource == null)
+            {
+                Debug.LogError($"Failed to find an input source for {baseInputEventData}");
+                return;
+            }
+
             // Send the event to global listeners
             base.HandleEvent(eventData, eventHandler);
 
             if (baseInputEventData.used)
             {
-                // All global listeners get a chance to see the event, but if any of them marked it used, we stop
-                // the event from going any further.
+                // All global listeners get a chance to see the event,
+                // but if any of them marked it used,
+                // we stop the event from going any further.
+                return;
+            }
+
+            if (baseInputEventData.InputSource.Pointers == null)
+            {
+                Debug.LogError($"InputSource {baseInputEventData.InputSource.SourceName} doesn't have any registered pointers! Input Sources without pointers should use the GazeProvider's pointer as a default fallback.");
                 return;
             }
 
-            GameObject focusedObject = FocusProvider?.GetFocusedObject(baseInputEventData);
+            var modalEventHandled = false;
 
-            // Handle modal input if one exists
-            if (modalInputStack.Count > 0)
+            // Get the focused object for each pointer of the event source
+            for (int i = 0; i < baseInputEventData.InputSource.Pointers.Length; i++)
             {
-                GameObject modalInput = modalInputStack.Peek();
+                GameObject focusedObject = FocusProvider?.GetFocusedObject(baseInputEventData.InputSource.Pointers[i]);
 
-                // If there is a focused object in the hierarchy of the modal handler, start the event bubble there
-                if (focusedObject != null && modalInput != null && focusedObject.transform.IsChildOf(modalInput.transform))
+                // Handle modal input if one exists
+                if (modalInputStack.Count > 0 && !modalEventHandled)
                 {
-                    if (ExecuteEvents.ExecuteHierarchy(focusedObject, baseInputEventData, eventHandler) && baseInputEventData.used)
+                    GameObject modalInput = modalInputStack.Peek();
+
+                    if (modalInput != null)
                     {
-                        return;
+                        modalEventHandled = true;
+
+                        // If there is a focused object in the hierarchy of the modal handler, start the event bubble there
+                        if (focusedObject != null && focusedObject.transform.IsChildOf(modalInput.transform))
+                        {
+                            if (ExecuteEvents.ExecuteHierarchy(focusedObject, baseInputEventData, eventHandler) && baseInputEventData.used)
+                            {
+                                return;
+                            }
+                        }
+                        // Otherwise, just invoke the event on the modal handler itself
+                        else
+                        {
+                            if (ExecuteEvents.ExecuteHierarchy(modalInput, baseInputEventData, eventHandler) && baseInputEventData.used)
+                            {
+                                return;
+                            }
+                        }
                     }
-                }
-                // Otherwise, just invoke the event on the modal handler itself
-                else
-                {
-                    if (ExecuteEvents.ExecuteHierarchy(modalInput, baseInputEventData, eventHandler) && baseInputEventData.used)
+                    else
                     {
-                        return;
+                        Debug.LogError("ModalInput GameObject reference was null!\nDid this GameObject get destroyed?");
                     }
                 }
-            }
 
-            // If event was not handled by modal, pass it on to the current focused object
-            if (focusedObject != null)
-            {
-                if (ExecuteEvents.ExecuteHierarchy(focusedObject, baseInputEventData, eventHandler) && baseInputEventData.used)
+                // If event was not handled by modal, pass it on to the current focused object
+                if (focusedObject != null)
                 {
-                    return;
+                    if (ExecuteEvents.ExecuteHierarchy(focusedObject, baseInputEventData, eventHandler) && baseInputEventData.used)
+                    {
+                        return;
+                    }
                 }
             }
 

Assets/MixedRealityToolkit/_Core/Interfaces/InputSystem/IMixedRealityFocusProvider.cs

@@ -31,29 +31,6 @@ public interface IMixedRealityFocusProvider : IMixedRealitySourceStateHandler
         /// </summary>
         GameObject OverrideFocusedObject { get; set; }
 
-        /// <summary>
-        /// Gets the currently focused object based on specified the event data.
-        /// </summary>
-        /// <param name="eventData"></param>
-        /// <returns>Currently focused <see cref="GameObject"/> for the events input source.</returns>
-        GameObject GetFocusedObject(BaseInputEventData eventData);
-
-        /// <summary>
-        /// Try to get the focus details based on the specified event data.
-        /// </summary>
-        /// <param name="eventData"></param>
-        /// <param name="focusDetails"></param>
-        /// <returns>True, if event data pointer input source is registered.</returns>
-        bool TryGetFocusDetails(BaseInputEventData eventData, out FocusDetails focusDetails);
-
-        /// <summary>
-        /// Try to get the registered pointer source that raised the event.
-        /// </summary>
-        /// <param name="eventData"></param>
-        /// <param name="pointer"></param>
-        /// <returns>True, if event data's pointer input source is registered.</returns>
-        bool TryGetPointingSource(BaseInputEventData eventData, out IMixedRealityPointer pointer);
-
         /// <summary>
         /// Gets the currently focused object for the pointing source.
         /// <para><remarks>If the pointing source is not registered, then the Gaze's Focused <see cref="GameObject"/> is returned.</remarks></para>
@@ -73,7 +50,7 @@ public interface IMixedRealityFocusProvider : IMixedRealitySourceStateHandler
         /// Get the Graphic Event Data for the specified pointing source.
         /// </summary>
         /// <param name="pointer">The pointer who's graphic event data we're looking for.</param>
-        /// <param name="graphicInputEventData">The graphihc event data for the specified pointer</param>
+        /// <param name="graphicInputEventData">The graphic event data for the specified pointer</param>
         /// <returns>True, if graphic event data exists.</returns>
         bool TryGetSpecificPointerGraphicEventData(IMixedRealityPointer pointer, out GraphicInputEventData graphicInputEventData);