Enum re_viewer_context::command_sender::SystemCommand

pub enum SystemCommand {
    ActivateApp(ApplicationId),
    CloseApp(ApplicationId),
    LoadDataSource(DataSource),
    ClearSourceAndItsStores(SmartChannelSource),
    AddReceiver(Receiver<LogMsg>),
    ResetViewer,
    ClearActiveBlueprint,
    ClearActiveBlueprintAndEnableHeuristics,
    ActivateRecording(StoreId),
    CloseStore(StoreId),
    CloseAllRecordings,
    UpdateBlueprint(StoreId, Vec<Chunk>),
    UndoBlueprint {
        blueprint_id: StoreId,
    },
    RedoBlueprint {
        blueprint_id: StoreId,
    },
    DropEntity(StoreId, EntityPath),
    EnableInspectBlueprintTimeline(bool),
    SetSelection(Item),
    SetActiveTimeline {
        rec_id: StoreId,
        timeline: Timeline,
    },
    SetFocus(Item),
    FileSaver(Box<dyn FnOnce() -> Result<PathBuf> + Send + 'static>),
}

Commands used by internal system components

Variants

ActivateApp(ApplicationId)

Make this the active application.

CloseApp(ApplicationId)

Close this app and all its recordings.

LoadDataSource(DataSource)

Load some data.

ClearSourceAndItsStores(SmartChannelSource)

Clear everything that came from this source, and close the source.

AddReceiver(Receiver<LogMsg>)

ResetViewer

Reset the Viewer to the default state

ClearActiveBlueprint

Clear the active blueprint.

This may have two outcomes:

• If a default blueprint is set, it will be used.
• Otherwise, the heuristics will be enabled.

To force using the heuristics, use Self::ClearActiveBlueprintAndEnableHeuristics.

UI note: because of the above ambiguity, controls for this command should only be enabled if a default blueprint is set.

ClearActiveBlueprintAndEnableHeuristics

Clear the active blueprint and enable heuristics.

The final outcome of this is to set the active blueprint to the heuristics. This command does not affect the default blueprint if any was set.

ActivateRecording(StoreId)

If this is a recording, switch to it.

CloseStore(StoreId)

Close a recording or blueprint (free its memory).

CloseAllRecordings

Close all stores and show the welcome screen again.

UpdateBlueprint(StoreId, Vec<Chunk>)

Update the blueprint with additional data

The StoreId should generally be the currently selected blueprint but is tracked manually to ensure self-consistency if the blueprint is both modified and changed in the same frame.

Instead of using this directly, consider using crate::ViewerContext::save_blueprint_archetype or similar.

UndoBlueprint

Fields

blueprint_id: StoreId

RedoBlueprint

Fields

blueprint_id: StoreId

DropEntity(StoreId, EntityPath)

Drop a specific entity from a store.

Also drops all recursive children.

The StoreId should generally be the currently selected blueprint but is tracked manually to ensure self-consistency if the blueprint is both modified and changed in the same frame.

EnableInspectBlueprintTimeline(bool)

Show a timeline of the blueprint data.

SetSelection(Item)

Set the item selection.

SetActiveTimeline

Set the active timeline for the given recording.

Fields

rec_id: StoreId

timeline: Timeline

SetFocus(Item)

Sets the focus to the given item.

The focused item is cleared out every frame. Focusing is triggered either explicitly by ui-elements saying so or by double-clicking on a button representing an item.

Unlike item selection, item focusing is not global state. It may however have stateful effects in certain views, e.g. the 3D view may follow the last focused item as it moves, or a frame may be highlighted for a few frames.

Just like selection highlighting, the exact behavior of focusing is up to the receiving views.

FileSaver(Box<dyn FnOnce() -> Result<PathBuf> + Send + 'static>)

Add a task, run on a background thread, that saves something to disk.

Trait Implementations

impl Debug for SystemCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum SystemCommand> for &'static str

fn from(x: &'_derivative_strum SystemCommand) -> &'static str

Converts to this type from the input type.

impl From<SystemCommand> for &'static str

fn from(x: SystemCommand) -> &'static str

Converts to this type from the input type.