Struct re_viewport_blueprint::view::ViewBlueprint

pub struct ViewBlueprint {
    pub id: ViewId,
    pub display_name: Option<String>,
    class_identifier: ViewClassIdentifier,
    pub space_origin: EntityPath,
    pub contents: ViewContents,
    pub visible: bool,
    pub defaults_path: EntityPath,
    pending_writes: Vec<Chunk>,
}

A view of a space.

Note: ViewBlueprint doesn’t implement Clone because it stores an internal uuid used for identifying the path of its data in the blueprint store. It’s ambiguous whether the intent is for a clone to write to the same place.

If you want a new view otherwise identical to an existing one, use re_viewport::ViewportBlueprint::duplicate_view.

Fields

id: ViewId

display_name: Option<String>

class_identifier: ViewClassIdentifier

space_origin: EntityPath

The “anchor point” of this view. The transform at this path forms the reference point for all scene->world transforms in this view. I.e. the position of this entity path in space forms the origin of the coordinate system in this view. Furthermore, this is the primary indicator for heuristics on what entities we show in this view.

contents: ViewContents

The content of this view as defined by its queries.

visible: bool

True if this view is visible in the UI.

defaults_path: EntityPath

Path where these views defaults can be found.

pending_writes: Vec<Chunk>

Pending blueprint writes for nested components from duplicate.

Implementations

impl ViewBlueprint

pub fn defaults_path(view_id: ViewId) -> EntityPath

Path at which a view writes defaults for components.

pub fn new( view_class: ViewClassIdentifier, recommended: RecommendedView, ) -> Self

Creates a new ViewBlueprint with a single ViewContents.

This ViewBlueprint is ephemeral. If you want to make it permanent, you must call Self::save_to_blueprint_store.

pub fn new_with_id( view_class: ViewClassIdentifier, recommended: RecommendedView, id: ViewId, ) -> Self

Creates a new ViewBlueprint with a single ViewContents, using the provided id.

Useful for testing contexts where random ids are not desired. Avoid using in production code.

This ViewBlueprint is ephemeral. If you want to make it permanent, you must call Self::save_to_blueprint_store.

pub fn missing_name_placeholder(&self) -> String

Placeholder name displayed in the UI if the user hasn’t explicitly named the view.

pub fn display_name_or_default(&self) -> ContentsName

Returns this view’s display name

When returning [ContentsName::Placeholder], the UI should display the resulting name using re_ui::LabelStyle::Unnamed.

pub fn try_from_db( id: ViewId, blueprint_db: &EntityDb, query: &LatestAtQuery, ) -> Option<Self>

Attempt to load a ViewBlueprint from the blueprint store.

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

Persist the entire ViewBlueprint to the blueprint store.

This only needs to be called if the ViewBlueprint was created with Self::new.

Otherwise, incremental calls to set_ functions will write just the necessary component update directly to the store.

pub fn duplicate( &self, store_context: &StoreContext<'_>, query: &LatestAtQuery, ) -> Self

Creates a new ViewBlueprint with the same contents, but a different [ViewId]

Also duplicates all the queries in the view.

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

pub fn set_display_name(&self, ctx: &ViewerContext<'_>, name: Option<String>)

pub fn set_origin(&self, ctx: &ViewerContext<'_>, origin: &EntityPath)

pub fn set_visible(&self, ctx: &ViewerContext<'_>, visible: bool)

pub fn class_identifier(&self) -> ViewClassIdentifier

pub fn class<'a>( &self, view_class_registry: &'a ViewClassRegistry, ) -> &'a dyn ViewClass

pub fn entity_path(&self) -> EntityPath

pub fn query_range( &self, blueprint: &EntityDb, blueprint_query: &LatestAtQuery, active_timeline: &Timeline, view_class_registry: &ViewClassRegistry, view_state: &dyn ViewState, ) -> QueryRange

pub fn bundle_context_with_states<'a>( &'a self, ctx: &'a ViewerContext<'a>, view_states: &'a mut ViewStates, ) -> ViewContext<'a>

pub fn bundle_context_with_state<'a>( &'a self, ctx: &'a ViewerContext<'a>, view_state: &'a dyn ViewState, ) -> ViewContext<'a>

fn visualizer_collection( &self, ctx: &ViewerContext<'_>, ) -> Arc<VisualizerCollection>

Trait Implementations

impl Clone for ViewBlueprint

fn clone(&self) -> ViewBlueprint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ViewBlueprint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.