Struct SpatialView2D 

pub struct SpatialView2D;

Implementations

impl SpatialView2D

Create the outer 2D view, which consists of a scrollable region

pub fn view_2d( &self, ctx: &ViewerContext<'_>, missing_chunk_reporter: &MissingChunkReporter, ui: &mut Ui, state: &mut SpatialViewState, query: &ViewQuery<'_>, system_output: SystemExecutionOutput, ) -> Result<(), ViewSystemExecutionError>

Trait Implementations

impl Default for SpatialView2D

fn default() -> SpatialView2D

Returns the “default value” for a type.

impl ViewClass for SpatialView2D

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(&self, os: OperatingSystem) -> Help

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 preferred_tile_aspect_ratio(&self, state: &dyn ViewState) -> 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 layout_priority(&self) -> ViewClassLayoutPriority

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

fn recommended_origin_for_entities( &self, entities: &IntSet<EntityPath>, entity_db: &EntityDb, ) -> Option<EntityPath>

Determines a suitable origin given the provided set of entities.

fn spawn_heuristics( &self, ctx: &ViewerContext<'_>, include_entity: &dyn Fn(&EntityPath) -> bool, ) -> ViewSpawnHeuristics

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

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 ui( &self, ctx: &ViewerContext<'_>, missing_chunk_reporter: &MissingChunkReporter, 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 recommendation_order(&self) -> i32

Ordering hint for view class recommendations. Lower values are recommended more.

fn is_experimental(&self) -> bool

Whether this view class is still experimental.

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

Default query range for this view.

fn recommended_visualizers_for_entity( &self, entity_path: &EntityPath, visualizers_with_reason: &[(ViewSystemIdentifier, &VisualizableReason)], indicated_entities_per_visualizer: &PerVisualizerType<&IndicatedEntities>, ) -> RecommendedVisualizers

Auto picked visualizers for an entity if there was not explicit selection.

fn visualizers_section<'a>( &'a self, _ctx: &'a ViewContext<'a>, ) -> Option<VisualizersSectionOutput<'a>>

Custom UI and add-visualizer options for the “Visualizers” section in the selection panel.

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.

fn handle_component_drop( &self, _ctx: &ViewerContext<'_>, _view_id: BlueprintId<ViewIdRegistry>, _component_paths: &[ComponentPath], _released: bool, ) -> DragAndDropFeedback

Handle components being dragged over a view of this class.