re_component_ui 0.31.0-rc.2

Provides ui editors for Rerun component data for registration with the Rerun Viewer component ui registry.
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
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

use std::error::Error;
use std::str::FromStr as _;

use egui::{Align, Layout, Link, Ui, UiBuilder};
use re_types_core::{ComponentIdentifier, RowId};
use re_ui::UiExt as _;
use re_uri::RedapUri;
use re_viewer_context::open_url::ViewerOpenUrl;
use re_viewer_context::{StoreViewContext, SystemCommand, SystemCommandSender as _};

/// Display an URL as an `Open` button (instead of spelling the full URL).
///
/// Requires a String mono-component which is valid [`RedapUri`].
pub fn redap_uri_button(
    ctx: &StoreViewContext<'_>,
    ui: &mut egui::Ui,
    _component: ComponentIdentifier,
    _row_id: Option<RowId>,
    array: &dyn arrow::array::Array,
) -> Result<(), Box<dyn Error>> {
    if array.len() != 1 {
        return Err("component batches are not supported".into());
    }

    let url_str = array
        .as_any()
        .downcast_ref::<arrow::array::StringArray>()
        .ok_or_else(|| format!("unsupported arrow datatype: {}", array.data_type()))?
        .value(0);

    let uri = RedapUri::from_str(url_str)?;

    let loaded_recording_info = ctx.store_bundle().recordings().find_map(|db| {
        if db
            .data_source
            .as_ref()
            .is_some_and(|source| source.stripped_redap_uri().as_ref() == Some(&uri))
        {
            db.store_info()
        } else {
            None
        }
    });
    let is_loading = loaded_recording_info.is_none()
        && ctx
            .connected_receivers
            .sources()
            .iter()
            .any(|source| source.stripped_redap_uri().as_ref() == Some(&uri));

    let uri_clone = uri.clone();
    // Show the link left aligned and justified so the whole cell is clickable.
    //
    // And add a button to copy the link.
    let link_with_copy = |ui: &mut Ui, link| {
        let rect = ui.max_rect();
        let contains_pointer = ui.rect_contains_pointer(rect);
        egui::Sides::new()
            .shrink_left()
            .height(ui.max_rect().height())
            .show(
                ui,
                |ui| {
                    ui.scope_builder(
                        UiBuilder::new().max_rect(ui.max_rect()).layout(
                            Layout::left_to_right(Align::Center)
                                .with_main_justify(false)
                                .with_cross_justify(true)
                                .with_main_align(Align::Min),
                        ),
                        |ui| ui.add(link),
                    )
                    .inner
                },
                |ui| {
                    if contains_pointer
                        && ui
                            .small_icon_button(&re_ui::icons::COPY, "Copy link")
                            .clicked()
                    {
                        if let Ok(url) = ViewerOpenUrl::from(uri_clone).sharable_url(None) {
                            ctx.command_sender
                                .send_system(SystemCommand::CopyViewerUrl(url));
                        } else {
                            re_log::error!("Failed to create a sharable url for recording");
                        }
                    }
                },
            )
            .0
    };

    ui.horizontal(|ui| {
        if let Some(loaded_recording_info) = loaded_recording_info {
            let response = link_with_copy(ui, Link::new("Switch to"))
                .on_hover_text("This recording is already loaded. Click to switch to it.");
            if response.clicked() {
                // Show it:
                ctx.command_sender.send_system(SystemCommand::set_selection(
                    re_viewer_context::Item::StoreId(loaded_recording_info.store_id.clone()),
                ));
            }
        } else if is_loading {
            ui.loading_indicator("Loading redap recording");

            if ui
                .small_icon_button(&re_ui::icons::CLOSE_SMALL, "Cancel loading the recording")
                .on_hover_text("Cancel")
                .clicked()
            {
                ctx.connected_receivers.remove_by_uri(&uri.to_string());
            }
        } else {
            let response = link_with_copy(ui, Link::new("Open")).on_hover_ui(|ui| {
                ui.label(uri.to_string());
            });

            handle_open_full_recording_link(ui, uri, &response);
        }
    });

    Ok(())
}

fn handle_open_full_recording_link(ui: &Ui, uri: RedapUri, response: &egui::Response) {
    if response.clicked_with_open_in_background() {
        ui.open_url(egui::OpenUrl::new_tab(uri));
    } else if response.clicked() {
        ui.open_url(egui::OpenUrl::same_tab(uri));
    }
}