rerun::blueprint::archetypes::ContainerBlueprint Struct Reference

Archetype: The top-level description of the Viewport. More...

#include <rerun/blueprint/archetypes/container_blueprint.hpp>

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	ContainerBlueprint (ContainerBlueprint &&other)=default
	ContainerBlueprint (rerun::blueprint::components::ContainerKind _container_kind)
ContainerBlueprint	with_display_name (rerun::components::Name _display_name) &&
	The name of the container.
ContainerBlueprint	with_contents (Collection< rerun::blueprint::components::IncludedContent > _contents) &&
	ContainerIds or SpaceViewIds that are children of this container.
ContainerBlueprint	with_col_shares (Collection< rerun::blueprint::components::ColumnShare > _col_shares) &&
	The layout shares of each column in the container.
ContainerBlueprint	with_row_shares (Collection< rerun::blueprint::components::RowShare > _row_shares) &&
	The layout shares of each row of the container.
ContainerBlueprint	with_active_tab (rerun::blueprint::components::ActiveTab _active_tab) &&
	Which tab is active.
ContainerBlueprint	with_visible (rerun::blueprint::components::Visible _visible) &&
	Whether this container is visible.
ContainerBlueprint	with_grid_columns (rerun::blueprint::components::GridColumns _grid_columns) &&
	How many columns this grid should have.

Public Attributes
rerun::blueprint::components::ContainerKind	container_kind
	The class of the view.
std::optional< rerun::components::Name >	display_name
	The name of the container.
std::optional< Collection< rerun::blueprint::components::IncludedContent > >	contents
	ContainerIds or SpaceViewIds that are children of this container.
std::optional< Collection< rerun::blueprint::components::ColumnShare > >	col_shares
	The layout shares of each column in the container.
std::optional< Collection< rerun::blueprint::components::RowShare > >	row_shares
	The layout shares of each row of the container.
std::optional< rerun::blueprint::components::ActiveTab >	active_tab
	Which tab is active.
std::optional< rerun::blueprint::components::Visible >	visible
	Whether this container is visible.
std::optional< rerun::blueprint::components::GridColumns >	grid_columns
	How many columns this grid should have.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: The top-level description of the Viewport.

Member Function Documentation

with_col_shares()

ContainerBlueprint rerun::blueprint::archetypes::ContainerBlueprint::with_col_shares ( Collection< rerun::blueprint::components::ColumnShare >  _col_shares ) &&

inline

The layout shares of each column in the container.

For Horizontal containers, the length of this list should always match the number of contents.

Ignored for Vertical containers.

with_row_shares()

ContainerBlueprint rerun::blueprint::archetypes::ContainerBlueprint::with_row_shares ( Collection< rerun::blueprint::components::RowShare >  _row_shares ) &&

inline

The layout shares of each row of the container.

For Vertical containers, the length of this list should always match the number of contents.

Ignored for Horizontal containers.

with_active_tab()

ContainerBlueprint rerun::blueprint::archetypes::ContainerBlueprint::with_active_tab ( rerun::blueprint::components::ActiveTab  _active_tab ) &&

inline

Which tab is active.

Only applies to Tabs containers.

with_visible()

ContainerBlueprint rerun::blueprint::archetypes::ContainerBlueprint::with_visible ( rerun::blueprint::components::Visible  _visible ) &&

inline

Whether this container is visible.

Defaults to true if not specified.

with_grid_columns()

ContainerBlueprint rerun::blueprint::archetypes::ContainerBlueprint::with_grid_columns ( rerun::blueprint::components::GridColumns  _grid_columns ) &&

inline

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for Horizontal/Vertical containers.

Member Data Documentation

col_shares

std::optional<Collection<rerun::blueprint::components::ColumnShare> > rerun::blueprint::archetypes::ContainerBlueprint::col_shares

The layout shares of each column in the container.

For Horizontal containers, the length of this list should always match the number of contents.

Ignored for Vertical containers.

row_shares

std::optional<Collection<rerun::blueprint::components::RowShare> > rerun::blueprint::archetypes::ContainerBlueprint::row_shares

The layout shares of each row of the container.

For Vertical containers, the length of this list should always match the number of contents.

Ignored for Horizontal containers.

active_tab

std::optional<rerun::blueprint::components::ActiveTab> rerun::blueprint::archetypes::ContainerBlueprint::active_tab

Which tab is active.

Only applies to Tabs containers.

visible

std::optional<rerun::blueprint::components::Visible> rerun::blueprint::archetypes::ContainerBlueprint::visible

Whether this container is visible.

Defaults to true if not specified.

grid_columns

std::optional<rerun::blueprint::components::GridColumns> rerun::blueprint::archetypes::ContainerBlueprint::grid_columns

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for Horizontal/Vertical containers.

IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::ContainerBlueprint::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.ContainerBlueprintIndicator"

---

The documentation for this struct was generated from the following file:

• rerun/blueprint/archetypes/container_blueprint.hpp