Struct re_viewport::viewport::TabViewer

struct TabViewer<'a, 'b> {
    view_states: &'a mut ViewStates,
    ctx: &'a ViewerContext<'b>,
    viewport_blueprint: &'a ViewportBlueprint,
    maximized: &'a mut Option<SpaceViewId>,
    root_container_id: ContainerId,
    tree_action_sender: Sender<TreeAction>,
    executed_systems_per_space_view: HashMap<SpaceViewId, (ViewQuery<'a>, SystemExecutionOutput)>,
    contents_per_tile_id: HashMap<TileId, Contents>,
    edited: bool,
}

egui_tiles has tiles which are either containers or panes.

In our case, each pane is a space view, while containers are just groups of things.

Fields

view_states: &'a mut ViewStates

ctx: &'a ViewerContext<'b>

viewport_blueprint: &'a ViewportBlueprint

maximized: &'a mut Option<SpaceViewId>

root_container_id: ContainerId

tree_action_sender: Sender<TreeAction>

executed_systems_per_space_view: HashMap<SpaceViewId, (ViewQuery<'a>, SystemExecutionOutput)>

List of query & system execution results for each space view.

contents_per_tile_id: HashMap<TileId, Contents>

List of contents for each tile id

edited: bool

The user edited the tree.

Trait Implementations

impl<'a, 'b> Behavior<BlueprintId<SpaceViewIdRegistry>> for TabViewer<'a, 'b>

fn drag_preview_stroke(&self, _visuals: &Visuals) -> Stroke

When drag-and-dropping a tile, the candidate area is drawn with this stroke.

fn drag_preview_color(&self, _visuals: &Visuals) -> Color32

When drag-and-dropping a tile, the candidate area is drawn with this background color.

fn tab_bar_height(&self, _style: &Style) -> f32

The height of the bar holding tab titles.

fn simplification_options(&self) -> SimplificationOptions

What are the rules for simplifying the tree?

These options are applied on every frame by egui_tiles.

fn pane_ui( &mut self, ui: &mut Ui, _tile_id: TileId, view_id: &mut SpaceViewId ) -> UiResponse

Show a pane tile in the given [egui::Ui].

fn tab_title_for_pane(&mut self, space_view_id: &SpaceViewId) -> WidgetText

The title of a pane tab.

fn tab_ui( &mut self, tiles: &mut Tiles<SpaceViewId>, ui: &mut Ui, id: Id, tile_id: TileId, tab_state: &TabState ) -> Response

Show the ui for the a tab of some tile.

fn drag_ui(&mut self, tiles: &Tiles<SpaceViewId>, ui: &mut Ui, tile_id: TileId)

Show the ui for the tab being dragged.

fn retain_pane(&mut self, space_view_id: &SpaceViewId) -> bool

Return false if a given pane should be removed from its parent.

fn top_bar_right_ui( &mut self, tiles: &Tiles<SpaceViewId>, ui: &mut Ui, _tile_id: TileId, tabs: &Tabs, _scroll_offset: &mut f32 )

Adds some UI to the top right of each tab bar.

fn tab_bar_color(&self, _visuals: &Visuals) -> Color32

The background color of the tab bar.

fn dragged_overlay_color(&self, visuals: &Visuals) -> Color32

Cover the tile that is being dragged with this color.

fn on_edit(&mut self, edit_action: EditAction)

Called if the user edits the tree somehow, e.g. changes the size of some container, clicks a tab, or drags a tile.

fn is_tab_closable(&self, _tiles: &Tiles<Pane>, _tile_id: TileId) -> bool

Should the tab have a close-button?

fn on_tab_close(&mut self, _tiles: &mut Tiles<Pane>, _tile_id: TileId) -> bool

Called when the close-button on a tab is pressed.

fn close_button_outer_size(&self) -> f32

The size of the close button in the tab.

fn close_button_inner_margin(&self) -> f32

How much smaller the visual part of the close-button will be compared to [Self::close_button_outer_size].

fn tab_title_for_tile( &mut self, tiles: &Tiles<Pane>, tile_id: TileId ) -> WidgetText

The title of a general tab.

fn on_tab_button( &mut self, _tiles: &Tiles<Pane>, _tile_id: TileId, button_response: Response ) -> Response

Called by the default implementation of [Self::tab_ui] for each added button

fn gap_width(&self, _style: &Style) -> f32

Width of the gap between tiles in a horizontal or vertical layout, and between rows/columns in a grid layout.

fn min_size(&self) -> f32

No child should shrink below this width nor height.

fn preview_dragged_panes(&self) -> bool

Show we preview panes that are being dragged, i.e. show their ui in the region where they will end up?

fn paint_on_top_of_tile( &self, _painter: &Painter, _style: &Style, _tile_id: TileId, _rect: Rect )

Add some custom painting on top of a tile (container or pane), e.g. draw an outline on top of it.

fn resize_stroke(&self, style: &Style, resize_state: ResizeState) -> Stroke

The stroke used for the lines in horizontal, vertical, and grid layouts.

fn tab_title_spacing(&self, _visuals: &Visuals) -> f32

Extra spacing to left and right of tab titles.

fn tab_bg_color( &self, visuals: &Visuals, _tiles: &Tiles<Pane>, _tile_id: TileId, state: &TabState ) -> Color32

The background color of a tab.

fn tab_outline_stroke( &self, visuals: &Visuals, _tiles: &Tiles<Pane>, _tile_id: TileId, state: &TabState ) -> Stroke

Stroke of the outline around a tab title.

fn tab_bar_hline_stroke(&self, visuals: &Visuals) -> Stroke

Stroke of the line separating the tab title bar and the content of the active tab.

fn tab_text_color( &self, visuals: &Visuals, _tiles: &Tiles<Pane>, _tile_id: TileId, state: &TabState ) -> Color32

The color of the title text of the tab.

fn paint_drag_preview( &self, visuals: &Visuals, painter: &Painter, parent_rect: Option<Rect>, preview_rect: Rect )

When drag-and-dropping a tile, how do we preview what is about to happen?

fn grid_auto_column_count( &self, num_visible_children: usize, rect: Rect, gap: f32 ) -> usize

How many columns should we use for a [crate::Grid] put into [crate::GridLayout::Auto]?

fn ideal_tile_aspect_ratio(&self) -> f32

When using [crate::GridLayout::Auto], what is the ideal aspect ratio of a tile?