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

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

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

 SpaceViewBlueprint (SpaceViewBlueprint &&other)=default
 
 SpaceViewBlueprint (rerun::blueprint::components::SpaceViewClass _class_identifier)
 
SpaceViewBlueprint with_display_name (rerun::components::Name _display_name) &&
 The name of the view.
 
SpaceViewBlueprint with_space_origin (rerun::blueprint::components::SpaceViewOrigin _space_origin) &&
 The "anchor point" of this space view.
 
SpaceViewBlueprint with_visible (rerun::blueprint::components::Visible _visible) &&
 Whether this space view is visible.
 

Public Attributes

rerun::blueprint::components::SpaceViewClass class_identifier
 The class of the view.
 
std::optional< rerun::components::Namedisplay_name
 The name of the view.
 
std::optional< rerun::blueprint::components::SpaceViewOriginspace_origin
 The "anchor point" of this space view.
 
std::optional< rerun::blueprint::components::Visiblevisible
 Whether this space view is visible.
 

Static Public Attributes

static constexpr const char IndicatorComponentName []
 

Detailed Description

Archetype: The top-level description of the Viewport.

Member Function Documentation

◆ with_space_origin()

SpaceViewBlueprint rerun::blueprint::archetypes::SpaceViewBlueprint::with_space_origin ( rerun::blueprint::components::SpaceViewOrigin  _space_origin) &&
inline

The "anchor point" of this space view.

Defaults to the root path '/' if not specified.

The transform at this path forms the reference point for all scene->world transforms in this space view. I.e. the position of this entity path in space forms the origin of the coordinate system in this space view. Furthermore, this is the primary indicator for heuristics on what entities we show in this space view.

◆ with_visible()

SpaceViewBlueprint rerun::blueprint::archetypes::SpaceViewBlueprint::with_visible ( rerun::blueprint::components::Visible  _visible) &&
inline

Whether this space view is visible.

Defaults to true if not specified.

Member Data Documentation

◆ space_origin

std::optional<rerun::blueprint::components::SpaceViewOrigin> rerun::blueprint::archetypes::SpaceViewBlueprint::space_origin

The "anchor point" of this space view.

Defaults to the root path '/' if not specified.

The transform at this path forms the reference point for all scene->world transforms in this space view. I.e. the position of this entity path in space forms the origin of the coordinate system in this space view. Furthermore, this is the primary indicator for heuristics on what entities we show in this space view.

◆ visible

std::optional<rerun::blueprint::components::Visible> rerun::blueprint::archetypes::SpaceViewBlueprint::visible

Whether this space view is visible.

Defaults to true if not specified.

◆ IndicatorComponentName

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

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