Support modifying the plot style by introducing a generic framework for overriding components #4914

jleibs · 2024-01-25T19:37:40Z

What

Part of UI for overriding SeriesStyle in TimeSeriesViews #4817

This tackles the problem of allowing SeriesStyle components to be overridden by building out a significant chunk of a general component override framework.

The new UI is limited to TimeSeriesScalar view at the moment because it still requires special Visualizer-side handling of the component data.

High level idea

When selecting an entity within a space-view, we now have the ability to override any component that is both queried by the visualizer, and for which we have a registered component-editor.

This override value is initialized based on looking for, in order:

The current value of the component for the entity
A value provided by the Visualizer (useful for things like matching the current auto-color)
A default value provided by a function registered along with the editor.

Notable changes:

Adds a new mechanism to the Component UI Registry that allows us to register editors and default-value providers for any component.
Adds a mechanism to all visualizers to find out the full set of components they query.
During the update_overrides process, we now checks the appropriate location in the blueprint override tree and insert the path to any overridden components into the DataResult.
In the TimeSeriesSpaceView we now respect any overrides that come from the DataResult.
Introduce a new Override Components UI in the seleciton panel, which allows us to add an override using a default-provided, or visualizer-provided initial value.
Once the override has been added, the override UI dispatches to the registered editor for each overridden component.

Screenshot

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 the web demo (if applicable):
- Using newly built examples: app.rerun.io
- Using examples from latest main build: app.rerun.io
- Using full set of examples from nightly build: app.rerun.io
The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

Wumpf

absolutely marvelous and not as complex as I feared it would be.

Comments are mostly starts of discussions, some of which we should have over Zoom or Slack instead, some of which need to be postponed.
The only thing that I believe is actually wrong is how initial overrides are determined (see comments). But since this won't affect the time series space view, I'll approve anyways (:

Wumpf · 2024-01-29T09:22:49Z

crates/re_data_ui/src/editors.rs

+fn edit_color_ui(
+    ctx: &ViewerContext<'_>,
+    ui: &mut egui::Ui,
+    _verbosity: UiVerbosity,


I wonder if ui verbosity ever makes sense for editors. Aren't they always only available at full verbosity?

I think it will eventually. I suspect there will be both a Small/Inline editor for some things, when it's appropriate, but I could imagine a way of expanding that to a more "full" multiline editor that we won't always want to show in the selection panel by default.

crates/re_space_view_bar_chart/src/visualizer_system.rs

Wumpf · 2024-01-29T09:34:49Z

crates/re_space_view_time_series/src/visualizer_system.rs

+                let override_color = lookup_override::<Color>(data_result, ctx).map(|c| {
+                    let arr = c.to_array();
+                    egui::Color32::from_rgba_unmultiplied(arr[0], arr[1], arr[2], arr[3])
+                });
+
+                let override_label =
+                    lookup_override::<Text>(data_result, ctx).map(|t| t.to_string());
+
+                let override_scattered =
+                    lookup_override::<ScalarScattering>(data_result, ctx).map(|s| s.0);
+
+                let override_radius = lookup_override::<Radius>(data_result, ctx).map(|r| r.0);


let's discuss after this PR how we can make this pattern nice, easy and fast. Overall doesn't look as bad as I thought it would (:

Yeah, it's not awful, esp since we restrict things to splats at the moment, but I'd still love to have it automagically happen inside one of the archetype-view-style generic queries.

crates/re_viewer/src/ui/selection_panel.rs

crates/re_viewer/src/ui/override_ui.rs

Wumpf · 2024-01-29T10:06:35Z

crates/re_viewer/src/ui/override_ui.rs

+                        }
+                    })
+                    .or_else(|| {
+                        system_for_initial_value.initial_override_value(


this doesn't check out for me: The system for the initial value may not have brought up the component that we're on right now.
I think what you iterate instead is pairs of component-visualizer where you somehow removed duplicated components, i.e. decided which visualizer would provide the initial override value :/

Aha! Yes, good catch. Changed to build a map of Component -> Visualizer and use the right now.

Wumpf · 2024-01-29T10:07:26Z

crates/re_viewer/src/ui/override_ui.rs

+                    return;
+                };
+
+                initial_data.compute_size_bytes();


why is this needed?

🤷 it's always needed when we write data to the store or else we get errors about using data that hasn't been sized yet.

crates/re_viewer/src/ui/selection_panel.rs

crates/re_viewer/src/ui/override_ui.rs

jleibs added 13 commits January 25, 2024 19:47

Hack in a check for overriden colors into the DataQueryResult

d7f7ec8

Add a color picker that sets the override value for color

5f82d98

Apply the color from the override and include a reset button

6914015

Use auto_color in the selection panel as well

e121166

Generic table for adding/previewing overrides

a04fa3c

Introduce a registry for component editors

54c9968

Wire up an editor for the color component

d886bba

Factor out VisualizerQueryInfo

e498154

Offer to override queried components for the visualizer

7d4205f

Skip components that don't have a registered editor

72b8699

Require editable components to provide a default value

8e9b029

Remove obsolete override editor

08507dd

lints

907c520

jleibs force-pushed the jleibs/component_overrides branch from ce587dc to 907c520 Compare January 25, 2024 21:06

jleibs added 6 commits January 25, 2024 22:15

comments

cb2ddde

Restrict overrides to TimeSeries and factor out the lookup function

f45ce9c

Override for Text

642147f

Override for scatter

5b716d9

Add override for radius

7d8cc11

Use default values if lookup fails in editor

2a86e8e

jleibs added the 🟦 blueprint The data that defines our UI label Jan 25, 2024

jleibs changed the title ~~New framework and UI for overriding components~~ Support modifying the plot style by introducing a generic framework for overriding components Jan 25, 2024

jleibs marked this pull request as ready for review January 25, 2024 23:18

jleibs added the include in changelog label Jan 25, 2024

Fix some comments

cd2598d

Wumpf self-requested a review January 26, 2024 15:53

Change remove icon, switch to table, and re-order columns

46d0a54

jleibs force-pushed the jleibs/component_overrides branch from 37223e7 to 46d0a54 Compare January 26, 2024 19:05

Wumpf approved these changes Jan 29, 2024

View reviewed changes

Merge branch 'main' into jleibs/component_overrides

392430d

jleibs added 5 commits January 29, 2024 22:32

Cleanup from PR

ad1309c

Use the right system for the given component

bdfe2d4

typo

0a69eda

Extra use

e8795eb

docstring

e5f3797

jleibs merged commit 5d9b278 into main Jan 29, 2024
40 of 41 checks passed

jleibs deleted the jleibs/component_overrides branch January 29, 2024 23:54

abey79 added ui concerns graphical user interface 📺 re_viewer affects re_viewer itself and removed ui concerns graphical user interface labels Feb 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support modifying the plot style by introducing a generic framework for overriding components #4914

Support modifying the plot style by introducing a generic framework for overriding components #4914

jleibs commented Jan 25, 2024 •

edited

Wumpf left a comment

Wumpf Jan 29, 2024

jleibs Jan 29, 2024

Wumpf Jan 29, 2024

jleibs Jan 29, 2024

Wumpf Jan 29, 2024

jleibs Jan 29, 2024

Wumpf Jan 29, 2024

jleibs Jan 29, 2024

Support modifying the plot style by introducing a generic framework for overriding components #4914

Support modifying the plot style by introducing a generic framework for overriding components #4914

Conversation

jleibs commented Jan 25, 2024 • edited

What

High level idea

Notable changes:

Screenshot

Checklist

Wumpf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jleibs commented Jan 25, 2024 •

edited