mirror of
https://github.com/bevyengine/bevy
synced 2025-02-16 22:18:33 +00:00
# Objective - As part of the migration process we need to a) see the end effect of the migration on user ergonomics b) check for serious perf regressions c) actually migrate the code - To accomplish this, I'm going to attempt to migrate all of the remaining user-facing usages of `LegacyColor` in one PR, being careful to keep a clean commit history. - Fixes #12056. ## Solution I've chosen to use the polymorphic `Color` type as our standard user-facing API. - [x] Migrate `bevy_gizmos`. - [x] Take `impl Into<Color>` in all `bevy_gizmos` APIs - [x] Migrate sprites - [x] Migrate UI - [x] Migrate `ColorMaterial` - [x] Migrate `MaterialMesh2D` - [x] Migrate fog - [x] Migrate lights - [x] Migrate StandardMaterial - [x] Migrate wireframes - [x] Migrate clear color - [x] Migrate text - [x] Migrate gltf loader - [x] Register color types for reflection - [x] Remove `LegacyColor` - [x] Make sure CI passes Incidental improvements to ease migration: - added `Color::srgba_u8`, `Color::srgba_from_array` and friends - added `set_alpha`, `is_fully_transparent` and `is_fully_opaque` to the `Alpha` trait - add and immediately deprecate (lol) `Color::rgb` and friends in favor of more explicit and consistent `Color::srgb` - standardized on white and black for most example text colors - added vector field traits to `LinearRgba`: ~~`Add`, `Sub`, `AddAssign`, `SubAssign`,~~ `Mul<f32>` and `Div<f32>`. Multiplications and divisions do not scale alpha. `Add` and `Sub` have been cut from this PR. - added `LinearRgba` and `Srgba` `RED/GREEN/BLUE` - added `LinearRgba_to_f32_array` and `LinearRgba::to_u32` ## Migration Guide Bevy's color types have changed! Wherever you used a `bevy::render::Color`, a `bevy::color::Color` is used instead. These are quite similar! Both are enums storing a color in a specific color space (or to be more precise, using a specific color model). However, each of the different color models now has its own type. TODO... - `Color::rgba`, `Color::rgb`, `Color::rbga_u8`, `Color::rgb_u8`, `Color::rgb_from_array` are now `Color::srgba`, `Color::srgb`, `Color::srgba_u8`, `Color::srgb_u8` and `Color::srgb_from_array`. - `Color::set_a` and `Color::a` is now `Color::set_alpha` and `Color::alpha`. These are part of the `Alpha` trait in `bevy_color`. - `Color::is_fully_transparent` is now part of the `Alpha` trait in `bevy_color` - `Color::r`, `Color::set_r`, `Color::with_r` and the equivalents for `g`, `b` `h`, `s` and `l` have been removed due to causing silent relatively expensive conversions. Convert your `Color` into the desired color space, perform your operations there, and then convert it back into a polymorphic `Color` enum. - `Color::hex` is now `Srgba::hex`. Call `.into` or construct a `Color::Srgba` variant manually to convert it. - `WireframeMaterial`, `ExtractedUiNode`, `ExtractedDirectionalLight`, `ExtractedPointLight`, `ExtractedSpotLight` and `ExtractedSprite` now store a `LinearRgba`, rather than a polymorphic `Color` - `Color::rgb_linear` and `Color::rgba_linear` are now `Color::linear_rgb` and `Color::linear_rgba` - The various CSS color constants are no longer stored directly on `Color`. Instead, they're defined in the `Srgba` color space, and accessed via `bevy::color::palettes::css`. Call `.into()` on them to convert them into a `Color` for quick debugging use, and consider using the much prettier `tailwind` palette for prototyping. - The `LIME_GREEN` color has been renamed to `LIMEGREEN` to comply with the standard naming. - Vector field arithmetic operations on `Color` (add, subtract, multiply and divide by a f32) have been removed. Instead, convert your colors into `LinearRgba` space, and perform your operations explicitly there. This is particularly relevant when working with emissive or HDR colors, whose color channel values are routinely outside of the ordinary 0 to 1 range. - `Color::as_linear_rgba_f32` has been removed. Call `LinearRgba::to_f32_array` instead, converting if needed. - `Color::as_linear_rgba_u32` has been removed. Call `LinearRgba::to_u32` instead, converting if needed. - Several other color conversion methods to transform LCH or HSL colors into float arrays or `Vec` types have been removed. Please reimplement these externally or open a PR to re-add them if you found them particularly useful. - Various methods on `Color` such as `rgb` or `hsl` to convert the color into a specific color space have been removed. Convert into `LinearRgba`, then to the color space of your choice. - Various implicitly-converting color value methods on `Color` such as `r`, `g`, `b` or `h` have been removed. Please convert it into the color space of your choice, then check these properties. - `Color` no longer implements `AsBindGroup`. Store a `LinearRgba` internally instead to avoid conversion costs. --------- Co-authored-by: Alice Cecile <alice.i.cecil@gmail.com> Co-authored-by: Afonso Lage <lage.afonso@gmail.com> Co-authored-by: Rob Parrett <robparrett@gmail.com> Co-authored-by: Zachary Harrold <zac@harrold.com.au>
400 lines
15 KiB
Rust
400 lines
15 KiB
Rust
//! Demonstrates how the to use the size constraints to control the size of a UI node.
|
|
|
|
use bevy::{color::palettes::css::*, prelude::*};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_event::<ButtonActivatedEvent>()
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, (update_buttons, update_radio_buttons_colors))
|
|
.run();
|
|
}
|
|
|
|
const ACTIVE_BORDER_COLOR: Color = Color::Srgba(ANTIQUE_WHITE);
|
|
const INACTIVE_BORDER_COLOR: Color = Color::BLACK;
|
|
|
|
const ACTIVE_INNER_COLOR: Color = Color::WHITE;
|
|
const INACTIVE_INNER_COLOR: Color = Color::Srgba(NAVY);
|
|
|
|
const ACTIVE_TEXT_COLOR: Color = Color::BLACK;
|
|
const HOVERED_TEXT_COLOR: Color = Color::WHITE;
|
|
const UNHOVERED_TEXT_COLOR: Color = Color::srgb(0.5, 0.5, 0.5);
|
|
|
|
#[derive(Component)]
|
|
struct Bar;
|
|
|
|
#[derive(Copy, Clone, Debug, Component, PartialEq)]
|
|
enum Constraint {
|
|
FlexBasis,
|
|
Width,
|
|
MinWidth,
|
|
MaxWidth,
|
|
}
|
|
|
|
#[derive(Copy, Clone, Component)]
|
|
struct ButtonValue(Val);
|
|
|
|
#[derive(Event)]
|
|
struct ButtonActivatedEvent(Entity);
|
|
|
|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
// ui camera
|
|
commands.spawn(Camera2dBundle::default());
|
|
|
|
let text_style = TextStyle {
|
|
font: asset_server.load("fonts/FiraSans-Bold.ttf"),
|
|
font_size: 40.0,
|
|
color: Color::srgb(0.9, 0.9, 0.9),
|
|
};
|
|
|
|
commands
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
width: Val::Percent(100.0),
|
|
height: Val::Percent(100.0),
|
|
justify_content: JustifyContent::Center,
|
|
align_items: AlignItems::Center,
|
|
..Default::default()
|
|
},
|
|
background_color: Color::BLACK.into(),
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
align_items: AlignItems::Center,
|
|
justify_content: JustifyContent::Center,
|
|
..Default::default()
|
|
},
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent.spawn(
|
|
TextBundle::from_section("Size Constraints Example", text_style.clone())
|
|
.with_style(Style {
|
|
margin: UiRect::bottom(Val::Px(25.)),
|
|
..Default::default()
|
|
}),
|
|
);
|
|
|
|
spawn_bar(parent);
|
|
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
align_items: AlignItems::Stretch,
|
|
padding: UiRect::all(Val::Px(10.)),
|
|
margin: UiRect::top(Val::Px(50.)),
|
|
..Default::default()
|
|
},
|
|
background_color: YELLOW.into(),
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
for constraint in [
|
|
Constraint::MinWidth,
|
|
Constraint::FlexBasis,
|
|
Constraint::Width,
|
|
Constraint::MaxWidth,
|
|
] {
|
|
spawn_button_row(parent, constraint, text_style.clone());
|
|
}
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
fn spawn_bar(parent: &mut ChildBuilder) {
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_basis: Val::Percent(100.0),
|
|
align_self: AlignSelf::Stretch,
|
|
padding: UiRect::all(Val::Px(10.)),
|
|
..Default::default()
|
|
},
|
|
background_color: YELLOW.into(),
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
align_items: AlignItems::Stretch,
|
|
width: Val::Percent(100.),
|
|
height: Val::Px(100.),
|
|
padding: UiRect::all(Val::Px(4.)),
|
|
..Default::default()
|
|
},
|
|
background_color: Color::BLACK.into(),
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent.spawn((
|
|
NodeBundle {
|
|
style: Style {
|
|
..Default::default()
|
|
},
|
|
background_color: Color::WHITE.into(),
|
|
..Default::default()
|
|
},
|
|
Bar,
|
|
));
|
|
});
|
|
});
|
|
}
|
|
|
|
fn spawn_button_row(parent: &mut ChildBuilder, constraint: Constraint, text_style: TextStyle) {
|
|
let label = match constraint {
|
|
Constraint::FlexBasis => "flex_basis",
|
|
Constraint::Width => "size",
|
|
Constraint::MinWidth => "min_size",
|
|
Constraint::MaxWidth => "max_size",
|
|
};
|
|
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
padding: UiRect::all(Val::Px(2.)),
|
|
align_items: AlignItems::Stretch,
|
|
..Default::default()
|
|
},
|
|
background_color: Color::BLACK.into(),
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Row,
|
|
justify_content: JustifyContent::End,
|
|
padding: UiRect::all(Val::Px(2.)),
|
|
..Default::default()
|
|
},
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
// spawn row label
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
min_width: Val::Px(200.),
|
|
max_width: Val::Px(200.),
|
|
justify_content: JustifyContent::Center,
|
|
align_items: AlignItems::Center,
|
|
..Default::default()
|
|
},
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent.spawn(TextBundle {
|
|
text: Text::from_section(label.to_string(), text_style.clone()),
|
|
..Default::default()
|
|
});
|
|
});
|
|
|
|
// spawn row buttons
|
|
parent
|
|
.spawn(NodeBundle {
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
spawn_button(
|
|
parent,
|
|
constraint,
|
|
ButtonValue(Val::Auto),
|
|
"Auto".to_string(),
|
|
text_style.clone(),
|
|
true,
|
|
);
|
|
for percent in [0., 25., 50., 75., 100., 125.] {
|
|
spawn_button(
|
|
parent,
|
|
constraint,
|
|
ButtonValue(Val::Percent(percent)),
|
|
format!("{percent}%"),
|
|
text_style.clone(),
|
|
false,
|
|
);
|
|
}
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
fn spawn_button(
|
|
parent: &mut ChildBuilder,
|
|
constraint: Constraint,
|
|
action: ButtonValue,
|
|
label: String,
|
|
text_style: TextStyle,
|
|
active: bool,
|
|
) {
|
|
parent
|
|
.spawn((
|
|
ButtonBundle {
|
|
style: Style {
|
|
align_items: AlignItems::Center,
|
|
justify_content: JustifyContent::Center,
|
|
border: UiRect::all(Val::Px(2.)),
|
|
margin: UiRect::horizontal(Val::Px(2.)),
|
|
..Default::default()
|
|
},
|
|
background_color: if active {
|
|
ACTIVE_BORDER_COLOR
|
|
} else {
|
|
INACTIVE_BORDER_COLOR
|
|
}
|
|
.into(),
|
|
..Default::default()
|
|
},
|
|
constraint,
|
|
action,
|
|
))
|
|
.with_children(|parent| {
|
|
parent
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
width: Val::Px(100.),
|
|
justify_content: JustifyContent::Center,
|
|
..Default::default()
|
|
},
|
|
background_color: if active {
|
|
ACTIVE_INNER_COLOR
|
|
} else {
|
|
INACTIVE_INNER_COLOR
|
|
}
|
|
.into(),
|
|
..Default::default()
|
|
})
|
|
.with_children(|parent| {
|
|
parent.spawn(TextBundle {
|
|
text: Text::from_section(
|
|
label,
|
|
TextStyle {
|
|
color: if active {
|
|
ACTIVE_TEXT_COLOR
|
|
} else {
|
|
UNHOVERED_TEXT_COLOR
|
|
},
|
|
..text_style
|
|
},
|
|
)
|
|
.with_justify(JustifyText::Center),
|
|
..Default::default()
|
|
});
|
|
});
|
|
});
|
|
}
|
|
|
|
fn update_buttons(
|
|
mut button_query: Query<
|
|
(Entity, &Interaction, &Constraint, &ButtonValue),
|
|
Changed<Interaction>,
|
|
>,
|
|
mut bar_query: Query<&mut Style, With<Bar>>,
|
|
mut text_query: Query<&mut Text>,
|
|
children_query: Query<&Children>,
|
|
mut button_activated_event: EventWriter<ButtonActivatedEvent>,
|
|
) {
|
|
let mut style = bar_query.single_mut();
|
|
for (button_id, interaction, constraint, value) in button_query.iter_mut() {
|
|
match interaction {
|
|
Interaction::Pressed => {
|
|
button_activated_event.send(ButtonActivatedEvent(button_id));
|
|
match constraint {
|
|
Constraint::FlexBasis => {
|
|
style.flex_basis = value.0;
|
|
}
|
|
Constraint::Width => {
|
|
style.width = value.0;
|
|
}
|
|
Constraint::MinWidth => {
|
|
style.min_width = value.0;
|
|
}
|
|
Constraint::MaxWidth => {
|
|
style.max_width = value.0;
|
|
}
|
|
}
|
|
}
|
|
Interaction::Hovered => {
|
|
if let Ok(children) = children_query.get(button_id) {
|
|
for &child in children {
|
|
if let Ok(grand_children) = children_query.get(child) {
|
|
for &grandchild in grand_children {
|
|
if let Ok(mut text) = text_query.get_mut(grandchild) {
|
|
if text.sections[0].style.color != ACTIVE_TEXT_COLOR {
|
|
text.sections[0].style.color = HOVERED_TEXT_COLOR;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
Interaction::None => {
|
|
if let Ok(children) = children_query.get(button_id) {
|
|
for &child in children {
|
|
if let Ok(grand_children) = children_query.get(child) {
|
|
for &grandchild in grand_children {
|
|
if let Ok(mut text) = text_query.get_mut(grandchild) {
|
|
if text.sections[0].style.color != ACTIVE_TEXT_COLOR {
|
|
text.sections[0].style.color = UNHOVERED_TEXT_COLOR;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn update_radio_buttons_colors(
|
|
mut event_reader: EventReader<ButtonActivatedEvent>,
|
|
button_query: Query<(Entity, &Constraint, &Interaction)>,
|
|
mut color_query: Query<&mut BackgroundColor>,
|
|
mut text_query: Query<&mut Text>,
|
|
children_query: Query<&Children>,
|
|
) {
|
|
for &ButtonActivatedEvent(button_id) in event_reader.read() {
|
|
let (_, target_constraint, _) = button_query.get(button_id).unwrap();
|
|
for (id, constraint, interaction) in button_query.iter() {
|
|
if target_constraint == constraint {
|
|
let (border_color, inner_color, text_color) = if id == button_id {
|
|
(ACTIVE_BORDER_COLOR, ACTIVE_INNER_COLOR, ACTIVE_TEXT_COLOR)
|
|
} else {
|
|
(
|
|
INACTIVE_BORDER_COLOR,
|
|
INACTIVE_INNER_COLOR,
|
|
if matches!(interaction, Interaction::Hovered) {
|
|
HOVERED_TEXT_COLOR
|
|
} else {
|
|
UNHOVERED_TEXT_COLOR
|
|
},
|
|
)
|
|
};
|
|
|
|
color_query.get_mut(id).unwrap().0 = border_color;
|
|
if let Ok(children) = children_query.get(id) {
|
|
for &child in children {
|
|
color_query.get_mut(child).unwrap().0 = inner_color;
|
|
if let Ok(grand_children) = children_query.get(child) {
|
|
for &grandchild in grand_children {
|
|
if let Ok(mut text) = text_query.get_mut(grandchild) {
|
|
text.sections[0].style.color = text_color;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|