Struct rerun::external::re_viewport::Viewport

pub struct Viewport<'a> {
    pub blueprint: &'a ViewportBlueprint,
    pub tree: Tree<BlueprintId<SpaceViewIdRegistry>>,
    pub tree_edited: bool,
    tree_action_receiver: Receiver<TreeAction>,
    tree_action_sender: Sender<TreeAction>,
}

Defines the layout of the Viewport

Fields

blueprint: &'a ViewportBlueprint

The blueprint that drives this viewport. This is the source of truth from the store for this frame.

tree: Tree<BlueprintId<SpaceViewIdRegistry>>

The [egui_tiles::Tree] tree that actually manages blueprint layout. This tree needs to be mutable for things like drag-and-drop and is ultimately saved back to the store. at the end of the frame if edited.

tree_edited: bool

Should be set to true whenever a tree modification should be back-ported to the blueprint store. That should only happen as a result of a user action.

tree_action_receiver: Receiver<TreeAction>

tree_action_sender: Sender<TreeAction>

Implementations

impl<'a> Viewport<'a>

pub fn new( blueprint: &'a ViewportBlueprint, space_view_class_registry: &SpaceViewClassRegistry, tree_action_receiver: Receiver<TreeAction>, tree_action_sender: Sender<TreeAction> ) -> Viewport<'a>

pub fn viewport_ui( &mut self, ui: &mut Ui, ctx: &'a ViewerContext<'_>, view_states: &mut ViewStates )

pub fn on_frame_start(&mut self, ctx: &ViewerContext<'_>)

pub fn update_and_sync_tile_tree_to_blueprint(self, ctx: &ViewerContext<'_>)

Process any deferred TreeActions and then sync to blueprint

pub fn is_item_valid( &self, store_context: &StoreContext<'_>, item: &Item ) -> bool

If false, the item is referring to data that is not present in this blueprint.