Add example for extending the viewer with custom callbacks #8284
Conversation
oxkitsune
force-pushed
the
gijs/re_control_example
branch
from
aaaae09 to
b1bc2de
Compare
teh-cmc
added
🦀 Rust API
There was a problem hiding this comment.
Like it a lot!
Feels a little bit thin on code docs but I think that's fine for the most part.
We also should add a small chapter on https://rerun.io/docs/howto/visualization/extend-ui for this
| re_crash_handler = { path = "../../../crates/utils/re_crash_handler" } | ||
| re_sdk_comms = { path = "../../../crates/store/re_sdk_comms", features = [ | ||
| "server", | ||
| ] } | ||
| re_viewer = { path = "../../../crates/viewer/re_viewer", default-features = false } | ||
| re_log = { path = "../../../crates/utils/re_log" } | ||
| re_error = { path = "../../../crates/utils/re_error" } |
There was a problem hiding this comment.
I think we have re-exports for all of those in rerun - we should use those when possible instead of depending on more crates. That likely requires adding some features to rerun
There was a problem hiding this comment.
☝️ I feel strongly about this. External users building Rerun extensions should never have to import anything but rerun.
Rerun is complicated enough without having to try and understand its internal architecture and dependencies 😬
| thumbnail_dimensions = [480, 291] | ||
| --> | ||
|
|
||
| Example showing how to control an app with the Rerun viewer, by extending the viewer UI. |
There was a problem hiding this comment.
the important part here is the communcation back. we have other examples that already talk about viewer extension in extend_viewer_ui. So maybe let's stress that a bit more:
| Example showing how to control an app with the Rerun viewer, by extending the viewer UI. | |
| Advanced example showing how to control an external application from the Rerun viewer, by extending the viewer UI. |
| This example is divided into two parts: | ||
|
|
||
| The example is divided into two parts: |
| Similar to the [`extend_viewer_ui`](../extend_viewer_ui/) example, the `viewer` is wrapped in an `eframe` app, which allows us to handle the extra communication logic and define our own contorl UI using [`egui`](https://github.com/emilk/egui). | ||
|
|
||
| The communication between the `viewer` and the `app` is implemented in the [`comms`](src/comms/) module. It defines a simple protocol to send messages between the `viewer` and the `app` using [`bincode`](https://github.com/bincode-org/bincode). | ||
| The protocol supports really basic commands that the `viewer` can send to the `app`, such as logging a [`Boxes3D`](https://www.rerun.io/docs/reference/types/archetypes/boxes3d) or [`Point3D`](https://www.rerun.io/docs/reference/types/archetypes/points3d) to an entity, or changing the radius of a set of points that is being logged. |
There was a problem hiding this comment.
| The protocol supports really basic commands that the `viewer` can send to the `app`, such as logging a [`Boxes3D`](https://www.rerun.io/docs/reference/types/archetypes/boxes3d) or [`Point3D`](https://www.rerun.io/docs/reference/types/archetypes/points3d) to an entity, or changing the radius of a set of points that is being logged. | |
| The protocol supports basic commands that the `viewer` can send to the `app`, such as logging a [`Boxes3D`](https://www.rerun.io/docs/reference/types/archetypes/boxes3d) or [`Point3D`](https://www.rerun.io/docs/reference/types/archetypes/points3d) to an entity, or changing the radius of a set of points that is being logged. |
| The communication between the `viewer` and the `app` is implemented in the [`comms`](src/comms/) module. It defines a simple protocol to send messages between the `viewer` and the `app` using [`bincode`](https://github.com/bincode-org/bincode). | ||
| The protocol supports really basic commands that the `viewer` can send to the `app`, such as logging a [`Boxes3D`](https://www.rerun.io/docs/reference/types/archetypes/boxes3d) or [`Point3D`](https://www.rerun.io/docs/reference/types/archetypes/points3d) to an entity, or changing the radius of a set of points that is being logged. | ||
|
|
||
| ## Testing it |
There was a problem hiding this comment.
It's not a test really
| ## Testing it | |
| ## Usage |
.. and yes I see that extend_viewer_ui did the same (can you plz fix that as well? thx :))
| @@ -0,0 +1,116 @@ | |||
| //! The example from our Getting Started page. | |||
There was a problem hiding this comment.
c&p mistake.
Recap instead what the app does and how it is expected to behave
| } | ||
|
|
||
| let num_spheres = | ||
| ((std::f32::consts::PI * current_offset) / current_radius.max(f32::EPSILON)).max(1.); |
There was a problem hiding this comment.
nit: a bit arbitrary what constants are imported and which ones aren't
| pub fn add_handler( | ||
| &self, | ||
| handler: HandlerFn, | ||
| ) -> std::result::Result<(), Box<dyn std::error::Error>> { |
There was a problem hiding this comment.
std::result:: and std::error:: seems a bit overzealous
| use super::protocol::Message; | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct ControlViewer { |
There was a problem hiding this comment.
would be nice to leave some doc strings for these key blocks of the example
|
@rerun-bot approve |
Wumpf
changed the title
What
control_panel.mp4
This adds an example on how to control an app using an extended version of Rerun.