Struct re_viewer_context::ViewerContext

pub struct ViewerContext<'a> {

    pub app_options: &'a AppOptions,
    pub cache: &'a Caches,
    pub reflection: &'a Reflection,
    pub component_ui_registry: &'a ComponentUiRegistry,
    pub view_class_registry: &'a ViewClassRegistry,
    pub store_context: &'a StoreContext<'a>,
    pub maybe_visualizable_entities_per_visualizer: &'a PerVisualizer<MaybeVisualizableEntities>,
    pub indicated_entities_per_visualizer: &'a PerVisualizer<IndicatedEntities>,
    pub query_results: &'a HashMap<ViewId, DataQueryResult>,
    pub rec_cfg: &'a RecordingConfig,
    pub blueprint_cfg: &'a RecordingConfig,
    pub selection_state: &'a ApplicationSelectionState,
    pub blueprint_query: &'a LatestAtQuery,
    pub egui_ctx: &'a Context,
    pub render_ctx: &'a RenderContext,
    pub command_sender: &'a CommandSender,
    pub focused_item: &'a Option<Item>,
    pub drag_and_drop_manager: &'a DragAndDropManager,
}

Common things needed by many parts of the viewer.

Fields

app_options: &'a AppOptions

Global options for the whole viewer.

cache: &'a Caches

Things that need caching and are shared across the whole viewer.

Use this only for things that you expected be shared across different panels and/or views.

reflection: &'a Reflection

Runtime info about components and archetypes.

The component placeholder values for components are to be used when crate::ComponentFallbackProvider::try_provide_fallback is not able to provide a value.

⚠️ In almost all cases you should not use this directly, but instead use the currently best fitting crate::ComponentFallbackProvider and call crate::ComponentFallbackProvider::fallback_for instead.

component_ui_registry: &'a ComponentUiRegistry

How to display components.

view_class_registry: &'a ViewClassRegistry

Registry of all known classes of views.

store_context: &'a StoreContext<'a>

The current view of the store

maybe_visualizable_entities_per_visualizer: &'a PerVisualizer<MaybeVisualizableEntities>

Mapping from class and system to entities for the store

TODO(andreas): This should have a generation id, allowing to update heuristics(?)/visualizable entities etc.

indicated_entities_per_visualizer: &'a PerVisualizer<IndicatedEntities>

For each visualizer, the set of entities that have at least one matching indicator component.

TODO(andreas): Should we always do the intersection with maybe_visualizable_entities_per_visualizer or are we ever interested in a (definitely-)non-visualizable but indicator-matching entity?

query_results: &'a HashMap<ViewId, DataQueryResult>

All the query results for this frame.

rec_cfg: &'a RecordingConfig

UI config for the current recording (found in EntityDb).

blueprint_cfg: &'a RecordingConfig

UI config for the current blueprint.

selection_state: &'a ApplicationSelectionState

Selection & hovering state.

blueprint_query: &'a LatestAtQuery

The blueprint query used for resolving blueprint in this frame

egui_ctx: &'a Context

The [egui::Context].

render_ctx: &'a RenderContext

The global re_renderer context, holds on to all GPU resources.

command_sender: &'a CommandSender

Interface for sending commands back to the app

focused_item: &'a Option<Item>

Item that got focused on the last frame if any.

The focused item is cleared every frame, but views may react with side-effects that last several frames.

drag_and_drop_manager: &'a DragAndDropManager

Helper object to manage drag-and-drop operations.

Implementations

impl ViewerContext<'_>

pub fn save_blueprint_archetype( &self, entity_path: &EntityPath, components: &dyn AsComponents, )

pub fn save_blueprint_component( &self, entity_path: &EntityPath, component_batch: &dyn ComponentBatch, )

pub fn save_blueprint_array( &self, entity_path: &EntityPath, component_name: ComponentName, array: ArrayRef, )

pub fn save_empty_blueprint_component<'a, C>(&self, entity_path: &EntityPath)

where C: Component + 'a,

Helper to save a component to the blueprint store.

pub fn raw_latest_at_in_default_blueprint( &self, entity_path: &EntityPath, component_name: ComponentName, ) -> Option<ArrayRef>

Queries a raw component from the default blueprint.

pub fn reset_blueprint_component_by_name( &self, entity_path: &EntityPath, component_name: ComponentName, )

Resets a blueprint component to the value it had in the default blueprint.

pub fn clear_blueprint_component_by_name( &self, entity_path: &EntityPath, component_name: ComponentName, )

Clears a component in the blueprint store by logging an empty array if it exists.

impl ViewerContext<'_>

pub fn lookup_query_result(&self, id: ViewId) -> &DataQueryResult

impl ViewerContext<'_>

pub fn recording(&self) -> &EntityDb

The active recording.

pub fn blueprint_db(&self) -> &EntityDb

The active blueprint.

pub fn recording_engine(&self) -> StorageEngineReadGuard<'_>

The StorageEngine for the active recording.

pub fn blueprint_engine(&self) -> StorageEngineReadGuard<'_>

The StorageEngine for the active blueprint.

pub fn recording_id(&self) -> StoreId

The StoreId of the active recording.

pub fn selection(&self) -> &ItemCollection

Returns the current selection.

pub fn hovered(&self) -> &ItemCollection

Returns the currently hovered objects.

pub fn selection_state(&self) -> &ApplicationSelectionState

pub fn current_query(&self) -> LatestAtQuery

The current time query, based on the current time control.

pub fn handle_select_hover_drag_interactions( &self, response: &Response, interacted_items: impl Into<ItemCollection>, draggable: bool, )

Consistently handle the selection, hover, drag start interactions for a given set of items.

The draggable parameter controls whether a drag can be initiated from this item. When a UI element represents an crate::Item, one must make the call whether this element should be meaningfully draggable by the users. This is ultimately a subjective decision, but some here are some guidelines:

• Is there a meaningful destination for the dragged payload? For example, dragging stuff out of a modal dialog is by definition meaningless.
• Even if a drag destination exists, would that be obvious to the user?
• Is it expected for that kind of UI element to be draggable? For example, buttons aren’t typically draggable.

Drag vs. selection semantics:

• When dragging an unselected item, that item only is dragged, and the selection is unchanged…
• …unless cmd/ctrl is held, in which case the item is added to the selection and the entire selection is dragged.
• When dragging a selected item, the entire selection is dragged as well.

pub fn placeholder_for(&self, component: ComponentName) -> ArrayRef

Returns a placeholder value for a given component, solely identified by its name.

A placeholder is an array of the component type with a single element which takes on some default value. It can be set as part of the reflection information, see re_types_core::reflection::ComponentReflection::custom_placeholder. Note that automatically generated placeholders ignore any extension types.

This requires the component name to be known by either datastore or blueprint store and will return a placeholder for a nulltype otherwise, logging an error. The rationale is that to get into this situation, we need to know of a component name for which we don’t have a datatype, meaning that we can’t make any statement about what data this component should represent.

pub fn is_safari_browser(&self) -> bool

Are we running inside the Safari browser?