mirror of
https://github.com/bevyengine/bevy
synced 2025-01-25 03:15:20 +00:00
1efc762924
# Objective
- Introduce a stable alternative to
[`std::any::type_name`](https://doc.rust-lang.org/std/any/fn.type_name.html).
- Rewrite of #5805 with heavy inspiration in design.
- On the path to #5830.
- Part of solving #3327.
## Solution
- Add a `TypePath` trait for static stable type path/name information.
- Add a `TypePath` derive macro.
- Add a `impl_type_path` macro for implementing internal and foreign
types in `bevy_reflect`.
---
## Changelog
- Added `TypePath` trait.
- Added `DynamicTypePath` trait and `get_type_path` method to `Reflect`.
- Added a `TypePath` derive macro.
- Added a `bevy_reflect::impl_type_path` for implementing `TypePath` on
internal and foreign types in `bevy_reflect`.
- Changed `bevy_reflect::utility::(Non)GenericTypeInfoCell` to
`(Non)GenericTypedCell<T>` which allows us to be generic over both
`TypeInfo` and `TypePath`.
- `TypePath` is now a supertrait of `Asset`, `Material` and
`Material2d`.
- `impl_reflect_struct` needs a `#[type_path = "..."]` attribute to be
specified.
- `impl_reflect_value` needs to either specify path starting with a
double colon (`::core::option::Option`) or an `in my_crate::foo`
declaration.
- Added `bevy_reflect_derive::ReflectTypePath`.
- Most uses of `Ident` in `bevy_reflect_derive` changed to use
`ReflectTypePath`.
## Migration Guide
- Implementors of `Asset`, `Material` and `Material2d` now also need to
derive `TypePath`.
- Manual implementors of `Reflect` will need to implement the new
`get_type_path` method.
## Open Questions
- [x] ~This PR currently does not migrate any usages of
`std::any::type_name` to use `bevy_reflect::TypePath` to ease the review
process. Should it?~ Migration will be left to a follow-up PR.
- [ ] This PR adds a lot of `#[derive(TypePath)]` and `T: TypePath` to
satisfy new bounds, mostly when deriving `TypeUuid`. Should we make
`TypePath` a supertrait of `TypeUuid`? [Should we remove `TypeUuid` in
favour of
`TypePath`?](2afbd85532 (r961067892)
)
136 lines
4.3 KiB
Rust
136 lines
4.3 KiB
Rust
use crate::{error::TextError, Font, FontAtlas};
|
|
use ab_glyph::{GlyphId, OutlinedGlyph, Point};
|
|
use bevy_asset::{Assets, Handle};
|
|
use bevy_math::Vec2;
|
|
use bevy_reflect::TypePath;
|
|
use bevy_reflect::TypeUuid;
|
|
use bevy_render::texture::Image;
|
|
use bevy_sprite::TextureAtlas;
|
|
use bevy_utils::FloatOrd;
|
|
use bevy_utils::HashMap;
|
|
|
|
type FontSizeKey = FloatOrd;
|
|
|
|
#[derive(TypeUuid, TypePath)]
|
|
#[uuid = "73ba778b-b6b5-4f45-982d-d21b6b86ace2"]
|
|
pub struct FontAtlasSet {
|
|
font_atlases: HashMap<FontSizeKey, Vec<FontAtlas>>,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct GlyphAtlasInfo {
|
|
pub texture_atlas: Handle<TextureAtlas>,
|
|
pub glyph_index: usize,
|
|
}
|
|
|
|
impl Default for FontAtlasSet {
|
|
fn default() -> Self {
|
|
FontAtlasSet {
|
|
font_atlases: HashMap::with_capacity_and_hasher(1, Default::default()),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl FontAtlasSet {
|
|
pub fn iter(&self) -> impl Iterator<Item = (&FontSizeKey, &Vec<FontAtlas>)> {
|
|
self.font_atlases.iter()
|
|
}
|
|
|
|
pub fn has_glyph(&self, glyph_id: GlyphId, glyph_position: Point, font_size: f32) -> bool {
|
|
self.font_atlases
|
|
.get(&FloatOrd(font_size))
|
|
.map_or(false, |font_atlas| {
|
|
font_atlas
|
|
.iter()
|
|
.any(|atlas| atlas.has_glyph(glyph_id, glyph_position.into()))
|
|
})
|
|
}
|
|
|
|
pub fn add_glyph_to_atlas(
|
|
&mut self,
|
|
texture_atlases: &mut Assets<TextureAtlas>,
|
|
textures: &mut Assets<Image>,
|
|
outlined_glyph: OutlinedGlyph,
|
|
) -> Result<GlyphAtlasInfo, TextError> {
|
|
let glyph = outlined_glyph.glyph();
|
|
let glyph_id = glyph.id;
|
|
let glyph_position = glyph.position;
|
|
let font_size = glyph.scale.y;
|
|
let font_atlases = self
|
|
.font_atlases
|
|
.entry(FloatOrd(font_size))
|
|
.or_insert_with(|| {
|
|
vec![FontAtlas::new(
|
|
textures,
|
|
texture_atlases,
|
|
Vec2::splat(512.0),
|
|
)]
|
|
});
|
|
|
|
let glyph_texture = Font::get_outlined_glyph_texture(outlined_glyph);
|
|
let add_char_to_font_atlas = |atlas: &mut FontAtlas| -> bool {
|
|
atlas.add_glyph(
|
|
textures,
|
|
texture_atlases,
|
|
glyph_id,
|
|
glyph_position.into(),
|
|
&glyph_texture,
|
|
)
|
|
};
|
|
if !font_atlases.iter_mut().any(add_char_to_font_atlas) {
|
|
// Find the largest dimension of the glyph, either its width or its height
|
|
let glyph_max_size: u32 = glyph_texture
|
|
.texture_descriptor
|
|
.size
|
|
.height
|
|
.max(glyph_texture.texture_descriptor.size.width);
|
|
// Pick the higher of 512 or the smallest power of 2 greater than glyph_max_size
|
|
let containing = (1u32 << (32 - glyph_max_size.leading_zeros())).max(512) as f32;
|
|
font_atlases.push(FontAtlas::new(
|
|
textures,
|
|
texture_atlases,
|
|
Vec2::new(containing, containing),
|
|
));
|
|
if !font_atlases.last_mut().unwrap().add_glyph(
|
|
textures,
|
|
texture_atlases,
|
|
glyph_id,
|
|
glyph_position.into(),
|
|
&glyph_texture,
|
|
) {
|
|
return Err(TextError::FailedToAddGlyph(glyph_id));
|
|
}
|
|
}
|
|
|
|
Ok(self
|
|
.get_glyph_atlas_info(font_size, glyph_id, glyph_position)
|
|
.unwrap())
|
|
}
|
|
|
|
pub fn get_glyph_atlas_info(
|
|
&mut self,
|
|
font_size: f32,
|
|
glyph_id: GlyphId,
|
|
position: Point,
|
|
) -> Option<GlyphAtlasInfo> {
|
|
self.font_atlases
|
|
.get(&FloatOrd(font_size))
|
|
.and_then(|font_atlases| {
|
|
font_atlases
|
|
.iter()
|
|
.find_map(|atlas| {
|
|
atlas
|
|
.get_glyph_index(glyph_id, position.into())
|
|
.map(|glyph_index| (glyph_index, atlas.texture_atlas.clone_weak()))
|
|
})
|
|
.map(|(glyph_index, texture_atlas)| GlyphAtlasInfo {
|
|
texture_atlas,
|
|
glyph_index,
|
|
})
|
|
})
|
|
}
|
|
|
|
pub fn num_font_atlases(&self) -> usize {
|
|
self.font_atlases.len()
|
|
}
|
|
}
|