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	with_root_container (rerun::blueprint::components::RootContainer _root_container) &&
	The layout of the space-views.
ViewportBlueprint	with_maximized (rerun::blueprint::components::SpaceViewMaximized _maximized) &&
	Show one tab as maximized?
ViewportBlueprint	with_auto_layout (rerun::blueprint::components::AutoLayout _auto_layout) &&
	Whether the viewport layout is determined automatically.
ViewportBlueprint	with_auto_space_views (rerun::blueprint::components::AutoSpaceViews _auto_space_views) &&
	Whether or not space views should be created automatically.
ViewportBlueprint	with_past_viewer_recommendations (Collection< rerun::blueprint::components::ViewerRecommendationHash > _past_viewer_recommendations) &&
	Hashes of all recommended space views the viewer has already added and that should not be added again.

Public Attributes
std::optional< rerun::blueprint::components::RootContainer >	root_container
	The layout of the space-views.
std::optional< rerun::blueprint::components::SpaceViewMaximized >	maximized
	Show one tab as maximized?
std::optional< rerun::blueprint::components::AutoLayout >	auto_layout
	Whether the viewport layout is determined automatically.
std::optional< rerun::blueprint::components::AutoSpaceViews >	auto_space_views
	Whether or not space views should be created automatically.
std::optional< Collection< rerun::blueprint::components::ViewerRecommendationHash > >	past_viewer_recommendations
	Hashes of all recommended space views the viewer has already added and that should not be added again.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: The top-level description of the Viewport.

Member Function Documentation

with_auto_layout()

ViewportBlueprint rerun::blueprint::archetypes::ViewportBlueprint::with_auto_layout ( 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 space view is added or removed. This defaults to false and is automatically set to false when there is user determined layout.

with_auto_space_views()

ViewportBlueprint rerun::blueprint::archetypes::ViewportBlueprint::with_auto_space_views ( rerun::blueprint::components::AutoSpaceViews  _auto_space_views ) &&

inline

Whether or not space views should be created automatically.

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

with_past_viewer_recommendations()

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

inline

Hashes of all recommended space 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 space views, you should set auto_space_views to false.

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

Member Data Documentation

auto_layout

std::optional<rerun::blueprint::components::AutoLayout> rerun::blueprint::archetypes::ViewportBlueprint::auto_layout

Whether the viewport layout is determined automatically.

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

auto_space_views

std::optional<rerun::blueprint::components::AutoSpaceViews> rerun::blueprint::archetypes::ViewportBlueprint::auto_space_views

Whether or not space views should be created automatically.

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

past_viewer_recommendations

std::optional<Collection<rerun::blueprint::components::ViewerRecommendationHash> > rerun::blueprint::archetypes::ViewportBlueprint::past_viewer_recommendations

Hashes of all recommended space 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 space views, you should set auto_space_views to false.

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

IndicatorComponentName

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

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.ViewportBlueprintIndicator"

---

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

• rerun/blueprint/archetypes/viewport_blueprint.hpp