siplot 0.3.0

silx-style scientific plotting for egui, rendered with wgpu
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

//! Headless end-to-end check for `SceneWidget` (plot3d P0.3): the widget frames
//! a scene, generates the bounding-box + RGB-axes chrome, uploads it, and paints
//! it through the offscreen-render-then-blit path; and a left-drag orbits the
//! camera so the rendered image changes.
//!
//! This exercises the whole widget wiring — geometry build, camera framing, GPU
//! upload, paint callback, and pointer interaction — on a real (or software) GPU
//! via `egui_kittest`, mirroring `tests/mask_pointer_offset.rs`. The pure camera
//! math is unit-tested separately in `core::scene3d`.

use egui_kittest::Harness;
use egui_kittest::wgpu::{WgpuTestRenderer, create_render_state, default_wgpu_setup};
use siplot::egui;
use siplot::egui::Color32;
use siplot::egui_wgpu::RenderState;
use siplot::{Box3D, Scene3dGeometry, SceneWidget, Vec3};
use std::cell::RefCell;
use std::rc::Rc;

const WIN: f32 = 320.0;

struct App {
    scene: SceneWidget,
    last_rect: Option<egui::Rect>,
}

impl App {
    fn new(rs: &RenderState) -> Self {
        let mut scene = SceneWidget::new(rs, 0);
        // A unit box centred at the origin: distinct positive axis directions.
        scene.set_bounds(rs, (Vec3::ZERO, Vec3::new(1.0, 1.0, 1.0)));
        Self {
            scene,
            last_rect: None,
        }
    }

    fn ui(&mut self, ui: &mut egui::Ui) {
        let resp = self.scene.show(ui);
        self.last_rect = Some(resp.rect);
    }
}

fn classify(raw: &[u8], iw: usize, ih: usize) -> (usize, usize, usize, usize) {
    let (mut red, mut green, mut blue, mut bg) = (0usize, 0usize, 0usize, 0usize);
    for px in 0..(iw * ih) {
        let i = px * 4;
        let (r, g, b, a) = (raw[i], raw[i + 1], raw[i + 2], raw[i + 3]);
        if r > 120 && g < 80 && b < 80 {
            red += 1;
        } else if g > 120 && r < 80 && b < 80 {
            green += 1;
        } else if b > 120 && r < 80 && g < 80 {
            blue += 1;
        } else if a == 255 && r < 60 && g < 60 && b < 60 && r.abs_diff(g).max(g.abs_diff(b)) <= 12 {
            // The scene background: opaque, dark, neutral grey. Tested by these
            // properties rather than an exact byte so the check holds whether the
            // target format is linear (byte ~3) or sRGB (byte ~30). The un-painted
            // border outside the scene rect is transparent (a == 0) and excluded.
            bg += 1;
        }
    }
    (red, green, blue, bg)
}

#[test]
fn scene_widget_renders_axes_and_orbits_on_drag() {
    let rs = create_render_state(default_wgpu_setup());
    let app = Rc::new(RefCell::new(App::new(&rs)));
    let renderer = WgpuTestRenderer::from_render_state(rs);

    let app_ui = app.clone();
    let mut harness = Harness::builder()
        .with_size(egui::vec2(WIN, WIN))
        .with_pixels_per_point(1.0)
        .renderer(renderer)
        .build_ui(move |ui| app_ui.borrow_mut().ui(ui));

    // Frame 1: the default side-view scene (no pointer → no cursor overlay).
    harness.step();
    let rect = app.borrow().last_rect.expect("scene rect");
    let image1 = harness.render().expect("headless wgpu render");
    let (iw, ih) = (image1.width() as usize, image1.height() as usize);
    let frame1 = image1.as_raw().clone();

    let (red, green, blue, bg) = classify(&frame1, iw, ih);
    // All three RGB axes must be visible.
    assert!(red > 0, "X axis (red) not visible");
    assert!(green > 0, "Y axis (green) not visible");
    assert!(blue > 0, "Z axis (blue) not visible");
    // The dark background must dominate the frame (the scene is a wireframe).
    assert!(
        bg > iw * ih / 2,
        "dark background should dominate; got {bg}/{} px",
        iw * ih
    );

    // Orbit: press at the centre and drag a quarter-width to the right. egui only
    // recognises a drag once the pointer clears its click-vs-drag threshold, so we
    // move in several steps (mirrors tests/mask_pointer_offset.rs).
    let a = rect.center();
    let b = a + egui::vec2(80.0, 0.0);
    harness.hover_at(a);
    harness.drag_at(a);
    harness.step(); // press
    for k in 1..=4 {
        harness.hover_at(a + (b - a) * (k as f32 / 4.0));
        harness.step();
    }
    harness.drop_at(b); // release; also removes the cursor overlay
    harness.step();

    let image2 = harness.render().expect("headless wgpu render");
    let frame2 = image2.as_raw();

    // The orbit must have changed the rendered view.
    let changed = frame1
        .iter()
        .zip(frame2.iter())
        .filter(|(x, y)| x.abs_diff(**y) > 30)
        .count();
    assert!(
        changed > 200,
        "left-drag orbit should change the rendered image; only {changed} byte diffs"
    );
}

/// A `SceneWidget` carrying a content data-item (a lit box) that fills the bounds.
struct ContentApp {
    scene: SceneWidget,
    last_rect: Option<egui::Rect>,
}

impl ContentApp {
    fn new(rs: &RenderState) -> Self {
        let mut scene = SceneWidget::new(rs, 1);
        scene.set_bounds(rs, (Vec3::ZERO, Vec3::new(1.0, 1.0, 1.0)));
        // A magenta box filling the bounds — magenta (r&b high, g low) is a colour
        // the chrome (grey wireframe + pure R/G/B axes) cannot produce, so its
        // presence proves the mesh channel is forwarded and rendered.
        let mut bx = Box3D::new();
        bx.set_data(
            [1.0, 1.0, 1.0],
            &[Color32::from_rgb(255, 0, 255)],
            &[[0.5, 0.5, 0.5]],
            (0.0, [0.0, 0.0, 1.0]),
        );
        let mut g = Scene3dGeometry::new();
        bx.append_to(&mut g);
        scene.set_geometry(rs, g);
        Self {
            scene,
            last_rect: None,
        }
    }

    fn ui(&mut self, ui: &mut egui::Ui) {
        let resp = self.scene.show(ui);
        self.last_rect = Some(resp.rect);
    }
}

#[test]
fn scene_widget_forwards_and_renders_content_mesh() {
    let rs = create_render_state(default_wgpu_setup());
    let app = Rc::new(RefCell::new(ContentApp::new(&rs)));
    let renderer = WgpuTestRenderer::from_render_state(rs);

    let app_ui = app.clone();
    let mut harness = Harness::builder()
        .with_size(egui::vec2(WIN, WIN))
        .with_pixels_per_point(1.0)
        .renderer(renderer)
        .build_ui(move |ui| app_ui.borrow_mut().ui(ui));

    harness.step();
    let image = harness.render().expect("headless wgpu render");
    let (iw, ih) = (image.width() as usize, image.height() as usize);
    let raw = image.as_raw();

    // Count magenta pixels: red and blue both high, green low. Lit faces of the
    // box carry this; the chrome cannot.
    let magenta = (0..iw * ih)
        .filter(|&px| {
            let i = px * 4;
            raw[i] > 120 && raw[i + 2] > 120 && raw[i + 1] < 80
        })
        .count();
    assert!(
        magenta > 200,
        "the content box (magenta) must render through the widget; only {magenta} px"
    );
}