mirror of
https://github.com/bevyengine/bevy
synced 2025-02-16 22:18:33 +00:00
**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>
112 lines
3.3 KiB
Rust
112 lines
3.3 KiB
Rust
//! This example illustrates how `FontAtlas`'s are populated.
|
|
//! Bevy uses `FontAtlas`'s under the hood to optimize text rendering.
|
|
|
|
use bevy::{color::palettes::basic::YELLOW, prelude::*, text::FontAtlasSets};
|
|
use rand::{Rng, SeedableRng};
|
|
use rand_chacha::ChaCha8Rng;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.init_resource::<State>()
|
|
.insert_resource(ClearColor(Color::BLACK))
|
|
.add_plugins(DefaultPlugins)
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, (text_update_system, atlas_render_system))
|
|
.run();
|
|
}
|
|
|
|
#[derive(Resource)]
|
|
struct State {
|
|
atlas_count: u32,
|
|
handle: Handle<Font>,
|
|
timer: Timer,
|
|
}
|
|
|
|
impl Default for State {
|
|
fn default() -> Self {
|
|
Self {
|
|
atlas_count: 0,
|
|
handle: Handle::default(),
|
|
timer: Timer::from_seconds(0.05, TimerMode::Repeating),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Resource, Deref, DerefMut)]
|
|
struct SeededRng(ChaCha8Rng);
|
|
|
|
fn atlas_render_system(
|
|
mut commands: Commands,
|
|
mut state: ResMut<State>,
|
|
font_atlas_sets: Res<FontAtlasSets>,
|
|
) {
|
|
if let Some(set) = font_atlas_sets.get(&state.handle) {
|
|
if let Some((_size, font_atlas)) = set.iter().next() {
|
|
let x_offset = state.atlas_count as f32;
|
|
if state.atlas_count == font_atlas.len() as u32 {
|
|
return;
|
|
}
|
|
let font_atlas = &font_atlas[state.atlas_count as usize];
|
|
state.atlas_count += 1;
|
|
commands.spawn(ImageBundle {
|
|
image: font_atlas.texture.clone().into(),
|
|
style: Style {
|
|
position_type: PositionType::Absolute,
|
|
top: Val::ZERO,
|
|
left: Val::Px(512.0 * x_offset),
|
|
..default()
|
|
},
|
|
..default()
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
fn text_update_system(
|
|
mut state: ResMut<State>,
|
|
time: Res<Time>,
|
|
mut query: Query<&mut Text>,
|
|
mut seeded_rng: ResMut<SeededRng>,
|
|
) {
|
|
if state.timer.tick(time.delta()).finished() {
|
|
for mut text in &mut query {
|
|
let c = seeded_rng.gen::<u8>() as char;
|
|
let string = &mut **text;
|
|
if !string.contains(c) {
|
|
string.push(c);
|
|
}
|
|
}
|
|
|
|
state.timer.reset();
|
|
}
|
|
}
|
|
|
|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>, mut state: ResMut<State>) {
|
|
let font_handle = asset_server.load("fonts/FiraSans-Bold.ttf");
|
|
state.handle = font_handle.clone();
|
|
commands.spawn(Camera2d);
|
|
commands
|
|
.spawn(NodeBundle {
|
|
background_color: Color::NONE.into(),
|
|
style: Style {
|
|
position_type: PositionType::Absolute,
|
|
bottom: Val::ZERO,
|
|
..default()
|
|
},
|
|
..default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent.spawn((
|
|
Text::new("a"),
|
|
TextStyle {
|
|
font: font_handle,
|
|
font_size: 50.0,
|
|
color: YELLOW.into(),
|
|
..default()
|
|
},
|
|
));
|
|
});
|
|
// We're seeding the PRNG here to make this example deterministic for testing purposes.
|
|
// This isn't strictly required in practical use unless you need your app to be deterministic.
|
|
commands.insert_resource(SeededRng(ChaCha8Rng::seed_from_u64(19878367467713)));
|
|
}
|