rerun::blueprint::archetypes::PanelBlueprint Struct Reference

Archetype: Shared state for the 3 collapsible panels. More...

#include <rerun/blueprint/archetypes/panel_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
	PanelBlueprint (PanelBlueprint &&other)=default
	PanelBlueprint (const PanelBlueprint &other)=default
PanelBlueprint &	operator= (const PanelBlueprint &other)=default
PanelBlueprint &	operator= (PanelBlueprint &&other)=default
PanelBlueprint	with_state (const rerun::blueprint::components::PanelState &_state) &&
	Current state of the panels.
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 PanelBlueprint	update_fields ()
	Update only some specific fields of a PanelBlueprint.
static PanelBlueprint	clear_fields ()
	Clear all the fields of a PanelBlueprint.

Public Attributes
std::optional< ComponentBatch >	state
	Current state of the panels.

Static Public Attributes
static constexpr const char	IndicatorComponentName []
static constexpr const char	ArchetypeName [] = "rerun.blueprint.archetypes.PanelBlueprint"
	The name of the archetype as used in ComponentDescriptors.
static constexpr auto	Descriptor_state
	ComponentDescriptor for the state field.

Detailed Description

Archetype: Shared state for the 3 collapsible panels.

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

Member Function Documentation

columns() [1/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::PanelBlueprint::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::PanelBlueprint::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

IndicatorComponentName

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

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.PanelBlueprintIndicator"

Descriptor_state

constexpr auto rerun::blueprint::archetypes::PanelBlueprint::Descriptor_state

staticconstexpr

Initial value:

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

ComponentDescriptor for the state field.

---

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

• rerun/blueprint/archetypes/panel_blueprint.hpp