Archetype: 2D boxes with half-extents and optional center, colors etc. More...

#include <rerun/archetypes/boxes2d.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
	Boxes2D (Boxes2D &&other)=default

	Boxes2D (const Boxes2D &other)=default

Boxes2D &	operator= (const Boxes2D &other)=default

Boxes2D &	operator= (Boxes2D &&other)=default

Boxes2D	with_half_sizes (const Collection< rerun::components::HalfSize2D > &_half_sizes) &&
	All half-extents that make up the batch of boxes.

Boxes2D	with_centers (const Collection< rerun::components::Position2D > &_centers) &&
	Optional center positions of the boxes.

Boxes2D	with_colors (const Collection< rerun::components::Color > &_colors) &&
	Optional colors for the boxes.

Boxes2D	with_radii (const Collection< rerun::components::Radius > &_radii) &&
	Optional radii for the lines that make up the boxes.

Boxes2D	with_labels (const Collection< rerun::components::Text > &_labels) &&
	Optional text labels for the boxes.

Boxes2D	with_show_labels (const rerun::components::ShowLabels &_show_labels) &&
	Optional choice of whether the text labels should be shown by default.

Boxes2D	with_many_show_labels (const Collection< rerun::components::ShowLabels > &_show_labels) &&
	This method makes it possible to pack multiple `show_labels` in a single component batch.

Boxes2D	with_draw_order (const rerun::components::DrawOrder &_draw_order) &&
	An optional floating point value that specifies the 2D drawing order.

Boxes2D	with_many_draw_order (const Collection< rerun::components::DrawOrder > &_draw_order) &&
	This method makes it possible to pack multiple `draw_order` in a single component batch.

Boxes2D	with_class_ids (const Collection< rerun::components::ClassId > &_class_ids) &&
	Optional `components::ClassId`s for the boxes.

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 Boxes2D	from_half_sizes (Collection< components::HalfSize2D > half_sizes)
	Creates new `Boxes2D` with `half_sizes` centered around the local origin.

static Boxes2D	from_centers_and_half_sizes (Collection< components::Position2D > centers, Collection< components::HalfSize2D > half_sizes)
	Creates new `Boxes2D` with `centers` and `half_sizes`.

static Boxes2D	from_sizes (const std::vector< datatypes::Vec2D > &sizes)
	Creates new `Boxes2D` with `half_sizes` created from (full) sizes.

static Boxes2D	from_centers_and_sizes (Collection< components::Position2D > centers, const std::vector< datatypes::Vec2D > &sizes)
	Creates new `Boxes2D` with `centers` and `half_sizes` created from centers and (full) sizes.

static Boxes2D	from_mins_and_sizes (const std::vector< datatypes::Vec2D > &mins, const std::vector< datatypes::Vec2D > &sizes)
	Creates new `Boxes2D` with `half_sizes` and `centers` created from minimums and (full) sizes.

static Boxes2D	update_fields ()
	Update only some specific fields of a `Boxes2D`.

static Boxes2D	clear_fields ()
	Clear all the fields of a `Boxes2D`.

Public Attributes
std::optional< ComponentBatch >	half_sizes
	All half-extents that make up the batch of boxes.

std::optional< ComponentBatch >	centers
	Optional center positions of the boxes.

std::optional< ComponentBatch >	colors
	Optional colors for the boxes.

std::optional< ComponentBatch >	radii
	Optional radii for the lines that make up the boxes.

std::optional< ComponentBatch >	labels
	Optional text labels for the boxes.

std::optional< ComponentBatch >	show_labels
	Optional choice of whether the text labels should be shown by default.

std::optional< ComponentBatch >	draw_order
	An optional floating point value that specifies the 2D drawing order.

std::optional< ComponentBatch >	class_ids
	Optional `components::ClassId`s for the boxes.

Static Public Attributes
static constexpr const char	IndicatorComponentName [] = "rerun.components.Boxes2DIndicator"

static constexpr const char	ArchetypeName [] = "rerun.archetypes.Boxes2D"
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_half_sizes
	`ComponentDescriptor` for the `half_sizes` field.

static constexpr auto	Descriptor_centers
	`ComponentDescriptor` for the `centers` field.

static constexpr auto	Descriptor_colors
	`ComponentDescriptor` for the `colors` field.

static constexpr auto	Descriptor_radii
	`ComponentDescriptor` for the `radii` field.

static constexpr auto	Descriptor_labels
	`ComponentDescriptor` for the `labels` field.

static constexpr auto	Descriptor_show_labels
	`ComponentDescriptor` for the `show_labels` field.

static constexpr auto	Descriptor_draw_order
	`ComponentDescriptor` for the `draw_order` field.

static constexpr auto	Descriptor_class_ids
	`ComponentDescriptor` for the `class_ids` field.

Detailed Description

Archetype: 2D boxes with half-extents and optional center, colors etc.

Example

Simple 2D boxes

#include <rerun.hpp>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_box2d");
    rec.spawn().exit_on_failure();
 
    rec.log("simple", rerun::Boxes2D::from_mins_and_sizes({{-1.f, -1.f}}, {{2.f, 2.f}}));
}

Member Function Documentation

◆ from_sizes()

static Boxes2D rerun::archetypes::Boxes2D::from_sizes ( const std::vector< datatypes::Vec2D > & sizes )

static

Creates new Boxes2D with half_sizes created from (full) sizes.

TODO(#3285): Does not preserve data as-is and instead creates half-sizes from the input data.

◆ from_centers_and_sizes()

static Boxes2D rerun::archetypes::Boxes2D::from_centers_and_sizes	(	Collection< components::Position2D >	centers,
		const std::vector< datatypes::Vec2D > &	sizes
	)

inlinestatic

Creates new Boxes2D with centers and half_sizes created from centers and (full) sizes.

TODO(#3285): Does not preserve data as-is and instead creates centers and half-sizes from the input data.

◆ from_mins_and_sizes()

static Boxes2D rerun::archetypes::Boxes2D::from_mins_and_sizes	(	const std::vector< datatypes::Vec2D > &	mins,
		const std::vector< datatypes::Vec2D > &	sizes
	)

static

Creates new Boxes2D with half_sizes and centers created from minimums and (full) sizes.

TODO(#3285): Does not preserve data as-is and instead creates centers and half-sizes from the input data.

◆ with_labels()

Boxes2D rerun::archetypes::Boxes2D::with_labels ( const Collection< rerun::components::Text > & _labels ) &&

inline

Optional text labels for the boxes.

If there's a single label present, it will be placed at the center of the entity. Otherwise, each instance will have its own label.

◆ with_many_show_labels()

Boxes2D rerun::archetypes::Boxes2D::with_many_show_labels ( const Collection< rerun::components::ShowLabels > & _show_labels ) &&

inline

This method makes it possible to pack multiple show_labels in a single component batch.

This only makes sense when used in conjunction with columns. with_show_labels should be used when logging a single row's worth of data.

◆ with_draw_order()

Boxes2D rerun::archetypes::Boxes2D::with_draw_order ( const rerun::components::DrawOrder & _draw_order ) &&

inline

An optional floating point value that specifies the 2D drawing order.

Objects with higher values are drawn on top of those with lower values.

The default for 2D boxes is 10.0.

◆ with_many_draw_order()

Boxes2D rerun::archetypes::Boxes2D::with_many_draw_order ( const Collection< rerun::components::DrawOrder > & _draw_order ) &&

inline

This method makes it possible to pack multiple draw_order in a single component batch.

This only makes sense when used in conjunction with columns. with_draw_order should be used when logging a single row's worth of data.

◆ with_class_ids()

Boxes2D rerun::archetypes::Boxes2D::with_class_ids ( const Collection< rerun::components::ClassId > & _class_ids ) &&

inline

Optional components::ClassIds for the boxes.

The components::ClassId provides colors and labels if not specified explicitly.

◆ columns() [1/2]

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

◆ labels

std::optional<ComponentBatch> rerun::archetypes::Boxes2D::labels

Optional text labels for the boxes.

If there's a single label present, it will be placed at the center of the entity. Otherwise, each instance will have its own label.

◆ draw_order

std::optional<ComponentBatch> rerun::archetypes::Boxes2D::draw_order

An optional floating point value that specifies the 2D drawing order.

Objects with higher values are drawn on top of those with lower values.

The default for 2D boxes is 10.0.

◆ class_ids

std::optional<ComponentBatch> rerun::archetypes::Boxes2D::class_ids

Optional components::ClassIds for the boxes.

The components::ClassId provides colors and labels if not specified explicitly.

◆ Descriptor_half_sizes

constexpr auto rerun::archetypes::Boxes2D::Descriptor_half_sizes

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "half_sizes",
            Loggable<rerun::components::HalfSize2D>::Descriptor.component_name
        )

ComponentDescriptor for the half_sizes field.

◆ Descriptor_centers

constexpr auto rerun::archetypes::Boxes2D::Descriptor_centers

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "centers",
            Loggable<rerun::components::Position2D>::Descriptor.component_name
        )

ComponentDescriptor for the centers field.

◆ Descriptor_colors

constexpr auto rerun::archetypes::Boxes2D::Descriptor_colors

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "colors", Loggable<rerun::components::Color>::Descriptor.component_name
        )

ComponentDescriptor for the colors field.

◆ Descriptor_radii

constexpr auto rerun::archetypes::Boxes2D::Descriptor_radii

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "radii", Loggable<rerun::components::Radius>::Descriptor.component_name
        )

ComponentDescriptor for the radii field.

◆ Descriptor_labels

constexpr auto rerun::archetypes::Boxes2D::Descriptor_labels

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "labels", Loggable<rerun::components::Text>::Descriptor.component_name
        )

ComponentDescriptor for the labels field.

◆ Descriptor_show_labels

constexpr auto rerun::archetypes::Boxes2D::Descriptor_show_labels

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "show_labels",
            Loggable<rerun::components::ShowLabels>::Descriptor.component_name
        )

ComponentDescriptor for the show_labels field.

◆ Descriptor_draw_order

constexpr auto rerun::archetypes::Boxes2D::Descriptor_draw_order

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "draw_order",
            Loggable<rerun::components::DrawOrder>::Descriptor.component_name
        )

ComponentDescriptor for the draw_order field.

◆ Descriptor_class_ids

constexpr auto rerun::archetypes::Boxes2D::Descriptor_class_ids

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "class_ids",
            Loggable<rerun::components::ClassId>::Descriptor.component_name
        )

ComponentDescriptor for the class_ids field.

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

rerun/archetypes/boxes2d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Example

Simple 2D boxes

Member Function Documentation

◆ from_sizes()

◆ from_centers_and_sizes()

◆ from_mins_and_sizes()

◆ with_labels()

◆ with_many_show_labels()

◆ with_draw_order()

◆ with_many_draw_order()

◆ with_class_ids()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ labels

◆ draw_order

◆ class_ids

◆ Descriptor_half_sizes

◆ Descriptor_centers

◆ Descriptor_colors

◆ Descriptor_radii

◆ Descriptor_labels

◆ Descriptor_show_labels

◆ Descriptor_draw_order

◆ Descriptor_class_ids