Struct re_viewer::external::re_ui::modal::Modal

pub struct Modal {
    title: String,
    min_width: Option<f32>,
    min_height: Option<f32>,
    default_height: Option<f32>,
    full_span_content: bool,
}

Show a modal window with Rerun style.

Modal fakes as a modal window, since egui doesn’t have them yet. This done by dimming the background and capturing clicks outside the window.

The positioning of the modal is as follows:

┌─rerun window─────▲─────────────────────┐
│                  │ 75px / 10%          │
│          ╔═modal═▼══════════╗  ▲       │
│          ║               ▲  ║  │       │
│          ║ actual height │  ║  │       │
│          ║      based on │  ║  │ max   │
│          ║       content │  ║  │ height│
│          ║               │  ║  │       │
│          ║               ▼  ║  │       │
│          ╚══════════════════╝  │       │
│          │                  │  │       │
│          └───────▲──────────┘  ▼       │
│                  │ 75px / 10%          │
└──────────────────▼─────────────────────┘

The modal sets the clip rect such as to allow full-span highlighting behavior (e.g. with crate::list_item::ListItem). Consider using crate::UiExt::full_span_separator to draw a separator that spans the full width of the modal instead of the usual [egui::Ui::separator] method.

Note that Modal are typically used via the ModalHandler helper object to reduce boilerplate.

Fields

title: String

min_width: Option<f32>

min_height: Option<f32>

default_height: Option<f32>

full_span_content: bool

Implementations

impl Modal

pub fn new(title: &str) -> Modal

Create a new modal with the given title.

pub fn min_width(self, min_width: f32) -> Modal

Set the minimum width of the modal window.

pub fn min_height(self, min_height: f32) -> Modal

Set the minimum height of the modal window.

pub fn default_height(self, default_height: f32) -> Modal

Set the default height of the modal window.

pub fn full_span_content(self, full_span_content: bool) -> Modal

Configure the content area of the modal for full span highlighting.

This includes:

• setting the vertical spacing to 0.0
• removing any padding at the bottom of the area

In this mode, the user code is responsible for adding spacing between items.

pub fn ui<R>( &mut self, ctx: &Context, content_ui: impl FnOnce(&mut Ui, &mut bool) -> R ) -> ModalResponse<R>

Show the modal window.

Typically called by ModalHandler::ui.