Archetype: The description of a container. 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 (const ContainerBlueprint &other)=default

ContainerBlueprint &	operator= (const ContainerBlueprint &other)=default

ContainerBlueprint &	operator= (ContainerBlueprint &&other)=default

	ContainerBlueprint (rerun::blueprint::components::ContainerKind _container_kind)

ContainerBlueprint	with_container_kind (const rerun::blueprint::components::ContainerKind &_container_kind) &&
	The class of the view.

ContainerBlueprint	with_display_name (const rerun::components::Name &_display_name) &&
	The name of the container.

ContainerBlueprint	with_contents (const Collection< rerun::blueprint::components::IncludedContent > &_contents) &&
	`ContainerId`s or `ViewId`s that are children of this container.

ContainerBlueprint	with_col_shares (const Collection< rerun::blueprint::components::ColumnShare > &_col_shares) &&
	The layout shares of each column in the container.

ContainerBlueprint	with_row_shares (const Collection< rerun::blueprint::components::RowShare > &_row_shares) &&
	The layout shares of each row of the container.

ContainerBlueprint	with_active_tab (const rerun::blueprint::components::ActiveTab &_active_tab) &&
	Which tab is active.

ContainerBlueprint	with_visible (const rerun::components::Visible &_visible) &&
	Whether this container is visible.

ContainerBlueprint	with_grid_columns (const rerun::blueprint::components::GridColumns &_grid_columns) &&
	How many columns this grid should have.

Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.

Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static ContainerBlueprint	update_fields ()
	Update only some specific fields of a `ContainerBlueprint`.

static ContainerBlueprint	clear_fields ()
	Clear all the fields of a `ContainerBlueprint`.

Public Attributes
std::optional< ComponentBatch >	container_kind
	The class of the view.

std::optional< ComponentBatch >	display_name
	The name of the container.

std::optional< ComponentBatch >	contents
	`ContainerId`s or `ViewId`s that are children of this container.

std::optional< ComponentBatch >	col_shares
	The layout shares of each column in the container.

std::optional< ComponentBatch >	row_shares
	The layout shares of each row of the container.

std::optional< ComponentBatch >	active_tab
	Which tab is active.

std::optional< ComponentBatch >	visible
	Whether this container is visible.

std::optional< ComponentBatch >	grid_columns
	How many columns this grid should have.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

static constexpr const char	ArchetypeName []
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_container_kind
	`ComponentDescriptor` for the `container_kind` field.

static constexpr auto	Descriptor_display_name
	`ComponentDescriptor` for the `display_name` field.

static constexpr auto	Descriptor_contents
	`ComponentDescriptor` for the `contents` field.

static constexpr auto	Descriptor_col_shares
	`ComponentDescriptor` for the `col_shares` field.

static constexpr auto	Descriptor_row_shares
	`ComponentDescriptor` for the `row_shares` field.

static constexpr auto	Descriptor_active_tab
	`ComponentDescriptor` for the `active_tab` field.

static constexpr auto	Descriptor_visible
	`ComponentDescriptor` for the `visible` field.

static constexpr auto	Descriptor_grid_columns
	`ComponentDescriptor` for the `grid_columns` field.

Detailed Description

Archetype: The description of a container.

⚠ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

Member Function Documentation

◆ with_col_shares()

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

inline

The layout shares of each column in the container.

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

Ignored for components::ContainerKind::Vertical containers.

◆ with_row_shares()

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

inline

The layout shares of each row of the container.

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

Ignored for components::ContainerKind::Horizontal containers.

◆ with_active_tab()

ContainerBlueprint rerun::blueprint::archetypes::ContainerBlueprint::with_active_tab ( const 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 ( const rerun::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 ( const rerun::blueprint::components::GridColumns & _grid_columns ) &&

inline

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for components::ContainerKind::Horizontal/components::ContainerKind::Vertical containers.

◆ columns() [1/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::ContainerBlueprint::columns ( const Collection< uint32_t > & lengths_ )

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

◆ columns() [2/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::ContainerBlueprint::columns ( )

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

◆ col_shares

std::optional<ComponentBatch> rerun::blueprint::archetypes::ContainerBlueprint::col_shares

The layout shares of each column in the container.

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

Ignored for components::ContainerKind::Vertical containers.

◆ row_shares

std::optional<ComponentBatch> rerun::blueprint::archetypes::ContainerBlueprint::row_shares

The layout shares of each row of the container.

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

Ignored for components::ContainerKind::Horizontal containers.

◆ active_tab

std::optional<ComponentBatch> rerun::blueprint::archetypes::ContainerBlueprint::active_tab

Which tab is active.

Only applies to Tabs containers.

◆ visible

std::optional<ComponentBatch> rerun::blueprint::archetypes::ContainerBlueprint::visible

Whether this container is visible.

Defaults to true if not specified.

◆ grid_columns

std::optional<ComponentBatch> rerun::blueprint::archetypes::ContainerBlueprint::grid_columns

How many columns this grid should have.

If unset, the grid layout will be auto.

Ignored for components::ContainerKind::Horizontal/components::ContainerKind::Vertical containers.

◆ IndicatorComponentName

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

staticconstexpr

Initial value:

=

"rerun.blueprint.components.ContainerBlueprintIndicator"

◆ ArchetypeName

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

staticconstexpr

Initial value:

=

"rerun.blueprint.archetypes.ContainerBlueprint"

The name of the archetype as used in ComponentDescriptors.

◆ Descriptor_container_kind

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_container_kind

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "container_kind",
            Loggable<rerun::blueprint::components::ContainerKind>::Descriptor.component_name
        )

ComponentDescriptor for the container_kind field.

◆ Descriptor_display_name

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_display_name

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "display_name",
            Loggable<rerun::components::Name>::Descriptor.component_name
        )

ComponentDescriptor for the display_name field.

◆ Descriptor_contents

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_contents

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "contents",
            Loggable<rerun::blueprint::components::IncludedContent>::Descriptor.component_name
        )

ComponentDescriptor for the contents field.

◆ Descriptor_col_shares

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_col_shares

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "col_shares",
            Loggable<rerun::blueprint::components::ColumnShare>::Descriptor.component_name
        )

ComponentDescriptor for the col_shares field.

◆ Descriptor_row_shares

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_row_shares

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "row_shares",
            Loggable<rerun::blueprint::components::RowShare>::Descriptor.component_name
        )

ComponentDescriptor for the row_shares field.

◆ Descriptor_active_tab

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_active_tab

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "active_tab",
            Loggable<rerun::blueprint::components::ActiveTab>::Descriptor.component_name
        )

ComponentDescriptor for the active_tab field.

◆ Descriptor_visible

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_visible

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "visible",
            Loggable<rerun::components::Visible>::Descriptor.component_name
        )

ComponentDescriptor for the visible field.

◆ Descriptor_grid_columns

constexpr auto rerun::blueprint::archetypes::ContainerBlueprint::Descriptor_grid_columns

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "grid_columns",
            Loggable<rerun::blueprint::components::GridColumns>::Descriptor.component_name
        )

ComponentDescriptor for the grid_columns field.

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

rerun/blueprint/archetypes/container_blueprint.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_col_shares()

◆ with_row_shares()

◆ with_active_tab()

◆ with_visible()

◆ with_grid_columns()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ col_shares

◆ row_shares

◆ active_tab

◆ visible

◆ grid_columns

◆ IndicatorComponentName

◆ ArchetypeName

◆ Descriptor_container_kind

◆ Descriptor_display_name

◆ Descriptor_contents

◆ Descriptor_col_shares

◆ Descriptor_row_shares

◆ Descriptor_active_tab

◆ Descriptor_visible

◆ Descriptor_grid_columns