forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

UI node bundle comment fix (#9404)

Browse Source 
# Objective

Doc comment for the `global_transform` field in `NodeBundle` says:

```
/// This field is automatically managed by the UI layout system.
```

The `GlobalTransform` component is the thing being managed, not the
`global_transform` field, and the `TransformPropagate` systems do the
managing, not the UI layout system.
This commit is contained in:
ickshonpe 2023-08-28 19:55:35 +01:00 committed by GitHub
parent a8dc8350c6
commit 05b7f60ae5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
crates/bevy_ui/src/node_bundles.rs
View File

@ -36,12 +36,12 @@ pub struct NodeBundle {
pub focus_policy: FocusPolicy, pub focus_policy: FocusPolicy,
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically managed by the UI layout system.
/// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component.
pub transform: Transform, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically updated by the [`TransformPropagate`](`bevy_transform::TransformSystem::TransformPropagate`) systems.
/// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component. /// To alter the position of the `NodeBundle`, use the properties of the [`Style`] component.
pub global_transform: GlobalTransform, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
@ -88,19 +88,18 @@ pub struct ImageBundle {
pub image: UiImage, pub image: UiImage,
/// The size of the image in pixels /// The size of the image in pixels
/// ///
/// This field is set automatically /// This component is set automatically
pub image_size: UiImageSize, pub image_size: UiImageSize,
/// Whether this node should block interaction with lower nodes /// Whether this node should block interaction with lower nodes
pub focus_policy: FocusPolicy, pub focus_policy: FocusPolicy,
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically managed by the UI layout system.
/// To alter the position of the `ImageBundle`, use the properties of the [`Style`] component. /// To alter the position of the `ImageBundle`, use the properties of the [`Style`] component.
pub transform: Transform, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically updated by the [`TransformPropagate`](`bevy_transform::TransformSystem::TransformPropagate`) systems.
/// To alter the position of the `ImageBundle`, use the properties of the [`Style`] component.
pub global_transform: GlobalTransform, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,
@ -132,17 +131,16 @@ pub struct AtlasImageBundle {
pub focus_policy: FocusPolicy, pub focus_policy: FocusPolicy,
/// The size of the image in pixels /// The size of the image in pixels
/// ///
/// This field is set automatically /// This component is set automatically
pub image_size: UiImageSize, pub image_size: UiImageSize,
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically managed by the UI layout system.
/// To alter the position of the `AtlasImageBundle`, use the properties of the [`Style`] component. /// To alter the position of the `AtlasImageBundle`, use the properties of the [`Style`] component.
pub transform: Transform, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically updated by the [`TransformPropagate`](`bevy_transform::TransformSystem::TransformPropagate`) systems.
/// To alter the position of the `AtlasImageBundle`, use the properties of the [`Style`] component.
pub global_transform: GlobalTransform, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,
@ -173,13 +171,12 @@ pub struct TextBundle {
pub focus_policy: FocusPolicy, pub focus_policy: FocusPolicy,
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically managed by the UI layout system.
/// To alter the position of the `TextBundle`, use the properties of the [`Style`] component. /// To alter the position of the `TextBundle`, use the properties of the [`Style`] component.
pub transform: Transform, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically updated by the [`TransformPropagate`](`bevy_transform::TransformSystem::TransformPropagate`) systems.
/// To alter the position of the `TextBundle`, use the properties of the [`Style`] component.
pub global_transform: GlobalTransform, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,
@ -285,13 +282,12 @@ pub struct ButtonBundle {
pub image: UiImage, pub image: UiImage,
/// The transform of the node /// The transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically managed by the UI layout system.
/// To alter the position of the `ButtonBundle`, use the properties of the [`Style`] component. /// To alter the position of the `ButtonBundle`, use the properties of the [`Style`] component.
pub transform: Transform, pub transform: Transform,
/// The global transform of the node /// The global transform of the node
/// ///
/// This field is automatically managed by the UI layout system. /// This component is automatically updated by the [`TransformPropagate`](`bevy_transform::TransformSystem::TransformPropagate`) systems.
/// To alter the position of the `ButtonBundle`, use the properties of the [`Style`] component.
pub global_transform: GlobalTransform, pub global_transform: GlobalTransform,
/// Describes the visibility properties of the node /// Describes the visibility properties of the node
pub visibility: Visibility, pub visibility: Visibility,