Add global events to the InputSystemUIInputModule #1533
+141
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ent to subscribe to UI events when not on the UI object itself.
Rene-Damm
reviewed
Apr 11, 2022
| @@ -387,7 +388,10 @@ private void ProcessPointerMovement(ExtendedPointerEventData eventData, GameObje | |||
| if (currentPointerTarget == null || eventData.pointerEnter == null) | |||
| { | |||
| for (var i = 0; i < eventData.hovered.Count; ++i) | |||
| { | |||
| onPointerExit?.Invoke(eventData.hovered[i], eventData); | |||
There was a problem hiding this comment.
For all these events, would probably make sense to allow the handler to call Use to "consume" the event and prevent ExecuteEvents from being run.
There was a problem hiding this comment.
You mean optionally, correct? I don't think all use-cases will want to fully 'consume' the events, plus there is no mechanism currently in place to prevent subsequent callbacks from being invoked if the prior callback 'consumed' the event.
There was a problem hiding this comment.
Yes, optionally.
onPointerExit?.Invoke(eventData.hovered[i], eventData);
if (!eventData.used)
EXecuteEvents.Execute(eventData.hovered[i], eventData, ExecuteEvents.pointerExitHandler);
jfreire-unity
added
the
waiting-for-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add global events to the
InputSystemUIInputModuleto allow any behavior to subscribe to UI events when not on the UI object itself.Goal
Provide existing event functionality to the InputSystemUIInputModule so that the XRUIInputModule can be retired to further our goal of consolidation and reduction of complexity/code-duplication.
Description
This would allow any subscribers to get events before the EventSystem fires them off to the respective components. This method is currently used in the
XRUIInputModuleto allow non-UI based components to know when events are happening. Some components can modify/update the eventData before it gets handed off to the EventSystem. This can also be used for other tools and management scripts to trigger context-specific behaviors external to the UI system without having to apply the behavior to every button/checkbox/etc.Changes made
Pulled event definitions from the
XRUIInputModuleover toInputSystemUIInputModule.Wired up events to fire before
ExecuteEvents.Execute().Notes
This is a conceptual/informational PR and will need unit tests and documentation added to fully support this feature.
Checklist
Before review:
Changed,Fixed,Addedsections.([case %number%](https://issuetracker.unity3d.com/issues/...)).Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.