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
use eframe::emath::NumExt;
use crate::{DesignTokens, UiExt as _};
/// Helper object to handle a [`ModalWrapper`] window.
///
/// A [`ModalWrapper`] is typically held only so long as it is displayed, so it's typically stored in an
/// [`Option`]. This helper object handles that for your.
///
/// Usage:
/// ```
/// # use re_ui::modal::{ModalWrapper, ModalHandler};
///
/// # egui::__run_test_ui(|ui| {
/// let mut modal_handler = ModalHandler::default();
///
/// if ui.button("Open").clicked() {
/// modal_handler.open();
/// }
///
/// modal_handler.ui(ui.ctx(), || ModalWrapper::new("Modal Window"), |ui, _| {
/// ui.label("Modal content");
/// });
/// # });
/// ```
#[derive(Default)]
pub struct ModalHandler {
modal: Option<ModalWrapper>,
should_open: bool,
}
impl ModalHandler {
/// Open the model the next time the [`ModalHandler::ui`] method is called.
pub fn open(&mut self) {
self.should_open = true;
}
/// Draw the modal window, creating/destroying it as required.
pub fn ui<R>(
&mut self,
ctx: &egui::Context,
make_modal: impl FnOnce() -> ModalWrapper,
content_ui: impl FnOnce(&mut egui::Ui, &mut bool) -> R,
) -> Option<R> {
if self.modal.is_none() && self.should_open {
self.modal = Some(make_modal());
self.should_open = false;
}
if let Some(modal) = &mut self.modal {
let ModalWrapperResponse { inner, open } = modal.ui(ctx, content_ui);
if !open {
self.modal = None;
}
Some(inner)
} else {
None
}
}
}
/// Response returned by [`ModalWrapper::ui`].
pub struct ModalWrapperResponse<R> {
/// What the content closure returned if it was actually run.
pub inner: R,
/// Whether the modal should remain open.
pub open: bool,
}
/// Show a modal window with Rerun style using [`egui::Modal`].
///
/// 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 [`ModalWrapper`] are typically used via the [`ModalHandler`] helper object to reduce
/// boilerplate.
pub struct ModalWrapper {
title: String,
min_width: Option<f32>,
min_height: Option<f32>,
default_height: Option<f32>,
full_span_content: bool,
scrollable: egui::Vec2b,
}
impl ModalWrapper {
/// Create a new modal with the given title.
pub fn new(title: &str) -> Self {
Self {
title: title.to_owned(),
min_width: None,
min_height: None,
default_height: None,
full_span_content: false,
scrollable: false.into(),
}
}
/// Set the minimum width of the modal window.
#[inline]
pub fn min_width(mut self, min_width: f32) -> Self {
self.min_width = Some(min_width);
self
}
/// Set the minimum height of the modal window.
#[inline]
pub fn min_height(mut self, min_height: f32) -> Self {
self.min_height = Some(min_height);
self
}
/// Set the default height of the modal window.
#[inline]
pub fn default_height(mut self, default_height: f32) -> Self {
self.default_height = Some(default_height);
self
}
/// 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.
#[inline]
pub fn full_span_content(mut self, full_span_content: bool) -> Self {
self.full_span_content = full_span_content;
self
}
/// Enclose the contents in a scroll area.
#[inline]
pub fn scrollable(mut self, scrollable: impl Into<egui::Vec2b>) -> Self {
self.scrollable = scrollable.into();
self
}
/// Show the modal window.
///
/// Typically called by [`ModalHandler::ui`].
pub fn ui<R>(
&self,
ctx: &egui::Context,
content_ui: impl FnOnce(&mut egui::Ui, &mut bool) -> R,
) -> ModalWrapperResponse<R> {
let id = egui::Id::new(&self.title);
let mut open = true;
let mut area = egui::Modal::default_area(id);
if let Some(default_height) = self.default_height {
area = area.default_height(default_height);
}
let modal_response = egui::Modal::new(id.with("modal"))
.frame(egui::Frame {
fill: ctx.style().visuals.panel_fill,
..Default::default()
})
.area(area)
.show(ctx, |ui| {
ui.set_clip_rect(ui.max_rect());
let item_spacing_y = ui.spacing().item_spacing.y;
ui.spacing_mut().item_spacing.y = 0.0;
if let Some(min_width) = self.min_width {
ui.set_min_width(min_width);
}
if let Some(min_height) = self.min_height {
ui.set_min_height(min_height);
}
//
// Title bar
//
view_padding_frame(&ViewPaddingFrameParams {
left_and_right: true,
top: true,
bottom: false,
})
.show(ui, |ui| {
Self::title_bar(ui, &self.title, &mut open);
ui.add_space(DesignTokens::view_padding());
ui.full_span_separator();
});
//
// Inner content
//
let wrapped_content_ui = |ui: &mut egui::Ui, open: &mut bool| -> R {
// We always have side margin, but these must happen _inside_ the scroll area
// (if any). Otherwise, the scroll bar is not snug with the right border and
// may interfere with the action buttons of `ListItem`s.
view_padding_frame(&ViewPaddingFrameParams {
left_and_right: true,
top: false,
bottom: false,
})
.show(ui, |ui| {
if self.full_span_content {
// no further spacing for the content UI
content_ui(ui, open)
} else {
// we must restore vertical spacing and add view padding at the bottom
ui.add_space(item_spacing_y);
view_padding_frame(&ViewPaddingFrameParams {
left_and_right: false,
top: false,
bottom: true,
})
.show(ui, |ui| {
ui.spacing_mut().item_spacing.y = item_spacing_y;
content_ui(ui, open)
})
.inner
}
})
.inner
};
//
// Optional scroll area
//
if self.scrollable.any() {
// Make the modal size less jumpy and work around https://github.com/emilk/egui/issues/5138
let max_height = 0.85 * ui.ctx().screen_rect().height();
let min_height = 0.3 * ui.ctx().screen_rect().height().at_most(max_height);
egui::ScrollArea::new(self.scrollable)
.min_scrolled_height(max_height)
.max_height(max_height)
.show(ui, |ui| {
let res = wrapped_content_ui(ui, &mut open);
if ui.min_rect().height() < min_height {
ui.add_space(min_height - ui.min_rect().height());
}
res
})
.inner
} else {
wrapped_content_ui(ui, &mut open)
}
});
if modal_response.should_close() {
open = false;
}
ModalWrapperResponse {
inner: modal_response.inner,
open,
}
}
/// Display a title bar in our own style.
fn title_bar(ui: &mut egui::Ui, title: &str, open: &mut bool) {
ui.horizontal(|ui| {
ui.strong(title);
ui.add_space(16.0);
let mut ui = ui.new_child(
egui::UiBuilder::new()
.max_rect(ui.max_rect())
.layout(egui::Layout::right_to_left(egui::Align::Center)),
);
if ui.small_icon_button(&crate::icons::CLOSE).clicked() {
*open = false;
}
});
}
}
struct ViewPaddingFrameParams {
left_and_right: bool,
top: bool,
bottom: bool,
}
/// Utility to produce a [`egui::Frame`] with padding on some sides.
#[inline]
fn view_padding_frame(params: &ViewPaddingFrameParams) -> egui::Frame {
let ViewPaddingFrameParams {
left_and_right,
top,
bottom,
} = *params;
egui::Frame {
inner_margin: egui::Margin {
left: if left_and_right {
DesignTokens::view_padding()
} else {
0.0
},
right: if left_and_right {
DesignTokens::view_padding()
} else {
0.0
},
top: if top {
DesignTokens::view_padding()
} else {
0.0
},
bottom: if bottom {
DesignTokens::view_padding()
} else {
0.0
},
},
..Default::default()
}
}