Rerun C++ SDK
|
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 | |
ViewportBlueprint & | operator= (const ViewportBlueprint &other)=default |
ViewportBlueprint & | operator= (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< 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 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< ComponentBatch > | root_container |
The layout of the views. | |
std::optional< ComponentBatch > | maximized |
Show one tab as maximized? | |
std::optional< ComponentBatch > | auto_layout |
Whether the viewport layout is determined automatically. | |
std::optional< ComponentBatch > | auto_views |
Whether or not views should be created automatically. | |
std::optional< ComponentBatch > | past_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 ComponentDescriptor s. | |
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. | |
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.
|
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.
|
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.
|
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.
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 ComponentColumn
s 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.
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.
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.
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.
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.
|
staticconstexpr |
|
staticconstexpr |
The name of the archetype as used in ComponentDescriptor
s.
|
staticconstexpr |
ComponentDescriptor
for the root_container
field.
|
staticconstexpr |
ComponentDescriptor
for the maximized
field.
|
staticconstexpr |
ComponentDescriptor
for the auto_layout
field.
|
staticconstexpr |
ComponentDescriptor
for the auto_views
field.
|
staticconstexpr |
ComponentDescriptor
for the past_viewer_recommendations
field.