use std::collections::BTreeMap;
use ahash::HashMap;
use egui_tiles::Behavior as _;
use once_cell::sync::Lazy;
use re_data_ui::item_ui;
use re_entity_db::EntityPropertyMap;
use re_ui::{Icon, ReUi};
use re_viewer_context::{
AppOptions, Item, SpaceViewClassIdentifier, SpaceViewClassRegistry, SpaceViewId,
SpaceViewState, SystemExecutionOutput, ViewQuery, ViewerContext,
};
use crate::{
space_view_entity_picker::SpaceViewEntityPicker,
space_view_heuristics::default_created_space_views,
space_view_highlights::highlights_for_space_view,
system_execution::execute_systems_for_space_views, SpaceInfoCollection, SpaceViewBlueprint,
ViewportBlueprint,
};
pub struct PerSpaceViewState {
pub auto_properties: EntityPropertyMap,
pub space_view_state: Box<dyn SpaceViewState>,
}
#[derive(Default)]
pub struct ViewportState {
space_view_entity_window: SpaceViewEntityPicker,
space_view_states: HashMap<SpaceViewId, PerSpaceViewState>,
space_views_displayed_last_frame: Vec<SpaceViewId>,
}
static DEFAULT_PROPS: Lazy<EntityPropertyMap> = Lazy::<EntityPropertyMap>::new(Default::default);
impl ViewportState {
pub fn space_view_state_mut(
&mut self,
space_view_class_registry: &SpaceViewClassRegistry,
space_view_id: SpaceViewId,
space_view_class: &SpaceViewClassIdentifier,
) -> &mut PerSpaceViewState {
self.space_view_states
.entry(space_view_id)
.or_insert_with(|| PerSpaceViewState {
auto_properties: Default::default(),
space_view_state: space_view_class_registry
.get_class_or_log_error(space_view_class)
.new_state(),
})
}
pub fn space_view_props(&self, space_view_id: SpaceViewId) -> &EntityPropertyMap {
self.space_view_states
.get(&space_view_id)
.map_or(&DEFAULT_PROPS, |state| &state.auto_properties)
}
}
#[derive(Clone)]
pub enum TreeAction {
AddSpaceView(SpaceViewId, Option<egui_tiles::TileId>),
AddContainer(egui_tiles::ContainerKind, Option<egui_tiles::TileId>),
SetContainerKind(egui_tiles::TileId, egui_tiles::ContainerKind),
FocusTab(SpaceViewId),
Remove(egui_tiles::TileId),
SimplifyContainer(egui_tiles::TileId, egui_tiles::SimplificationOptions),
}
fn tree_simplification_option_for_app_options(
app_options: &AppOptions,
) -> egui_tiles::SimplificationOptions {
if app_options.experimental_additive_workflow {
egui_tiles::SimplificationOptions {
prune_empty_tabs: false,
all_panes_must_have_tabs: true,
prune_empty_containers: false,
prune_single_child_tabs: false,
prune_single_child_containers: false,
join_nested_linear_containers: true,
}
} else {
egui_tiles::SimplificationOptions {
all_panes_must_have_tabs: true,
..Default::default()
}
}
}
pub struct Viewport<'a, 'b> {
pub blueprint: &'a ViewportBlueprint,
pub state: &'b mut ViewportState,
pub tree: egui_tiles::Tree<SpaceViewId>,
pub edited: bool,
tree_action_receiver: std::sync::mpsc::Receiver<TreeAction>,
}
impl<'a, 'b> Viewport<'a, 'b> {
pub fn new(
blueprint: &'a ViewportBlueprint,
state: &'b mut ViewportState,
space_view_class_registry: &SpaceViewClassRegistry,
tree_action_receiver: std::sync::mpsc::Receiver<TreeAction>,
) -> Self {
re_tracing::profile_function!();
let mut edited = false;
let tree = if blueprint.tree.is_empty() && !blueprint.space_views.is_empty() {
edited = true;
super::auto_layout::tree_from_space_views(
space_view_class_registry,
&blueprint.space_views,
)
} else {
blueprint.tree.clone()
};
Self {
blueprint,
state,
tree,
edited,
tree_action_receiver,
}
}
pub fn show_add_remove_entities_window(&mut self, space_view_id: SpaceViewId) {
self.state.space_view_entity_window.open(space_view_id);
}
pub fn viewport_ui(&mut self, ui: &mut egui::Ui, ctx: &'a ViewerContext<'_>) {
self.state
.space_view_entity_window
.ui(ui, ctx, self.blueprint);
let Viewport {
blueprint, state, ..
} = self;
let is_zero_sized_viewport = ui.available_size().min_elem() <= 0.0;
if is_zero_sized_viewport {
return;
}
let mut maximized = blueprint.maximized;
if let Some(space_view_id) = blueprint.maximized {
if !blueprint.space_views.contains_key(&space_view_id) {
maximized = None;
} else if let Some(tile_id) = blueprint.tree.tiles.find_pane(&space_view_id) {
if !blueprint.tree.tiles.is_visible(tile_id) {
maximized = None;
}
}
}
let mut maximized_tree;
let tree = if let Some(space_view_id) = blueprint.maximized {
let mut tiles = egui_tiles::Tiles::default();
let root = tiles.insert_pane(space_view_id);
maximized_tree = egui_tiles::Tree::new("viewport_tree", root, tiles);
&mut maximized_tree
} else {
&mut self.tree
};
let executed_systems_per_space_view = execute_systems_for_space_views(
ctx,
std::mem::take(&mut state.space_views_displayed_last_frame),
&blueprint.space_views,
);
ui.scope(|ui| {
ui.spacing_mut().item_spacing.x = re_ui::ReUi::view_padding();
re_tracing::profile_scope!("tree.ui");
let mut tab_viewer = TabViewer {
viewport_state: state,
ctx,
space_views: &blueprint.space_views,
maximized: &mut maximized,
edited: false,
space_views_displayed_current_frame: Vec::new(),
executed_systems_per_space_view,
};
tree.ui(&mut tab_viewer, ui);
let is_dragging_a_tile = tree.dragged_id(ui.ctx()).is_some();
if tab_viewer.edited || is_dragging_a_tile {
if blueprint.auto_layout {
re_log::trace!(
"The user is manipulating the egui_tiles tree - will no longer auto-layout"
);
}
blueprint.set_auto_layout(false, ctx);
}
self.edited |= tab_viewer.edited;
state.space_views_displayed_last_frame = tab_viewer.space_views_displayed_current_frame;
});
self.blueprint.set_maximized(maximized, ctx);
}
pub fn on_frame_start(&mut self, ctx: &ViewerContext<'_>, spaces_info: &SpaceInfoCollection) {
re_tracing::profile_function!();
for space_view in self.blueprint.space_views.values() {
let PerSpaceViewState {
auto_properties,
space_view_state,
} = self.state.space_view_state_mut(
ctx.space_view_class_registry,
space_view.id,
space_view.class_identifier(),
);
space_view.on_frame_start(ctx, space_view_state.as_mut(), auto_properties);
}
if self.blueprint.auto_space_views {
let mut new_space_views = vec![];
for space_view_candidate in default_created_space_views(ctx, spaces_info) {
if self.should_auto_add_space_view(&new_space_views, &space_view_candidate) {
new_space_views.push(space_view_candidate);
}
}
self.blueprint
.add_space_views(new_space_views.into_iter(), ctx, None);
}
}
fn should_auto_add_space_view(
&self,
already_added: &[SpaceViewBlueprint],
space_view_candidate: &SpaceViewBlueprint,
) -> bool {
re_tracing::profile_function!();
for existing_view in self
.blueprint
.space_views
.values()
.chain(already_added.iter())
{
if existing_view.space_origin == space_view_candidate.space_origin {
if existing_view.entities_determined_by_user {
return false;
}
if existing_view
.queries
.iter()
.zip(space_view_candidate.queries.iter())
.all(|(q1, q2)| q1.is_equivalent(q2))
{
return false;
}
}
}
true
}
pub fn update_and_sync_tile_tree_to_blueprint(mut self, ctx: &ViewerContext<'_>) {
let mut reset = false;
for tree_action in self.tree_action_receiver.try_iter() {
match tree_action {
TreeAction::AddSpaceView(space_view_id, parent_container) => {
if self.blueprint.auto_layout {
re_log::trace!(
"Added a space view with no user edits yet - will re-run auto-layout"
);
reset = true;
} else if let Some(parent_id) = parent_container.or(self.tree.root) {
let tile_id = self.tree.tiles.insert_pane(space_view_id);
if let Some(egui_tiles::Tile::Container(container)) =
self.tree.tiles.get_mut(parent_id)
{
re_log::trace!("Inserting new space view into root container");
container.add_child(tile_id);
} else {
re_log::trace!("Root was not a container - will re-run auto-layout");
reset = true;
}
} else {
re_log::trace!("No root found - will re-run auto-layout");
}
self.edited = true;
}
TreeAction::AddContainer(container_kind, parent_container) => {
if let Some(parent_id) = parent_container.or(self.tree.root) {
let tile_id = self
.tree
.tiles
.insert_container(egui_tiles::Container::new(container_kind, vec![]));
if let Some(egui_tiles::Tile::Container(container)) =
self.tree.tiles.get_mut(parent_id)
{
re_log::trace!("Inserting new space view into container {parent_id:?}");
container.add_child(tile_id);
} else {
re_log::trace!(
"Parent or root was not a container - will re-run auto-layout"
);
reset = true;
}
} else {
re_log::trace!("No root found - will re-run auto-layout");
}
self.edited = true;
}
TreeAction::SetContainerKind(container_id, container_kind) => {
if let Some(egui_tiles::Tile::Container(container)) =
self.tree.tiles.get_mut(container_id)
{
re_log::trace!("Mutating container {container_id:?} to {container_kind:?}");
container.set_kind(container_kind);
} else {
re_log::trace!("No root found - will re-run auto-layout");
}
self.edited = true;
}
TreeAction::FocusTab(space_view_id) => {
let found = self.tree.make_active(|_, tile| match tile {
egui_tiles::Tile::Pane(this_space_view_id) => {
*this_space_view_id == space_view_id
}
egui_tiles::Tile::Container(_) => false,
});
re_log::trace!(
"Found tab to focus on for space view ID {space_view_id}: {found}"
);
self.edited = true;
}
TreeAction::Remove(tile_id) => {
for tile in self.tree.remove_recursively(tile_id) {
re_log::trace!("Removing tile {tile_id:?}");
if let egui_tiles::Tile::Pane(space_view_id) = tile {
re_log::trace!("Removing space view {space_view_id}");
self.tree.tiles.remove(tile_id);
self.blueprint.remove_space_view(&space_view_id, ctx);
}
}
if Some(tile_id) == self.tree.root {
self.tree.root = None;
}
self.edited = true;
}
TreeAction::SimplifyContainer(tile_id, options) => {
re_log::trace!("Simplifying tree with options: {options:?}");
self.tree.simplify_children_of_tile(tile_id, &options);
self.edited = true;
}
}
}
if reset {
re_log::trace!("Clearing the blueprint tree to force reset on the next frame");
self.tree = egui_tiles::Tree::empty("viewport_tree");
self.edited = true;
}
if ctx.app_options.legacy_container_blueprint {
self.blueprint.set_tree(&self.tree, ctx);
} else if self.edited {
let options = tree_simplification_option_for_app_options(ctx.app_options);
self.tree.simplify(&options);
self.blueprint.save_tree_as_containers(&self.tree, ctx);
}
}
#[inline]
pub fn is_item_valid(&self, item: &Item) -> bool {
self.blueprint.is_item_valid(item)
}
}
struct TabViewer<'a, 'b> {
viewport_state: &'a mut ViewportState,
ctx: &'a ViewerContext<'b>,
space_views: &'a BTreeMap<SpaceViewId, SpaceViewBlueprint>,
maximized: &'a mut Option<SpaceViewId>,
executed_systems_per_space_view: HashMap<SpaceViewId, (ViewQuery<'a>, SystemExecutionOutput)>,
space_views_displayed_current_frame: Vec<SpaceViewId>,
edited: bool,
}
impl<'a, 'b> egui_tiles::Behavior<SpaceViewId> for TabViewer<'a, 'b> {
fn pane_ui(
&mut self,
ui: &mut egui::Ui,
_tile_id: egui_tiles::TileId,
space_view_id: &mut SpaceViewId,
) -> egui_tiles::UiResponse {
re_tracing::profile_function!();
let Some(space_view_blueprint) = self.space_views.get(space_view_id) else {
return Default::default();
};
let is_zero_sized_viewport = ui.available_size().min_elem() <= 0.0;
if is_zero_sized_viewport {
return Default::default();
}
let Some(latest_at) = self.ctx.rec_cfg.time_ctrl.read().time_int() else {
ui.centered_and_justified(|ui| {
ui.weak("No time selected");
});
return Default::default();
};
let (query, system_output) =
if let Some(result) = self.executed_systems_per_space_view.remove(space_view_id) {
result
} else {
let highlights = highlights_for_space_view(self.ctx, *space_view_id);
space_view_blueprint.execute_systems(self.ctx, latest_at, highlights)
};
let PerSpaceViewState {
auto_properties: _,
space_view_state,
} = self.viewport_state.space_view_state_mut(
self.ctx.space_view_class_registry,
space_view_blueprint.id,
space_view_blueprint.class_identifier(),
);
self.space_views_displayed_current_frame
.push(space_view_blueprint.id);
space_view_blueprint.scene_ui(
space_view_state.as_mut(),
self.ctx,
ui,
&query,
system_output,
);
Default::default()
}
fn tab_title_for_pane(&mut self, space_view_id: &SpaceViewId) -> egui::WidgetText {
if let Some(space_view) = self.space_views.get(space_view_id) {
space_view.display_name.clone().into()
} else {
re_log::warn_once!("SpaceViewId missing during egui_tiles");
self.ctx.re_ui.error_text("Internal error").into()
}
}
fn tab_title_for_tile(
&mut self,
tiles: &egui_tiles::Tiles<SpaceViewId>,
tile_id: egui_tiles::TileId,
) -> egui::WidgetText {
if let Some(tile) = tiles.get(tile_id) {
match tile {
egui_tiles::Tile::Pane(pane) => self.tab_title_for_pane(pane),
egui_tiles::Tile::Container(container) => {
format!("{:?} Container", container.kind()).into()
}
}
} else {
re_log::warn_once!("SpaceViewId missing during tab_title_for_tile");
self.ctx.re_ui.error_text("Internal error").into()
}
}
#[allow(clippy::fn_params_excessive_bools)]
fn tab_ui(
&mut self,
tiles: &egui_tiles::Tiles<SpaceViewId>,
ui: &mut egui::Ui,
id: egui::Id,
tile_id: egui_tiles::TileId,
active: bool,
is_being_dragged: bool,
) -> egui::Response {
let tab_widget = TabWidget::new(self, ui, tiles, tile_id, active, 1.0);
let response = ui.interact(tab_widget.rect, id, egui::Sense::click_and_drag());
if ui.is_rect_visible(tab_widget.rect) && !is_being_dragged {
tab_widget.paint(ui);
}
if let Some(egui_tiles::Tile::Pane(space_view_id)) = tiles.get(tile_id) {
item_ui::select_hovered_on_click(self.ctx, &response, Item::SpaceView(*space_view_id));
}
response
}
fn drag_ui(
&mut self,
tiles: &egui_tiles::Tiles<SpaceViewId>,
ui: &mut egui::Ui,
tile_id: egui_tiles::TileId,
) {
let tab_widget = TabWidget::new(self, ui, tiles, tile_id, true, 0.5);
let frame = egui::Frame {
inner_margin: egui::Margin::same(0.),
outer_margin: egui::Margin::same(0.),
rounding: egui::Rounding::ZERO,
shadow: Default::default(),
fill: egui::Color32::TRANSPARENT,
stroke: egui::Stroke::NONE,
};
frame.show(ui, |ui| {
tab_widget.paint(ui);
});
}
fn retain_pane(&mut self, space_view_id: &SpaceViewId) -> bool {
self.space_views.contains_key(space_view_id)
}
fn top_bar_right_ui(
&mut self,
tiles: &egui_tiles::Tiles<SpaceViewId>,
ui: &mut egui::Ui,
_tile_id: egui_tiles::TileId,
tabs: &egui_tiles::Tabs,
_scroll_offset: &mut f32,
) {
let Some(active) = tabs.active.and_then(|active| tiles.get(active)) else {
return;
};
let egui_tiles::Tile::Pane(space_view_id) = active else {
return;
};
let space_view_id = *space_view_id;
let Some(space_view) = self.space_views.get(&space_view_id) else {
return;
};
let num_space_views = tiles.tiles().filter(|tile| tile.is_pane()).count();
ui.add_space(8.0);
if *self.maximized == Some(space_view_id) {
if self
.ctx
.re_ui
.small_icon_button(ui, &re_ui::icons::MINIMIZE)
.on_hover_text("Restore - show all spaces")
.clicked()
{
*self.maximized = None;
}
} else if num_space_views > 1 {
if self
.ctx
.re_ui
.small_icon_button(ui, &re_ui::icons::MAXIMIZE)
.on_hover_text("Maximize Space View")
.clicked()
{
*self.maximized = Some(space_view_id);
}
}
let help_text = space_view
.class(self.ctx.space_view_class_registry)
.help_text(self.ctx.re_ui);
re_ui::help_hover_button(ui).on_hover_text(help_text);
}
fn tab_bar_color(&self, _visuals: &egui::Visuals) -> egui::Color32 {
self.ctx.re_ui.design_tokens.tab_bar_color
}
fn dragged_overlay_color(&self, visuals: &egui::Visuals) -> egui::Color32 {
visuals.panel_fill.gamma_multiply(0.5)
}
fn drag_preview_stroke(&self, _visuals: &egui::Visuals) -> egui::Stroke {
egui::Stroke::new(1.0, egui::Color32::WHITE.gamma_multiply(0.5))
}
fn drag_preview_color(&self, _visuals: &egui::Visuals) -> egui::Color32 {
egui::Color32::WHITE.gamma_multiply(0.1)
}
fn tab_bar_height(&self, _style: &egui::Style) -> f32 {
re_ui::ReUi::title_bar_height()
}
fn simplification_options(&self) -> egui_tiles::SimplificationOptions {
tree_simplification_option_for_app_options(self.ctx.app_options)
}
fn on_edit(&mut self) {
self.edited = true;
}
}
struct TabWidget {
galley: egui::widget_text::WidgetTextGalley,
rect: egui::Rect,
galley_rect: egui::Rect,
icon: &'static Icon,
icon_size: egui::Vec2,
icon_rect: egui::Rect,
bg_color: egui::Color32,
text_color: egui::Color32,
}
impl TabWidget {
fn new<'a>(
tab_viewer: &'a mut TabViewer<'_, '_>,
ui: &'a mut egui::Ui,
tiles: &'a egui_tiles::Tiles<SpaceViewId>,
tile_id: egui_tiles::TileId,
active: bool,
gamma: f32,
) -> Self {
let space_view = if let Some(egui_tiles::Tile::Pane(space_view_id)) = tiles.get(tile_id) {
tab_viewer.space_views.get(space_view_id)
} else {
None
};
let selected = space_view.map_or(false, |space_view| {
tab_viewer
.ctx
.selection()
.contains_item(&Item::SpaceView(space_view.id))
});
let hovered = space_view.map_or(false, |space_view| {
tab_viewer
.ctx
.hovered()
.contains_item(&Item::SpaceView(space_view.id))
});
let icon_size = ReUi::small_icon_size();
let icon_width_plus_padding = icon_size.x + ReUi::text_to_icon_padding();
let icon = space_view.map_or(&re_ui::icons::CONTAINER, |space_view| {
space_view
.class(tab_viewer.ctx.space_view_class_registry)
.icon()
});
let text = tab_viewer.tab_title_for_tile(tiles, tile_id);
let font_id = egui::TextStyle::Button.resolve(ui.style());
let galley = text.into_galley(ui, Some(false), f32::INFINITY, font_id);
let x_margin = tab_viewer.tab_title_spacing(ui.visuals());
let (_, rect) = ui.allocate_space(egui::vec2(
galley.size().x + 2.0 * x_margin + icon_width_plus_padding,
ReUi::title_bar_height(),
));
let galley_rect = egui::Rect::from_two_pos(
rect.min + egui::vec2(icon_width_plus_padding, 0.0),
rect.max,
);
let icon_rect = egui::Rect::from_center_size(
egui::pos2(rect.left() + x_margin + icon_size.x / 2.0, rect.center().y),
icon_size,
);
let bg_color = if selected {
ui.visuals().selection.bg_fill
} else if hovered {
ui.visuals().widgets.hovered.bg_fill
} else {
tab_viewer.tab_bar_color(ui.visuals())
};
let bg_color = bg_color.gamma_multiply(gamma);
let text_color = tab_viewer
.tab_text_color(ui.visuals(), tiles, tile_id, active)
.gamma_multiply(gamma);
Self {
galley,
rect,
galley_rect,
icon,
icon_size,
icon_rect,
bg_color,
text_color,
}
}
fn paint(self, ui: &egui::Ui) {
ui.painter()
.rect(self.rect, 0.0, self.bg_color, egui::Stroke::NONE);
let icon_image = self
.icon
.as_image()
.fit_to_exact_size(self.icon_size)
.tint(self.text_color);
icon_image.paint_at(ui, self.icon_rect);
ui.painter().galley_with_color(
egui::Align2::CENTER_CENTER
.align_size_within_rect(self.galley.size(), self.galley_rect)
.min,
self.galley.galley,
self.text_color,
);
}
}