spottedcat 0.3.9

Rusty SpottedCat simple game engine
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

use crate::with_graphics;

/// Handle to a 3D model resource.
///
/// Models are collection of meshes and materials that can be rendered in 3D space.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub struct Material {
    pub albedo: Option<u32>,
    pub pbr: Option<u32>, // Metallic (B) / Roughness (G)
    pub normal: Option<u32>,
    pub occlusion: Option<u32>,
    pub emissive: Option<u32>,
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Model {
    pub(crate) id: u32,
    pub(crate) material: Material,
}

impl Model {
    pub fn id(&self) -> u32 {
        self.id
    }

    /// Creates a new model from vertex and index data.
    pub fn new(vertices: &[Vertex], indices: &[u32]) -> anyhow::Result<Self> {
        with_graphics(|g| g.create_model(vertices, indices))
            .ok_or_else(|| anyhow::anyhow!("Graphics not initialized"))?
    }

    /// Sets the albedo material (texture) for this model.
    pub fn with_material(mut self, image: crate::Image) -> Self {
        self.material.albedo = Some(image.id());
        self
    }

    pub fn with_albedo(mut self, image: crate::Image) -> Self {
        self.material.albedo = Some(image.id());
        self
    }

    pub fn with_normal_map(mut self, image: crate::Image) -> Self {
        self.material.normal = Some(image.id());
        self
    }

    pub fn with_pbr_map(mut self, image: crate::Image) -> Self {
        self.material.pbr = Some(image.id());
        self
    }

    pub fn with_ao_map(mut self, image: crate::Image) -> Self {
        self.material.occlusion = Some(image.id());
        self
    }

    pub fn with_emissive_map(mut self, image: crate::Image) -> Self {
        self.material.emissive = Some(image.id());
        self
    }

    /// Creates a simple cube model with the specified size.
    pub fn cube(size: f32) -> anyhow::Result<Self> {
        let s = size / 2.0;
        let vertices = vec![
            // Front face
            Vertex { pos: [-s, -s,  s], uv: [0.0, 1.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s, -s,  s], uv: [1.0, 1.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s,  s,  s], uv: [1.0, 0.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s,  s,  s], uv: [0.0, 0.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s, -s, -s], uv: [1.0, 1.0], normal: [0.0, 0.0, -1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s,  s, -s], uv: [1.0, 0.0], normal: [0.0, 0.0, -1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s,  s, -s], uv: [0.0, 0.0], normal: [0.0, 0.0, -1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s, -s, -s], uv: [0.0, 1.0], normal: [0.0, 0.0, -1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s,  s, -s], uv: [0.0, 0.0], normal: [0.0, 1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s,  s,  s], uv: [0.0, 1.0], normal: [0.0, 1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s,  s,  s], uv: [1.0, 1.0], normal: [0.0, 1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s,  s, -s], uv: [1.0, 0.0], normal: [0.0, 1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s, -s, -s], uv: [1.0, 1.0], normal: [0.0, -1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s, -s, -s], uv: [0.0, 1.0], normal: [0.0, -1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s, -s,  s], uv: [0.0, 0.0], normal: [0.0, -1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s, -s,  s], uv: [1.0, 0.0], normal: [0.0, -1.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s, -s, -s], uv: [1.0, 1.0], normal: [1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s,  s, -s], uv: [1.0, 0.0], normal: [1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s,  s,  s], uv: [0.0, 0.0], normal: [1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ s, -s,  s], uv: [0.0, 1.0], normal: [1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s, -s, -s], uv: [0.0, 1.0], normal: [-1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s, -s,  s], uv: [1.0, 1.0], normal: [-1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s,  s,  s], uv: [1.0, 0.0], normal: [-1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-s,  s, -s], uv: [0.0, 0.0], normal: [-1.0, 0.0, 0.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
        ];

        let indices = vec![
            0, 1, 2,  0, 2, 3,    // Front
            4, 5, 6,  4, 6, 7,    // Back
            8, 9, 10, 8, 10, 11,  // Top
            12, 13, 14, 12, 14, 15, // Bottom
            16, 17, 18, 16, 18, 19, // Right
            20, 21, 22, 20, 22, 23, // Left
        ];

        let mut model = Self::new(&vertices, &indices)?;
        model.material = Material::default();
        Ok(model)
    }

    /// Creates a 2D plane model in 3D space, facing +Z. Good for billboards or ground planes.
    pub fn plane(width: f32, height: f32) -> anyhow::Result<Self> {
        let hw = width / 2.0;
        let hh = height / 2.0;
        
        // Vertices face +Z direction
        let vertices = vec![
            Vertex { pos: [-hw, -hh, 0.0], uv: [0.0, 1.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ hw, -hh, 0.0], uv: [1.0, 1.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [ hw,  hh, 0.0], uv: [1.0, 0.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
            Vertex { pos: [-hw,  hh, 0.0], uv: [0.0, 0.0], normal: [0.0, 0.0, 1.0], joint_indices: [0; 4], joint_weights: [0.0; 4] },
        ];

        let indices = vec![0, 1, 2, 0, 2, 3];

        let mut model = Self::new(&vertices, &indices)?;
        model.material = Material::default();
        Ok(model)
    }

    /// Creates a UV sphere model with the specified radius.
    pub fn sphere(radius: f32) -> anyhow::Result<Self> {
        let segments = 32;
        let rings = 16;
        let mut vertices = Vec::new();
        let mut indices = Vec::new();

        for y in 0..=rings {
            let phi = y as f32 * std::f32::consts::PI / rings as f32;
            for x in 0..=segments {
                let theta = x as f32 * 2.0 * std::f32::consts::PI / segments as f32;

                let nx = phi.sin() * theta.cos();
                let ny = phi.cos();
                let nz = phi.sin() * theta.sin();

                vertices.push(Vertex {
                    pos: [radius * nx, radius * ny, radius * nz],
                    uv: [x as f32 / segments as f32, y as f32 / rings as f32],
                    normal: [nx, ny, nz],
                    joint_indices: [0; 4],
                    joint_weights: [0.0; 4],
                });
            }
        }

        for y in 0..rings {
            for x in 0..segments {
                let first = y * (segments + 1) + x;
                let second = first + segments + 1;

                indices.push(first);
                indices.push(first + 1);
                indices.push(second);

                indices.push(second);
                indices.push(first + 1);
                indices.push(second + 1);
            }
        }

        let mut model = Self::new(&vertices, &indices)?;
        model.material = Material::default();
        Ok(model)
    }

    pub fn draw(&self, context: &mut crate::Context, options: crate::DrawOption3D) {
        context.push_3d(crate::drawable::DrawCommand3D::Model(
            *self,
            options,
            0,
            crate::ShaderOpts::default(),
            None,
        ));
    }

    pub fn draw_skinned(
        &self,
        context: &mut crate::Context,
        options: crate::DrawOption3D,
        skin_id: u32,
    ) {
        context.push_3d(crate::drawable::DrawCommand3D::Model(
            *self,
            options,
            0,
            crate::ShaderOpts::default(),
            Some(skin_id),
        ));
    }

    pub fn draw_with_shader(
        &self,
        context: &mut crate::Context,
        shader_id: u32,
        options: crate::DrawOption3D,
        shader_opts: crate::ShaderOpts,
        skin_id: Option<u32>,
    ) {
        context.push_3d(crate::drawable::DrawCommand3D::Model(
            *self,
            options,
            shader_id,
            shader_opts,
            skin_id,
        ));
    }

    /// Renders thousands of instances of this model with a single draw call.
    /// 
    /// `transforms` should be an array of 4x4 matrices representing the View/Model transformations
    /// for each instance. This achieves massive performance improvements for identical meshes.
    pub fn draw_instanced(
        &self,
        context: &mut crate::Context,
        options: crate::DrawOption3D,
        transforms: &[[[f32; 4]; 4]],
    ) {
        if transforms.is_empty() { return; }
        context.push_3d(crate::drawable::DrawCommand3D::ModelInstanced(
            *self,
            options,
            0,
            crate::ShaderOpts::default(),
            None,
            transforms.to_vec(),
        ));
    }
}

#[repr(C)]
#[derive(Debug, Clone, Copy, bytemuck::Pod, bytemuck::Zeroable)]
pub struct Vertex {
    pub pos: [f32; 3],
    pub uv: [f32; 2],
    pub normal: [f32; 3],
    pub joint_indices: [u32; 4],
    pub joint_weights: [f32; 4],
}

impl Vertex {
    pub(crate) fn layout() -> wgpu::VertexBufferLayout<'static> {
        wgpu::VertexBufferLayout {
            array_stride: std::mem::size_of::<Vertex>() as wgpu::BufferAddress,
            step_mode: wgpu::VertexStepMode::Vertex,
            attributes: &[
                wgpu::VertexAttribute {
                    offset: 0,
                    shader_location: 0,
                    format: wgpu::VertexFormat::Float32x3,
                },
                wgpu::VertexAttribute {
                    offset: 12, // 3 * 4
                    shader_location: 1,
                    format: wgpu::VertexFormat::Float32x2,
                },
                wgpu::VertexAttribute {
                    offset: 20, // (3 + 2) * 4
                    shader_location: 2,
                    format: wgpu::VertexFormat::Float32x3,
                },
                wgpu::VertexAttribute {
                    offset: 32, // (3 + 2 + 3) * 4
                    shader_location: 3,
                    format: wgpu::VertexFormat::Uint32x4,
                },
                wgpu::VertexAttribute {
                    offset: 48, // (3 + 2 + 3 + 4) * 4
                    shader_location: 4,
                    format: wgpu::VertexFormat::Float32x4,
                },
            ],
        }
    }
}