[bevy_ui/layout] Make fields private in UiSurface #13359
+1,000
−202
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
alice-i-cecile
added
A-UI
alice-i-cecile
added
C-Code-Quality
StrikeForceZero
commented
May 13, 2024
| @@ -270,4 +424,553 @@ with UI components as a child of an entity without UI components, results may be | |||
| Err(LayoutError::InvalidHierarchy) | |||
| } | |||
| } | |||
|
|
|||
| /// Returns a debug representation of the computed layout of the UI layout tree for each camera. | |||
| pub fn ui_layout_tree_debug_string(&self) -> Result<String, fmt::Error> { | |||
There was a problem hiding this comment.
This feels weird, as noted in the PR description. Open to alternatives. Maybe the pub(super) get accessors to become available outside of #[cfg(test)], and then layout/debug defines a trait that the user can manually import?
StrikeForceZero
commented
May 13, 2024
| #[deprecated( | ||
| since = "0.13.3", | ||
| note = "use `ui_surface.ui_layout_tree_debug_string()` instead" | ||
| )] |
There was a problem hiding this comment.
see: #13359 (comment)
If we leave ui_layout_tree_debug_string in UiSurface then this function should retain the deprecation notice so it can be removed later.
- Either Remove the notice or update the version to match whatever version this is slated to land in.
3 tasks
Apply rustfmt Move test_initialization next to other tests Add doc comment to is_root_node_pair_valid Move helper methods into the single test case where they are used Add tests for helper methods Remove trait helpers to reduce complexity of tests Mark specific test functions as unreachable Move ui_surface test only methods into mod tests as trait Fix tests after rebase Add tests for bevy_ui/layout/ui_surface Widen type for parameter children in UiSurface::update_children Add missing asserts and Debug fields in UiSurface from bevyengine#12268 and bevyengine#12698
Move assertion above panic triggering line Remove demotion logic to simplify scope Remove potentially duplicated context update loop Remove duplicated ContentSize removal handler Restore assertion in ui tracking tests Remove promotion test Satisfy linter Update test Remove promotion helper Apply rustfmt Fix documentation Add missing back ticks in doc comment Underscore unused variables Rebase fixes Add regression test for recursive despawn on ui nodes Apply rustfmt in bevy_ui/layout/debug Remove message from unreachable! Add/update documentation for UiSurface Make missing root_node_data in compute_camera_layout an error Fix promote_ui_node, add a test, and set to only be in cfg(test) Update documentation Use replace_camera_association to reduce redundant code Use mark_root_node_as_orphaned Add explicit taffy node counts to tests Add test for promoting normal ui nodes into root nodes Add support demoting root nodes into normal ui nodes Expand tests to cover different methods of despawn Remove user_root_node field in favor of using entity_to_taffy Replace is_root_node_data_valid helper with has_valid_root_node_data Implement updated map structure in UiSurface Deprecate user_root_node in RootNodeData Extract default viewport style into inline fn Rename camera_id to camera_entity
StrikeForceZero
force-pushed
the
dev/bevy_ui/ui_surface_make_fields_private
branch
from
368e1bd
to
8b3f47c
Compare
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.
Blocked on:
Objective
UiSurfaceSolution
Since the fields were originally
pub(super)and not used outside of testing, replacing direct access withpub(super)get accessors for#[cfg(test)]seemed like the path of least resistance.Testing
layout/modand how they've been updated to use the accessors.ui_layout_tree_debug_string(). Or if the function is an appropriate level of responsibility for theUiSurfacestruct in the first place. A trait that you have to import might be interesting.Changelog
UiSurfacefields private and replaced directpub(super)access withpub(super)get accessors forlayout/mod.layout/debug)