Make clipped areas of UI nodes non-interactive #10454
Merged
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
* The clipped, non-visible regions of UI nodes are interactive. * `RelativeCursorPostion` is set relative to the visible part of the node. It should be relative to the whole node. Changes: * `ui_focus_system` intersects a node's bounding rect with its clipping rect before checking if mouse over. * `RelativeCursorPostion` is calculated relative to the whole node's position and size, not only the visible part. * Added some outlines to the `overflow` example that respond to `Interaction` changes.
ickshonpe
added
C-Bug
|
To understand why the relative coordinates change is needed, consider a node that displays a small clipped section of a large map image. Coordinates relative to the visible area would not be sufficient to determine where on the map the cursor is pointing. |
MrGVSV
approved these changes
Nov 9, 2023
…n node_rect with unwrap_or, instead of binding the intermediate clip_rect variable.
ickshonpe
added
A-UI
alice-i-cecile
added
the
M-Needs-Migration-Guide
Selene-Amanita
approved these changes
Nov 21, 2023
There was a problem hiding this comment.
Beside documentation nitpicks, this PR looks good to me (with my limited knowledge of Bevy's internal UI code), and I tested that it fixes one of the bugs in #10668
Could this be modified to still have a Deref and DerefMut implementation, though? This would make this PR a candidate to a 0.12 patch release.
I don't think it's correct to implement It is quite a bad bug though, maybe we could merge this and have a separate PR that reimplements |
|
I was thinking the other way around (implementing Deref and DerefMut here and not implement it in another PR) but the idea is the same: yes I agree it is not "right", but also I think this bug should be fixed in 0.12.x so having a temporary Deref implementation is a small price to pay. |
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
Let's go with ickshonpe's approach :) |
cart
pushed a commit
that referenced
this pull request
Nov 30, 2023
# Objective Problems: * The clipped, non-visible regions of UI nodes are interactive. * `RelativeCursorPostion` is set relative to the visible part of the node. It should be relative to the whole node. * The `RelativeCursorPostion::mouse_over` method returns `true` when the mouse is over a clipped part of a node. fixes #10470 ## Solution Intersect a node's bounding rect with its clipping rect before checking if it contains the cursor. Added the field `normalized_visible_node_rect` to `RelativeCursorPosition`. This is set to the bounds of the unclipped area of the node rect by `ui_focus_system` expressed in normalized coordinates relative to the entire node. Instead of checking if the normalized cursor position lies within a unit square, it instead checks if it is contained by `normalized_visible_node_rect`. Added outlines to the `overflow` example that appear when the cursor is over the visible part of the images, but not the clipped area. --- ## Changelog * `ui_focus_system` intersects a node's bounding rect with its clipping rect before checking if mouse over. * Added the field `normalized_visible_node_rect` to `RelativeCursorPosition`. This is set to the bounds of the unclipped area of the node rect by `ui_focus_system` expressed in normalized coordinates relative to the entire node. * `RelativeCursorPostion` is calculated relative to the whole node's position and size, not only the visible part. * `RelativeCursorPosition::mouse_over` only returns true when the mouse is over an unclipped region of the UI node. * Removed the `Deref` and `DerefMut` derives from `RelativeCursorPosition` as it is no longer a single field struct. * Added some outlines to the `overflow` example that respond to `Interaction` changes. ## Migration Guide The clipped areas of UI nodes are no longer interactive. `RelativeCursorPostion` is now calculated relative to the whole node's position and size, not only the visible part. Its `mouse_over` method only returns true when the cursor is over an unclipped part of the node. `RelativeCursorPosition` no longer implements `Deref` and `DerefMut`.
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
# Objective Problems: * The clipped, non-visible regions of UI nodes are interactive. * `RelativeCursorPostion` is set relative to the visible part of the node. It should be relative to the whole node. * The `RelativeCursorPostion::mouse_over` method returns `true` when the mouse is over a clipped part of a node. fixes bevyengine#10470 ## Solution Intersect a node's bounding rect with its clipping rect before checking if it contains the cursor. Added the field `normalized_visible_node_rect` to `RelativeCursorPosition`. This is set to the bounds of the unclipped area of the node rect by `ui_focus_system` expressed in normalized coordinates relative to the entire node. Instead of checking if the normalized cursor position lies within a unit square, it instead checks if it is contained by `normalized_visible_node_rect`. Added outlines to the `overflow` example that appear when the cursor is over the visible part of the images, but not the clipped area. --- ## Changelog * `ui_focus_system` intersects a node's bounding rect with its clipping rect before checking if mouse over. * Added the field `normalized_visible_node_rect` to `RelativeCursorPosition`. This is set to the bounds of the unclipped area of the node rect by `ui_focus_system` expressed in normalized coordinates relative to the entire node. * `RelativeCursorPostion` is calculated relative to the whole node's position and size, not only the visible part. * `RelativeCursorPosition::mouse_over` only returns true when the mouse is over an unclipped region of the UI node. * Removed the `Deref` and `DerefMut` derives from `RelativeCursorPosition` as it is no longer a single field struct. * Added some outlines to the `overflow` example that respond to `Interaction` changes. ## Migration Guide The clipped areas of UI nodes are no longer interactive. `RelativeCursorPostion` is now calculated relative to the whole node's position and size, not only the visible part. Its `mouse_over` method only returns true when the cursor is over an unclipped part of the node. `RelativeCursorPosition` no longer implements `Deref` and `DerefMut`.
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.
Objective
Problems:
RelativeCursorPostionis set relative to the visible part of the node. It should be relative to the whole node.RelativeCursorPostion::mouse_overmethod returnstruewhen the mouse is over a clipped part of a node.fixes #10470
Solution
Intersect a node's bounding rect with its clipping rect before checking if it contains the cursor.
Added the field
normalized_visible_node_recttoRelativeCursorPosition. This is set to the bounds of the unclipped area of the node rect byui_focus_systemexpressed in normalized coordinates relative to the entire node.Instead of checking if the normalized cursor position lies within a unit square, it instead checks if it is contained by
normalized_visible_node_rect.Added outlines to the
overflowexample that appear when the cursor is over the visible part of the images, but not the clipped area.Changelog
ui_focus_systemintersects a node's bounding rect with its clipping rect before checking if mouse over.normalized_visible_node_recttoRelativeCursorPosition. This is set to the bounds of the unclipped area of the node rect byui_focus_systemexpressed in normalized coordinates relative to the entire node.RelativeCursorPostionis calculated relative to the whole node's position and size, not only the visible part.RelativeCursorPosition::mouse_overonly returns true when the mouse is over an unclipped region of the UI node.DerefandDerefMutderives fromRelativeCursorPositionas it is no longer a single field struct.overflowexample that respond toInteractionchanges.Migration Guide
The clipped areas of UI nodes are no longer interactive.
RelativeCursorPostionis now calculated relative to the whole node's position and size, not only the visible part. Itsmouse_overmethod only returns true when the cursor is over an unclipped part of the node.RelativeCursorPositionno longer implementsDerefandDerefMut.