**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>
		
			
				
	
	
		
			145 lines
		
	
	
		
			4.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			145 lines
		
	
	
		
			4.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
//! This example illustrates the [`UiScale`] resource from `bevy_ui`.
 | 
						|
 | 
						|
use bevy::{color::palettes::css::*, prelude::*, utils::Duration};
 | 
						|
 | 
						|
const SCALE_TIME: u64 = 400;
 | 
						|
 | 
						|
fn main() {
 | 
						|
    App::new()
 | 
						|
        .add_plugins(DefaultPlugins)
 | 
						|
        .insert_resource(TargetScale {
 | 
						|
            start_scale: 1.0,
 | 
						|
            target_scale: 1.0,
 | 
						|
            target_time: Timer::new(Duration::from_millis(SCALE_TIME), TimerMode::Once),
 | 
						|
        })
 | 
						|
        .add_systems(Startup, setup)
 | 
						|
        .add_systems(
 | 
						|
            Update,
 | 
						|
            (change_scaling, apply_scaling.after(change_scaling)),
 | 
						|
        )
 | 
						|
        .run();
 | 
						|
}
 | 
						|
 | 
						|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
 | 
						|
    commands.spawn(Camera2d);
 | 
						|
 | 
						|
    let text_style = TextStyle {
 | 
						|
        font_size: 13.,
 | 
						|
        color: Color::BLACK,
 | 
						|
        ..default()
 | 
						|
    };
 | 
						|
 | 
						|
    commands
 | 
						|
        .spawn(NodeBundle {
 | 
						|
            style: Style {
 | 
						|
                width: Val::Percent(50.0),
 | 
						|
                height: Val::Percent(50.0),
 | 
						|
                position_type: PositionType::Absolute,
 | 
						|
                left: Val::Percent(25.),
 | 
						|
                top: Val::Percent(25.),
 | 
						|
                justify_content: JustifyContent::SpaceAround,
 | 
						|
                align_items: AlignItems::Center,
 | 
						|
                ..default()
 | 
						|
            },
 | 
						|
            background_color: ANTIQUE_WHITE.into(),
 | 
						|
            ..default()
 | 
						|
        })
 | 
						|
        .with_children(|parent| {
 | 
						|
            parent
 | 
						|
                .spawn(NodeBundle {
 | 
						|
                    style: Style {
 | 
						|
                        width: Val::Px(40.0),
 | 
						|
                        height: Val::Px(40.0),
 | 
						|
                        ..default()
 | 
						|
                    },
 | 
						|
                    background_color: RED.into(),
 | 
						|
                    ..default()
 | 
						|
                })
 | 
						|
                .with_children(|parent| {
 | 
						|
                    parent.spawn((Text::new("Size!"), text_style));
 | 
						|
                });
 | 
						|
            parent.spawn(NodeBundle {
 | 
						|
                style: Style {
 | 
						|
                    width: Val::Percent(15.0),
 | 
						|
                    height: Val::Percent(15.0),
 | 
						|
                    ..default()
 | 
						|
                },
 | 
						|
                background_color: BLUE.into(),
 | 
						|
                ..default()
 | 
						|
            });
 | 
						|
            parent.spawn(ImageBundle {
 | 
						|
                style: Style {
 | 
						|
                    width: Val::Px(30.0),
 | 
						|
                    height: Val::Px(30.0),
 | 
						|
                    ..default()
 | 
						|
                },
 | 
						|
                image: asset_server.load("branding/icon.png").into(),
 | 
						|
                ..default()
 | 
						|
            });
 | 
						|
        });
 | 
						|
}
 | 
						|
 | 
						|
/// System that changes the scale of the ui when pressing up or down on the keyboard.
 | 
						|
fn change_scaling(input: Res<ButtonInput<KeyCode>>, mut ui_scale: ResMut<TargetScale>) {
 | 
						|
    if input.just_pressed(KeyCode::ArrowUp) {
 | 
						|
        let scale = (ui_scale.target_scale * 2.0).min(8.);
 | 
						|
        ui_scale.set_scale(scale);
 | 
						|
        info!("Scaling up! Scale: {}", ui_scale.target_scale);
 | 
						|
    }
 | 
						|
    if input.just_pressed(KeyCode::ArrowDown) {
 | 
						|
        let scale = (ui_scale.target_scale / 2.0).max(1. / 8.);
 | 
						|
        ui_scale.set_scale(scale);
 | 
						|
        info!("Scaling down! Scale: {}", ui_scale.target_scale);
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
#[derive(Resource)]
 | 
						|
struct TargetScale {
 | 
						|
    start_scale: f32,
 | 
						|
    target_scale: f32,
 | 
						|
    target_time: Timer,
 | 
						|
}
 | 
						|
 | 
						|
impl TargetScale {
 | 
						|
    fn set_scale(&mut self, scale: f32) {
 | 
						|
        self.start_scale = self.current_scale();
 | 
						|
        self.target_scale = scale;
 | 
						|
        self.target_time.reset();
 | 
						|
    }
 | 
						|
 | 
						|
    fn current_scale(&self) -> f32 {
 | 
						|
        let completion = self.target_time.fraction();
 | 
						|
        let t = ease_in_expo(completion);
 | 
						|
        self.start_scale.lerp(self.target_scale, t)
 | 
						|
    }
 | 
						|
 | 
						|
    fn tick(&mut self, delta: Duration) -> &Self {
 | 
						|
        self.target_time.tick(delta);
 | 
						|
        self
 | 
						|
    }
 | 
						|
 | 
						|
    fn already_completed(&self) -> bool {
 | 
						|
        self.target_time.finished() && !self.target_time.just_finished()
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
fn apply_scaling(
 | 
						|
    time: Res<Time>,
 | 
						|
    mut target_scale: ResMut<TargetScale>,
 | 
						|
    mut ui_scale: ResMut<UiScale>,
 | 
						|
) {
 | 
						|
    if target_scale.tick(time.delta()).already_completed() {
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    ui_scale.0 = target_scale.current_scale();
 | 
						|
}
 | 
						|
 | 
						|
fn ease_in_expo(x: f32) -> f32 {
 | 
						|
    if x == 0. {
 | 
						|
        0.
 | 
						|
    } else {
 | 
						|
        ops::powf(2.0f32, 5. * x - 5.)
 | 
						|
    }
 | 
						|
}
 |