use std::ops::Range;
use super::SPRITE_LOD_LEVELS;
use common::{
assets,
terrain::{
sprite::{self, RelativeNeighborPosition},
Block, SpriteKind,
},
};
use hashbrown::HashMap;
use serde::Deserialize;
use vek::*;
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
pub(super) struct SpriteModelConfig {
pub model: String,
pub offset: (f32, f32, f32),
pub lod_axes: (f32, f32, f32),
}
macro_rules! impl_sprite_attribute_filter {
(
$($attr:ident $field_name:ident = |$filter_arg:ident: $filter_ty:ty, $value_arg:ident| $filter:block),+ $(,)?
) => {
#[derive(Debug, Clone, Deserialize, Default, PartialEq, Eq, Hash)]
#[serde(default, deny_unknown_fields)]
pub struct SpriteAttributeFilters {
$(
pub $field_name: Option<$filter_ty>,
)+
}
impl SpriteAttributeFilters {
fn matches_filter(&self, block: &Block) -> bool {
$(
self.$field_name.as_ref().map_or(true, |$filter_arg| {
block
.get_attr::<sprite::$attr>()
.map_or(false, |$value_arg| $filter)
})
)&&+
}
#[cfg(test)]
fn is_valid_for_category(&self, category: sprite::Category) -> Result<(), &'static str> {
$(if self.$field_name.is_some() && !category.has_attr::<sprite::$attr>() {
return Err(::std::any::type_name::<sprite::$attr>());
})*
Ok(())
}
fn no_filters(&self) -> bool {
true $(&& self.$field_name.is_none())+
}
}
};
}
impl_sprite_attribute_filter!(
Growth growth_stage = |filter: Range<u8>, growth| { filter.contains(&growth.0) },
LightEnabled light_enabled = |filter: bool, light_enabled| { *filter == light_enabled.0 },
Damage damage = |filter: Range<u8>, damage| { filter.contains(&damage.0) },
AdjacentType adjacent_type = |filter: RelativeNeighborPosition, adjacent_type| { (*filter as u8) == adjacent_type.0 },
SnowCovered snow_covered = |filter: bool, snow_covered| { *filter == snow_covered.0 },
);
#[derive(Deserialize, Debug)]
#[serde(deny_unknown_fields)]
struct SpriteConfig {
#[serde(default)]
filter: SpriteAttributeFilters,
#[serde(default)]
variations: Vec<SpriteModelConfig>,
#[serde(default)]
wind_sway: f32,
}
#[serde_with::serde_as]
#[derive(Deserialize)]
struct SpriteSpecRaw(
#[serde_as(as = "serde_with::MapPreventDuplicates<_, _>")]
HashMap<SpriteKind, Vec<SpriteConfig>>,
);
#[derive(Deserialize)]
#[serde(try_from = "SpriteSpecRaw")]
pub struct SpriteSpec(HashMap<SpriteKind, Vec<SpriteConfig>>);
struct SpritesMissing(Vec<SpriteKind>);
impl core::fmt::Display for SpritesMissing {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
writeln!(
f,
"Missing entries in the sprite manifest for these sprites: {:?}",
&self.0,
)
}
}
impl TryFrom<SpriteSpecRaw> for SpriteSpec {
type Error = SpritesMissing;
fn try_from(SpriteSpecRaw(map): SpriteSpecRaw) -> Result<Self, Self::Error> {
let sprites_missing = SpriteKind::all()
.iter()
.copied()
.filter(|kind| !map.contains_key(kind))
.collect::<Vec<_>>();
if sprites_missing.is_empty() {
Ok(Self(map))
} else {
Err(SpritesMissing(sprites_missing))
}
}
}
impl assets::Asset for SpriteSpec {
type Loader = assets::RonLoader;
const EXTENSION: &'static str = "ron";
}
impl SpriteSpec {
pub fn map_to_data(
&self,
mut map_variation: impl FnMut(&SpriteModelConfig) -> [SpriteModelData; super::SPRITE_LOD_LEVELS],
) -> HashMap<SpriteKind, FilteredSpriteData> {
let mut to_sprite_data = |config: &SpriteConfig| SpriteData {
variations: config.variations.iter().map(&mut map_variation).collect(),
wind_sway: config.wind_sway,
};
self.0
.iter()
.map(|(kind, config)| {
let filtered_data = match config.as_slice() {
[config] if config.filter.no_filters() => {
FilteredSpriteData::Unfiltered(to_sprite_data(config))
},
filtered_configs => {
let list = filtered_configs
.iter()
.map(|config| (config.filter.clone(), to_sprite_data(config)))
.collect::<Box<[_]>>();
FilteredSpriteData::Filtered(list)
},
};
(*kind, filtered_data)
})
.collect()
}
}
pub(in crate::scene) struct SpriteModelData {
pub vert_pages: core::ops::Range<u32>,
pub scale: Vec3<f32>,
pub offset: Vec3<f32>,
}
pub(in crate::scene) struct SpriteData {
pub variations: Box<[[SpriteModelData; SPRITE_LOD_LEVELS]]>,
pub wind_sway: f32,
}
pub(in crate::scene) enum FilteredSpriteData {
Unfiltered(SpriteData),
Filtered(Box<[(SpriteAttributeFilters, SpriteData)]>),
}
impl FilteredSpriteData {
pub fn for_block(&self, block: &Block) -> Option<&SpriteData> {
match self {
Self::Unfiltered(data) => Some(data),
Self::Filtered(multiple) => multiple
.iter()
.find_map(|(filter, data)| filter.matches_filter(block).then_some(data)),
}
}
}
#[cfg(test)]
mod test {
use super::SpriteSpec;
use common_assets::AssetExt;
#[test]
fn test_sprite_spec_valid() {
let spec = SpriteSpec::load_expect("voxygen.voxel.sprite_manifest").read();
for (sprite, filter) in spec.0.iter().flat_map(|(&sprite, configs)| {
configs.iter().map(move |config| (sprite, &config.filter))
}) {
if let Err(invalid_attribute) = filter.is_valid_for_category(sprite.category()) {
panic!(
"Sprite category '{:?}' does not have attribute '{}' (in sprite config for \
{:?})",
sprite.category(),
invalid_attribute,
sprite,
);
}
}
let mut empty_config = Vec::new();
for (kind, configs) in &spec.0 {
if configs.is_empty() {
empty_config.push(kind)
}
}
assert!(
empty_config.is_empty(),
"Sprite config(s) with no entries, if these sprite(s) are intended to have no models \
use an explicit entry with an empty `variations` list instead: {empty_config:?}",
);
}
}