mirror of
https://github.com/bevyengine/bevy
synced 2024-12-19 09:33:06 +00:00
015f2c69ca
# Objective Continue improving the user experience of our UI Node API in the direction specified by [Bevy's Next Generation Scene / UI System](https://github.com/bevyengine/bevy/discussions/14437) ## Solution As specified in the document above, merge `Style` fields into `Node`, and move "computed Node fields" into `ComputedNode` (I chose this name over something like `ComputedNodeLayout` because it currently contains more than just layout info. If we want to break this up / rename these concepts, lets do that in a separate PR). `Style` has been removed. This accomplishes a number of goals: ## Ergonomics wins Specifying both `Node` and `Style` is now no longer required for non-default styles Before: ```rust commands.spawn(( Node::default(), Style { width: Val::Px(100.), ..default() }, )); ``` After: ```rust commands.spawn(Node { width: Val::Px(100.), ..default() }); ``` ## Conceptual clarity `Style` was never a comprehensive "style sheet". It only defined "core" style properties that all `Nodes` shared. Any "styled property" that couldn't fit that mold had to be in a separate component. A "real" style system would style properties _across_ components (`Node`, `Button`, etc). We have plans to build a true style system (see the doc linked above). By moving the `Style` fields to `Node`, we fully embrace `Node` as the driving concept and remove the "style system" confusion. ## Next Steps * Consider identifying and splitting out "style properties that aren't core to Node". This should not happen for Bevy 0.15. --- ## Migration Guide Move any fields set on `Style` into `Node` and replace all `Style` component usage with `Node`. Before: ```rust commands.spawn(( Node::default(), Style { width: Val::Px(100.), ..default() }, )); ``` After: ```rust commands.spawn(Node { width: Val::Px(100.), ..default() }); ``` For any usage of the "computed node properties" that used to live on `Node`, use `ComputedNode` instead: Before: ```rust fn system(nodes: Query<&Node>) { for node in &nodes { let computed_size = node.size(); } } ``` After: ```rust fn system(computed_nodes: Query<&ComputedNode>) { for computed_node in &computed_nodes { let computed_size = computed_node.size(); } } ```
128 lines
4.1 KiB
Rust
128 lines
4.1 KiB
Rust
//! This example demonstrates text wrapping and use of the `LineBreakOn` property.
|
|
|
|
use argh::FromArgs;
|
|
use bevy::{prelude::*, text::LineBreak, window::WindowResolution, winit::WinitSettings};
|
|
|
|
#[derive(FromArgs, Resource)]
|
|
/// `text_wrap_debug` demonstrates text wrapping and use of the `LineBreakOn` property
|
|
struct Args {
|
|
#[argh(option)]
|
|
/// window scale factor
|
|
scale_factor: Option<f32>,
|
|
|
|
#[argh(option, default = "1.")]
|
|
/// ui scale factor
|
|
ui_scale: f32,
|
|
}
|
|
|
|
fn main() {
|
|
// `from_env` panics on the web
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
let args: Args = argh::from_env();
|
|
#[cfg(target_arch = "wasm32")]
|
|
let args = Args::from_args(&[], &[]).unwrap();
|
|
|
|
let window = if let Some(scale_factor) = args.scale_factor {
|
|
Window {
|
|
resolution: WindowResolution::default().with_scale_factor_override(scale_factor),
|
|
..Default::default()
|
|
}
|
|
} else {
|
|
Window::default()
|
|
};
|
|
|
|
App::new()
|
|
.add_plugins(DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(window),
|
|
..Default::default()
|
|
}))
|
|
.insert_resource(WinitSettings::desktop_app())
|
|
.insert_resource(UiScale(args.ui_scale))
|
|
.add_systems(Startup, spawn)
|
|
.run();
|
|
}
|
|
|
|
fn spawn(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
commands.spawn(Camera2d);
|
|
|
|
let text_font = TextFont {
|
|
font: asset_server.load("fonts/FiraSans-Bold.ttf"),
|
|
font_size: 12.0,
|
|
..default()
|
|
};
|
|
|
|
let root = commands
|
|
.spawn((
|
|
Node {
|
|
width: Val::Percent(100.),
|
|
height: Val::Percent(100.),
|
|
flex_direction: FlexDirection::Column,
|
|
..default()
|
|
},
|
|
BackgroundColor(Color::BLACK),
|
|
))
|
|
.id();
|
|
|
|
for linebreak in [
|
|
LineBreak::AnyCharacter,
|
|
LineBreak::WordBoundary,
|
|
LineBreak::WordOrCharacter,
|
|
LineBreak::NoWrap,
|
|
] {
|
|
let row_id = commands
|
|
.spawn(Node {
|
|
flex_direction: FlexDirection::Row,
|
|
justify_content: JustifyContent::SpaceAround,
|
|
align_items: AlignItems::Center,
|
|
width: Val::Percent(100.),
|
|
height: Val::Percent(50.),
|
|
..default()
|
|
})
|
|
.id();
|
|
|
|
let justifications = vec![
|
|
JustifyContent::Center,
|
|
JustifyContent::FlexStart,
|
|
JustifyContent::FlexEnd,
|
|
JustifyContent::SpaceAround,
|
|
JustifyContent::SpaceBetween,
|
|
JustifyContent::SpaceEvenly,
|
|
];
|
|
|
|
for (i, justification) in justifications.into_iter().enumerate() {
|
|
let c = 0.3 + i as f32 * 0.1;
|
|
let column_id = commands
|
|
.spawn((
|
|
Node {
|
|
justify_content: justification,
|
|
flex_direction: FlexDirection::Column,
|
|
width: Val::Percent(16.),
|
|
height: Val::Percent(95.),
|
|
overflow: Overflow::clip_x(),
|
|
..default()
|
|
},
|
|
BackgroundColor(Color::srgb(0.5, c, 1.0 - c)),
|
|
))
|
|
.id();
|
|
|
|
let messages = [
|
|
format!("JustifyContent::{justification:?}"),
|
|
format!("LineBreakOn::{linebreak:?}"),
|
|
"Line 1\nLine 2".to_string(),
|
|
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas auctor, nunc ac faucibus fringilla.".to_string(),
|
|
"pneumonoultramicroscopicsilicovolcanoconiosis".to_string()
|
|
];
|
|
|
|
for (j, message) in messages.into_iter().enumerate() {
|
|
commands.entity(column_id).with_child((
|
|
Text(message.clone()),
|
|
text_font.clone(),
|
|
TextLayout::new(JustifyText::Left, linebreak),
|
|
BackgroundColor(Color::srgb(0.8 - j as f32 * 0.2, 0., 0.)),
|
|
));
|
|
}
|
|
commands.entity(row_id).add_child(column_id);
|
|
}
|
|
commands.entity(root).add_child(row_id);
|
|
}
|
|
}
|