Introduce a welcome screen when no recording is loaded #2982

abey79 · 2023-08-15T09:14:53Z

What

This adds a MVP Welcome Screen that shows up instead of the current "Loading" screen in certain circumstances.

In general terms:

The Welcome Screen is drawn in the Viewport's place, ie. with the panels visible.
The Welcome Screen is never displayed when a recording is available.
The current implementation of the Welcome Screen is very basic—mostly links to webpages.
The current "loading screen" still exists and is "sometimes" displayed.

The tricky thing is when to show the Welcome Screen vs. the legacy loading screen. This PR includes an heuristic (implemented in App::handle_default_blueprint()). The main determinant is the nature of the receiver (file, tcp, web socket, etc.) which we use as a proxy for the workflow in which the viewer is being used. The TCP receiver is a bit tricky, as it's used by both the Python SDK (we don't want the Welcome Screen to distractingly flash at spawn, before data arrives) and when running manually ($ rerun). To address this, this PR introduces a new --skip-welcome-screen CLI option, used by the Python SDK. This situation is still not entirely perfect though: #3018.

Implementation details:

Technically, the Welcome Screen is triggered when the app ID is set to StoreHub::welcome_screen_app_id(). A corresponding blank blueprint is created at startup (by StoreHub) to make the UI happy. App::handle_default_blueprint() basically sets that app ID to trigger the Welcome Screen.
Likewise, an empty recording is always set as active whenever the app ID is set but no recording is available. This empty recording isn't in the list of available recordings (ViewerContext::alternate_recordings). This make the UI happy.
The status string and source originally displayed in the legacy loading screen are also displayed on the Welcome Screen in some circumstances (i.e for "infinite" data sources, tcp, ws, etc.)

Expect these follow-up PRs:

display the status string in the menu bar instead (as per Mårten designs)
address All files Rerun can open should support command line, drag, and open from menu #2229
address Show the welcome screen when closing recordings even with --skip-welcome-screen #3018
fix UI of streams with empty recording Fix the Streams UI when the recording is empty #3027
add external_link icon wherever we have external links Uniform icon, pointer, and tooltip for external links #3026

Fixes #2513

Checklist

I have read and agree to Contributor Guide and the Code of Conduct
I've included a screenshot or gif (if applicable)
I have tested demo.rerun.io (if applicable)

nikolausWest · 2023-08-15T09:45:45Z

??? what's the acceptable minimum that the "Add View" button can do?

Could you highlight (or even also virtually click) the "+" button in the blueprint view?

abey79 · 2023-08-15T09:59:25Z

Could you highlight (or even also virtually click) the "+" button in the blueprint view?

I'll experiment with that.

abey79 · 2023-08-16T08:19:39Z

@nikolausWest bad news, the "add blueprint" button is empty when the recording is empty:

(that circle there is an empty popup when clicking the + icon)

I'll check how bad it would be to have something in there, but not liking how that might drag this PR too far.

abey79 · 2023-08-16T08:43:51Z

Actually, that was easy enough to hack:

- use empty recording if none is open - keep current blueprint id when closing all recordings - offer every types of blueprints when recording is empty

# Conflicts: # crates/re_viewer/src/app.rs # crates/re_viewer/src/store_hub.rs

abey79 · 2023-08-16T13:15:34Z

Next challenge is around that empty blueprint being edited. We'll need to set an associated app ID which means more UI. More generally, I'm still struggling to see how this would result in a meaningful workflow in the short term 🤔

…ewport. The old loading ui is used when no blueprint is available.

- added --skip-welcome-screen - store hub inited with a "welcome screen" blueprint (for use as marker to show welcome screen) - welcome screen shown only if app_id is <welcome screen>

…leaning, renames, comments

emilk

It looks great! I haven't tested it on web yet though

crates/re_ui/data/images/welcome_screen_configure.jpg

crates/re_viewer/src/ui/wait_screen_ui.rs

emilk · 2023-08-17T07:39:52Z

crates/re_viewer/src/ui/wait_screen_ui.rs

+            ui.label(
+                egui::RichText::new(
+                    "Open and visualize recorded data from previous Rerun sessions (.rrd) as well \
+                    as data in formats like .gltf and .jpg.",


This is a bit confusing right now - the "Open file" dialog and file drag-dropping only supports .rrd files atm, thought that should be fairly easy to fix:

All files Rerun can open should support command line, drag, and open from menu #2229

Added to my short term todo

crates/re_ui/src/icons.rs

emilk · 2023-08-17T07:44:37Z

crates/re_ui/src/icons.rs

@@ -54,6 +54,11 @@ pub const RESET: Icon = Icon::new("reset", include_bytes!("../data/icons/reset.p

 pub const CLOSE: Icon = Icon::new("close", include_bytes!("../data/icons/close.png"));

+pub const EXTERNAL_LINK: Icon = Icon::new(


We should use this icon on the "Help" button in the rerun menu too, and maybe elsewhere.

Noted, will do a follow-up PR

crates/re_viewer/src/ui/wait_screen_ui.rs

emilk · 2023-08-17T08:01:53Z

crates/rerun/src/run.rs

@@ -98,6 +98,10 @@ struct Args {
    #[clap(long)]
    screenshot_to: Option<std::path::PathBuf>,

+    /// Do not display the welcome screen.
+    #[clap(long)]
+    skip_welcome_screen: bool,


This is never used?

Good question. I (prematurely?) added it thinking that it would be needed to avoid the welcome screen temporarily showing up in this situation:

rr.init("delay", spawn=True) time.sleep(5) rr.log_points("points", np.random.rand(10, 2))

However, rr.init() itself sends stuff (at least the app ID, etc.) which gets us directly into the "active blueprint and recording" state. So for this scenario, this --skip-welcome-screen is not needed. I assume it will be the same for the C++ SDK. Rust uses the Sdk channel, which skips the welcome screen until the recording is closed, so that's ok.

Beyond the web demo, I haven't tested all other scenarios yet though—I wouldn't even be capable to list them tbh. But I don't really expect we have an immediate need for that flag yet. I can think of future scenarios where this could come handy(e.g. long running server where advanced users don't want to see "that annoying screen"), but I'm totally fine removing it for the time being.

👍🏻👎🏻❓

Never mind the above 🦆

The Python SDKs really want that --skip-welcome_screen. I can easily see it by adding delays in the spawn() function. So it means that on a slow computer, or due to future change, that welcome screen could temporarily "flash" before data is displayed, which is far worse than the loading screen. So I'll use that flag in the python SDK (and C++ if I can figure out how).

Co-authored-by: Emil Ernerfeldt <[email protected]>

abey79 added 2 commits August 15, 2023 10:59

Onboarding welcome screen v0

5225de2

Clippy

b4ea623

abey79 added the ui concerns graphical user interface label Aug 15, 2023

Disable open button on wasm

92ea25e

abey79 added 2 commits August 15, 2023 11:48

Added status strings at the bottom of the welcome screen

a062722

Clippy

5baf913

abey79 added 3 commits August 16, 2023 11:09

State changes:

101f328

- use empty recording if none is open - keep current blueprint id when closing all recordings - offer every types of blueprints when recording is empty

Merge branch 'main' into antoine/welcome-screen-v0

d0ce443

# Conflicts: # crates/re_viewer/src/app.rs # crates/re_viewer/src/store_hub.rs

Rounded corners

7f0de08

abey79 added 8 commits August 16, 2023 15:35

AppState::show() can now display the welcome screen instead of the vi…

189bce4

…ewport. The old loading ui is used when no blueprint is available.

fixed auto shrink

1720ae7

revert change to add blueprint menu

278a43d

many updates:

9ed37d0

- added --skip-welcome-screen - store hub inited with a "welcome screen" blueprint (for use as marker to show welcome screen) - welcome screen shown only if app_id is <welcome screen>

wasm fixes

fb1f5cc

clippy on wasm

96d6792

C++ hidden and added external link icon

3f9c326

Conditionally displaying status strings in welcome screen + various c…

1722a63

…leaning, renames, comments

abey79 changed the title ~~(WIP) Onboarding welcome screen MVP~~ Introduce a welcome screen when no recording is loaded Aug 17, 2023

abey79 marked this pull request as ready for review August 17, 2023 07:32

emilk self-requested a review August 17, 2023 07:33

emilk approved these changes Aug 17, 2023

View reviewed changes

abey79 and others added 4 commits August 17, 2023 10:29

Update crates/re_viewer/src/ui/wait_screen_ui.rs

82896f9

Co-authored-by: Emil Ernerfeldt <[email protected]>

Update crates/re_ui/src/icons.rs

58f1c77

Co-authored-by: Emil Ernerfeldt <[email protected]>

Update crates/re_viewer/src/app.rs

9d1bad3

Co-authored-by: Emil Ernerfeldt <[email protected]>

Update crates/re_viewer/src/app.rs

66b6125

Co-authored-by: Emil Ernerfeldt <[email protected]>

abey79 and others added 4 commits August 17, 2023 10:47

Update crates/re_viewer/src/ui/wait_screen_ui.rs

5fa048b

Co-authored-by: Emil Ernerfeldt <[email protected]>

Added skip-welcome-screen to python sdk and addressed review comments

d252bbf

Last review comments

4824c46

Proper setup of scroll area

7e9ccb7

abey79 merged commit ce6829b into main Aug 17, 2023

abey79 deleted the antoine/welcome-screen-v0 branch August 17, 2023 12:23

abey79 mentioned this pull request Aug 17, 2023

Show the welcome screen when closing recordings even with --skip-welcome-screen #3018

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce a welcome screen when no recording is loaded #2982

Introduce a welcome screen when no recording is loaded #2982

abey79 commented Aug 15, 2023 •

edited

Loading

nikolausWest commented Aug 15, 2023

abey79 commented Aug 15, 2023

abey79 commented Aug 16, 2023 •

edited

Loading

abey79 commented Aug 16, 2023

abey79 commented Aug 16, 2023

emilk left a comment

emilk Aug 17, 2023

abey79 Aug 17, 2023

emilk Aug 17, 2023

abey79 Aug 17, 2023

emilk Aug 17, 2023

abey79 Aug 17, 2023

abey79 Aug 17, 2023

		@@ -54,6 +54,11 @@ pub const RESET: Icon = Icon::new("reset", include_bytes!("../data/icons/reset.p

		pub const CLOSE: Icon = Icon::new("close", include_bytes!("../data/icons/close.png"));

		pub const EXTERNAL_LINK: Icon = Icon::new(

Introduce a welcome screen when no recording is loaded #2982

Introduce a welcome screen when no recording is loaded #2982

Conversation

abey79 commented Aug 15, 2023 • edited Loading

What

Checklist

nikolausWest commented Aug 15, 2023

abey79 commented Aug 15, 2023

abey79 commented Aug 16, 2023 • edited Loading

abey79 commented Aug 16, 2023

abey79 commented Aug 16, 2023

emilk left a comment

Choose a reason for hiding this comment

emilk Aug 17, 2023

Choose a reason for hiding this comment

abey79 Aug 17, 2023

Choose a reason for hiding this comment

emilk Aug 17, 2023

Choose a reason for hiding this comment

abey79 Aug 17, 2023

Choose a reason for hiding this comment

emilk Aug 17, 2023

Choose a reason for hiding this comment

abey79 Aug 17, 2023

Choose a reason for hiding this comment

abey79 Aug 17, 2023

Choose a reason for hiding this comment

abey79 commented Aug 15, 2023 •

edited

Loading

abey79 commented Aug 16, 2023 •

edited

Loading