Struct re_view_text_document::view_class::TextDocumentView

pub struct TextDocumentView;

Trait Implementations

impl Default for TextDocumentView

fn default() -> TextDocumentView

Returns the “default value” for a type.

impl ViewClass for TextDocumentView

fn identifier() -> ViewClassIdentifier

Identifier string of this view class.

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

User-facing name of this view class.

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

Icon used to identify this view class.

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

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

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

Called once upon registration of the class

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

Called once for every new view instance of this class.

fn layout_priority(&self) -> ViewClassLayoutPriority

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

fn selection_ui( &self, _ctx: &ViewerContext<'_>, ui: &mut Ui, state: &mut dyn ViewState, _space_origin: &EntityPath, _view_id: ViewId, ) -> Result<(), ViewSystemExecutionError>

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

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

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

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

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

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

Optional archetype of the View’s blueprint properties.

fn preferred_tile_aspect_ratio( &self, _state: &(dyn ViewState + 'static), ) -> Option<f32>

Preferred aspect ratio for the ui tiles of this view.

fn supports_visible_time_range(&self) -> bool

Controls whether the visible time range UI should be displayed for this view.

fn default_query_range(&self, _state: &(dyn ViewState + 'static)) -> QueryRange

Default query range for this view.

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

Determines a suitable origin given the provided set of entities.

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

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>, ) -> SmallVec<[ViewSystemIdentifier; 4]>

Choose the default visualizers to enable for this entity.

fn extra_title_bar_ui( &self, _ctx: &ViewerContext<'_>, _ui: &mut Ui, _state: &mut (dyn ViewState + 'static), _space_origin: &EntityPath, _view_id: BlueprintId<ViewIdRegistry>, ) -> Result<(), ViewSystemExecutionError>

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