9b32e09551
# Objective Now that #13432 has been merged, it's important we update our reflected types to properly opt into this feature. If we do not, then this could cause issues for users downstream who want to make use of reflection-based cloning. ## Solution This PR is broken into 4 commits: 1. Add `#[reflect(Clone)]` on all types marked `#[reflect(opaque)]` that are also `Clone`. This is mandatory as these types would otherwise cause the cloning operation to fail for any type that contains it at any depth. 2. Update the reflection example to suggest adding `#[reflect(Clone)]` on opaque types. 3. Add `#[reflect(clone)]` attributes on all fields marked `#[reflect(ignore)]` that are also `Clone`. This prevents the ignored field from causing the cloning operation to fail. Note that some of the types that contain these fields are also `Clone`, and thus can be marked `#[reflect(Clone)]`. This makes the `#[reflect(clone)]` attribute redundant. However, I think it's safer to keep it marked in the case that the `Clone` impl/derive is ever removed. I'm open to removing them, though, if people disagree. 4. Finally, I added `#[reflect(Clone)]` on all types that are also `Clone`. While not strictly necessary, it enables us to reduce the generated output since we can just call `Clone::clone` directly instead of calling `PartialReflect::reflect_clone` on each variant/field. It also means we benefit from any optimizations or customizations made in the `Clone` impl, including directly dereferencing `Copy` values and increasing reference counters. Along with that change I also took the liberty of adding any missing registrations that I saw could be applied to the type as well, such as `Default`, `PartialEq`, and `Hash`. There were hundreds of these to edit, though, so it's possible I missed quite a few. That last commit is **_massive_**. There were nearly 700 types to update. So it's recommended to review the first three before moving onto that last one. Additionally, I can break the last commit off into its own PR or into smaller PRs, but I figured this would be the easiest way of doing it (and in a timely manner since I unfortunately don't have as much time as I used to for code contributions). ## Testing You can test locally with a `cargo check`: ``` cargo check --workspace --all-features ```
72 lines
2.1 KiB
Rust
72 lines
2.1 KiB
Rust
use bevy_ecs::{component::Component, reflect::ReflectComponent};
|
|
use bevy_math::Vec2;
|
|
use bevy_reflect::{std_traits::ReflectDefault, Reflect};
|
|
|
|
/// The maximum width and height of text. The text will wrap according to the specified size.
|
|
///
|
|
/// Characters out of the bounds after wrapping will be truncated. Text is aligned according to the
|
|
/// specified [`JustifyText`](crate::text::JustifyText).
|
|
///
|
|
/// Note: only characters that are completely out of the bounds will be truncated, so this is not a
|
|
/// reliable limit if it is necessary to contain the text strictly in the bounds. Currently this
|
|
/// component is mainly useful for text wrapping only.
|
|
#[derive(Component, Copy, Clone, Debug, Reflect)]
|
|
#[reflect(Component, Default, Debug, Clone)]
|
|
pub struct TextBounds {
|
|
/// The maximum width of text in logical pixels.
|
|
/// If `None`, the width is unbounded.
|
|
pub width: Option<f32>,
|
|
/// The maximum height of text in logical pixels.
|
|
/// If `None`, the height is unbounded.
|
|
pub height: Option<f32>,
|
|
}
|
|
|
|
impl Default for TextBounds {
|
|
#[inline]
|
|
fn default() -> Self {
|
|
Self::UNBOUNDED
|
|
}
|
|
}
|
|
|
|
impl TextBounds {
|
|
/// Unbounded text will not be truncated or wrapped.
|
|
pub const UNBOUNDED: Self = Self {
|
|
width: None,
|
|
height: None,
|
|
};
|
|
|
|
/// Creates a new `TextBounds`, bounded with the specified width and height values.
|
|
#[inline]
|
|
pub const fn new(width: f32, height: f32) -> Self {
|
|
Self {
|
|
width: Some(width),
|
|
height: Some(height),
|
|
}
|
|
}
|
|
|
|
/// Creates a new `TextBounds`, bounded with the specified width value and unbounded on height.
|
|
#[inline]
|
|
pub const fn new_horizontal(width: f32) -> Self {
|
|
Self {
|
|
width: Some(width),
|
|
height: None,
|
|
}
|
|
}
|
|
|
|
/// Creates a new `TextBounds`, bounded with the specified height value and unbounded on width.
|
|
#[inline]
|
|
pub const fn new_vertical(height: f32) -> Self {
|
|
Self {
|
|
width: None,
|
|
height: Some(height),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl From<Vec2> for TextBounds {
|
|
#[inline]
|
|
fn from(v: Vec2) -> Self {
|
|
Self::new(v.x, v.y)
|
|
}
|
|
}
|