Example of how to embed the Rerun Viewer inside your own GUI (+ ergonomic improvements) #2250
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emilk
added
ui
Wumpf
approved these changes
May 29, 2023
Comment on lines
+12
to
+13
| # Turn on if you want to share analytics with Rerun (e.g. callstacks on crashes). | ||
| analytics = ["re_crash_handler/analytics", "re_viewer/analytics"] |
There was a problem hiding this comment.
I reckon this is opt-in since we want to force the user to make a conscious choice to have analytics that may include their own callstack? A bit unfortunate since this might make us miss a lot of analytics going forward 🤔
There was a problem hiding this comment.
Yeah, exactly. I'm not sure if we want to see a lot of analytics from unwrap()s in our users code though.
| }); | ||
| ui.separator(); | ||
|
|
||
| if let Some(log_db) = self.rerun_app.log_db() { |
There was a problem hiding this comment.
kinda out of scope, but if we'd expose the ViewerContext instead, we could do extra nice things like showing our data ui on on_hover 🤔
emilk
changed the title
emilk
added a commit
that referenced
this pull request
Jun 15, 2023
…omic improvements) (#2250) Closes #2243 Add an example showing how to wrap the Rerun Viewer in your own GUI, using [`eframe`](https://github.com/emilk/egui/tree/master/crates/eframe) and [`egui`](https://github.com/emilk/egui). This example can be useful for anyone who wants to extend the viewer with their own controls and widgets. The example shows how to read from the data store. Analytics are supported but is an opt-in feature in the example `Cargo.toml`. I created a `re_crash_handler` crate so that the example can get useful info on panics and signals, and have them sent to rerun if they enable analytics. Only works on `main` (not on 0.6.0).  * [ ] Top-level docs at https://www.rerun.io/docs * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) <!-- This line will get updated when the PR build summary job finishes. --> PR Build Summary: https://build.rerun.io/pr/2250 --------- Co-authored-by: Andreas Reich <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2243
What
Add an example showing how to wrap the Rerun Viewer in your own GUI, using
eframeandegui.This example can be useful for anyone who wants to extend the viewer with their own controls and widgets. The example shows how to read from the data store.
Analytics are supported but is an opt-in feature in the example
Cargo.toml.I created a
re_crash_handlercrate so that the example can get useful info on panics and signals, and have them sent to rerun if they enable analytics.Only works on
main(not on 0.6.0).TODO
Checklist
PR Build Summary: https://build.rerun.io/pr/2250