NEW: Added CursorLockBehavior to InputSystemUIInputModule to enable pointer events when the cursor is locked. #1518
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
Rene-Damm
reviewed
Mar 18, 2022
| EditorGUIUtility.TrTextContent("Cursor Lock Behavior", | ||
| $"Controls the origin point of UI raycasts when the cursor is locked. {InputSystemUIInputModule.CursorLockBehavior.OutsideScreen} " + | ||
| $"is the default behavior and will force the raycast to miss all objects. {InputSystemUIInputModule.CursorLockBehavior.ScreenCenter} " + | ||
| $"will cast the ray from the center of the screen.")); |
There was a problem hiding this comment.
Should probably update manual screenshot and doc.
There was a problem hiding this comment.
Agree, and include @duckets on the review after the change
Rene-Damm
reviewed
Mar 18, 2022
Packages/com.unity.inputsystem/InputSystem/Plugins/UI/InputSystemUIInputModule.cs
Show resolved
Hide resolved
ekcoh
approved these changes
Mar 21, 2022
| EditorGUIUtility.TrTextContent("Cursor Lock Behavior", | ||
| $"Controls the origin point of UI raycasts when the cursor is locked. {InputSystemUIInputModule.CursorLockBehavior.OutsideScreen} " + | ||
| $"is the default behavior and will force the raycast to miss all objects. {InputSystemUIInputModule.CursorLockBehavior.ScreenCenter} " + | ||
| $"will cast the ray from the center of the screen.")); |
There was a problem hiding this comment.
Agree, and include @duckets on the review after the change
Rene-Damm
approved these changes
Mar 29, 2022
…ointer events when the cursor is locked.
* Updated documentation and images * Fixed compile error on newer versions of Unity due to UIElements
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.
Fogbugz
Issue Tracker
Description
IPointerEnterHandler and IPointerExitHandler interfaces did not work when the cursor was locked. This made it impossible to use PhysicsRaycaster to interact with world space UI or objects using pointer-driven gaze direction. The issue occurs because when the cursor is locked, the raycast origin is placed outside the screen, which causes raycast logic to short-circuit and always miss all objects.
Changes made
Added the CursorLockBehaviour enum and a setting in InputSystemUIInputModule to allow the user to specify that when the cursor is locked, raycasts should originate from the center of the screen.
Checklist
Before review:
Changed,Fixed,Addedsections.([case %number%](https://issuetracker.unity3d.com/issues/...)).Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.