Trait re_viewer_context::space_view::space_view_class::SpaceViewClass

pub trait SpaceViewClass: Send + Sync {
    // Required methods
    fn identifier() -> SpaceViewClassIdentifier
       where Self: Sized;
    fn display_name(&self) -> &'static str;
    fn help_markdown(&self, egui_ctx: &Context) -> String;
    fn on_register(
        &self,
        system_registry: &mut SpaceViewSystemRegistrator<'_>
    ) -> Result<(), SpaceViewClassRegistryError>;
    fn new_state(&self) -> Box<dyn SpaceViewState>;
    fn layout_priority(&self) -> SpaceViewClassLayoutPriority;
    fn spawn_heuristics(
        &self,
        ctx: &ViewerContext<'_>
    ) -> SpaceViewSpawnHeuristics;
    fn ui(
        &self,
        ctx: &ViewerContext<'_>,
        ui: &mut Ui,
        state: &mut dyn SpaceViewState,
        query: &ViewQuery<'_>,
        system_output: SystemExecutionOutput
    ) -> Result<(), SpaceViewSystemExecutionError>;

    // Provided methods
    fn icon(&self) -> &'static Icon { ... }
    fn blueprint_archetype(&self) -> Option<Vec<ComponentName>> { ... }
    fn preferred_tile_aspect_ratio(
        &self,
        _state: &dyn SpaceViewState
    ) -> Option<f32> { ... }
    fn default_query_range(&self, _state: &dyn SpaceViewState) -> QueryRange { ... }
    fn recommended_root_for_entities(
        &self,
        _entities: &IntSet<EntityPath>,
        _entity_db: &EntityDb
    ) -> Option<EntityPath> { ... }
    fn visualizable_filter_context(
        &self,
        _space_origin: &EntityPath,
        _entity_db: &EntityDb
    ) -> Box<dyn VisualizableFilterContext> { ... }
    fn choose_default_visualizers(
        &self,
        entity_path: &EntityPath,
        _applicable_entities_per_visualizer: &PerVisualizer<ApplicableEntities>,
        visualizable_entities_per_visualizer: &PerVisualizer<VisualizableEntities>,
        indicated_entities_per_visualizer: &PerVisualizer<IndicatedEntities>
    ) -> SmallVisualizerSet { ... }
    fn selection_ui(
        &self,
        _ctx: &ViewerContext<'_>,
        _ui: &mut Ui,
        _state: &mut dyn SpaceViewState,
        _space_origin: &EntityPath,
        _space_view_id: SpaceViewId
    ) -> Result<(), SpaceViewSystemExecutionError> { ... }
    fn extra_title_bar_ui(
        &self,
        _ctx: &ViewerContext<'_>,
        _ui: &mut Ui,
        _state: &mut dyn SpaceViewState,
        _space_origin: &EntityPath,
        _space_view_id: SpaceViewId
    ) -> Result<(), SpaceViewSystemExecutionError> { ... }
}

Defines a class of space view without any concrete types making it suitable for storage and interfacing.

Each Space View in the viewer’s viewport has a single class assigned immutable at its creation time. The class defines all aspects of its behavior. It determines which entities are queried, how they are rendered, and how the user can interact with them.

Required Methods

fn identifier() -> SpaceViewClassIdentifier

where Self: Sized,

Identifier string of this space view class.

By convention we use PascalCase.

fn display_name(&self) -> &'static str

User-facing name of this space view class.

Used for UI display.

fn help_markdown(&self, egui_ctx: &Context) -> String

Help text describing how to interact with this space view in the ui.

fn on_register( &self, system_registry: &mut SpaceViewSystemRegistrator<'_> ) -> Result<(), SpaceViewClassRegistryError>

Called once upon registration of the class

This can be used to register all built-in crate::ViewContextSystem and crate::VisualizerSystem.

fn new_state(&self) -> Box<dyn SpaceViewState>

Called once for every new space view instance of this class.

The state is not persisted across viewer sessions, only shared frame-to-frame.

fn layout_priority(&self) -> SpaceViewClassLayoutPriority

Controls how likely this space view will get a large tile in the ui.

fn spawn_heuristics(&self, ctx: &ViewerContext<'_>) -> SpaceViewSpawnHeuristics

Determines which space views should be spawned by default for this class.

fn ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, state: &mut dyn SpaceViewState, query: &ViewQuery<'_>, system_output: SystemExecutionOutput ) -> Result<(), SpaceViewSystemExecutionError>

Draws the ui for this space view class and handles ui events.

The passed state is kept frame-to-frame.

TODO(wumpf): Right now the ui methods control when and how to create re_renderer::ViewBuilders. In the future, we likely want to move view builder handling to re_viewport with minimal configuration options exposed via crate::SpaceViewClass.

Provided Methods

fn icon(&self) -> &'static Icon

Icon used to identify this space view class.

fn blueprint_archetype(&self) -> Option<Vec<ComponentName>>

Optional archetype of the Space View’s blueprint properties.

Blueprint components that only apply to the space view itself, not to the entities it displays.

fn preferred_tile_aspect_ratio( &self, _state: &dyn SpaceViewState ) -> Option<f32>

Preferred aspect ratio for the ui tiles of this space view.

fn default_query_range(&self, _state: &dyn SpaceViewState) -> QueryRange

Default query range for this space view.

fn recommended_root_for_entities( &self, _entities: &IntSet<EntityPath>, _entity_db: &EntityDb ) -> Option<EntityPath>

Determines a suitable origin given the provided set of entities.

This function only considers the transform topology, disregarding the actual visualizability of the entities (for this, use Self::visualizable_filter_context).

fn visualizable_filter_context( &self, _space_origin: &EntityPath, _entity_db: &EntityDb ) -> Box<dyn VisualizableFilterContext>

Create context object that is passed to all of this classes visualizers to determine whether they can be visualized

See crate::VisualizerSystem::filter_visualizable_entities.

fn choose_default_visualizers( &self, entity_path: &EntityPath, _applicable_entities_per_visualizer: &PerVisualizer<ApplicableEntities>, visualizable_entities_per_visualizer: &PerVisualizer<VisualizableEntities>, indicated_entities_per_visualizer: &PerVisualizer<IndicatedEntities> ) -> SmallVisualizerSet

Choose the default visualizers to enable for this entity.

Helpful for customizing fallback behavior for types that are insufficient to determine indicated on their own.

Will only be called for entities where the selected visualizers have not been overridden by the blueprint.

This interface provides a default implementation which will return all visualizers which are both visualizable and indicated for the given entity.

fn selection_ui( &self, _ctx: &ViewerContext<'_>, _ui: &mut Ui, _state: &mut dyn SpaceViewState, _space_origin: &EntityPath, _space_view_id: SpaceViewId ) -> Result<(), SpaceViewSystemExecutionError>

Ui shown when the user selects a space view of this class.

fn extra_title_bar_ui( &self, _ctx: &ViewerContext<'_>, _ui: &mut Ui, _state: &mut dyn SpaceViewState, _space_origin: &EntityPath, _space_view_id: SpaceViewId ) -> Result<(), SpaceViewSystemExecutionError>

Additional UI displayed in the tab title bar, between the “maximize” and “help” buttons.

Note: this is a right-to-left layout.

Trait Implementations

impl<'a> SpaceViewClassExt<'a> for dyn SpaceViewClass + 'a

fn determine_visualizable_entities( &self, applicable_entities_per_visualizer: &PerVisualizer<ApplicableEntities>, entity_db: &EntityDb, visualizers: &VisualizerCollection, space_origin: &EntityPath ) -> PerVisualizer<VisualizableEntities>

Determines the set of visible entities for a given space view.

Implementors

impl SpaceViewClass for SpaceViewClassPlaceholder