nexus_viewer2d 0.5.0

Viewer for 2D GPU physics demos with nexus.
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
use crate::viewer::{MpmRenderMode, UiState};
use crate::{DemoKind, RunState, Transition};
use kiss3d::egui;
use nexus::rbd::pipeline::RunStats;
use nexus::state::NexusCounts;
use std::time::Duration;

use crate::backend::BackendType;
use egui::{Button, CollapsingHeader, Color32, ComboBox, CornerRadius, RichText, Stroke};

/// Sets up a custom warm theme that complements the app's off-white background.
pub fn setup_custom_theme(ctx: &egui::Context) {
    let bg_fill = Color32::from_rgb(250, 250, 245);
    let window_fill = Color32::from_rgb(252, 252, 248);
    let faint_bg = Color32::from_rgb(240, 240, 232);
    let extreme_bg = Color32::from_rgb(255, 255, 252);

    let text_color = Color32::from_rgb(60, 58, 52);

    let accent = Color32::from_rgb(82, 130, 150);
    let accent_active = Color32::from_rgb(70, 115, 135);

    let widget_bg = Color32::from_rgb(235, 235, 225);
    let widget_bg_hover = Color32::from_rgb(225, 225, 215);
    let widget_bg_active = Color32::from_rgb(215, 215, 205);

    let stroke_color = Color32::from_rgb(200, 198, 190);
    let stroke_hover = Color32::from_rgb(180, 178, 170);

    let rounding = CornerRadius::same(6);
    let small_rounding = CornerRadius::same(4);

    ctx.global_style_mut(|style| {
        let v = &mut style.visuals;
        v.dark_mode = false;

        v.widgets.noninteractive.bg_fill = faint_bg;
        v.widgets.noninteractive.weak_bg_fill = faint_bg;
        v.widgets.noninteractive.bg_stroke = Stroke::new(1.0_f32, stroke_color);
        v.widgets.noninteractive.corner_radius = rounding;
        v.widgets.noninteractive.fg_stroke = Stroke::new(1.0_f32, text_color);

        v.widgets.inactive.bg_fill = widget_bg;
        v.widgets.inactive.weak_bg_fill = widget_bg;
        v.widgets.inactive.bg_stroke = Stroke::new(1.0_f32, stroke_color);
        v.widgets.inactive.corner_radius = small_rounding;
        v.widgets.inactive.fg_stroke = Stroke::new(1.0_f32, text_color);

        v.widgets.hovered.bg_fill = widget_bg_hover;
        v.widgets.hovered.weak_bg_fill = widget_bg_hover;
        v.widgets.hovered.bg_stroke = Stroke::new(1.0_f32, stroke_hover);
        v.widgets.hovered.corner_radius = small_rounding;
        v.widgets.hovered.fg_stroke = Stroke::new(1.5_f32, text_color);

        v.widgets.active.bg_fill = widget_bg_active;
        v.widgets.active.weak_bg_fill = widget_bg_active;
        v.widgets.active.bg_stroke = Stroke::new(1.0_f32, accent);
        v.widgets.active.corner_radius = small_rounding;
        v.widgets.active.fg_stroke = Stroke::new(2.0_f32, accent_active);

        v.widgets.open.bg_fill = widget_bg;
        v.widgets.open.weak_bg_fill = widget_bg;
        v.widgets.open.bg_stroke = Stroke::new(1.0_f32, stroke_color);
        v.widgets.open.corner_radius = small_rounding;
        v.widgets.open.fg_stroke = Stroke::new(1.0_f32, text_color);

        v.selection.bg_fill = accent.gamma_multiply(0.25);
        v.selection.stroke = Stroke::new(1.0_f32, accent);

        v.hyperlink_color = accent;
        v.faint_bg_color = faint_bg;
        v.extreme_bg_color = extreme_bg;
        v.code_bg_color = Color32::from_rgb(230, 230, 220);
        v.warn_fg_color = Color32::from_rgb(180, 120, 60);
        v.error_fg_color = Color32::from_rgb(180, 70, 70);

        v.window_corner_radius = CornerRadius::same(8);
        v.window_fill = window_fill;
        v.window_stroke = Stroke::new(1.0_f32, stroke_color);

        v.panel_fill = bg_fill;

        v.slider_trailing_fill = true;
        v.handle_shape = egui::style::HandleShape::Circle;

        style.spacing.item_spacing = egui::vec2(6.0, 3.0);
        style.spacing.window_margin = egui::Margin::same(10);
        style.spacing.button_padding = egui::vec2(6.0, 3.0);
        style.spacing.slider_width = 130.0;
        style.spacing.indent = 14.0;
        style.spacing.interact_size = egui::vec2(32.0, 18.0);
        style.spacing.combo_width = 100.0;
    });
}

/// Draws a centered "compiling shaders" banner into an existing egui context.
///
/// Shown as an overlay on the first GPU frame of a demo so it stays on screen
/// while the (blocking) shader compilation freezes the app for a few seconds —
/// otherwise the window looks frozen with no explanation. Uses a distinct
/// window id from [`main_panel`] to avoid an egui id collision.
pub fn compiling_overlay(ctx: &egui::Context) {
    egui::Window::new("⏳ Compiling shaders")
        .anchor(egui::Align2::CENTER_CENTER, [0.0, 0.0])
        .collapsible(false)
        .resizable(false)
        .show(ctx, |ui| {
            ui.colored_label(
                Color32::from_rgb(82, 130, 150),
                "Compiling shaders…\nThe app will freeze for a few seconds.\n\nIf nothing happens after a minute or two, check the dev console for an error.",
            );
        });
}

/// Builds the viewer control panel. Mutates `state` in place (run state, demo
/// selection, backend choice) and queries the scene for scene-specific widgets.
pub fn main_panel(ctx: &egui::Context, state: &mut UiState, gpu_available: bool) {
    egui::Window::new("Nexus Viewer")
        .default_width(300.0)
        .show(ctx, |ui| {
            // GPU error banner.
            if let Some(error_msg) = &state.gpu_init_error {
                ui.colored_label(
                    Color32::from_rgb(180, 70, 70),
                    format!("GPU: {}", error_msg),
                );
                ui.separator();
            }

            // Section toggles.
            ui.horizontal(|ui| {
                ui.toggle_value(&mut state.ui_sections.show_performance, "Performance");
                ui.toggle_value(&mut state.ui_sections.show_settings, "Settings");
                ui.toggle_value(&mut state.ui_sections.show_examples, "Examples");
            });

            egui::ScrollArea::vertical()
                .max_height(500.0)
                .show(ui, |ui| {
                    if state.ui_sections.show_settings {
                        ui.separator();
                        backend_selector(ui, state, gpu_available);
                        ui.add_space(4.0);
                        simulation_settings(ui, state);
                    }

                    if state.ui_sections.show_performance {
                        ui.separator();
                        performance_ui(ui, &state.counts, &state.run_stats, state.sync_time);
                    }

                    if state.ui_sections.show_examples && !state.demos.is_empty() {
                        ui.separator();
                        examples_section(ui, state);
                    }
                });

            ui.separator();

            // Bottom controls.
            ui.horizontal(|ui| {
                let (play_label, play_hover) = if state.run_state == RunState::Running {
                    ("Pause", "Pause simulation (T)")
                } else {
                    ("Play", "Start simulation (T)")
                };

                if ui.button(play_label).on_hover_text(play_hover).clicked() {
                    state.run_state = if state.run_state == RunState::Running {
                        RunState::Paused
                    } else {
                        RunState::Running
                    };
                }

                if ui.button("Step").on_hover_text("Single step (S)").clicked() {
                    state.run_state = RunState::Step;
                }

                if ui
                    .button("Restart")
                    .on_hover_text("Restart example (R)")
                    .clicked()
                {
                    state.transition = Some(Transition::Switch);
                }
            });
        });
}

/// Per-scene simulation settings. The viewer seeds these from the scene on load
/// and pushes edits back into the running `NexusState` each frame (see
/// [`crate::NexusViewer::sync`]). Only the groups relevant to the current scene
/// are shown.
fn simulation_settings(ui: &mut egui::Ui, state: &mut UiState) {
    let (has_mpm, has_rbd) = (state.has_mpm, state.has_rbd);
    if !(has_mpm || has_rbd) {
        return;
    }

    ui.label(RichText::new("Simulation").strong());
    ui.add_space(2.0);
    let s = &mut state.sim_settings;

    if has_mpm {
        ui.label("MPM");
        ui.add(egui::Slider::new(&mut s.mpm_substeps, 1..=200).text("substeps"));
        ui.checkbox(&mut s.mpm_use_cpic, "Use CPIC")
            .on_hover_text("Compatible particle-in-cell coupling with rigid colliders");
        gravity_drag(ui, "gravity", &mut s.mpm_gravity);
        // View-only coloring mode (not part of `sim_settings`).
        ComboBox::from_label("coloring")
            .selected_text(state.mpm_render_mode.text())
            .show_ui(ui, |ui| {
                for mode in MpmRenderMode::ALL {
                    ui.selectable_value(&mut state.mpm_render_mode, *mode, mode.text());
                }
            });
    }

    if has_rbd {
        if has_mpm {
            ui.add_space(4.0);
        }
        ui.label("Rigid bodies");
        ui.add(egui::Slider::new(&mut s.rbd_steps_per_frame, 1..=20).text("steps / frame"));
    }
}

/// A labelled per-component drag editor for a gravity vector (2D or 3D).
fn gravity_drag(ui: &mut egui::Ui, label: &str, g: &mut nexus::rbd::math::Vector) {
    ui.horizontal(|ui| {
        ui.label(label);
        ui.add(egui::DragValue::new(&mut g.x).speed(0.1).prefix("x "));
        ui.add(egui::DragValue::new(&mut g.y).speed(0.1).prefix("y "));
        #[cfg(feature = "dim3")]
        ui.add(egui::DragValue::new(&mut g.z).speed(0.1).prefix("z "));
    });
}

fn performance_ui(
    ui: &mut egui::Ui,
    counts: &NexusCounts,
    run_stats: &RunStats,
    sync_time: Duration,
) {
    // Scene entity counts.
    ui.label(RichText::new("Scene").strong());
    ui.add_space(2.0);
    egui::Grid::new("scene_counts")
        .num_columns(2)
        .spacing([20.0, 2.0])
        .show(ui, |ui| {
            let mut row = |label: &str, value: usize| {
                ui.label(label);
                ui.label(format!("{value}"));
                ui.end_row();
            };

            if counts.rigid_bodies > 0 {
                row("Environments:", counts.num_environments);
                row("Rigid bodies:", counts.rigid_bodies);
                row("Colliders:", counts.colliders);
                row("Collision pairs:", counts.collision_pairs);
                row("Collision capacity:", counts.collision_pairs_capacity);
                row("Impulse joints:", counts.impulse_joints);
                row("Multibodies:", counts.multibodies);
                row("Multibody DOFs:", counts.multibody_dofs);
            }

            if counts.particles > 0 {
                row("Particles:", counts.particles);
            }
        });

    ui.add_space(8.0);
    ui.separator();
    ui.add_space(4.0);

    // Timing.
    let encoding_time = run_stats.encoding_time_ms();
    let sync_time = sync_time.as_secs_f32() * 1000.0;
    ui.label(
        RichText::new(format!(
            "Encoding: {:.2}ms\nGPU: {:.2}ms\nSync: {:.2}ms",
            encoding_time, run_stats.gpu_total_time_ms, sync_time
        ))
        .strong(),
    );
    if !run_stats.gpu_pass_times.is_empty() {
        CollapsingHeader::new(format!("GPU passes: {:.2}ms", run_stats.gpu_total_time_ms))
            .id_salt("rbd_gpu_passes")
            .default_open(false)
            .show(ui, |ui| {
                egui::Grid::new("rbd_timestamp_grid")
                    .num_columns(2)
                    .spacing([20.0, 2.0])
                    .show(ui, |ui| {
                        for (label, ms) in &run_stats.gpu_pass_times {
                            ui.label(format!("{}:", label));
                            ui.label(format!("{:.2}ms", ms));
                            ui.end_row();
                        }
                    });
            });
    }

    // Slow performance warning.
    if run_stats.gpu_total_time_ms > 100.0 {
        ui.add_space(4.0);
        ui.colored_label(
            Color32::from_rgb(180, 120, 60),
            #[cfg(not(target_arch = "wasm32"))]
            "Running slow? If you have both an integrated and discrete GPU, ensure the discrete GPU is in use.",
            #[cfg(target_arch = "wasm32")]
            "Running slow? If you have both an integrated and discrete GPU, ensure your browser runs exclusively on the discrete GPU.",
        );
    }
}

impl UiState {
    /// Order in which demos appear in the picker: grouped by kind (Rbd, Mpm),
    /// preserving each group's listing order. Prev/Next walks this sequence so it
    /// matches the visible list rather than the raw (lexicographically-sorted)
    /// `demos` index order.
    fn demo_display_order(&self) -> Vec<usize> {
        let mut order = Vec::with_capacity(self.demos.len());
        for kind in [DemoKind::Rbd, DemoKind::Mpm] {
            for (i, (_, k)) in self.demos.iter().enumerate() {
                if *k == kind {
                    order.push(i);
                }
            }
        }
        order
    }
}

fn examples_section(ui: &mut egui::Ui, state: &mut UiState) {
    // Previous/Next navigation + current demo name. Navigation follows the
    // grouped listing order (see `demo_display_order`), not the raw index.
    let order = state.demo_display_order();
    let pos = order
        .iter()
        .position(|&i| i == state.selected_demo)
        .unwrap_or(0);

    ui.horizontal(|ui| {
        if ui
            .add_enabled(pos > 0, Button::new("<"))
            .on_hover_text("Previous example")
            .clicked()
        {
            state.selected_demo = order[pos - 1];
            state.transition = Some(Transition::Switch);
        }

        if ui
            .add_enabled(pos + 1 < order.len(), Button::new(">"))
            .on_hover_text("Next example")
            .clicked()
        {
            state.selected_demo = order[pos + 1];
            state.transition = Some(Transition::Switch);
        }

        ui.label(
            RichText::new(state.demos[state.selected_demo].0.clone())
                .strong()
                .italics(),
        );
    });

    ui.add_space(4.0);
    ui.separator();
    ui.add_space(4.0);

    demo_group(ui, state, DemoKind::Rbd, "Rigid Bodies");
    demo_group(ui, state, DemoKind::Mpm, "MPM");
}

fn demo_group(ui: &mut egui::Ui, state: &mut UiState, kind: DemoKind, label: &str) {
    // Collect owned (index, name) so the closure can freely mutate `state`.
    let demos: Vec<(usize, String)> = state
        .demos
        .iter()
        .enumerate()
        .filter(|(_, (_, k))| *k == kind)
        .map(|(i, (name, _))| (i, name.clone()))
        .collect();

    if demos.is_empty() {
        return;
    }

    CollapsingHeader::new(format!("{} ({})", label, demos.len()))
        .default_open(true)
        .show(ui, |ui| {
            for (idx, name) in &demos {
                let is_selected = state.selected_demo == *idx;
                let text = if is_selected {
                    RichText::new(name).strong()
                } else {
                    RichText::new(name)
                };
                if ui
                    .selectable_label(is_selected, text)
                    .on_hover_text("Click to run this example")
                    .clicked()
                    && !is_selected
                {
                    state.selected_demo = *idx;
                    state.transition = Some(Transition::Switch);
                }
            }
        });
}

/// Unified backend selector. The "CPU (rapier)" option is only shown for RBD
/// scenes; for MPM scenes a current Rapier selection is shown as CPU (nexus).
fn backend_selector(ui: &mut egui::Ui, state: &mut UiState, gpu_available: bool) {
    ui.label(RichText::new("Physics Backend").strong());
    ui.add_space(2.0);

    let mut new_backend: Option<BackendType> = None;

    if gpu_available
        && ui
            .radio(state.backend_type == BackendType::Gpu, "GPU (nexus)")
            .on_hover_text("GPU-accelerated physics with nexus")
            .clicked()
        && state.backend_type != BackendType::Gpu
    {
        new_backend = Some(BackendType::Gpu);
    }

    #[cfg(feature = "cuda")]
    if ui
        .radio(state.backend_type == BackendType::Cuda, "CUDA (nexus)")
        .on_hover_text("GPU-accelerated physics with nexus via CUDA")
        .clicked()
        && state.backend_type != BackendType::Cuda
    {
        new_backend = Some(BackendType::Cuda);
    }

    #[cfg(feature = "metal")]
    if ui
        .radio(state.backend_type == BackendType::Metal, "Metal (nexus)")
        .on_hover_text("GPU-accelerated physics with nexus via native Metal")
        .clicked()
        && state.backend_type != BackendType::Metal
    {
        new_backend = Some(BackendType::Metal);
    }

    #[cfg(feature = "cpu")]
    if ui
        .radio(state.backend_type == BackendType::Cpu, "CPU (nexus)")
        .on_hover_text("CPU physics using the nexus GPU pipeline executed on CPU")
        .clicked()
        && state.backend_type != BackendType::Cpu
    {
        new_backend = Some(BackendType::Cpu);
    }

    if let Some(bt) = new_backend {
        state.backend_type = bt;
        state.transition = Some(Transition::Switch);
    }
}