re_plot 0.32.0-rc.1

Shared utilities for plot-based views.
Documentation 
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

use crate::legend::LegendSwatch;
use egui::{Atom, AtomExt as _, AtomLayout, TextWrapMode};
use re_ui::{DesignTokens, UiExt as _};

/// Shows a plot tooltip at the pointer for the given response.
///
/// The tooltip has a small header label, followed by a value line with a color swatch,
/// series label, and right-aligned value text.
pub fn show_plot_tooltip(
    ui: &egui::Ui,
    response: &egui::Response,
    id_salt: egui::Id,
    header: &str,
    label: &str,
    value: &str,
    color: egui::Color32,
) {
    plot_tooltip(ui, response, id_salt).show(|ui| {
        let tokens = ui.tokens();

        ui.label(
            egui::RichText::new(header)
                .size(DesignTokens::combo_item_small_font_size())
                .color(tokens.text_default),
        );

        ui.add_space(tokens.text_to_icon_padding());

        plot_tooltip_label_value(ui, label, value, color);
    });
}

/// Creates a plot tooltip for the given response with Rerun's plot tooltip settings.
///
/// Temporarily overrides the global egui style to use a shorter tooltip delay (150ms)
/// and keeps the tooltip visible once shown. Restores the original style after creation.
fn plot_tooltip<'a>(
    ui: &egui::Ui,
    response: &'a egui::Response,
    id_salt: egui::Id,
) -> egui::Tooltip<'a> {
    let prev_style = ui.ctx().global_style();
    ui.ctx().global_style_mut(|style| {
        style.interaction.tooltip_delay = 0.15;
        style.interaction.tooltip_grace_time = 3.0;
    });

    let is_open = response.enabled() && egui::Tooltip::should_show_tooltip(response, true);
    let mut tooltip = egui::Tooltip::for_widget(response);
    tooltip.popup = tooltip.popup.open(is_open).id(response.id.with(id_salt));

    ui.ctx().set_global_style(prev_style);

    tooltip
        .at_pointer()
        .gap(f32::from(ui.tokens().view_padding()))
}

/// Renders a single value line in the plot tooltip with truncation.
///
/// Max total width is 500px. The label is marked as `shrink` so it truncates
/// first when space is tight, while the value stays fully visible.
pub fn plot_tooltip_label_value(
    ui: &mut egui::Ui,
    label_text: &str,
    value_text: &str,
    color: egui::Color32,
) {
    const MAX_WIDTH: f32 = 500.0;
    const SWATCH_GAP: f32 = 6.0;
    const LABEL_VALUE_GAP: f32 = 16.0;

    let tokens = ui.tokens();

    let label = egui::RichText::new(label_text)
        .color(tokens.list_item_noninteractive_text)
        .atom_shrink(true);
    let value = egui::RichText::new(value_text).color(tokens.list_item_strong_text);

    let atoms = (
        LegendSwatch::atom(),
        label,
        Atom::default().atom_size(egui::vec2(LABEL_VALUE_GAP - SWATCH_GAP * 2.0, 0.0)),
        value,
    );

    ui.set_max_width(MAX_WIDTH);

    let atom_layout = AtomLayout::new(atoms)
        .gap(SWATCH_GAP)
        .max_width(MAX_WIDTH)
        .sense(egui::Sense::hover())
        .wrap_mode(TextWrapMode::Truncate)
        .allocate(ui);

    let atom_response = atom_layout.paint(ui);

    LegendSwatch {
        color,
        visible: true,
    }
    .paint(ui, &atom_response);
}