Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split the Blueprint into AppBlueprint and ViewportBlueprint #2358

Merged
merged 12 commits into from
Jun 13, 2023
Merged

Split the Blueprint into AppBlueprint and ViewportBlueprint #2358

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
62b9141
Let the blueprint hold a reference to the store
jleibs Jun 9, 2023
b9168ae
Inline blueprint_panel_and_viewport
jleibs Jun 9, 2023
4b03ac6
Split out AppBlueprint
jleibs Jun 9, 2023
f4b94f5
Push blueprint down into AppState.show()
jleibs Jun 9, 2023
69c6e99
Blueprint becomes ViewportBlueprint
jleibs Jun 9, 2023
d5c1ad1
Make the viewport delta calculation an internal detail
jleibs Jun 9, 2023
e74443d
Assorted cleanup
jleibs Jun 9, 2023
93abc3b
lint
jleibs Jun 9, 2023
28a426d
Wasm build and some comments
jleibs Jun 9, 2023
203830c
One more wasm clippy
jleibs Jun 9, 2023
c89df7d
Merge branch 'main' into jleibs/split_up_blueprint
jleibs Jun 12, 2023
98ae066
Clean up naming
jleibs Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 64 additions & 96 deletions crates/re_viewer/src/app.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ use re_renderer::WgpuResourcePoolStatistics;
use re_smart_channel::Receiver;
use re_ui::{toasts, UICommand, UICommandSender};
use re_viewer_context::{
command_channel, AppOptions, Command, CommandReceiver, CommandSender, ComponentUiRegistry,
command_channel, AppOptions, CommandReceiver, CommandSender, ComponentUiRegistry,
DynSpaceViewClass, PlayState, SpaceViewClassRegistry, SpaceViewClassRegistryError,
StoreContext, SystemCommand,
StoreContext, SystemCommand, SystemCommandSender,
};

use crate::{
app_blueprint::AppBlueprint,
background_tasks::BackgroundTasks,
store_hub::{StoreHub, StoreHubStats},
ui::Blueprint,
viewer_analytics::ViewerAnalytics,
AppState, StoreBundle,
};
Expand Down Expand Up @@ -245,80 +245,87 @@ impl App {
}
}

fn run_pending_commands(
&mut self,
blueprint: &mut Blueprint,
store_hub: &mut StoreHub,
egui_ctx: &egui::Context,
frame: &mut eframe::Frame,
) {
while let Some(cmd) = self.command_receiver.recv() {
self.run_command(cmd, blueprint, store_hub, frame, egui_ctx);
fn run_pending_system_commands(&mut self, store_hub: &mut StoreHub, egui_ctx: &egui::Context) {
while let Some(cmd) = self.command_receiver.recv_system() {
self.run_system_command(cmd, store_hub, egui_ctx);
}
}

fn run_command(
fn run_pending_ui_commands(
&mut self,
cmd: Command,
blueprint: &mut Blueprint,
store_hub: &mut StoreHub,
app_blueprint: &AppBlueprint<'_>,
store_context: Option<&StoreContext<'_>>,
frame: &mut eframe::Frame,
egui_ctx: &egui::Context,
) {
match cmd {
Command::SystemCommand(cmd) => self.run_system_command(cmd, store_hub),
Command::UICommand(cmd) => {
self.run_ui_command(cmd, blueprint, store_hub, frame, egui_ctx);
}
while let Some(cmd) = self.command_receiver.recv_ui() {
self.run_ui_command(cmd, app_blueprint, store_context, frame);
}
}

#[allow(clippy::unused_self)]
fn run_system_command(&mut self, cmd: SystemCommand, store_hub: &mut StoreHub) {
fn run_system_command(
&mut self,
cmd: SystemCommand,
store_hub: &mut StoreHub,
egui_ctx: &egui::Context,
) {
match cmd {
SystemCommand::SetRecordingId(recording_id) => {
store_hub.set_recording_id(recording_id);
}
SystemCommand::LoadRrd(path) => {
if let Some(rrd) = crate::loading::load_file_path(&path) {
store_hub.add_bundle(rrd);
}
}
SystemCommand::ResetViewer => self.reset(store_hub, egui_ctx),
SystemCommand::UpdateBlueprint(blueprint_id, updates) => {
let blueprint_db = store_hub.store_db_mut(&blueprint_id);
for row in updates {
match blueprint_db.entity_db.try_add_data_row(&row) {
Ok(()) => {}
Err(err) => {
re_log::warn_once!("Failed to store blueprint delta: {err}",);
}
}
}
}
}
}

fn run_ui_command(
&mut self,
cmd: UICommand,
blueprint: &mut Blueprint,
store_hub: &mut StoreHub,
app_blueprint: &AppBlueprint<'_>,
store_context: Option<&StoreContext<'_>>,
_frame: &mut eframe::Frame,
egui_ctx: &egui::Context,
) {
let is_narrow_screen = egui_ctx.screen_rect().width() < 600.0; // responsive ui for mobiles etc
let store_context = store_hub.read_context();
match cmd {
#[cfg(not(target_arch = "wasm32"))]
UICommand::Save => {
save(self, store_context.as_ref(), None);
save(self, store_context, None);
}
#[cfg(not(target_arch = "wasm32"))]
UICommand::SaveSelection => {
save(
self,
store_context.as_ref(),
self.state.loop_selection(store_context.as_ref()),
store_context,
self.state.loop_selection(store_context),
);
}
#[cfg(not(target_arch = "wasm32"))]
UICommand::Open => {
if let Some(rrd) = open_rrd_dialog() {
self.on_rrd_loaded(store_hub, rrd);
if let Some(rrd_file) = open_rrd_dialog() {
self.command_sender
.send_system(SystemCommand::LoadRrd(rrd_file));
}
}
#[cfg(not(target_arch = "wasm32"))]
UICommand::Quit => {
_frame.close();
}

UICommand::ResetViewer => {
self.reset(store_hub, egui_ctx);
}
UICommand::ResetViewer => self.command_sender.send_system(SystemCommand::ResetViewer),

#[cfg(not(target_arch = "wasm32"))]
UICommand::OpenProfiler => {
Expand All @@ -329,24 +336,12 @@ impl App {
self.memory_panel_open ^= true;
}
UICommand::ToggleBlueprintPanel => {
blueprint.blueprint_panel_expanded ^= true;

// Only one of blueprint or selection panel can be open at a time on mobile:
if is_narrow_screen && blueprint.blueprint_panel_expanded {
blueprint.selection_panel_expanded = false;
}
app_blueprint.toggle_blueprint_panel(&self.command_sender);
}
UICommand::ToggleSelectionPanel => {
blueprint.selection_panel_expanded ^= true;

// Only one of blueprint or selection panel can be open at a time on mobile:
if is_narrow_screen && blueprint.selection_panel_expanded {
blueprint.blueprint_panel_expanded = false;
}
}
UICommand::ToggleTimePanel => {
blueprint.time_panel_expanded ^= true;
app_blueprint.toggle_selection_panel(&self.command_sender);
}
UICommand::ToggleTimePanel => app_blueprint.toggle_time_panel(&self.command_sender),

#[cfg(not(target_arch = "wasm32"))]
UICommand::ToggleFullscreen => {
Expand Down Expand Up @@ -390,25 +385,19 @@ impl App {
}

UICommand::PlaybackTogglePlayPause => {
self.run_time_control_command(
store_context.as_ref(),
TimeControlCommand::TogglePlayPause,
);
self.run_time_control_command(store_context, TimeControlCommand::TogglePlayPause);
}
UICommand::PlaybackFollow => {
self.run_time_control_command(store_context.as_ref(), TimeControlCommand::Follow);
self.run_time_control_command(store_context, TimeControlCommand::Follow);
}
UICommand::PlaybackStepBack => {
self.run_time_control_command(store_context.as_ref(), TimeControlCommand::StepBack);
self.run_time_control_command(store_context, TimeControlCommand::StepBack);
}
UICommand::PlaybackStepForward => {
self.run_time_control_command(
store_context.as_ref(),
TimeControlCommand::StepForward,
);
self.run_time_control_command(store_context, TimeControlCommand::StepForward);
}
UICommand::PlaybackRestart => {
self.run_time_control_command(store_context.as_ref(), TimeControlCommand::Restart);
self.run_time_control_command(store_context, TimeControlCommand::Restart);
}

#[cfg(not(target_arch = "wasm32"))]
Expand Down Expand Up @@ -482,7 +471,7 @@ impl App {
&mut self,
egui_ctx: &egui::Context,
frame: &mut eframe::Frame,
blueprint: &mut Blueprint,
app_blueprint: &AppBlueprint<'_>,
gpu_resource_stats: &WgpuResourcePoolStatistics,
store_context: Option<&StoreContext<'_>>,
store_stats: &StoreHubStats,
Expand All @@ -501,7 +490,7 @@ impl App {
crate::ui::mobile_warning_ui(&self.re_ui, ui);

crate::ui::top_panel(
blueprint,
app_blueprint,
store_context,
ui,
frame,
Expand All @@ -518,15 +507,6 @@ impl App {
// static data, but we need to jump through some hoops to
// handle a missing `RecordingConfig` in this case.
if let Some(store_db) = store_view.recording {
self.state
.recording_config_entry(
store_db.store_id().clone(),
self.rx.source(),
store_db,
)
.selection_state
.on_frame_start(|item| blueprint.is_item_valid(item));

// TODO(andreas): store the re_renderer somewhere else.
let egui_renderer = {
let render_state = frame.wgpu_render_state().unwrap();
Expand All @@ -539,7 +519,7 @@ impl App {
render_ctx.begin_frame();

self.state.show(
blueprint,
app_blueprint,
ui,
render_ctx,
store_db,
Expand Down Expand Up @@ -870,16 +850,12 @@ impl eframe::App for App {

let store_context = store_hub.read_context();

let blueprint_snapshot =
Blueprint::from_db(egui_ctx, store_context.as_ref().map(|ctx| ctx.blueprint));

// Make a mutable copy we can edit.
let mut blueprint = blueprint_snapshot.clone();
let app_blueprint = AppBlueprint::new(store_context.as_ref(), egui_ctx);

self.ui(
egui_ctx,
frame,
&mut blueprint,
&app_blueprint,
&gpu_resource_stats,
store_context.as_ref(),
&store_stats,
Expand All @@ -890,8 +866,6 @@ impl eframe::App for App {
paint_native_window_frame(egui_ctx);
}

self.handle_dropping_files(&mut store_hub, egui_ctx);

if !self.screenshotter.is_screenshotting() {
self.toasts.show(egui_ctx);
}
Expand All @@ -900,14 +874,11 @@ impl eframe::App for App {
self.command_sender.send_ui(cmd);
}

self.run_pending_commands(&mut blueprint, &mut store_hub, egui_ctx, frame);
self.run_pending_ui_commands(&app_blueprint, store_context.as_ref(), frame);

// The only way we don't have a `blueprint_id` is if we don't have a blueprint
// and the only way we don't have a blueprint is if we don't have an app.
if let Some(blueprint_id) = &blueprint.blueprint_id {
let blueprint_db = store_hub.store_db_mut(blueprint_id);
blueprint.sync_changes_to_store(&blueprint_snapshot, blueprint_db);
}
self.run_pending_system_commands(&mut store_hub, egui_ctx);

self.handle_dropping_files(&mut store_hub, egui_ctx);

// Return the `StoreHub` to the Viewer so we have it on the next frame
self.store_hub = Some(store_hub);
Expand Down Expand Up @@ -1038,15 +1009,12 @@ fn file_saver_progress_ui(egui_ctx: &egui::Context, background_tasks: &mut Backg
}

#[cfg(not(target_arch = "wasm32"))]
fn open_rrd_dialog() -> Option<StoreBundle> {
if let Some(path) = rfd::FileDialog::new()
use std::path::PathBuf;
#[cfg(not(target_arch = "wasm32"))]
fn open_rrd_dialog() -> Option<PathBuf> {
rfd::FileDialog::new()
.add_filter("rerun data file", &["rrd"])
.pick_file()
{
crate::loading::load_file_path(&path)
} else {
None
}
}

#[cfg(not(target_arch = "wasm32"))]
Expand Down
Loading