rerun::blueprint::archetypes::VisualBounds2D Struct Reference

Archetype: Controls the visual bounds of a 2D view. More...

#include <rerun/blueprint/archetypes/visual_bounds2d.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
	VisualBounds2D (VisualBounds2D &&other)=default
	VisualBounds2D (const VisualBounds2D &other)=default
VisualBounds2D &	operator= (const VisualBounds2D &other)=default
VisualBounds2D &	operator= (VisualBounds2D &&other)=default
	VisualBounds2D (rerun::blueprint::components::VisualBounds2D _range)
VisualBounds2D	with_range (const rerun::blueprint::components::VisualBounds2D &_range) &&
	Controls the visible range of a 2D view.
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 VisualBounds2D	update_fields ()
	Update only some specific fields of a VisualBounds2D.
static VisualBounds2D	clear_fields ()
	Clear all the fields of a VisualBounds2D.

Public Attributes
std::optional< ComponentBatch >	range
	Controls the visible range of a 2D view.

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

Detailed Description

Archetype: Controls the visual bounds of a 2D view.

Everything within these bounds are guaranteed to be visible. Somethings outside of these bounds may also be visible due to letterboxing.

If no visual bounds are set, it will be determined automatically, based on the bounding-box of the data or other camera information present in the view.

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

Member Function Documentation

with_range()

VisualBounds2D rerun::blueprint::archetypes::VisualBounds2D::with_range ( const rerun::blueprint::components::VisualBounds2D &  _range ) &&

inline

Controls the visible range of a 2D view.

Use this to control pan & zoom of the view.

columns() [1/2]

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

range

std::optional<ComponentBatch> rerun::blueprint::archetypes::VisualBounds2D::range

Controls the visible range of a 2D view.

Use this to control pan & zoom of the view.

IndicatorComponentName

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

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.VisualBounds2DIndicator"

Descriptor_range

constexpr auto rerun::blueprint::archetypes::VisualBounds2D::Descriptor_range

staticconstexpr

Initial value:

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

ComponentDescriptor for the range field.

---

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

• rerun/blueprint/archetypes/visual_bounds2d.hpp