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

//! Viewpoint-preset checks for `SceneWidget` (plot3d P3.1): the seven named
//! viewpoints (silx `actions/viewpoint.py`) orient the camera along the
//! expected axis, the auto-rotate primitive (silx `RotateViewpoint`) orbits the
//! scene, and the `viewpoint_menu` drop-down (silx `ViewpointToolButton`) wires
//! a menu click through to `set_viewpoint`.
//!
//! The preset/rotate properties are asserted directly on the camera (no pixels
//! needed); the menu is exercised end-to-end through the egui/AccessKit harness:
//! clicking "View" → "Top" must reorient the camera, proving the full
//! button → menu item → `set_viewpoint` chain.

use egui_kittest::Harness;
use egui_kittest::kittest::Queryable;
use egui_kittest::wgpu::{WgpuTestRenderer, create_render_state, default_wgpu_setup};
use siplot::egui;
use siplot::egui_wgpu::RenderState;
use siplot::{CameraFace, SceneWidget, Vec3, viewpoint_menu};
use std::cell::RefCell;
use std::rc::Rc;

const WIN: f32 = 320.0;
const UNIT: (Vec3, Vec3) = (Vec3::ZERO, Vec3::new(1.0, 1.0, 1.0));

/// The expected eye-offset direction (eye − centre, normalized) for each preset.
/// silx looks *along* `-direction`, so the eye sits on the `+axis` side:
/// Front looks -Z (eye +Z), Top looks -Y (eye +Y), etc.; Side is the
/// `(1,1,1)` three-quarter view.
fn expected_offset(face: CameraFace) -> Vec3 {
    match face {
        CameraFace::Front => Vec3::new(0.0, 0.0, 1.0),
        CameraFace::Back => Vec3::new(0.0, 0.0, -1.0),
        CameraFace::Top => Vec3::new(0.0, 1.0, 0.0),
        CameraFace::Bottom => Vec3::new(0.0, -1.0, 0.0),
        CameraFace::Right => Vec3::new(1.0, 0.0, 0.0),
        CameraFace::Left => Vec3::new(-1.0, 0.0, 0.0),
        CameraFace::Side => Vec3::new(1.0, 1.0, 1.0).normalized(),
    }
}

#[test]
fn viewpoint_presets_orient_camera_along_expected_axis() {
    let rs = create_render_state(default_wgpu_setup());
    let mut scene = SceneWidget::new(&rs, 0);
    scene.set_bounds(&rs, UNIT);
    let center = scene.center();

    for face in [
        CameraFace::Front,
        CameraFace::Back,
        CameraFace::Top,
        CameraFace::Bottom,
        CameraFace::Right,
        CameraFace::Left,
        CameraFace::Side,
    ] {
        scene.set_viewpoint(face);
        let offset = (scene.camera().extrinsic.position() - center).normalized();
        let want = expected_offset(face);
        let alignment = offset.dot(want);
        assert!(
            alignment > 0.999,
            "viewpoint {face:?}: eye offset {offset:?} should align with {want:?} (dot={alignment})"
        );
    }
}

#[test]
fn rotate_scene_orbits_around_the_center_preserving_radius() {
    let rs = create_render_state(default_wgpu_setup());
    let mut scene = SceneWidget::new(&rs, 1);
    scene.set_bounds(&rs, UNIT);
    let center = scene.center();

    scene.set_viewpoint(CameraFace::Side);
    let before = scene.camera().extrinsic.position();
    let r_before = (before - center).length();

    scene.rotate_scene(45.0);
    let after = scene.camera().extrinsic.position();
    let r_after = (after - center).length();

    assert_ne!(before, after, "rotate_scene must move the camera");
    assert!(
        (r_before - r_after).abs() < 1e-3,
        "an orbit preserves the distance to the centre: {r_before} vs {r_after}"
    );
}

/// A `SceneWidget` under a `viewpoint_menu` drop-down — the menu's click wiring
/// is exercised through the harness.
struct MenuApp {
    scene: SceneWidget,
}

impl MenuApp {
    fn new(rs: &RenderState) -> Self {
        let mut scene = SceneWidget::new(rs, 2);
        scene.set_bounds(rs, UNIT);
        Self { scene }
    }

    fn ui(&mut self, ui: &mut egui::Ui) {
        ui.horizontal(|ui| {
            let _ = viewpoint_menu(ui, &mut self.scene);
        });
        self.scene.show(ui);
    }
}

#[test]
fn viewpoint_menu_click_reorients_the_camera() {
    let rs = create_render_state(default_wgpu_setup());
    let app = Rc::new(RefCell::new(MenuApp::new(&rs)));
    let renderer = WgpuTestRenderer::from_render_state(rs.clone());

    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.
    harness.step();
    let center = app.borrow().scene.center();
    let before = app.borrow().scene.camera().extrinsic.position();

    // Open the "View" menu, then pick "Top".
    harness.get_by_label("View").click();
    harness.run();
    harness.get_by_label("Top").click();
    harness.run();

    let after = app.borrow().scene.camera().extrinsic.position();
    let offset = (after - center).normalized();
    assert_ne!(
        before, after,
        "selecting a viewpoint from the menu must move the camera"
    );
    assert!(
        offset.dot(Vec3::new(0.0, 1.0, 0.0)) > 0.999,
        "menu 'Top' must orient the camera along +Y; got offset {offset:?}"
    );
}