Struct re_viewport_blueprint::ContainerBlueprint

pub struct ContainerBlueprint {
    pub id: ContainerId,
    pub container_kind: ContainerKind,
    pub display_name: Option<String>,
    pub contents: Vec<Contents>,
    pub col_shares: Vec<f32>,
    pub row_shares: Vec<f32>,
    pub active_tab: Option<Contents>,
    pub visible: bool,
    pub grid_columns: Option<u32>,
}

The native version of a re_types::blueprint::archetypes::ContainerBlueprint.

This represents a single container in the blueprint. On each frame, it is used to populate an [egui_tiles::Container]. Each child in contents can be either a [ViewId] or another [ContainerId].

The main reason this exists is to handle type conversions that aren’t yet well handled by the code-generated archetypes.

Fields

id: ContainerId

container_kind: ContainerKind

display_name: Option<String>

contents: Vec<Contents>

col_shares: Vec<f32>

row_shares: Vec<f32>

active_tab: Option<Contents>

visible: bool

grid_columns: Option<u32>

Implementations

impl ContainerBlueprint

pub fn new(id: ContainerId) -> Self

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

Attempt to load a ContainerBlueprint from the blueprint store.

pub fn entity_path(&self) -> EntityPath

pub fn add_child(&mut self, content: Contents)

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

Persist the entire ContainerBlueprint to the blueprint store.

This only needs to be called if the ContainerBlueprint was created with Self::from_egui_tiles_container.

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

pub fn from_egui_tiles_container( container_id: ContainerId, container: &Container, visible: bool, tile_to_contents: &HashMap<TileId, Contents>, ) -> Self

Creates a new ContainerBlueprint from the given [egui_tiles::Container].

This ContainerBlueprint 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 container’s display name

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

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

Sets the display name for this container.

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

pub fn set_grid_columns( &self, ctx: &ViewerContext<'_>, grid_columns: Option<u32>, )

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

Clears the blueprint component for this container.

pub fn to_tile(&self) -> Tile<ViewId>

Trait Implementations

impl Clone for ContainerBlueprint

fn clone(&self) -> ContainerBlueprint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerBlueprint

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

Formats the value using the given formatter.

impl Default for ContainerBlueprint

fn default() -> Self

Returns the “default value” for a type.