Skip to main content

bevy_feathers/
font_styles.rs

1//! A framework for inheritable font styles.
2use bevy_app::{Propagate, PropagateOver};
3use bevy_asset::Handle;
4use bevy_ecs::{
5    component::Component,
6    lifecycle::Insert,
7    observer::On,
8    reflect::ReflectComponent,
9    system::{Commands, Query},
10    template::FromTemplate,
11};
12use bevy_reflect::{prelude::ReflectDefault, Reflect};
13use bevy_text::{Font, FontSize, FontWeight, TextFont};
14
15use crate::theme::ThemedText;
16
17/// A component which, when inserted on an entity, will load the given font and propagate it
18/// downward to any child text entity that has the [`ThemedText`] marker.
19#[derive(#[doc =
"**Required Components**: [`ThemedText`], [`PropagateOver :: < TextFont >`]. \n\n A component's Required Components are inserted whenever it is inserted. Note that this will also insert the required components _of_ the required components, recursively, in depth-first order."]
impl bevy_ecs::component::Component for InheritableFont where
    Self: ::core::marker::Send + ::core::marker::Sync + 'static {
    const STORAGE_TYPE: bevy_ecs::component::StorageType =
        bevy_ecs::component::StorageType::Table;
    type Mutability = bevy_ecs::component::Mutable;
    fn register_required_components(_requiree:
            bevy_ecs::component::ComponentId,
        required_components:
            &mut bevy_ecs::component::RequiredComponentsRegistrator) {
        required_components.register_required::<ThemedText>(<ThemedText as
                ::core::default::Default>::default);
        required_components.register_required::<PropagateOver<TextFont>>(<PropagateOver<TextFont>
                as ::core::default::Default>::default);
    }
    fn clone_behavior() -> bevy_ecs::component::ComponentCloneBehavior {
        use bevy_ecs::component::{
            DefaultCloneBehaviorBase, DefaultCloneBehaviorViaClone,
        };
        (&&&bevy_ecs::component::DefaultCloneBehaviorSpecialization::<Self>::default()).default_clone_behavior()
    }
    fn relationship_accessor()
        ->
            ::core::option::Option<bevy_ecs::relationship::ComponentRelationshipAccessor<Self>> {
        ::core::option::Option::None
    }
}Component, #[automatically_derived]
impl ::core::default::Default for InheritableFont {
    #[inline]
    fn default() -> InheritableFont {
        InheritableFont {
            font: ::core::default::Default::default(),
            font_size: ::core::default::Default::default(),
            weight: ::core::default::Default::default(),
        }
    }
}Default, #[automatically_derived]
impl ::core::clone::Clone for InheritableFont {
    #[inline]
    fn clone(&self) -> InheritableFont {
        InheritableFont {
            font: ::core::clone::Clone::clone(&self.font),
            font_size: ::core::clone::Clone::clone(&self.font_size),
            weight: ::core::clone::Clone::clone(&self.weight),
        }
    }
}Clone, #[automatically_derived]
impl ::core::fmt::Debug for InheritableFont {
    #[inline]
    fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
        ::core::fmt::Formatter::debug_struct_field3_finish(f,
            "InheritableFont", "font", &self.font, "font_size",
            &self.font_size, "weight", &&self.weight)
    }
}Debug, const _: () =
    {
        impl bevy_reflect::GetTypeRegistration for InheritableFont where  {
            fn get_type_registration() -> bevy_reflect::TypeRegistration {
                let mut registration =
                    bevy_reflect::TypeRegistration::of::<Self>();
                registration.insert::<bevy_reflect::ReflectFromPtr>(bevy_reflect::FromType::<Self>::from_type());
                registration.insert::<bevy_reflect::ReflectFromReflect>(bevy_reflect::FromType::<Self>::from_type());
                registration.register_type_data::<ReflectComponent, Self>();
                registration.register_type_data::<ReflectDefault, Self>();
                registration
            }
            #[inline(never)]
            fn register_type_dependencies(registry:
                    &mut bevy_reflect::TypeRegistry) {
                <Handle<Font> as
                        bevy_reflect::__macro_exports::RegisterForReflection>::__register(registry);
                <FontSize as
                        bevy_reflect::__macro_exports::RegisterForReflection>::__register(registry);
                <FontWeight as
                        bevy_reflect::__macro_exports::RegisterForReflection>::__register(registry);
            }
        }
        impl bevy_reflect::Typed for InheritableFont where  {
            #[inline]
            fn type_info() -> &'static bevy_reflect::TypeInfo {
                static CELL: bevy_reflect::utility::NonGenericTypeInfoCell =
                    bevy_reflect::utility::NonGenericTypeInfoCell::new();
                CELL.get_or_set(||
                        {
                            bevy_reflect::TypeInfo::Struct(bevy_reflect::structs::StructInfo::new::<Self>(&[bevy_reflect::NamedField::new::<Handle<Font>>("font"),
                                                bevy_reflect::NamedField::new::<FontSize>("font_size"),
                                                bevy_reflect::NamedField::new::<FontWeight>("weight")]))
                        })
            }
        }
        #[allow(deprecated, reason =
        "derives on a deprecated type shouldn't be considered a usage")]
        impl bevy_reflect::TypePath for InheritableFont where  {
            fn type_path() -> &'static str {
                "bevy_feathers::font_styles::InheritableFont"
            }
            fn short_type_path() -> &'static str { "InheritableFont" }
            fn type_ident() -> ::core::option::Option<&'static str> {
                ::core::option::Option::Some("InheritableFont")
            }
            fn crate_name() -> ::core::option::Option<&'static str> {
                ::core::option::Option::Some("bevy_feathers::font_styles".split(':').next().unwrap())
            }
            fn module_path() -> ::core::option::Option<&'static str> {
                ::core::option::Option::Some("bevy_feathers::font_styles")
            }
        }
        impl bevy_reflect::Reflect for InheritableFont where  {
            #[inline]
            fn into_any(self:
                    bevy_reflect::__macro_exports::alloc_utils::Box<Self>)
                ->
                    bevy_reflect::__macro_exports::alloc_utils::Box<dyn ::core::any::Any> {
                self
            }
            #[inline]
            fn as_any(&self) -> &dyn ::core::any::Any { self }
            #[inline]
            fn as_any_mut(&mut self) -> &mut dyn ::core::any::Any { self }
            #[inline]
            fn into_reflect(self:
                    bevy_reflect::__macro_exports::alloc_utils::Box<Self>)
                ->
                    bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::Reflect> {
                self
            }
            #[inline]
            fn as_reflect(&self) -> &dyn bevy_reflect::Reflect { self }
            #[inline]
            fn as_reflect_mut(&mut self) -> &mut dyn bevy_reflect::Reflect {
                self
            }
            #[inline]
            fn set(&mut self,
                value:
                    bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::Reflect>)
                ->
                    ::core::result::Result<(),
                    bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::Reflect>> {
                *self = <dyn bevy_reflect::Reflect>::take(value)?;
                ::core::result::Result::Ok(())
            }
        }
        #[allow(non_upper_case_globals)]
        const _: () =
            {
                static __INVENTORY: ::inventory::Node =
                    ::inventory::Node {
                        value: &{
                                bevy_reflect::__macro_exports::auto_register::AutomaticReflectRegistrations(<InheritableFont
                                        as
                                        bevy_reflect::__macro_exports::auto_register::RegisterForReflection>::__register)
                            },
                        next: ::inventory::__private::UnsafeCell::new(::inventory::__private::Option::None),
                    };
                #[link_section = ".text.startup"]
                unsafe extern "C" fn __ctor() {
                    unsafe {
                        ::inventory::ErasedNode::submit(__INVENTORY.value,
                            &__INVENTORY)
                    }
                }
                #[used]
                #[link_section = ".init_array"]
                static __CTOR: unsafe extern "C" fn() = __ctor;
            };
        impl bevy_reflect::structs::Struct for InheritableFont where  {
            fn field(&self, name: &str)
                -> ::core::option::Option<&dyn bevy_reflect::PartialReflect> {
                match name {
                    "font" => ::core::option::Option::Some(&self.font),
                    "font_size" =>
                        ::core::option::Option::Some(&self.font_size),
                    "weight" => ::core::option::Option::Some(&self.weight),
                    _ => ::core::option::Option::None,
                }
            }
            fn field_mut(&mut self, name: &str)
                ->
                    ::core::option::Option<&mut dyn bevy_reflect::PartialReflect> {
                match name {
                    "font" => ::core::option::Option::Some(&mut self.font),
                    "font_size" =>
                        ::core::option::Option::Some(&mut self.font_size),
                    "weight" => ::core::option::Option::Some(&mut self.weight),
                    _ => ::core::option::Option::None,
                }
            }
            fn field_at(&self, index: usize)
                -> ::core::option::Option<&dyn bevy_reflect::PartialReflect> {
                match index {
                    0usize => ::core::option::Option::Some(&self.font),
                    1usize => ::core::option::Option::Some(&self.font_size),
                    2usize => ::core::option::Option::Some(&self.weight),
                    _ => ::core::option::Option::None,
                }
            }
            fn field_at_mut(&mut self, index: usize)
                ->
                    ::core::option::Option<&mut dyn bevy_reflect::PartialReflect> {
                match index {
                    0usize => ::core::option::Option::Some(&mut self.font),
                    1usize => ::core::option::Option::Some(&mut self.font_size),
                    2usize => ::core::option::Option::Some(&mut self.weight),
                    _ => ::core::option::Option::None,
                }
            }
            fn name_at(&self, index: usize) -> ::core::option::Option<&str> {
                match index {
                    0usize => ::core::option::Option::Some("font"),
                    1usize => ::core::option::Option::Some("font_size"),
                    2usize => ::core::option::Option::Some("weight"),
                    _ => ::core::option::Option::None,
                }
            }
            fn index_of_name(&self, name: &str)
                -> ::core::option::Option<usize> {
                match name {
                    "font" => ::core::option::Option::Some(0usize),
                    "font_size" => ::core::option::Option::Some(1usize),
                    "weight" => ::core::option::Option::Some(2usize),
                    _ => ::core::option::Option::None,
                }
            }
            fn field_len(&self) -> usize { 3usize }
            fn iter_fields(&self) -> bevy_reflect::structs::FieldIter {
                bevy_reflect::structs::FieldIter::new(self)
            }
            fn to_dynamic_struct(&self)
                -> bevy_reflect::structs::DynamicStruct {
                let mut dynamic: bevy_reflect::structs::DynamicStruct =
                    ::core::default::Default::default();
                dynamic.set_represented_type(bevy_reflect::PartialReflect::get_represented_type_info(self));
                dynamic.insert_boxed("font",
                    bevy_reflect::PartialReflect::to_dynamic(&self.font));
                dynamic.insert_boxed("font_size",
                    bevy_reflect::PartialReflect::to_dynamic(&self.font_size));
                dynamic.insert_boxed("weight",
                    bevy_reflect::PartialReflect::to_dynamic(&self.weight));
                dynamic
            }
        }
        impl bevy_reflect::PartialReflect for InheritableFont where  {
            #[inline]
            fn get_represented_type_info(&self)
                -> ::core::option::Option<&'static bevy_reflect::TypeInfo> {
                ::core::option::Option::Some(<Self as
                            bevy_reflect::Typed>::type_info())
            }
            #[inline]
            fn try_apply(&mut self, value: &dyn bevy_reflect::PartialReflect)
                -> ::core::result::Result<(), bevy_reflect::ApplyError> {
                if let bevy_reflect::ReflectRef::Struct(struct_value) =
                        bevy_reflect::PartialReflect::reflect_ref(value) {
                    for (name, value) in
                        bevy_reflect::structs::Struct::iter_fields(struct_value) {
                        if let ::core::option::Option::Some(v) =
                                bevy_reflect::structs::Struct::field_mut(self, name) {
                            bevy_reflect::PartialReflect::try_apply(v, value)?;
                        }
                    }
                } else {
                    return ::core::result::Result::Err(bevy_reflect::ApplyError::MismatchedKinds {
                                from_kind: bevy_reflect::PartialReflect::reflect_kind(value),
                                to_kind: bevy_reflect::ReflectKind::Struct,
                            });
                }
                ::core::result::Result::Ok(())
            }
            #[inline]
            fn reflect_kind(&self) -> bevy_reflect::ReflectKind {
                bevy_reflect::ReflectKind::Struct
            }
            #[inline]
            fn reflect_ref(&self) -> bevy_reflect::ReflectRef {
                bevy_reflect::ReflectRef::Struct(self)
            }
            #[inline]
            fn reflect_mut(&mut self) -> bevy_reflect::ReflectMut {
                bevy_reflect::ReflectMut::Struct(self)
            }
            #[inline]
            fn reflect_owned(self:
                    bevy_reflect::__macro_exports::alloc_utils::Box<Self>)
                -> bevy_reflect::ReflectOwned {
                bevy_reflect::ReflectOwned::Struct(self)
            }
            #[inline]
            fn try_into_reflect(self:
                    bevy_reflect::__macro_exports::alloc_utils::Box<Self>)
                ->
                    ::core::result::Result<bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::Reflect>,
                    bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::PartialReflect>> {
                ::core::result::Result::Ok(self)
            }
            #[inline]
            fn try_as_reflect(&self)
                -> ::core::option::Option<&dyn bevy_reflect::Reflect> {
                ::core::option::Option::Some(self)
            }
            #[inline]
            fn try_as_reflect_mut(&mut self)
                -> ::core::option::Option<&mut dyn bevy_reflect::Reflect> {
                ::core::option::Option::Some(self)
            }
            #[inline]
            fn into_partial_reflect(self:
                    bevy_reflect::__macro_exports::alloc_utils::Box<Self>)
                ->
                    bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::PartialReflect> {
                self
            }
            #[inline]
            fn as_partial_reflect(&self)
                -> &dyn bevy_reflect::PartialReflect {
                self
            }
            #[inline]
            fn as_partial_reflect_mut(&mut self)
                -> &mut dyn bevy_reflect::PartialReflect {
                self
            }
            fn reflect_partial_eq(&self,
                value: &dyn bevy_reflect::PartialReflect)
                -> ::core::option::Option<bool> {
                (bevy_reflect::structs::struct_partial_eq)(self, value)
            }
            fn reflect_partial_cmp(&self,
                value: &dyn bevy_reflect::PartialReflect)
                -> ::core::option::Option<::core::cmp::Ordering> {
                (bevy_reflect::structs::struct_partial_cmp)(self, value)
            }
            #[inline]
            #[allow(unreachable_code, reason =
            "Ignored fields without a `clone` attribute will early-return with an error")]
            fn reflect_clone(&self)
                ->
                    ::core::result::Result<bevy_reflect::__macro_exports::alloc_utils::Box<dyn bevy_reflect::Reflect>,
                    bevy_reflect::ReflectCloneError> {
                ::core::result::Result::Ok(bevy_reflect::__macro_exports::alloc_utils::Box::new(Self {
                            font: <Handle<Font> as
                                        bevy_reflect::PartialReflect>::reflect_clone_and_take(&self.font)?,
                            font_size: <FontSize as
                                        bevy_reflect::PartialReflect>::reflect_clone_and_take(&self.font_size)?,
                            weight: <FontWeight as
                                        bevy_reflect::PartialReflect>::reflect_clone_and_take(&self.weight)?,
                        }))
            }
        }
        impl bevy_reflect::FromReflect for InheritableFont where  {
            fn from_reflect(reflect: &dyn bevy_reflect::PartialReflect)
                -> ::core::option::Option<Self> {
                if let bevy_reflect::ReflectRef::Struct(__ref_struct) =
                        bevy_reflect::PartialReflect::reflect_ref(reflect) {
                    let mut __this =
                        <Self as ::core::default::Default>::default();
                    if let ::core::option::Option::Some(__field) =
                            (||
                                        <Handle<Font> as
                                                bevy_reflect::FromReflect>::from_reflect(bevy_reflect::structs::Struct::field(__ref_struct,
                                                    "font")?))() {
                        __this.font = __field;
                    }
                    if let ::core::option::Option::Some(__field) =
                            (||
                                        <FontSize as
                                                bevy_reflect::FromReflect>::from_reflect(bevy_reflect::structs::Struct::field(__ref_struct,
                                                    "font_size")?))() {
                        __this.font_size = __field;
                    }
                    if let ::core::option::Option::Some(__field) =
                            (||
                                        <FontWeight as
                                                bevy_reflect::FromReflect>::from_reflect(bevy_reflect::structs::Struct::field(__ref_struct,
                                                    "weight")?))() {
                        __this.weight = __field;
                    }
                    ::core::option::Option::Some(__this)
                } else { ::core::option::Option::None }
            }
        }
    };Reflect, impl ::core::default::Default for InheritableFontTemplate {
    fn default() -> Self {
        Self {
            font: ::core::default::Default::default(),
            font_size: ::core::default::Default::default(),
            weight: ::core::default::Default::default(),
        }
    }
}FromTemplate)]
20#[reflect(Component, Default)]
21#[require(ThemedText, PropagateOver::<TextFont>)]
22pub struct InheritableFont {
23    /// The font handle.
24    pub font: Handle<Font>,
25    /// The desired font size.
26    pub font_size: FontSize,
27    /// The desired font weight.
28    pub weight: FontWeight,
29}
30
31/// An observer which looks for changes to the [`InheritableFont`] component on an entity, and
32/// propagates downward the font to all participating text entities.
33pub(crate) fn on_changed_font(
34    insert: On<Insert, InheritableFont>,
35    font_style: Query<&InheritableFont>,
36    mut commands: Commands,
37) {
38    if let Ok(inheritable_font) = font_style.get(insert.entity) {
39        commands.entity(insert.entity).insert(Propagate(TextFont {
40            font: inheritable_font.font.clone().into(),
41            font_size: inheritable_font.font_size,
42            weight: inheritable_font.weight,
43            ..Default::default()
44        }));
45    }
46}