[Merged by Bors] - Partially document bevy_ui #3526
Conversation
| Auto, | ||
| /// If the parent has [`AlignItems::Center`] only this item will be at the start |
There was a problem hiding this comment.
Why are you mentioning Center in particular?
There was a problem hiding this comment.
The descriptions are heavily inspired by https://cssreference.io/flexbox/#align-items, which uses that as an example to underline how this causes the item to diverge from the parent's align-items property
| Relative, | ||
| /// Independent of all other nodes |
There was a problem hiding this comment.
I think it's only independent from siblings, but still relative to it's parent
There was a problem hiding this comment.
PositionType::Relative actually makes it influenced by seemingly unrelated other nodes if they also have PositionType::Relative, but I've never actually set absolute on a node with a parent, so I'm not sure what happens when you do that 🤔
There was a problem hiding this comment.
IIUC, with PositionType::Absolute, it stops participating in the layout of its parent and siblings, and sets it's local transform and node size according to style.position.
There was a problem hiding this comment.
It also stops being influenced by unrelated nodes with relative positioning, I was struggling with layouting because stuff was unexpectedly interacting with each other without being related
There was a problem hiding this comment.
stuff was unexpectedly interacting with each other without being related
Could you give more details about that?
To be clear, this is what I meant:
- if style.position_type == PositionType::Relative, the node takes part in it's parent/siblings' flexbox layout, which sets it's default position (and "interacts" with their default position)
- if style.position_type == PositionType::Absolute, the node does not take part in it's parent/siblings' layout, and it's default position is the position of it's parent (that is, it's local transform is 0)
- style.position displaces the node from its default position after the layout algo is finished. it doesn't "push" other nodes, regardless of the node's position_type.
There was a problem hiding this comment.
What I mean is that nodes with a relative positioning also influence other nodes with relative positioning that aren't in the same hierarchy at all - this is a counterintuitive issue I had to wrangle for one of my games
There was a problem hiding this comment.
That's because there is effectively only one layout hierarchy. All the "root" UI nodes are children of a "window" node (which only exists during layout).
alice-i-cecile
added
A-UI
# Objective - As noticed by @Sheepyhead in #3526, `anchor.rs` is completely unused. ## Solution - Anchors away!
|
Alright I'll just fix the merge conflicts then |
Yeah this pr is only concerned with rustdoc |
Co-authored-by: Pascal Hertleif <[email protected]>
Co-authored-by: Pascal Hertleif <[email protected]>
Co-authored-by: Pascal Hertleif <[email protected]>
Co-authored-by: Pascal Hertleif <[email protected]>
I meant example code blocks in the API docs to demonstrate how everything is used together. But yes, not here! |
Co-authored-by: Alice Cecile <[email protected]>
Co-authored-by: Alice Cecile <[email protected]>
Co-authored-by: Alice Cecile <[email protected]>
|
bors r+ |
# Objective Updated the docs for bevy_ui as requested by #3492 ## Solution I have documented the parts I understand. anchors.rs is not in use and should be removed, thus I haven't documented that, and some of the more renderer-heavy code is beyond me and needs input from either cart or someone familiar with bevy rendering Co-authored-by: Troels Jessen <[email protected]>
bors
bot
changed the title
Objective
Updated the docs for bevy_ui as requested by #3492
Solution
I have documented the parts I understand. anchors.rs is not in use and should be removed, thus I haven't documented that, and some of the more renderer-heavy code is beyond me and needs input from either cart or someone familiar with bevy rendering