mirror of
https://github.com/bevyengine/bevy
synced 2025-02-16 14:08:32 +00:00
c2c19e5ae4
**Ready for review. Examples migration progress: 100%.** # Objective - Implement https://github.com/bevyengine/bevy/discussions/15014 ## Solution This implements [cart's proposal](https://github.com/bevyengine/bevy/discussions/15014#discussioncomment-10574459) faithfully except for one change. I separated `TextSpan` from `TextSpan2d` because `TextSpan` needs to require the `GhostNode` component, which is a `bevy_ui` component only usable by UI. Extra changes: - Added `EntityCommands::commands_mut` that returns a mutable reference. This is a blocker for extension methods that return something other than `self`. Note that `sickle_ui`'s `UiBuilder::commands` returns a mutable reference for this reason. ## Testing - [x] Text examples all work. --- ## Showcase TODO: showcase-worthy ## Migration Guide TODO: very breaking ### Accessing text spans by index Text sections are now text sections on different entities in a hierarchy, Use the new `TextReader` and `TextWriter` system parameters to access spans by index. Before: ```rust fn refresh_text(mut query: Query<&mut Text, With<TimeText>>, time: Res<Time>) { let text = query.single_mut(); text.sections[1].value = format_time(time.elapsed()); } ``` After: ```rust fn refresh_text( query: Query<Entity, With<TimeText>>, mut writer: UiTextWriter, time: Res<Time> ) { let entity = query.single(); *writer.text(entity, 1) = format_time(time.elapsed()); } ``` ### Iterating text spans Text spans are now entities in a hierarchy, so the new `UiTextReader` and `UiTextWriter` system parameters provide ways to iterate that hierarchy. The `UiTextReader::iter` method will give you a normal iterator over spans, and `UiTextWriter::for_each` lets you visit each of the spans. --------- Co-authored-by: ickshonpe <david.curthoys@googlemail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>
330 lines
10 KiB
Rust
330 lines
10 KiB
Rust
//! Shows various text layout options.
|
|
|
|
use std::{collections::VecDeque, time::Duration};
|
|
|
|
use bevy::{
|
|
color::palettes::css::*,
|
|
diagnostic::{DiagnosticsStore, FrameTimeDiagnosticsPlugin},
|
|
prelude::*,
|
|
ui::widget::UiTextWriter,
|
|
window::PresentMode,
|
|
};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins((
|
|
DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(Window {
|
|
present_mode: PresentMode::AutoNoVsync,
|
|
..default()
|
|
}),
|
|
..default()
|
|
}),
|
|
FrameTimeDiagnosticsPlugin,
|
|
))
|
|
.add_systems(Startup, infotext_system)
|
|
.add_systems(Update, change_text_system)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct TextChanges;
|
|
|
|
fn infotext_system(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
let font = asset_server.load("fonts/FiraSans-Bold.ttf");
|
|
let background_color = MAROON.into();
|
|
commands.spawn(Camera2d);
|
|
|
|
let root_uinode = commands
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
width: Val::Percent(100.),
|
|
height: Val::Percent(100.),
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
..default()
|
|
},
|
|
..default()
|
|
})
|
|
.id();
|
|
|
|
let left_column = commands.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
align_items: AlignItems::Start,
|
|
flex_grow: 1.,
|
|
margin: UiRect::axes(Val::Px(15.), Val::Px(5.)),
|
|
..default()
|
|
},
|
|
..default()
|
|
}).with_children(|builder| {
|
|
builder.spawn((
|
|
Text::new("This is\ntext with\nline breaks\nin the top left."),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
..default()
|
|
},
|
|
BackgroundColor(background_color)
|
|
));
|
|
builder.spawn((
|
|
Text::new(
|
|
"This text is right-justified. The `JustifyText` component controls the horizontal alignment of the lines of multi-line text relative to each other, and does not affect the text node's position in the UI layout.",
|
|
),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: YELLOW.into(),
|
|
..default()
|
|
},
|
|
TextBlock::new_with_justify(JustifyText::Right),
|
|
Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
},
|
|
BackgroundColor(background_color)
|
|
));
|
|
builder.spawn((
|
|
Text::new(
|
|
"This\ntext has\nline breaks and also a set width in the bottom left."),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
..default()
|
|
},
|
|
Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
},
|
|
BackgroundColor(background_color)
|
|
)
|
|
);
|
|
}).id();
|
|
|
|
let right_column = commands.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
align_items: AlignItems::End,
|
|
flex_grow: 1.,
|
|
margin: UiRect::axes(Val::Px(15.), Val::Px(5.)),
|
|
..default()
|
|
},
|
|
..default()
|
|
}).with_children(|builder| {
|
|
|
|
builder.spawn((Text::new(
|
|
"This text is very long, has a limited width, is center-justified, is positioned in the top right and is also colored pink."),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 33.0,
|
|
color: Color::srgb(0.8, 0.2, 0.7),
|
|
..default()
|
|
},
|
|
TextBlock::new_with_justify(JustifyText::Center),
|
|
Style {
|
|
max_width: Val::Px(400.),
|
|
..default()
|
|
},BackgroundColor(background_color))
|
|
);
|
|
|
|
builder.spawn((Text::new(
|
|
"This text is left-justified and is vertically positioned to distribute the empty space equally above and below it."),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 29.0,
|
|
color: YELLOW.into(),
|
|
..default()
|
|
},
|
|
TextBlock::new_with_justify(JustifyText::Left),
|
|
Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
},
|
|
BackgroundColor(background_color)
|
|
));
|
|
|
|
builder.spawn((
|
|
Text::new("This text is fully justified and is positioned in the same way."),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 29.0,
|
|
color: GREEN_YELLOW.into(),
|
|
..default()
|
|
},
|
|
TextBlock::new_with_justify(JustifyText::Justified),
|
|
Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
},
|
|
BackgroundColor(background_color)
|
|
)
|
|
);
|
|
|
|
builder.spawn((
|
|
Text::default(),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 21.0,
|
|
..default()
|
|
},
|
|
TextChanges,
|
|
BackgroundColor(background_color)
|
|
))
|
|
.with_children(|p| {
|
|
p.spawn((
|
|
TextSpan::new("\nThis text changes in the bottom right"),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 21.0,
|
|
..default()
|
|
},
|
|
));
|
|
p.spawn((
|
|
TextSpan::new(" this text has zero fontsize"),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 0.0,
|
|
color: BLUE.into(),
|
|
..default()
|
|
},
|
|
));
|
|
p.spawn((
|
|
TextSpan::new("\nThis text changes in the bottom right - "),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 21.0,
|
|
color: RED.into(),
|
|
..default()
|
|
},
|
|
));
|
|
p.spawn((
|
|
TextSpan::default(),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 21.0,
|
|
color: ORANGE_RED.into(),
|
|
..default()
|
|
}
|
|
));
|
|
p.spawn((
|
|
TextSpan::new(" fps, "),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 10.0,
|
|
color: YELLOW.into(),
|
|
..default()
|
|
},
|
|
));
|
|
p.spawn((
|
|
TextSpan::default(),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 21.0,
|
|
color: LIME.into(),
|
|
..default()
|
|
}
|
|
));
|
|
p.spawn((
|
|
TextSpan::new(" ms/frame"),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 42.0,
|
|
color: BLUE.into(),
|
|
..default()
|
|
},
|
|
));
|
|
p.spawn((
|
|
TextSpan::new(" this text has negative fontsize"),
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: -42.0,
|
|
color: BLUE.into(),
|
|
..default()
|
|
},
|
|
));
|
|
});
|
|
})
|
|
.id();
|
|
commands
|
|
.entity(root_uinode)
|
|
.add_children(&[left_column, right_column]);
|
|
}
|
|
|
|
fn change_text_system(
|
|
mut fps_history: Local<VecDeque<f64>>,
|
|
mut time_history: Local<VecDeque<Duration>>,
|
|
time: Res<Time>,
|
|
diagnostics: Res<DiagnosticsStore>,
|
|
query: Query<Entity, With<TextChanges>>,
|
|
mut writer: UiTextWriter,
|
|
) {
|
|
time_history.push_front(time.elapsed());
|
|
time_history.truncate(120);
|
|
let avg_fps = (time_history.len() as f64)
|
|
/ (time_history.front().copied().unwrap_or_default()
|
|
- time_history.back().copied().unwrap_or_default())
|
|
.as_secs_f64()
|
|
.max(0.0001);
|
|
fps_history.push_front(avg_fps);
|
|
fps_history.truncate(120);
|
|
let fps_variance = std_deviation(fps_history.make_contiguous()).unwrap_or_default();
|
|
|
|
for entity in &query {
|
|
let mut fps = 0.0;
|
|
if let Some(fps_diagnostic) = diagnostics.get(&FrameTimeDiagnosticsPlugin::FPS) {
|
|
if let Some(fps_smoothed) = fps_diagnostic.smoothed() {
|
|
fps = fps_smoothed;
|
|
}
|
|
}
|
|
|
|
let mut frame_time = time.delta_seconds_f64();
|
|
if let Some(frame_time_diagnostic) =
|
|
diagnostics.get(&FrameTimeDiagnosticsPlugin::FRAME_TIME)
|
|
{
|
|
if let Some(frame_time_smoothed) = frame_time_diagnostic.smoothed() {
|
|
frame_time = frame_time_smoothed;
|
|
}
|
|
}
|
|
|
|
*writer.text(entity, 0) =
|
|
format!("{avg_fps:.1} avg fps, {fps_variance:.1} frametime variance",);
|
|
|
|
*writer.text(entity, 1) = format!(
|
|
"\nThis text changes in the bottom right - {fps:.1} fps, {frame_time:.3} ms/frame",
|
|
);
|
|
|
|
*writer.text(entity, 4) = format!("{fps:.1}");
|
|
|
|
*writer.text(entity, 6) = format!("{frame_time:.3}");
|
|
}
|
|
}
|
|
|
|
fn mean(data: &[f64]) -> Option<f64> {
|
|
let sum = data.iter().sum::<f64>();
|
|
let count = data.len();
|
|
|
|
match count {
|
|
positive if positive > 0 => Some(sum / count as f64),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
fn std_deviation(data: &[f64]) -> Option<f64> {
|
|
match (mean(data), data.len()) {
|
|
(Some(data_mean), count) if count > 0 => {
|
|
let variance = data
|
|
.iter()
|
|
.map(|value| {
|
|
let diff = data_mean - *value;
|
|
|
|
diff * diff
|
|
})
|
|
.sum::<f64>()
|
|
/ count as f64;
|
|
|
|
Some(variance.sqrt())
|
|
}
|
|
_ => None,
|
|
}
|
|
}
|