Improve Visible History to support more general time queries #4123

abey79 · 2023-11-02T10:30:43Z

What

Fixes From visual history to a general time query #3933

Scope

Improve the "Visible History" feature to build more general time queries:
- Control both start/end time boundaries
- relative/absolute/full mode for each boundaries
- explicit active/inactive state/checkbox
Improve usability:
- Proper scaling and bounds for the 'DragValue` widgets
- Proper cascading behaviour from data group(s) to entity: a child's "visible history" settings will override the parent's if the feature is active.
- Do not display Visible History UI in places where it's not supported

Out-of-scope

Add support for Visible History to space views other than 2D/3D
Add Visible History UI to 3D/2D space view themselves (for consistency with what precedes and to address some corner cases)
Add (read-only) shading in the time panel
Fix the numerous issues/missing features listed in:
- Tracking issue: Visible History feature #4107

TODO

fine-tune the UI layout
discuss/implement heuristics to decide whether or not to display the UI
add information notices (e.g. "this applies to ALL sequence timelines")

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)
The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

abey79 · 2023-11-02T17:24:05Z

crates/re_viewer/src/ui/selection_panel.rs

+static VISIBLE_HISTORY_COMPONENT_NAMES: once_cell::sync::Lazy<Vec<ComponentName>> =
+    once_cell::sync::Lazy::new(|| {
+        [
+            ComponentName::from("rerun.components.Position2D"),
+            ComponentName::from("rerun.components.Position3D"),
+            ComponentName::from("rerun.components.LineStrip2D"),
+            ComponentName::from("rerun.components.LineStrip3D"),
+            ComponentName::from("rerun.components.TensorData"),
+            ComponentName::from("rerun.components.Vector3D"),
+            ComponentName::from("rerun.components.HalfSizes2D"),
+            ComponentName::from("rerun.components.HalfSizes3D"),
+        ]
+        .into()
+    });
+
+fn should_display_visible_history(
+    ctx: &mut ViewerContext<'_>,
+    entity_path: Option<&EntityPath>,
+) -> bool {
+    if let Some(entity_path) = entity_path {
+        let store = ctx.store_db.store();
+        let component_names = store.all_components(ctx.rec_cfg.time_ctrl.timeline(), entity_path);
+        if let Some(component_names) = component_names {
+            if !component_names
+                .iter()
+                .any(|name| VISIBLE_HISTORY_COMPONENT_NAMES.contains(name))
+            {
+                return false;
+            }
+        } else {
+            return false;
+        }
+    }
+
+    true
+}


Is this really how it should be done?

teh-cmc

I've tried it on the web build but it doesn't seem to do anything?

I might be doing something wrong, but it's hard to tell without any on-hover pop-ups explaining what each button/label/etc does.

23-11-03_09.05.38.patched.mp4

abey79 · 2023-11-03T08:16:25Z

@teh-cmc looks like I've introduced a last minute bug 🤦🏻 Onto fixing it.

Wumpf · 2023-11-03T15:47:47Z

would be nice to make the number pickers not allow nonsensical values like so:

Wumpf · 2023-11-03T15:49:48Z

I don't quite get why you made the Relative/Infinite things checkboxes since they clearly exclude each other. Also not being relative implying absolute took me a lil bit.
-> A dropdown box or radio buttons seem to be more appropriate

Wumpf

great feature overall, leveraging abilities we already have ⭐
code lgtm for the most part, the reason I put request changes is the ui concerns prior to the code review

crates/re_data_store/src/entity_properties.rs

Wumpf · 2023-11-03T15:55:57Z

crates/re_query/src/util.rs

@@ -17,14 +17,15 @@ pub fn query_archetype_with_history<'a, A: Archetype + 'a, const N: usize>(
        re_log_types::TimeType::Sequence => history.sequences,
    };

-    if visible_history == 0 {
+    if !history.enabled || visible_history == VisibleHistory::OFF {


to clarify, when can it happen that one is off but the other is enabled?

How the visible history is stored is not fully normalised: there is a slight duplication:

the enabled/disabled bool

the fact that {from: Relative(0), to: Relative(0)} (that's what VisibleHistory::OFF is) disable the feature for all practical purposes.

I've introduced that "enabled" bool to allow the user to disable the feature without losing their configured boundaries (ie. that checkbox next to the Visible History label). Overall, better UX I believe, but the cost is this check.

BTW, the test against VisibleHistory::OFF could actually be dropped and the result would be the same. So it can be seen as an optimisation to avoid a range query when we know none is needed :)

crates/re_ui/src/lib.rs

crates/re_viewer/src/ui/selection_panel.rs

Co-authored-by: Andreas Reich <[email protected]>

abey79 · 2023-11-03T16:53:20Z

A dropdown box or radio buttons seem to be more appropriate

Makes sense, I'll try that.

…iew comments

abey79 · 2023-11-04T10:52:20Z

would be nice to make the number pickers not allow nonsensical values like so:

I attempted to do that with bf65bf6. It's kind of tricky though. Please give it a good try 🙏🏻

Wumpf

love those improvements. worked great when I played around with it

WIP: Make visible history more general

e6a0eba

abey79 added ui concerns graphical user interface include in changelog labels Nov 2, 2023

abey79 mentioned this pull request Nov 2, 2023

From visual history to a general time query #3933

Closed

abey79 added 2 commits November 2, 2023 17:22

Fine-tuning, lints, etc.

36058ec

Add heuristic to show/hide visible history UI

adce254

abey79 marked this pull request as ready for review November 2, 2023 17:21

Fix cargo docs

9c01f7f

abey79 commented Nov 2, 2023

View reviewed changes

teh-cmc self-requested a review November 3, 2023 08:02

teh-cmc reviewed Nov 3, 2023

View reviewed changes

abey79 added 4 commits November 3, 2023 10:01

Fix time range for non-zero-based sequence timeline

6f4517e

Added some tooltips

648dcf9

Added playground test script

dc39ea7

Merge branch 'main' into antoine/better-visible-history

34608e0

Wumpf self-requested a review November 3, 2023 15:45

Wumpf requested changes Nov 3, 2023

View reviewed changes

abey79 and others added 3 commits November 3, 2023 17:19

Update crates/re_data_store/src/entity_properties.rs

c5b04d9

Co-authored-by: Andreas Reich <[email protected]>

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

00629fc

Co-authored-by: Andreas Reich <[email protected]>

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

2d82812

Co-authored-by: Andreas Reich <[email protected]>

abey79 mentioned this pull request Nov 3, 2023

Add a read-only representation of the visible history on the timeline #4141

Closed

abey79 added 3 commits November 4, 2023 09:53

Updated UI to use a combobox instead of the two checkboxes + some rev…

acd1a0e

…iew comments

Proper constants for 2D/3D space views' names

5ddf00a

Make it impossible to set "inverted" boundary (low > high)

bf65bf6

abey79 mentioned this pull request Nov 4, 2023

Views should report their ability to handle the Visible History feature #4145

Closed

Added TODO for should_display_visible_history

6bc0ba7

Wumpf self-requested a review November 6, 2023 12:46

Wumpf approved these changes Nov 6, 2023

View reviewed changes

abey79 merged commit ce2493c into main Nov 6, 2023
37 checks passed

abey79 deleted the antoine/better-visible-history branch November 6, 2023 14:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Visible History to support more general time queries #4123

Improve Visible History to support more general time queries #4123

abey79 commented Nov 2, 2023 •

edited by github-actions bot

Loading

abey79 Nov 2, 2023

teh-cmc left a comment •

edited

Loading

abey79 commented Nov 3, 2023

Wumpf commented Nov 3, 2023 •

edited

Loading

Wumpf commented Nov 3, 2023

Wumpf left a comment

Wumpf Nov 3, 2023

abey79 Nov 3, 2023

abey79 commented Nov 3, 2023

abey79 commented Nov 4, 2023

Wumpf left a comment

Improve Visible History to support more general time queries #4123

Improve Visible History to support more general time queries #4123

Conversation

abey79 commented Nov 2, 2023 • edited by github-actions bot Loading

What

Scope

Out-of-scope

TODO

Checklist

abey79 Nov 2, 2023

Choose a reason for hiding this comment

teh-cmc left a comment • edited Loading

Choose a reason for hiding this comment

abey79 commented Nov 3, 2023

Wumpf commented Nov 3, 2023 • edited Loading

Wumpf commented Nov 3, 2023

Wumpf left a comment

Choose a reason for hiding this comment

Wumpf Nov 3, 2023

Choose a reason for hiding this comment

abey79 Nov 3, 2023

Choose a reason for hiding this comment

abey79 commented Nov 3, 2023

abey79 commented Nov 4, 2023

Wumpf left a comment

Choose a reason for hiding this comment

abey79 commented Nov 2, 2023 •

edited by github-actions bot

Loading

teh-cmc left a comment •

edited

Loading

Wumpf commented Nov 3, 2023 •

edited

Loading