Struct re_viewer::App

pub struct App {

    main_thread_token: MainThreadToken,
    build_info: BuildInfo,
    startup_options: StartupOptions,
    start_time: Instant,
    ram_limit_warner: RamLimitWarner,
    pub(crate) egui_ctx: Context,
    screenshotter: Screenshotter,
    profiler: Profiler,
    text_log_rx: Receiver<LogMsg>,
    component_ui_registry: ComponentUiRegistry,
    rx: ReceiveSet<LogMsg>,
    pub(crate) state: AppState,
    pub(crate) background_tasks: BackgroundTasks,
    pub(crate) store_hub: Option<StoreHub>,
    pub(crate) notifications: NotificationUi,
    memory_panel: MemoryPanel,
    memory_panel_open: bool,
    egui_debug_panel_open: bool,
    pub(crate) latest_queue_interest: Instant,
    pub(crate) frame_time_history: History<f32>,
    pub command_sender: CommandSender,
    command_receiver: CommandReceiver,
    cmd_palette: CommandPalette,
    analytics: ViewerAnalytics,
    view_class_registry: ViewClassRegistry,
    pub(crate) panel_state_overrides_active: bool,
    pub(crate) panel_state_overrides: PanelStateOverrides,
    reflection: Reflection,
    pub timeline_callbacks: Option<TimelineCallbacks>,
}

The Rerun Viewer as an [eframe] application.

Fields

main_thread_token: MainThreadToken

build_info: BuildInfo

startup_options: StartupOptions

start_time: Instant

ram_limit_warner: RamLimitWarner

egui_ctx: Context

screenshotter: Screenshotter

profiler: Profiler

text_log_rx: Receiver<LogMsg>

Listens to the local text log stream

component_ui_registry: ComponentUiRegistry

rx: ReceiveSet<LogMsg>

state: AppState

What is serialized

background_tasks: BackgroundTasks

Pending background tasks, e.g. files being saved.

store_hub: Option<StoreHub>

Interface for all recordings and blueprints

notifications: NotificationUi

Notification panel.

memory_panel: MemoryPanel

memory_panel_open: bool

egui_debug_panel_open: bool

latest_queue_interest: Instant

frame_time_history: History<f32>

Measures how long a frame takes to paint

command_sender: CommandSender

Commands to run at the end of the frame.

command_receiver: CommandReceiver

cmd_palette: CommandPalette

analytics: ViewerAnalytics

view_class_registry: ViewClassRegistry

All known view types.

panel_state_overrides_active: bool

panel_state_overrides: PanelStateOverrides

reflection: Reflection

timeline_callbacks: Option<TimelineCallbacks>

Interaction between JS and timeline.

This field isn’t used directly, but is propagated to all recording configs when they are created.

Implementations

impl App

pub fn new( main_thread_token: MainThreadToken, build_info: BuildInfo, app_env: &AppEnvironment, startup_options: StartupOptions, creation_context: &CreationContext<'_>, ) -> Self

Create a viewer that receives new log messages over time

pub fn set_profiler(&mut self, profiler: Profiler)

pub fn set_examples_manifest_url(&mut self, url: String)

pub fn build_info(&self) -> &BuildInfo

pub fn app_options(&self) -> &AppOptions

pub fn app_options_mut(&mut self) -> &mut AppOptions

pub fn is_screenshotting(&self) -> bool

pub fn add_receiver(&mut self, rx: Receiver<LogMsg>)

pub fn msg_receive_set(&self) -> &ReceiveSet<LogMsg>

pub fn add_view_class<T: ViewClass + Default + 'static>( &mut self, ) -> Result<(), ViewClassRegistryError>

Adds a new view class to the viewer.

fn check_keyboard_shortcuts(&self, egui_ctx: &Context)

fn run_pending_system_commands( &mut self, store_hub: &mut StoreHub, egui_ctx: &Context, )

fn run_pending_ui_commands( &mut self, egui_ctx: &Context, app_blueprint: &AppBlueprint<'_>, store_context: Option<&StoreContext<'_>>, )

fn run_system_command( &mut self, cmd: SystemCommand, store_hub: &mut StoreHub, egui_ctx: &Context, )

fn run_ui_command( &mut self, egui_ctx: &Context, app_blueprint: &AppBlueprint<'_>, store_context: Option<&StoreContext<'_>>, cmd: UICommand, )

fn run_time_control_command( &mut self, store_context: Option<&StoreContext<'_>>, command: TimeControlCommand, )

fn memory_panel_ui( &self, ui: &mut Ui, gpu_resource_stats: &WgpuResourcePoolStatistics, store_stats: Option<&StoreHubStats>, )

fn egui_debug_panel_ui(&self, ui: &mut Ui)

fn ui( &mut self, egui_ctx: &Context, frame: &Frame, app_blueprint: &AppBlueprint<'_>, gpu_resource_stats: &WgpuResourcePoolStatistics, store_context: Option<&StoreContext<'_>>, store_stats: Option<&StoreHubStats>, )

Top-level ui function.

Shows the viewer ui.

fn show_text_logs_as_notifications(&mut self)

Show recent text log messages to the user as toast notifications.

fn receive_messages(&self, store_hub: &mut StoreHub, egui_ctx: &Context)

fn validate_loaded_events(&self, store_events: &[ChunkStoreEvent])

After loading some data; check if the loaded data makes sense.

fn purge_memory_if_needed(&mut self, store_hub: &mut StoreHub)

fn reset_viewer(&mut self, store_hub: &mut StoreHub, egui_ctx: &Context)

Reset the viewer to how it looked the first time you ran it.

pub fn recording_db(&self) -> Option<&EntityDb>

fn handle_dropping_files( egui_ctx: &Context, store_ctx: Option<&StoreContext<'_>>, command_sender: &CommandSender, )

fn should_fade_in_welcome_screen(&self) -> bool

fn welcome_screen_opacity(&self, egui_ctx: &Context) -> f32

Handle fading in the welcome screen, if we should.

pub(crate) fn toggle_fullscreen(&self)

fn process_screenshot_result( &mut self, image: &Arc<ColorImage>, user_data: &UserData, )

impl App

pub fn rerun_menu_button_ui( &mut self, render_state: Option<&RenderState>, _store_context: Option<&StoreContext<'_>>, ui: &mut Ui, )

fn rerun_menu_ui( &mut self, ui: &mut Ui, render_state: Option<&RenderState>, _store_context: Option<&StoreContext<'_>>, )

fn about_rerun_ui(&self, ui: &mut Ui, render_state: Option<&RenderState>)

fn save_buttons_ui(&self, ui: &mut Ui, store_ctx: Option<&StoreContext<'_>>)

Trait Implementations

impl App for App

fn clear_color(&self, _visuals: &Visuals) -> [f32; 4]

Background color values for the app, e.g. what is sent to gl.clearColor.

fn save(&mut self, storage: &mut dyn Storage)

Called on shutdown, and perhaps at regular intervals. Allows you to save state.

fn update(&mut self, egui_ctx: &Context, frame: &mut Frame)

Called each time the UI needs repainting, which may be many times per second.

fn on_exit(&mut self)

Called once on shutdown, after [Self::save].

fn auto_save_interval(&self) -> Duration

Time between automatic calls to [Self::save]

fn persist_egui_memory(&self) -> bool

Controls whether or not the egui memory (window positions etc) will be persisted (only if the “persistence” feature is enabled).

fn raw_input_hook(&mut self, _ctx: &Context, _raw_input: &mut RawInput)

A hook for manipulating or filtering raw input before it is processed by [Self::update].