mirror of
https://github.com/bevyengine/bevy
synced 2024-12-24 20:13:07 +00:00
07ed1d053e
This implements the most minimal variant of #1843 - a derive for marker trait. This is a prerequisite to more complicated features like statically defined storage type or opt-out component reflection. In order to make component struct's purpose explicit and avoid misuse, it must be annotated with `#[derive(Component)]` (manual impl is discouraged for compatibility). Right now this is just a marker trait, but in the future it might be expanded. Making this change early allows us to make further changes later without breaking backward compatibility for derive macro users. This already prevents a lot of issues, like using bundles in `insert` calls. Primitive types are no longer valid components as well. This can be easily worked around by adding newtype wrappers and deriving `Component` for them. One funny example of prevented bad code (from our own tests) is when an newtype struct or enum variant is used. Previously, it was possible to write `insert(Newtype)` instead of `insert(Newtype(value))`. That code compiled, because function pointers (in this case newtype struct constructor) implement `Send + Sync + 'static`, so we allowed them to be used as components. This is no longer the case and such invalid code will trigger a compile error. Co-authored-by: = <=> Co-authored-by: TheRawMeatball <therawmeatball@gmail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>
108 lines
2.6 KiB
Rust
108 lines
2.6 KiB
Rust
use bevy_asset::Handle;
|
|
use bevy_ecs::component::Component;
|
|
use bevy_math::Size;
|
|
use bevy_render::color::Color;
|
|
use glyph_brush_layout::{HorizontalAlign, VerticalAlign};
|
|
|
|
use crate::Font;
|
|
|
|
#[derive(Component, Debug, Default, Clone)]
|
|
pub struct Text {
|
|
pub sections: Vec<TextSection>,
|
|
pub alignment: TextAlignment,
|
|
}
|
|
|
|
impl Text {
|
|
/// Constructs a [`Text`] with (initially) one section.
|
|
///
|
|
/// ```
|
|
/// # use bevy_asset::{AssetServer, Handle};
|
|
/// # use bevy_render::color::Color;
|
|
/// # use bevy_text::{Font, Text, TextAlignment, TextStyle};
|
|
/// # use glyph_brush_layout::{HorizontalAlign, VerticalAlign};
|
|
/// #
|
|
/// # let font_handle: Handle<Font> = Default::default();
|
|
/// #
|
|
/// // basic usage
|
|
/// let hello_world = Text::with_section(
|
|
/// "hello world!".to_string(),
|
|
/// TextStyle {
|
|
/// font: font_handle.clone(),
|
|
/// font_size: 60.0,
|
|
/// color: Color::WHITE,
|
|
/// },
|
|
/// TextAlignment {
|
|
/// vertical: VerticalAlign::Center,
|
|
/// horizontal: HorizontalAlign::Center,
|
|
/// },
|
|
/// );
|
|
///
|
|
/// let hello_bevy = Text::with_section(
|
|
/// // accepts a String or any type that converts into a String, such as &str
|
|
/// "hello bevy!",
|
|
/// TextStyle {
|
|
/// font: font_handle,
|
|
/// font_size: 60.0,
|
|
/// color: Color::WHITE,
|
|
/// },
|
|
/// // you can still use Default
|
|
/// Default::default(),
|
|
/// );
|
|
/// ```
|
|
pub fn with_section<S: Into<String>>(
|
|
value: S,
|
|
style: TextStyle,
|
|
alignment: TextAlignment,
|
|
) -> Self {
|
|
Self {
|
|
sections: vec![TextSection {
|
|
value: value.into(),
|
|
style,
|
|
}],
|
|
alignment,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Default, Clone)]
|
|
pub struct TextSection {
|
|
pub value: String,
|
|
pub style: TextStyle,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Copy)]
|
|
pub struct TextAlignment {
|
|
pub vertical: VerticalAlign,
|
|
pub horizontal: HorizontalAlign,
|
|
}
|
|
|
|
impl Default for TextAlignment {
|
|
fn default() -> Self {
|
|
TextAlignment {
|
|
vertical: VerticalAlign::Top,
|
|
horizontal: HorizontalAlign::Left,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug)]
|
|
pub struct TextStyle {
|
|
pub font: Handle<Font>,
|
|
pub font_size: f32,
|
|
pub color: Color,
|
|
}
|
|
|
|
impl Default for TextStyle {
|
|
fn default() -> Self {
|
|
Self {
|
|
font: Default::default(),
|
|
font_size: 12.0,
|
|
color: Color::WHITE,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Component, Default, Copy, Clone, Debug)]
|
|
pub struct Text2dSize {
|
|
pub size: Size,
|
|
}
|