concinnity-core 0.19.0

Runtime vocabulary for the Concinnity engine: GPU layouts, ECS components, registry, CPU kernels
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

// Multi-mesh model schema.

use crate::ecs::MaterialHandle;
use crate::ecs::MeshHandle;
use crate::ecs::asset_id::AssetId;
use crate::ecs::de_opt_material_handle;
use crate::ecs::de_opt_mesh_handle;
use alloc::vec::Vec;

/// One geometric part of a Model, referencing a mesh and its surface material.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct SubMeshRef {
    /// A [Mesh](#mesh) or [ProceduralMesh](#proceduralmesh) asset.
    #[serde(default, deserialize_with = "de_opt_mesh_handle")]
    pub mesh: Option<MeshHandle>,
    /// A [Material](#material) asset.  `None` uses the default material.
    #[serde(default, deserialize_with = "de_opt_material_handle")]
    pub material: Option<MaterialHandle>,
}

/// An ordered list of sub-meshes, each with its own material.
///
/// Use via the `model` field on a [Prop](#prop) instead of `mesh`. Each
/// sub-mesh is drawn with its own material, all sharing the prop's transform.
///
/// Each `mesh` must name a [Mesh](#mesh) or [ProceduralMesh](#proceduralmesh)
/// asset present in the scene. `material` may be empty to use the default
/// material.
#[derive(Debug, Default, Clone, serde::Serialize, serde::Deserialize)]
#[serde(default)]
pub struct Model {
    /// Asset identity; injected via `inject_name`. Not part of `args`.
    #[serde(skip)]
    pub asset_id: AssetId,
    /// Ordered list of sub-meshes that make up this model.
    pub meshes: Vec<SubMeshRef>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn a_blank_model_has_no_sub_meshes() {
        let m = Model::default();
        assert!(m.meshes.is_empty());
        assert_eq!(m.asset_id, AssetId::default());
    }

    #[test]
    fn a_sub_mesh_may_declare_geometry_without_a_material() {
        crate::test_support::install_resolvers();
        let s: SubMeshRef = serde_json::from_str(r#"{"mesh":"body"}"#).unwrap();
        assert_eq!(s.mesh, Some(MeshHandle(4)));
        // No material means the sub-mesh inherits whatever the prop supplies.
        assert_eq!(s.material, None);
        let s: SubMeshRef = serde_json::from_str("{}").unwrap();
        assert_eq!(s.mesh, None);
        assert_eq!(s.material, None);
    }

    #[test]
    fn an_imported_model_keeps_its_sub_mesh_order_through_postcard() {
        crate::test_support::install_resolvers();
        let m: Model = serde_json::from_str(
            r#"{"meshes":[{"mesh":"body","material":"skin"},
                         {"mesh":"trim","material":"metal"}]}"#,
        )
        .unwrap();
        assert_eq!(m.meshes.len(), 2);

        let bytes = postcard::to_allocvec(&m).unwrap();
        let back: Model = postcard::from_bytes(&bytes).unwrap();
        assert_eq!(back.meshes[0].mesh, Some(MeshHandle(4)));
        assert_eq!(back.meshes[0].material, Some(MaterialHandle(4)));
        assert_eq!(back.meshes[1].mesh, Some(MeshHandle(4)));
        assert_eq!(back.meshes[1].material, Some(MaterialHandle(5)));
        assert_eq!(back.asset_id, AssetId::default());
    }
}