re_viewport 0.10.1

The central viewport panel of the Rerun viewer.
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
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
use egui::{Response, Ui};
use itertools::Itertools;

use re_data_store::InstancePath;
use re_data_ui::item_ui;
use re_space_view::DataBlueprintGroup;
use re_ui::list_item::ListItem;
use re_ui::ReUi;
use re_viewer_context::{
    DataBlueprintGroupHandle, HoverHighlight, Item, SpaceViewId, ViewerContext,
};

use crate::{
    space_view_heuristics::{all_possible_space_views, identify_entities_per_system_per_class},
    viewport_blueprint::TreeActions,
    SpaceInfoCollection, SpaceViewBlueprint, ViewportBlueprint,
};

impl ViewportBlueprint<'_> {
    /// Show the blueprint panel tree view.
    pub fn tree_ui(&mut self, ctx: &mut ViewerContext<'_>, ui: &mut egui::Ui) {
        re_tracing::profile_function!();

        egui::ScrollArea::both()
            .id_source("blueprint_tree_scroll_area")
            .auto_shrink([true, false])
            .show(ui, |ui| {
                if let Some(root) = self.tree.root() {
                    self.tile_ui(ctx, ui, root);
                }
            });

        let TreeActions { focus_tab, remove } = std::mem::take(&mut self.deferred_tree_actions);

        if let Some(focus_tab) = &focus_tab {
            let found = self.tree.make_active(|tile| match tile {
                egui_tiles::Tile::Pane(space_view_id) => space_view_id == focus_tab,
                egui_tiles::Tile::Container(_) => false,
            });
            re_log::trace!("Found tab {focus_tab}: {found}");
        }

        for tile_id in remove {
            for tile in self.tree.tiles.remove_recursively(tile_id) {
                if let egui_tiles::Tile::Pane(space_view_id) = tile {
                    self.remove(&space_view_id);
                }
            }

            if Some(tile_id) == self.tree.root {
                self.tree.root = None;
            }
        }
    }

    /// If a group or spaceview has a total of this number of elements, show its subtree by default?
    fn default_open_for_group(group: &DataBlueprintGroup) -> bool {
        let num_children = group.children.len() + group.entities.len();
        2 <= num_children && num_children <= 3
    }

    fn tile_ui(
        &mut self,
        ctx: &mut ViewerContext<'_>,
        ui: &mut egui::Ui,
        tile_id: egui_tiles::TileId,
    ) {
        // Temporarily remove the tile so we don't get borrow-checker fights:
        let Some(mut tile) = self.tree.tiles.remove(tile_id) else {
            return;
        };

        match &mut tile {
            egui_tiles::Tile::Container(container) => {
                self.container_tree_ui(ctx, ui, tile_id, container);
            }
            egui_tiles::Tile::Pane(space_view_id) => {
                // A space view
                self.space_view_entry_ui(ctx, ui, tile_id, space_view_id);
            }
        };

        self.tree.tiles.insert(tile_id, tile);
    }

    fn container_tree_ui(
        &mut self,
        ctx: &mut ViewerContext<'_>,
        ui: &mut egui::Ui,
        tile_id: egui_tiles::TileId,
        container: &egui_tiles::Container,
    ) {
        if let Some(child_id) = container.only_child() {
            // Maybe a tab container with only one child - collapse it in the tree view to make it more easily understood.
            // This means we won't be showing the visibility button of the parent container,
            // so if the child is made invisible, we should do the same for the parent.
            let child_is_visible = self.tree.is_visible(child_id);
            self.tree.set_visible(tile_id, child_is_visible);
            return self.tile_ui(ctx, ui, child_id);
        }

        let mut visibility_changed = false;
        let mut visible = self.tree.is_visible(tile_id);
        let mut remove = false;

        let default_open = true;

        ListItem::new(ctx.re_ui, format!("{:?}", container.kind()))
            .subdued(true)
            .with_buttons(|re_ui, ui| {
                let vis_response = visibility_button_ui(re_ui, ui, true, &mut visible);
                visibility_changed = vis_response.changed();

                let remove_response = remove_button_ui(re_ui, ui, "Remove container");
                remove = remove_response.clicked();

                remove_response | vis_response
            })
            .show_collapsing(ui, ui.id().with(tile_id), default_open, |_, ui| {
                for &child in container.children() {
                    self.tile_ui(ctx, ui, child);
                }
            });

        if remove {
            self.mark_user_interaction();
            self.deferred_tree_actions.remove.push(tile_id);
        }

        if visibility_changed {
            if self.auto_layout {
                re_log::trace!("Container visibility changed - will no longer auto-layout");
            }

            self.auto_layout = false; // Keep `auto_space_views` enabled.
            self.tree.set_visible(tile_id, visible);
        }
    }

    fn space_view_entry_ui(
        &mut self,
        ctx: &mut ViewerContext<'_>,
        ui: &mut egui::Ui,
        tile_id: egui_tiles::TileId,
        space_view_id: &SpaceViewId,
    ) {
        let Some(space_view) = self.space_views.get_mut(space_view_id) else {
            re_log::warn_once!("Bug: asked to show a ui for a Space View that doesn't exist");
            self.deferred_tree_actions.remove.push(tile_id);
            return;
        };
        debug_assert_eq!(space_view.id, *space_view_id);

        let mut visibility_changed = false;
        let mut visible = self.tree.is_visible(tile_id);
        let visible_child = visible;
        let item = Item::SpaceView(space_view.id);

        let root_group = space_view.contents.root_group();
        let default_open = Self::default_open_for_group(root_group);
        let collapsing_header_id = ui.id().with(space_view.id);
        let is_item_hovered =
            ctx.selection_state().highlight_for_ui_element(&item) == HoverHighlight::Hovered;

        let response = ListItem::new(ctx.re_ui, space_view.display_name.clone())
            .selected(ctx.selection().contains(&item))
            .subdued(!visible)
            .force_hovered(is_item_hovered)
            .with_icon(space_view.class(ctx.space_view_class_registry).icon())
            .with_buttons(|re_ui, ui| {
                let vis_response = visibility_button_ui(re_ui, ui, true, &mut visible);
                visibility_changed = vis_response.changed();

                let response = remove_button_ui(re_ui, ui, "Remove Space View from the Viewport");
                if response.clicked() {
                    self.deferred_tree_actions.remove.push(tile_id);
                }

                response | vis_response
            })
            .show_collapsing(ui, collapsing_header_id, default_open, |_, ui| {
                Self::space_view_blueprint_ui(
                    ctx,
                    ui,
                    space_view.contents.root_handle(),
                    space_view,
                    visible_child,
                );
            })
            .item_response
            .on_hover_text("Space View");

        if response.clicked() {
            self.deferred_tree_actions.focus_tab = Some(space_view.id);
        }

        item_ui::select_hovered_on_click(ctx, &response, &[item]);

        if visibility_changed {
            if self.auto_layout {
                re_log::trace!("Space view visibility changed - will no longer auto-layout");
            }

            self.auto_layout = false; // Keep `auto_space_views` enabled.
            self.tree.set_visible(tile_id, visible);
        }
    }

    fn space_view_blueprint_ui(
        ctx: &mut ViewerContext<'_>,
        ui: &mut egui::Ui,
        group_handle: DataBlueprintGroupHandle,
        space_view: &mut SpaceViewBlueprint,
        space_view_visible: bool,
    ) {
        let Some(group) = space_view.contents.group(group_handle) else {
            debug_assert!(false, "Invalid group handle in blueprint group tree");
            return;
        };

        // TODO(andreas): These clones are workarounds against borrowing multiple times from space_view_blueprint_ui.
        let children = group.children.clone();
        let entities = group.entities.clone();
        let group_name = group.display_name.clone();
        let group_is_visible = group.properties_projected.visible && space_view_visible;

        for entity_path in &entities {
            if entity_path.is_root() {
                continue;
            }

            let is_selected = ctx.selection().contains(&Item::InstancePath(
                Some(space_view.id),
                InstancePath::entity_splat(entity_path.clone()),
            ));

            let item = Item::InstancePath(
                Some(space_view.id),
                InstancePath::entity_splat(entity_path.clone()),
            );
            let is_item_hovered =
                ctx.selection_state().highlight_for_ui_element(&item) == HoverHighlight::Hovered;

            let mut properties = space_view
                .contents
                .data_blueprints_individual()
                .get(entity_path);
            let name = entity_path.iter().last().unwrap().to_string();
            let label = format!("🔹 {name}");
            let response = ListItem::new(ctx.re_ui, label)
                .selected(is_selected)
                .subdued(!group_is_visible || !properties.visible)
                .force_hovered(is_item_hovered)
                .with_buttons(|re_ui, ui| {
                    let vis_response =
                        visibility_button_ui(re_ui, ui, group_is_visible, &mut properties.visible);
                    if vis_response.changed() {
                        space_view
                            .contents
                            .data_blueprints_individual()
                            .set(entity_path.clone(), properties);
                    }

                    let response = remove_button_ui(re_ui, ui, "Remove Entity from the Space View");
                    if response.clicked() {
                        space_view.contents.remove_entity(entity_path);
                        space_view.entities_determined_by_user = true;
                    }

                    response | vis_response
                })
                .show(ui)
                .on_hover_ui(|ui| {
                    re_data_ui::item_ui::entity_hover_card_ui(ui, ctx, entity_path);
                });

            item_ui::select_hovered_on_click(ctx, &response, &[item]);
        }

        for child_group_handle in &children {
            let Some(child_group) = space_view.contents.group_mut(*child_group_handle) else {
                debug_assert!(
                    false,
                    "Data blueprint group {group_name} has an invalid child"
                );
                continue;
            };

            let item = Item::DataBlueprintGroup(space_view.id, *child_group_handle);
            let is_selected = ctx.selection().contains(&item);
            let is_item_hovered =
                ctx.selection_state().highlight_for_ui_element(&item) == HoverHighlight::Hovered;

            let mut remove_group = false;
            let default_open = Self::default_open_for_group(child_group);

            let mut child_group_visible = child_group.properties_individual.visible;
            let response = ListItem::new(ctx.re_ui, child_group.display_name.clone())
                .selected(is_selected)
                .subdued(!child_group_visible || !group_is_visible)
                .force_hovered(is_item_hovered)
                .with_icon(&re_ui::icons::CONTAINER)
                .with_buttons(|re_ui, ui| {
                    let vis_response =
                        visibility_button_ui(re_ui, ui, group_is_visible, &mut child_group_visible);

                    let response = remove_button_ui(
                        re_ui,
                        ui,
                        "Remove Group and all its children from the Space View",
                    );
                    if response.clicked() {
                        remove_group = true;
                    }

                    response | vis_response
                })
                .show_collapsing(
                    ui,
                    ui.id().with(child_group_handle),
                    default_open,
                    |_, ui| {
                        Self::space_view_blueprint_ui(
                            ctx,
                            ui,
                            *child_group_handle,
                            space_view,
                            space_view_visible,
                        );
                    },
                )
                .item_response
                .on_hover_text("Group");

            item_ui::select_hovered_on_click(ctx, &response, &[item]);

            // needed by the borrow checker
            let Some(child_group) = space_view.contents.group_mut(*child_group_handle) else {
                unreachable!("we did the same thing just above");
            };
            child_group.properties_individual.visible = child_group_visible;

            if remove_group {
                space_view.contents.remove_group(*child_group_handle);
                space_view.entities_determined_by_user = true;
            }
        }
    }

    pub fn add_new_spaceview_button_ui(
        &mut self,
        ctx: &mut ViewerContext<'_>,
        ui: &mut egui::Ui,
        spaces_info: &SpaceInfoCollection,
    ) {
        #![allow(clippy::collapsible_if)]

        ui.menu_image_button(
            re_ui::icons::ADD
                .as_image()
                .fit_to_exact_size(re_ui::ReUi::small_icon_size()),
            |ui| {
                ui.style_mut().wrap = Some(false);

                let entities_per_system_per_class = identify_entities_per_system_per_class(ctx);
                for space_view in
                    all_possible_space_views(ctx, spaces_info, &entities_per_system_per_class)
                        .into_iter()
                        .sorted_by_key(|space_view| space_view.space_origin.to_string())
                {
                    if ctx
                        .re_ui
                        .selectable_label_with_icon(
                            ui,
                            space_view.class(ctx.space_view_class_registry).icon(),
                            if space_view.space_origin.is_root() {
                                space_view.display_name.clone()
                            } else {
                                space_view.space_origin.to_string()
                            },
                            false,
                        )
                        .clicked()
                    {
                        ui.close_menu();
                        let new_space_view_id = self.add_space_view(space_view);
                        ctx.set_single_selection(&Item::SpaceView(new_space_view_id));
                    }
                }
            },
        )
        .response
        .on_hover_text("Add new Space View");
    }
}

// ----------------------------------------------------------------------------

fn remove_button_ui(re_ui: &ReUi, ui: &mut Ui, tooltip: &str) -> Response {
    re_ui
        .small_icon_button(ui, &re_ui::icons::REMOVE)
        .on_hover_text(tooltip)
}

fn visibility_button_ui(
    re_ui: &re_ui::ReUi,
    ui: &mut egui::Ui,
    enabled: bool,
    visible: &mut bool,
) -> egui::Response {
    ui.set_enabled(enabled);
    re_ui
        .visibility_toggle_button(ui, visible)
        .on_hover_text("Toggle visibility")
        .on_disabled_hover_text("A parent is invisible")
}