Rerun C++ SDK
Loading...
Searching...
No Matches
rerun::blueprint::archetypes::ViewportBlueprint Struct Reference

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

#include <rerun/blueprint/archetypes/viewport_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

 ViewportBlueprint (ViewportBlueprint &&other)=default
 
 ViewportBlueprint (const ViewportBlueprint &other)=default
 
ViewportBlueprintoperator= (const ViewportBlueprint &other)=default
 
ViewportBlueprintoperator= (ViewportBlueprint &&other)=default
 
ViewportBlueprint with_root_container (const rerun::blueprint::components::RootContainer &_root_container) &&
 The layout of the views.
 
ViewportBlueprint with_maximized (const rerun::blueprint::components::ViewMaximized &_maximized) &&
 Show one tab as maximized?
 
ViewportBlueprint with_auto_layout (const rerun::blueprint::components::AutoLayout &_auto_layout) &&
 Whether the viewport layout is determined automatically.
 
ViewportBlueprint with_auto_views (const rerun::blueprint::components::AutoViews &_auto_views) &&
 Whether or not views should be created automatically.
 
ViewportBlueprint with_past_viewer_recommendations (const Collection< rerun::blueprint::components::ViewerRecommendationHash > &_past_viewer_recommendations) &&
 Hashes of all recommended views the viewer has already added and that should not be added again.
 
Collection< ComponentColumncolumns (const Collection< uint32_t > &lengths_)
 Partitions the component data into multiple sub-batches.
 
Collection< ComponentColumncolumns ()
 Partitions the component data into unit-length sub-batches.
 

Static Public Member Functions

static ViewportBlueprint update_fields ()
 Update only some specific fields of a ViewportBlueprint.
 
static ViewportBlueprint clear_fields ()
 Clear all the fields of a ViewportBlueprint.
 

Public Attributes

std::optional< ComponentBatchroot_container
 The layout of the views.
 
std::optional< ComponentBatchmaximized
 Show one tab as maximized?
 
std::optional< ComponentBatchauto_layout
 Whether the viewport layout is determined automatically.
 
std::optional< ComponentBatchauto_views
 Whether or not views should be created automatically.
 
std::optional< ComponentBatchpast_viewer_recommendations
 Hashes of all recommended views the viewer has already added and that should not be added again.
 

Static Public Attributes

static constexpr const char IndicatorComponentName []
 
static constexpr const char ArchetypeName []
 The name of the archetype as used in ComponentDescriptors.
 
static constexpr auto Descriptor_root_container
 ComponentDescriptor for the root_container field.
 
static constexpr auto Descriptor_maximized
 ComponentDescriptor for the maximized field.
 
static constexpr auto Descriptor_auto_layout
 ComponentDescriptor for the auto_layout field.
 
static constexpr auto Descriptor_auto_views
 ComponentDescriptor for the auto_views field.
 
static constexpr auto Descriptor_past_viewer_recommendations
 ComponentDescriptor for the past_viewer_recommendations field.
 

Detailed Description

Archetype: The top-level description of the viewport.

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

Member Function Documentation

◆ with_auto_layout()

ViewportBlueprint rerun::blueprint::archetypes::ViewportBlueprint::with_auto_layout ( const rerun::blueprint::components::AutoLayout _auto_layout) &&
inline

Whether the viewport layout is determined automatically.

If true, the container layout will be reset whenever a new view is added or removed. This defaults to false and is automatically set to false when there is user determined layout.

◆ with_auto_views()

ViewportBlueprint rerun::blueprint::archetypes::ViewportBlueprint::with_auto_views ( const rerun::blueprint::components::AutoViews _auto_views) &&
inline

Whether or not views should be created automatically.

If true, the viewer will only add views that it hasn't considered previously (as identified by past_viewer_recommendations) and which aren't deemed redundant to existing views. This defaults to false and is automatically set to false when the user adds views manually in the viewer.

◆ with_past_viewer_recommendations()

ViewportBlueprint rerun::blueprint::archetypes::ViewportBlueprint::with_past_viewer_recommendations ( const Collection< rerun::blueprint::components::ViewerRecommendationHash > &  _past_viewer_recommendations) &&
inline

Hashes of all recommended views the viewer has already added and that should not be added again.

This is an internal field and should not be set usually. If you want the viewer from stopping to add views, you should set auto_views to false.

The viewer uses this to determine whether it should keep adding views.

◆ columns() [1/2]

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

◆ auto_layout

std::optional<ComponentBatch> rerun::blueprint::archetypes::ViewportBlueprint::auto_layout

Whether the viewport layout is determined automatically.

If true, the container layout will be reset whenever a new view is added or removed. This defaults to false and is automatically set to false when there is user determined layout.

◆ auto_views

std::optional<ComponentBatch> rerun::blueprint::archetypes::ViewportBlueprint::auto_views

Whether or not views should be created automatically.

If true, the viewer will only add views that it hasn't considered previously (as identified by past_viewer_recommendations) and which aren't deemed redundant to existing views. This defaults to false and is automatically set to false when the user adds views manually in the viewer.

◆ past_viewer_recommendations

std::optional<ComponentBatch> rerun::blueprint::archetypes::ViewportBlueprint::past_viewer_recommendations

Hashes of all recommended views the viewer has already added and that should not be added again.

This is an internal field and should not be set usually. If you want the viewer from stopping to add views, you should set auto_views to false.

The viewer uses this to determine whether it should keep adding views.

◆ IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::ViewportBlueprint::IndicatorComponentName[]
staticconstexpr
Initial value:
=
"rerun.blueprint.components.ViewportBlueprintIndicator"

◆ ArchetypeName

constexpr const char rerun::blueprint::archetypes::ViewportBlueprint::ArchetypeName[]
staticconstexpr
Initial value:
=
"rerun.blueprint.archetypes.ViewportBlueprint"

The name of the archetype as used in ComponentDescriptors.

◆ Descriptor_root_container

constexpr auto rerun::blueprint::archetypes::ViewportBlueprint::Descriptor_root_container
staticconstexpr
Initial value:
= ComponentDescriptor(
ArchetypeName, "root_container",
Loggable<rerun::blueprint::components::RootContainer>::Descriptor.component_name
)
static constexpr const char ArchetypeName[]
The name of the archetype as used in ComponentDescriptors.
Definition viewport_blueprint.hpp:62

ComponentDescriptor for the root_container field.

◆ Descriptor_maximized

constexpr auto rerun::blueprint::archetypes::ViewportBlueprint::Descriptor_maximized
staticconstexpr
Initial value:
= ComponentDescriptor(
ArchetypeName, "maximized",
Loggable<rerun::blueprint::components::ViewMaximized>::Descriptor.component_name
)

ComponentDescriptor for the maximized field.

◆ Descriptor_auto_layout

constexpr auto rerun::blueprint::archetypes::ViewportBlueprint::Descriptor_auto_layout
staticconstexpr
Initial value:
= ComponentDescriptor(
ArchetypeName, "auto_layout",
Loggable<rerun::blueprint::components::AutoLayout>::Descriptor.component_name
)

ComponentDescriptor for the auto_layout field.

◆ Descriptor_auto_views

constexpr auto rerun::blueprint::archetypes::ViewportBlueprint::Descriptor_auto_views
staticconstexpr
Initial value:
= ComponentDescriptor(
ArchetypeName, "auto_views",
Loggable<rerun::blueprint::components::AutoViews>::Descriptor.component_name
)

ComponentDescriptor for the auto_views field.

◆ Descriptor_past_viewer_recommendations

constexpr auto rerun::blueprint::archetypes::ViewportBlueprint::Descriptor_past_viewer_recommendations
staticconstexpr
Initial value:
= ComponentDescriptor(
ArchetypeName, "past_viewer_recommendations",
Loggable<rerun::blueprint::components::ViewerRecommendationHash>::Descriptor
.component_name
)

ComponentDescriptor for the past_viewer_recommendations field.


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