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 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
use egui::{NumExt as _, Ui};
use ehttp::{fetch, Request};
use itertools::Itertools as _;
use poll_promise::Promise;
use re_viewer_context::{CommandSender, SystemCommand, SystemCommandSender as _};
#[derive(Debug, serde::Deserialize)]
struct ExampleThumbnail {
url: String,
width: u32,
height: u32,
}
#[derive(Debug, serde::Deserialize)]
struct ExampleDesc {
/// `snake_case` version of the example name
name: String,
/// human-readable version of the example name
title: String,
tags: Vec<String>,
rrd_url: String,
thumbnail: ExampleThumbnail,
/// URL of the source code in GitHub
source_url: Option<String>,
}
// TODO(ab): use design tokens
pub(super) const MIN_COLUMN_WIDTH: f32 = 250.0;
const MAX_COLUMN_WIDTH: f32 = 337.0;
const MAX_COLUMN_COUNT: usize = 3;
const COLUMN_HSPACE: f32 = 20.0;
const AFTER_HEADER_VSPACE: f32 = 48.0;
const TITLE_TO_GRID_VSPACE: f32 = 24.0;
const ROW_VSPACE: f32 = 20.0;
const THUMBNAIL_RADIUS: f32 = 12.0;
const CARD_THUMBNAIL_ASPECT_RATIO: f32 = 337.0 / 250.0;
const CARD_DESCRIPTION_HEIGHT: f32 = 130.0;
const DESCRIPTION_INNER_MARGIN: f32 = 20.0;
/// Structure to track both an example description and its layout in the grid.
///
/// For layout purposes, each example spans multiple cells in the grid. This structure is used to
/// track the rectangle that spans the block of cells used for the corresponding example, so hover/
/// click can be detected.
struct ExampleDescLayout {
desc: ExampleDesc,
rect: egui::Rect,
/// We do an async HEAD request to get the size of the RRD file
/// so we can show it to the user.
rrd_byte_size_promise: Promise<Option<u64>>,
}
impl ExampleDescLayout {
fn new(egui_ctx: &egui::Context, desc: ExampleDesc) -> Self {
Self {
rrd_byte_size_promise: load_file_size(egui_ctx, desc.rrd_url.clone()),
desc,
rect: egui::Rect::NOTHING,
}
}
/// Move the egui cursor to the bottom of this example card.
fn move_cursor_to_bottom(&self, ui: &mut Ui) {
let vspace = (self.rect.max.y - ui.cursor().min.y).at_least(0.0);
ui.add_space(vspace);
}
}
type ManifestJson = Vec<ExampleDesc>;
type Manifest = Vec<ExampleDescLayout>;
type ManifestPromise = Promise<Result<Manifest, LoadError>>;
enum LoadError {
Deserialize(serde_json::Error),
Fetch(String),
}
impl std::fmt::Display for LoadError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Deserialize(err) => {
write!(f, "manifest is invalid, it may be outdated: {err}")
}
Self::Fetch(err) => f.write_str(err),
}
}
}
fn load_manifest(egui_ctx: &egui::Context, url: String) -> ManifestPromise {
let (sender, promise) = Promise::new();
let egui_ctx = egui_ctx.clone(); // So we can wake up the ui thread
fetch(Request::get(url), move |response| {
match response {
Ok(response) => sender.send(
serde_json::from_slice::<ManifestJson>(&response.bytes)
.map(|examples| {
examples
.into_iter()
.map(|example| ExampleDescLayout::new(&egui_ctx, example))
.collect()
})
.map_err(LoadError::Deserialize),
),
Err(err) => sender.send(Err(LoadError::Fetch(err))),
}
egui_ctx.request_repaint();
});
promise
}
/// Do a HEAD request to get the size of a file.
///
/// In case of an error, it is logged as DEBUG and
/// the promise is resolved to `None`.
fn load_file_size(egui_ctx: &egui::Context, url: String) -> Promise<Option<u64>> {
let (sender, promise) = Promise::new();
let egui_ctx = egui_ctx.clone(); // So we can wake up the ui thread
let request = Request {
method: "HEAD".into(),
..Request::get(url.clone())
};
fetch(request, move |response| {
match response {
Ok(response) => {
if response.ok {
let headers = &response.headers;
let content_length = headers
.get("content-length")
.or_else(|| headers.get("x-goog-stored-content-length"))
.and_then(|s| s.parse::<u64>().ok());
sender.send(content_length);
} else {
re_log::debug!(
"Failed to load file size of {url:?}: {} {}",
response.status,
response.status_text
);
sender.send(None);
}
}
Err(err) => {
re_log::debug!("Failed to load file size of {url:?}: {err}");
sender.send(None);
}
}
egui_ctx.request_repaint();
});
promise
}
pub(super) struct ExampleSection {
id: egui::Id,
manifest_url: String,
examples: Option<ManifestPromise>,
}
fn default_manifest_url() -> String {
// Sometimes we want the default to point somewhere else, such as when doing nightly builds.
if let Some(url) = option_env!("DEFAULT_EXAMPLES_MANIFEST_URL") {
return url.into();
}
let build_info = re_build_info::build_info!();
if build_info.version.is_rc() || build_info.version.is_release() {
// If this is versioned as a release or rc, always point to the versioned
// example manifest. This applies even if doing a local source build.
format!(
"https://app.rerun.io/version/{version}/examples_manifest.json",
version = build_info.version,
)
} else {
// We don't build examples on each PR, so we don't have much to point to except for the nightly examples
// We could point to the main branch, but it's not always finished building, and so doesn't always work.
"https://app.rerun.io/version/nightly/examples_manifest.json".into()
}
}
impl Default for ExampleSection {
fn default() -> Self {
Self {
id: egui::Id::new("example_section"),
manifest_url: default_manifest_url(),
examples: None,
}
}
}
impl ExampleSection {
pub fn set_manifest_url(&mut self, egui_ctx: &egui::Context, url: String) {
if self.manifest_url != url {
self.manifest_url = url.clone();
self.examples = Some(load_manifest(egui_ctx, url));
}
}
/// Draw the example section of the welcome screen.
///
/// Layout:
/// ```text
/// {MIN|MAX}_COLUMN_WIDTH COLUMN_HSPACE
/// ◀───────────────────────────────▶◀──▶
/// ╔═══════════════════════════════╗ ┌────────
/// ║ THUMBNAIL ▲ ║ │
/// ║ │ ║ │
/// ║ │ ║ │
/// ║ │ ║ │
/// ║ CARD_THUMBNAIL_ │ ║ │
/// ║ ASPECT_RATIO │ ║ │
/// ║ │ ║ │
/// ║ │ ║ │
/// ║ ▼ ║ │
/// ╠═══════════════════════════════╣ │
/// ║ ▲ ║ │
/// ║ ┌─────────────────────┼─┐ ║ │
/// ║ │DESCRIPTION │ │ ║ │
/// ║ │ │ │ ║ DESCRIPTION_
/// ║ │ CARD_DESCRIPTION_ │ │◀─▶║ INNER_
/// ║ │ HEIGHT │ │ ║ MARGIN
/// ║ └─────────────────────┼─┘ ║ │
/// ║ ▼ ║ │
/// ╚═══════════════════════════════╝ └────────
/// ▲
/// │ ROW_VSPACE
/// ▼
/// ┌───────────────────────────────┐ ┌────────
/// │ │ │
/// │ │ │
/// ```
pub(super) fn ui(
&mut self,
ui: &mut egui::Ui,
command_sender: &CommandSender,
header_ui: &impl Fn(&mut Ui),
is_history_enabled: bool,
) {
let examples = self
.examples
.get_or_insert_with(|| load_manifest(ui.ctx(), self.manifest_url.clone()));
// vertical spacing isn't homogeneous so it's handled manually
let grid_spacing = egui::vec2(COLUMN_HSPACE, 0.0);
let column_count = (((ui.available_width() + grid_spacing.x)
/ (MIN_COLUMN_WIDTH + grid_spacing.x))
.floor() as usize)
.clamp(1, MAX_COLUMN_COUNT);
let column_width = ((ui.available_width() + grid_spacing.x) / column_count as f32
- grid_spacing.x)
.floor()
.clamp(MIN_COLUMN_WIDTH, MAX_COLUMN_WIDTH);
ui.horizontal(|ui| {
// this space is added on the left so that the grid is centered
let centering_hspace = (ui.available_width()
- column_count as f32 * column_width
- (column_count - 1) as f32 * grid_spacing.x)
.max(0.0)
/ 2.0;
ui.add_space(centering_hspace);
ui.vertical(|ui| {
header_ui(ui);
ui.add_space(AFTER_HEADER_VSPACE);
let Some(examples) = examples.ready_mut() else {
// Still waiting for example to load
ui.separator();
ui.spinner(); // Placeholder for the examples
return;
};
let examples = match examples {
Ok(examples) => examples,
Err(err) => {
// Examples failed to load.
re_log::warn_once!("Failed to load examples: {err}");
return;
}
};
if examples.is_empty() {
ui.label("No examples found.");
return;
}
ui.add(egui::Label::new(
egui::RichText::new("View example recordings")
.strong()
.line_height(Some(32.0))
.text_style(re_ui::DesignTokens::welcome_screen_h2()),
));
ui.add_space(TITLE_TO_GRID_VSPACE);
egui::Grid::new("example_section_grid")
.spacing(grid_spacing)
.min_col_width(column_width)
.max_col_width(column_width)
.show(ui, |ui| {
// Disable text selection so that hovering the example card only hovers the card
ui.style_mut().interaction.selectable_labels = false;
for row_of_examples in examples.chunks_mut(column_count) {
let mut row_example_responses: Vec<egui::Response> = vec![];
// Background and thumbnail
for example in &mut *row_of_examples {
// this is the beginning of the first cell for this example, we can
// fully compute its rect now
example.rect = egui::Rect::from_min_size(
ui.cursor().min,
egui::vec2(
column_width,
column_width / CARD_THUMBNAIL_ASPECT_RATIO
+ CARD_DESCRIPTION_HEIGHT,
),
);
let response = ui.interact(
example.rect,
self.id.with(&example.desc.name),
egui::Sense::click(),
);
// paint background
ui.painter().rect_filled(
example.rect,
THUMBNAIL_RADIUS,
//TODO(ab): as per figma, use design tokens instead
egui::Color32::WHITE.gamma_multiply(0.04),
);
if response.clicked() {
// TODO(#5177): This workaround is needed to avoid the click to "leak"
// through the UI, potentially causing some views (e.g. timeseries or time
// panel to quit auto-zoom mode.
ui.input_mut(|i| i.pointer = Default::default());
open_example_url(
ui.ctx(),
command_sender,
&example.desc.rrd_url,
is_history_enabled,
);
}
row_example_responses.push(response);
ui.vertical(|ui| example.image_ui(ui, column_width));
}
ui.end_row();
// Title
for example in &*row_of_examples {
ui.vertical(|ui| example.tile_ui(ui));
}
ui.end_row();
// Tags
for example in &*row_of_examples {
ui.vertical(|ui| example.tags_ui(ui));
}
ui.end_row();
// Source code link and file size
for example in &*row_of_examples {
ui.vertical(|ui| {
// The previous row (tags) may take one or two lines, depending
// on wrapping, so we use the bottom of the example card as
// reference to position the source link.
example.move_cursor_to_bottom(ui);
ui.add_space(-DESCRIPTION_INNER_MARGIN - 15.0);
example.github_link_and_size_ui(ui);
// Ensure the egui cursor is moved according to this card's
// geometry.
example.move_cursor_to_bottom(ui);
// Manual spacing between rows.
ui.add_space(ROW_VSPACE);
});
}
// Hover effect
for (example, response) in
itertools::izip!(&*row_of_examples, row_example_responses)
{
if response.hovered() {
// We do the hover effect here, last, so we can make the whole card,
// including the image, brighter.
ui.painter().rect_filled(
example.rect,
THUMBNAIL_RADIUS,
//TODO(ab): use design tokens
egui::Color32::from_additive_luminance(25),
);
}
}
ui.end_row();
}
});
});
});
}
}
fn open_example_url(
_egui_ctx: &egui::Context,
command_sender: &CommandSender,
rrd_url: &str,
_is_history_enabled: bool,
) {
let data_source = re_data_source::DataSource::RrdHttpUrl {
url: rrd_url.to_owned(),
follow: false,
};
// If the user re-download an already open recording, clear it out first
command_sender.send_system(SystemCommand::ClearSourceAndItsStores(
re_smart_channel::SmartChannelSource::RrdHttpStream {
url: rrd_url.to_owned(),
follow: false,
},
));
command_sender.send_system(SystemCommand::LoadDataSource(data_source));
#[cfg(target_arch = "wasm32")]
if _is_history_enabled {
use crate::history::{history, HistoryEntry, HistoryExt as _};
use crate::web_tools::JsResultExt as _;
if let Some(history) = history().ok_or_log_js_error() {
let entry = HistoryEntry::default().rrd_url(rrd_url.to_owned());
history.push_entry(entry).ok_or_log_js_error();
}
}
}
impl ExampleDescLayout {
fn image_ui(&self, ui: &mut Ui, column_width: f32) {
// dimensions of the source image to use as thumbnail
let image_width = self.desc.thumbnail.width as f32;
let image_height = self.desc.thumbnail.height as f32;
// the thumbnail rect is determined by the column width and a fixed aspect ratio
let thumbnail_rect = egui::Rect::from_min_size(
ui.cursor().left_top(),
egui::vec2(column_width, column_width / CARD_THUMBNAIL_ASPECT_RATIO),
);
let thumbnail_width = thumbnail_rect.width();
let thumbnail_height = thumbnail_rect.height();
// compute image UV coordinates implementing a "cropping" scale to fit thumbnail rect
let display_aspect_ratio = thumbnail_width / thumbnail_height;
let image_aspect_ratio = image_width / image_height;
let uv_rect = if image_aspect_ratio > display_aspect_ratio {
let a = (image_width / image_height * thumbnail_height - thumbnail_width)
/ 2.0
/ image_width;
egui::Rect::from_min_max(egui::Pos2::new(a, 0.0), egui::Pos2::new(1.0 - a, 1.0))
} else {
let a = (image_height / image_width * thumbnail_width - thumbnail_height)
/ 2.0
/ image_height;
egui::Rect::from_min_max(egui::Pos2::new(0.0, a), egui::Pos2::new(1.0, 1.0 - a))
};
let rounding = egui::Rounding {
nw: THUMBNAIL_RADIUS,
ne: THUMBNAIL_RADIUS,
sw: 0.0,
se: 0.0,
};
egui::Image::new(&self.desc.thumbnail.url)
.uv(uv_rect)
.rounding(rounding)
.paint_at(ui, thumbnail_rect);
ui.advance_cursor_after_rect(thumbnail_rect);
}
fn tile_ui(&self, ui: &mut Ui) {
let title = egui::RichText::new(self.desc.title.clone())
.strong()
.line_height(Some(16.0))
.text_style(re_ui::DesignTokens::welcome_screen_example_title());
ui.add_space(DESCRIPTION_INNER_MARGIN);
egui::Frame {
inner_margin: egui::Margin::symmetric(DESCRIPTION_INNER_MARGIN, 0.0),
..Default::default()
}
.show(ui, |ui| {
ui.add(egui::Label::new(title).truncate());
});
}
fn tags_ui(&self, ui: &mut Ui) {
ui.add_space(10.0);
egui::Frame {
inner_margin: egui::Margin::symmetric(DESCRIPTION_INNER_MARGIN, 0.0),
..Default::default()
}
.show(ui, |ui| {
ui.horizontal_wrapped(|ui| {
// TODO(ab): use design tokens
ui.style_mut().spacing.button_padding = egui::vec2(4.0, 2.0);
ui.style_mut().spacing.item_spacing = egui::vec2(4.0, 4.0);
for tag in self.desc.tags.iter().sorted() {
ui.add(
egui::Button::new(
egui::RichText::new(tag)
.text_style(re_ui::DesignTokens::welcome_screen_tag()),
)
.sense(egui::Sense::hover())
.rounding(6.0)
.fill(egui::Color32::from_rgb(26, 29, 30))
.stroke(egui::Stroke::new(
1.0,
egui::Color32::WHITE.gamma_multiply(0.086),
))
.wrap_mode(egui::TextWrapMode::Extend),
);
}
});
});
}
fn github_link_and_size_ui(&self, ui: &mut Ui) {
let source_url = self.desc.source_url.as_deref();
egui::Frame {
inner_margin: egui::Margin::symmetric(DESCRIPTION_INNER_MARGIN, 0.0),
..Default::default()
}
.show(ui, |ui| {
ui.horizontal(|ui| {
if ui
.add_enabled(
source_url.is_some(),
egui::Button::image_and_text(
re_ui::icons::GITHUB.as_image(),
"Source code",
),
)
.on_hover_cursor(egui::CursorIcon::PointingHand)
.on_disabled_hover_text("Source code is not available for this example")
.clicked()
{
if let Some(source_url) = source_url {
ui.ctx().open_url(egui::output::OpenUrl {
url: source_url.to_owned(),
new_tab: true,
});
}
}
if let Some(Some(size)) = self.rrd_byte_size_promise.ready().copied() {
ui.with_layout(egui::Layout::right_to_left(egui::Align::Center), |ui| {
ui.label(egui::RichText::new(re_format::format_bytes(size as f64)).weak());
});
}
});
});
}
}