Skip to main content

brep_render/
thumbnail.rs

1//! Part thumbnails: a small CPU rasterizer over the [`RenderScene`]'s display
2//! meshes, the one picture producer that runs the same on native, in the
3//! browser and in the headless bake worker (which has no GPU device at all).
4//!
5//! The picture is the ViewCube's ISO view (from +X+Y+Z, +Y up), orthographic,
6//! fit to what is drawn, square, on a transparent background: Lambert shading
7//! under a fixed light, a depth buffer, each body's viewport colour (a face's
8//! colour, else its solid's, else the name-hashed colour), and the display
9//! edges drawn over it. It is supersampled `SUPERSAMPLE`× per axis and
10//! averaged down, so silhouettes are anti-aliased.
11//!
12//! [`capture`] copies what the picture needs out of the scene (cheap, on the
13//! caller's thread); [`render_png`] does the rest and is `Send`-safe, so a
14//! native host can run it on a thread of its own. The PNG carries no text or
15//! time chunks: the same scene gives the same bytes.
16
17use crate::color::solid_color_srgb;
18use crate::scene::RenderScene;
19
20/// The renderer's version, stored beside each thumbnail on the server. Bump it
21/// whenever the picture for the same document would change, so a server can
22/// tell a thumbnail made by an older renderer.
23pub const RENDERER: &str = "brep-thumb/1";
24
25/// The default thumbnail edge, in pixels.
26pub const SIZE: u32 = 256;
27
28/// Samples per pixel per axis.
29const SUPERSAMPLE: u32 = 2;
30
31/// The fraction of the picture the model's projected extent fills.
32const FILL: f64 = 0.9;
33
34/// Edge colour (sRGB 0..1).
35const EDGE: [f32; 3] = [0.10, 0.11, 0.13];
36
37/// One body's triangles, ready to draw.
38#[derive(Debug, Clone, Default)]
39pub struct Body {
40    pub positions: Vec<[f32; 3]>,
41    pub normals: Vec<[f32; 3]>,
42    pub indices: Vec<u32>,
43    /// sRGB colour per triangle.
44    pub colors: Vec<[f32; 3]>,
45    /// World polylines of the body's display edges.
46    pub edges: Vec<Vec<[f32; 3]>>,
47}
48
49/// What [`render_png`] draws: an owned copy of the visible scene.
50#[derive(Debug, Clone, Default)]
51pub struct Capture {
52    pub bodies: Vec<Body>,
53}
54
55impl Capture {
56    pub fn triangles(&self) -> usize {
57        self.bodies.iter().map(|b| b.indices.len() / 3).sum()
58    }
59
60    pub fn is_empty(&self) -> bool {
61        self.triangles() == 0
62    }
63}
64
65/// Copy the visible bodies out of `scene`: every visible solid and committed
66/// sketch sheet, hidden faces left out, in the viewport's colours.
67pub fn capture(scene: &RenderScene) -> Capture {
68    Capture { bodies: scene.solids().iter().filter(|s| s.visible).filter_map(body_of).collect() }
69}
70
71/// One display's body as [`capture`] copies it, whatever its visibility:
72/// hidden faces left out, in the viewport's colours. `None` when no face is
73/// left to draw.
74pub fn body_of(solid: &crate::scene::SolidDisplay) -> Option<Body> {
75    let mesh = &solid.mesh;
76    let base = solid.color_override.unwrap_or_else(|| solid_color_srgb(&solid.name).map(|c| c as f32));
77    let mut body = Body { positions: mesh.positions.clone(), normals: mesh.normals.clone(), ..Body::default() };
78    for (tri, idx) in mesh.indices.chunks_exact(3).enumerate() {
79        let face_index = mesh.face_ids.get(tri).map(|&f| f as usize);
80        if face_index.is_some_and(|f| !solid.visibility.is_face_visible(f)) {
81            continue;
82        }
83        let face = face_index.and_then(|f| solid.faces.get(f));
84        body.indices.extend_from_slice(idx);
85        body.colors.push(face.and_then(|f| f.color_override).unwrap_or(base));
86    }
87    body.edges = solid
88        .edges
89        .iter()
90        .enumerate()
91        .filter(|(i, e)| !e.centerline && solid.visibility.is_edge_visible(*i))
92        .map(|(_, e)| e.polyline.clone())
93        .collect();
94    (!body.indices.is_empty()).then_some(body)
95}
96
97/// A view's orthonormal basis: right, up, and the direction from the model
98/// toward the eye.
99pub type Basis = ([f64; 3], [f64; 3], [f64; 3]);
100
101/// The ISO view's orthonormal basis: right, up, and the direction from the
102/// model toward the eye.
103fn iso_basis() -> Basis {
104    let k = 1.0 / 3f64.sqrt();
105    let back = [k, k, k];
106    let up_world = [0.0, 1.0, 0.0];
107    let right = normalize(cross(up_world, back));
108    let up = cross(back, right);
109    (right, up, back)
110}
111
112use crate::geometry3d::cross3 as cross;
113
114use crate::geometry3d::dot3 as dot;
115
116fn normalize(v: [f64; 3]) -> [f64; 3] {
117    let n = dot(v, v).sqrt();
118    if n > 0.0 { [v[0] / n, v[1] / n, v[2] / n] } else { v }
119}
120
121fn f64s(p: [f32; 3]) -> [f64; 3] {
122    [p[0] as f64, p[1] as f64, p[2] as f64]
123}
124
125/// World → the supersampled raster: `(x, y, depth)`, x right, y down, depth
126/// growing away from the eye.
127struct Projection {
128    right: [f64; 3],
129    up: [f64; 3],
130    back: [f64; 3],
131    center: [f64; 3],
132    scale: f64,
133    half: f64,
134}
135
136impl Projection {
137    fn fit(capture: &Capture, pixels: u32, (right, up, back): Basis) -> Self {
138        // Fit the projected extent of every vertex, not the bbox's corners, so
139        // a long thin part fills the picture.
140        let (mut lo, mut hi) = ([f64::INFINITY; 2], [f64::NEG_INFINITY; 2]);
141        for body in &capture.bodies {
142            for &i in &body.indices {
143                let p = f64s(body.positions[i as usize]);
144                let (x, y) = (dot(p, right), dot(p, up));
145                lo = [lo[0].min(x), lo[1].min(y)];
146                hi = [hi[0].max(x), hi[1].max(y)];
147            }
148        }
149        let extent = (hi[0] - lo[0]).max(hi[1] - lo[1]).max(1e-12);
150        let mid = [(lo[0] + hi[0]) * 0.5, (lo[1] + hi[1]) * 0.5];
151        let center = [
152            right[0] * mid[0] + up[0] * mid[1],
153            right[1] * mid[0] + up[1] * mid[1],
154            right[2] * mid[0] + up[2] * mid[1],
155        ];
156        Self { right, up, back, center, scale: pixels as f64 * FILL / extent, half: pixels as f64 * 0.5 }
157    }
158
159    fn project(&self, p: [f64; 3]) -> [f64; 3] {
160        let d = [p[0] - self.center[0], p[1] - self.center[1], p[2] - self.center[2]];
161        [self.half + dot(d, self.right) * self.scale, self.half - dot(d, self.up) * self.scale, -dot(d, self.back) * self.scale]
162    }
163}
164
165/// Render `capture` as a `size`×`size` RGBA PNG. `None` when nothing is drawn
166/// (an empty document gets no thumbnail; consumers show their placeholder).
167pub fn render_png(capture: &Capture, size: u32) -> Option<Vec<u8>> {
168    let rgba = render_rgba(capture, size)?;
169    encode_png(&rgba, size, size).ok()
170}
171
172/// [`render_png`] from another direction: `basis` (right, up, toward the
173/// eye) in place of the ISO view's, fit and lit the same way.
174pub fn render_png_from(capture: &Capture, size: u32, basis: Basis) -> Option<Vec<u8>> {
175    let rgba = render_rgba_from(capture, size, basis)?;
176    encode_png(&rgba, size, size).ok()
177}
178
179/// [`render_png`]'s pixels, before encoding: `size`² RGBA, row-major.
180pub fn render_rgba(capture: &Capture, size: u32) -> Option<Vec<u8>> {
181    render_rgba_from(capture, size, iso_basis())
182}
183
184/// [`render_png_from`]'s pixels, before encoding.
185pub fn render_rgba_from(capture: &Capture, size: u32, basis: Basis) -> Option<Vec<u8>> {
186    if capture.is_empty() || size == 0 {
187        return None;
188    }
189    let n = size * SUPERSAMPLE;
190    let w = n as usize;
191    let projection = Projection::fit(capture, n, basis);
192    let mut depth = vec![f32::INFINITY; w * w];
193    let mut color = vec![[0f32; 4]; w * w];
194    // The key light, from the upper left of the view and toward the viewer; a
195    // fill from the opposite side keeps faces turned away from it readable.
196    let (right, up, back) = (projection.right, projection.up, projection.back);
197    let key = normalize([
198        -0.45 * right[0] + 0.6 * up[0] + 0.66 * back[0],
199        -0.45 * right[1] + 0.6 * up[1] + 0.66 * back[1],
200        -0.45 * right[2] + 0.6 * up[2] + 0.66 * back[2],
201    ]);
202    for body in &capture.bodies {
203        let screen: Vec<[f64; 3]> = body.positions.iter().map(|&p| projection.project(f64s(p))).collect();
204        for (tri, idx) in body.indices.chunks_exact(3).enumerate() {
205            let [a, b, c] = [idx[0] as usize, idx[1] as usize, idx[2] as usize];
206            let (pa, pb, pc) = (screen[a], screen[b], screen[c]);
207            let normal_at = |i: usize| -> [f64; 3] {
208                match body.normals.get(i) {
209                    Some(&n) if n != [0.0; 3] => normalize(f64s(n)),
210                    _ => {
211                        let (wa, wb, wc) = (f64s(body.positions[a]), f64s(body.positions[b]), f64s(body.positions[c]));
212                        normalize(cross([wb[0] - wa[0], wb[1] - wa[1], wb[2] - wa[2]], [wc[0] - wa[0], wc[1] - wa[1], wc[2] - wa[2]]))
213                    }
214                }
215            };
216            let shade = |n: [f64; 3]| -> f32 {
217                // Two-sided: a normal facing away from the eye is flipped.
218                let n = if dot(n, back) < 0.0 { [-n[0], -n[1], -n[2]] } else { n };
219                (0.34 + 0.56 * dot(n, key).max(0.0) + 0.10 * dot(n, back).max(0.0)) as f32
220            };
221            let (sa, sb, sc) = (shade(normal_at(a)), shade(normal_at(b)), shade(normal_at(c)));
222            let rgb = body.colors[tri];
223            fill_triangle(&mut depth, &mut color, w, [pa, pb, pc], [sa, sb, sc], rgb);
224        }
225    }
226    // Edges over the faces, depth-tested with a bias of a couple of samples so
227    // an edge lying on its face wins.
228    let bias = 2.5f32;
229    for body in &capture.bodies {
230        for line in &body.edges {
231            for seg in line.windows(2) {
232                let (p, q) = (projection.project(f64s(seg[0])), projection.project(f64s(seg[1])));
233                draw_segment(&mut depth, &mut color, w, p, q, bias);
234            }
235        }
236    }
237    // Box-filter down to the output size.
238    let s = SUPERSAMPLE as usize;
239    let out_w = size as usize;
240    let mut out = vec![0u8; out_w * out_w * 4];
241    let inv = 1.0 / (s * s) as f32;
242    for y in 0..out_w {
243        for x in 0..out_w {
244            let mut acc = [0f32; 4];
245            for dy in 0..s {
246                for dx in 0..s {
247                    let c = color[(y * s + dy) * w + x * s + dx];
248                    // Premultiplied accumulation.
249                    for k in 0..3 {
250                        acc[k] += c[k] * c[3];
251                    }
252                    acc[3] += c[3];
253                }
254            }
255            let alpha = acc[3] * inv;
256            let o = (y * out_w + x) * 4;
257            if acc[3] > 0.0 {
258                for k in 0..3 {
259                    out[o + k] = ((acc[k] / acc[3]).clamp(0.0, 1.0) * 255.0).round() as u8;
260                }
261            }
262            out[o + 3] = (alpha.clamp(0.0, 1.0) * 255.0).round() as u8;
263        }
264    }
265    Some(out)
266}
267
268/// Fill one screen triangle with Gouraud-interpolated shade, depth-tested.
269fn fill_triangle(depth: &mut [f32], color: &mut [[f32; 4]], w: usize, p: [[f64; 3]; 3], shade: [f32; 3], rgb: [f32; 3]) {
270    let area = (p[1][0] - p[0][0]) * (p[2][1] - p[0][1]) - (p[2][0] - p[0][0]) * (p[1][1] - p[0][1]);
271    if area.abs() < 1e-12 {
272        return;
273    }
274    let min_x = p.iter().map(|q| q[0]).fold(f64::INFINITY, f64::min).floor().max(0.0) as usize;
275    let max_x = (p.iter().map(|q| q[0]).fold(f64::NEG_INFINITY, f64::max).ceil() as i64).min(w as i64 - 1);
276    let min_y = p.iter().map(|q| q[1]).fold(f64::INFINITY, f64::min).floor().max(0.0) as usize;
277    let max_y = (p.iter().map(|q| q[1]).fold(f64::NEG_INFINITY, f64::max).ceil() as i64).min(w as i64 - 1);
278    if max_x < 0 || max_y < 0 {
279        return;
280    }
281    let inv_area = 1.0 / area;
282    for y in min_y..=max_y as usize {
283        let cy = y as f64 + 0.5;
284        for x in min_x..=max_x as usize {
285            let cx = x as f64 + 0.5;
286            let w0 = ((p[1][0] - cx) * (p[2][1] - cy) - (p[2][0] - cx) * (p[1][1] - cy)) * inv_area;
287            let w1 = ((p[2][0] - cx) * (p[0][1] - cy) - (p[0][0] - cx) * (p[2][1] - cy)) * inv_area;
288            let w2 = 1.0 - w0 - w1;
289            if w0 < 0.0 || w1 < 0.0 || w2 < 0.0 {
290                continue;
291            }
292            let z = (w0 * p[0][2] + w1 * p[1][2] + w2 * p[2][2]) as f32;
293            let i = y * w + x;
294            if z >= depth[i] {
295                continue;
296            }
297            depth[i] = z;
298            let s = w0 as f32 * shade[0] + w1 as f32 * shade[1] + w2 as f32 * shade[2];
299            color[i] = [rgb[0] * s, rgb[1] * s, rgb[2] * s, 1.0];
300        }
301    }
302}
303
304/// Draw one edge segment, about 1.5 output pixels wide, where it is not hidden.
305fn draw_segment(depth: &mut [f32], color: &mut [[f32; 4]], w: usize, p: [f64; 3], q: [f64; 3], bias: f32) {
306    let steps = ((q[0] - p[0]).abs().max((q[1] - p[1]).abs()).ceil() as usize).max(1);
307    for i in 0..=steps {
308        let t = i as f64 / steps as f64;
309        let (x, y, z) = (p[0] + (q[0] - p[0]) * t, p[1] + (q[1] - p[1]) * t, (p[2] + (q[2] - p[2]) * t) as f32);
310        for (dx, dy) in [(0i64, 0i64), (1, 0), (0, 1), (1, 1)] {
311            let (px, py) = (x.floor() as i64 + dx, y.floor() as i64 + dy);
312            if px < 0 || py < 0 || px >= w as i64 || py >= w as i64 {
313                continue;
314            }
315            let k = py as usize * w + px as usize;
316            if z - bias <= depth[k] {
317                color[k] = [EDGE[0], EDGE[1], EDGE[2], 1.0];
318            }
319        }
320    }
321}
322
323/// 8-bit RGBA PNG, no ancillary chunks.
324fn encode_png(rgba: &[u8], width: u32, height: u32) -> Result<Vec<u8>, String> {
325    brep_gizmos::raster::encode_png(rgba, width, height, png::ColorType::Rgba)
326}
327
328/// Portable preview carried by native CAD JSON. The image has no external URL.
329pub fn embedded_png(png: &[u8], size: u32, status: &str) -> serde_json::Value {
330    use base64::Engine;
331    serde_json::json!({
332        "mimeType": "image/png", "data": base64::engine::general_purpose::STANDARD.encode(png),
333        "width": size, "height": size, "renderer": RENDERER, "status": status,
334    })
335}
336
337/// Empty documents and edits still rebuilding have an honest empty preview.
338pub fn empty_embedded(status: &str) -> serde_json::Value {
339    static EMPTY: std::sync::OnceLock<Vec<u8>> = std::sync::OnceLock::new();
340    let png = EMPTY.get_or_init(|| encode_png(&vec![0; (SIZE * SIZE * 4) as usize], SIZE, SIZE)
341        .expect("a fixed-size in-memory PNG can be encoded"));
342    embedded_png(png, SIZE, status)
343}
344