 9f906fdc8b
			
		
	
	
		9f906fdc8b
		
	
	
	
	
		
			
			# Objective
Creating UI elements is very boilerplate-y with lots of indentation.
This PR aims to reduce boilerplate around creating text elements.
## Changelog
* Renamed `Text::with_section` to `from_section`.
  It no longer takes a `TextAlignment` as argument, as the vast majority of cases left it `Default::default()`.
* Added `Text::from_sections` which creates a `Text` from a list of `TextSections`.
  Reduces line-count and reduces indentation by one level.
* Added `Text::with_alignment`.
  A builder style method for setting the `TextAlignment` of a `Text`.
* Added `TextSection::new`.
  Does not reduce line count, but reduces character count and made it easier to read. No more `.to_string()` calls!
* Added `TextSection::from_style` which creates an empty `TextSection` with a style.
  No more empty strings! Reduces indentation.
* Added `TextAlignment::CENTER` and friends.
* Added methods to `TextBundle`. `from_section`, `from_sections`, `with_text_alignment` and `with_style`.
## Note for reviewers.
Because of the nature of these changes I recommend setting diff view to 'split'.
~~Look for the book icon~~ cog in the top-left of the Files changed tab.
Have fun reviewing ❤️
<sup> >:D </sup>
## Migration Guide
`Text::with_section` was renamed to `from_section` and no longer takes a `TextAlignment` as argument.
Use `with_alignment` to set the alignment instead.
Co-authored-by: devil-ira <justthecooldude@gmail.com>
		
	
			
		
			
				
	
	
		
			188 lines
		
	
	
		
			5.8 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			188 lines
		
	
	
		
			5.8 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Shows various text layout options.
 | |
| 
 | |
| use bevy::{
 | |
|     diagnostic::{Diagnostics, FrameTimeDiagnosticsPlugin},
 | |
|     prelude::*,
 | |
|     window::PresentMode,
 | |
| };
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .insert_resource(WindowDescriptor {
 | |
|             present_mode: PresentMode::AutoNoVsync,
 | |
|             ..default()
 | |
|         })
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_plugin(FrameTimeDiagnosticsPlugin)
 | |
|         .add_startup_system(infotext_system)
 | |
|         .add_system(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");
 | |
|     commands.spawn_bundle(Camera2dBundle::default());
 | |
|     commands.spawn_bundle(
 | |
|         TextBundle::from_section(
 | |
|             "This is\ntext with\nline breaks\nin the top left",
 | |
|             TextStyle {
 | |
|                 font: font.clone(),
 | |
|                 font_size: 50.0,
 | |
|                 color: Color::WHITE,
 | |
|             },
 | |
|         )
 | |
|         .with_style(Style {
 | |
|             align_self: AlignSelf::FlexEnd,
 | |
|             position_type: PositionType::Absolute,
 | |
|             position: UiRect {
 | |
|                 top: Val::Px(5.0),
 | |
|                 left: Val::Px(15.0),
 | |
|                 ..default()
 | |
|             },
 | |
|             ..default()
 | |
|         }),
 | |
|     );
 | |
|     commands.spawn_bundle(TextBundle::from_section(
 | |
|             "This text is very long, has a limited width, is centred, is positioned in the top right and is also coloured pink.",
 | |
|             TextStyle {
 | |
|                 font: font.clone(),
 | |
|                 font_size: 50.0,
 | |
|                 color: Color::rgb(0.8, 0.2, 0.7),
 | |
|             },
 | |
|         )
 | |
|         .with_text_alignment(TextAlignment::CENTER)
 | |
|         .with_style(Style {
 | |
|             align_self: AlignSelf::FlexEnd,
 | |
|             position_type: PositionType::Absolute,
 | |
|             position: UiRect {
 | |
|                 top: Val::Px(5.0),
 | |
|                 right: Val::Px(15.0),
 | |
|                 ..default()
 | |
|             },
 | |
|             max_size: Size {
 | |
|                 width: Val::Px(400.),
 | |
|                 height: Val::Undefined,
 | |
|             },
 | |
|             ..default()
 | |
|         })
 | |
|     );
 | |
|     commands
 | |
|         .spawn_bundle(
 | |
|             TextBundle::from_sections([
 | |
|                 TextSection::new(
 | |
|                     "This text changes in the bottom right",
 | |
|                     TextStyle {
 | |
|                         font: font.clone(),
 | |
|                         font_size: 30.0,
 | |
|                         color: Color::WHITE,
 | |
|                     },
 | |
|                 ),
 | |
|                 TextSection::new(
 | |
|                     "\nThis text changes in the bottom right - ",
 | |
|                     TextStyle {
 | |
|                         font: font.clone(),
 | |
|                         font_size: 30.0,
 | |
|                         color: Color::RED,
 | |
|                     },
 | |
|                 ),
 | |
|                 TextSection::from_style(TextStyle {
 | |
|                     font: font.clone(),
 | |
|                     font_size: 30.0,
 | |
|                     color: Color::ORANGE_RED,
 | |
|                 }),
 | |
|                 TextSection::new(
 | |
|                     " fps, ",
 | |
|                     TextStyle {
 | |
|                         font: font.clone(),
 | |
|                         font_size: 30.0,
 | |
|                         color: Color::YELLOW,
 | |
|                     },
 | |
|                 ),
 | |
|                 TextSection::from_style(TextStyle {
 | |
|                     font: font.clone(),
 | |
|                     font_size: 30.0,
 | |
|                     color: Color::GREEN,
 | |
|                 }),
 | |
|                 TextSection::new(
 | |
|                     " ms/frame",
 | |
|                     TextStyle {
 | |
|                         font: font.clone(),
 | |
|                         font_size: 30.0,
 | |
|                         color: Color::BLUE,
 | |
|                     },
 | |
|                 ),
 | |
|             ])
 | |
|             .with_style(Style {
 | |
|                 align_self: AlignSelf::FlexEnd,
 | |
|                 position_type: PositionType::Absolute,
 | |
|                 position: UiRect {
 | |
|                     bottom: Val::Px(5.0),
 | |
|                     right: Val::Px(15.0),
 | |
|                     ..default()
 | |
|                 },
 | |
|                 ..default()
 | |
|             }),
 | |
|         )
 | |
|         .insert(TextChanges);
 | |
|     commands.spawn_bundle(
 | |
|         TextBundle::from_section(
 | |
|             "This\ntext has\nline breaks and also a set width in the bottom left",
 | |
|             TextStyle {
 | |
|                 font,
 | |
|                 font_size: 50.0,
 | |
|                 color: Color::WHITE,
 | |
|             },
 | |
|         )
 | |
|         .with_style(Style {
 | |
|             align_self: AlignSelf::FlexEnd,
 | |
|             position_type: PositionType::Absolute,
 | |
|             position: UiRect {
 | |
|                 bottom: Val::Px(5.0),
 | |
|                 left: Val::Px(15.0),
 | |
|                 ..default()
 | |
|             },
 | |
|             size: Size {
 | |
|                 width: Val::Px(200.0),
 | |
|                 ..default()
 | |
|             },
 | |
|             ..default()
 | |
|         }),
 | |
|     );
 | |
| }
 | |
| 
 | |
| fn change_text_system(
 | |
|     time: Res<Time>,
 | |
|     diagnostics: Res<Diagnostics>,
 | |
|     mut query: Query<&mut Text, With<TextChanges>>,
 | |
| ) {
 | |
|     for mut text in &mut query {
 | |
|         let mut fps = 0.0;
 | |
|         if let Some(fps_diagnostic) = diagnostics.get(FrameTimeDiagnosticsPlugin::FPS) {
 | |
|             if let Some(fps_avg) = fps_diagnostic.average() {
 | |
|                 fps = fps_avg;
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         let mut frame_time = time.delta_seconds_f64();
 | |
|         if let Some(frame_time_diagnostic) = diagnostics.get(FrameTimeDiagnosticsPlugin::FRAME_TIME)
 | |
|         {
 | |
|             if let Some(frame_time_avg) = frame_time_diagnostic.average() {
 | |
|                 frame_time = frame_time_avg;
 | |
|             }
 | |
|         }
 | |
| 
 | |
|         text.sections[0].value = format!(
 | |
|             "This text changes in the bottom right - {:.1} fps, {:.3} ms/frame",
 | |
|             fps,
 | |
|             frame_time * 1000.0,
 | |
|         );
 | |
| 
 | |
|         text.sections[2].value = format!("{:.1}", fps);
 | |
| 
 | |
|         text.sections[4].value = format!("{:.3}", frame_time * 1000.0);
 | |
|     }
 | |
| }
 |