rerun::archetypes::LineStrips3D Struct Reference

Archetype: 3D line strips with positions and optional colors, radii, labels, etc. More...

#include <rerun/archetypes/line_strips3d.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
	LineStrips3D (LineStrips3D &&other)=default
	LineStrips3D (Collection< rerun::components::LineStrip3D > _strips)
LineStrips3D	with_radii (Collection< rerun::components::Radius > _radii) &&
	Optional radii for the line strips.
LineStrips3D	with_colors (Collection< rerun::components::Color > _colors) &&
	Optional colors for the line strips.
LineStrips3D	with_labels (Collection< rerun::components::Text > _labels) &&
	Optional text labels for the line strips.
LineStrips3D	with_class_ids (Collection< rerun::components::ClassId > _class_ids) &&
	Optional ClassIds for the lines.
size_t	num_instances () const
	Returns the number of primary instances of this archetype.

Public Attributes
Collection< rerun::components::LineStrip3D >	strips
	All the actual 3D line strips that make up the batch.
std::optional< Collection< rerun::components::Radius > >	radii
	Optional radii for the line strips.
std::optional< Collection< rerun::components::Color > >	colors
	Optional colors for the line strips.
std::optional< Collection< rerun::components::Text > >	labels
	Optional text labels for the line strips.
std::optional< Collection< rerun::components::ClassId > >	class_ids
	Optional ClassIds for the lines.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: 3D line strips with positions and optional colors, radii, labels, etc.

Example

Many strips

#include <rerun.hpp>
 
#include <vector>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_line_strip3d_batch");
    rec.spawn().exit_on_failure();
 
    rerun::Collection<rerun::Vec3D> strip1 = {
        {0.f, 0.f, 2.f},
        {1.f, 0.f, 2.f},
        {1.f, 1.f, 2.f},
        {0.f, 1.f, 2.f},
    };
    rerun::Collection<rerun::Vec3D> strip2 = {
        {0.f, 0.f, 0.f},
        {0.f, 0.f, 1.f},
        {1.f, 0.f, 0.f},
        {1.f, 0.f, 1.f},
        {1.f, 1.f, 0.f},
        {1.f, 1.f, 1.f},
        {0.f, 1.f, 0.f},
        {0.f, 1.f, 1.f},
    };
    rec.log(
        "strips",
        rerun::LineStrips3D({strip1, strip2})
            .with_colors({0xFF0000FF, 0x00FF00FF})
            .with_radii({0.025f, 0.005f})
            .with_labels({"one strip here", "and one strip there"})
    );
}

Member Function Documentation

with_class_ids()

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

inline

Optional ClassIds for the lines.

The class ID provides colors and labels if not specified explicitly.

Member Data Documentation

class_ids

std::optional<Collection<rerun::components::ClassId> > rerun::archetypes::LineStrips3D::class_ids

Optional ClassIds for the lines.

The class ID provides colors and labels if not specified explicitly.

IndicatorComponentName

constexpr const char rerun::archetypes::LineStrips3D::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.components.LineStrips3DIndicator"

---

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

• rerun/archetypes/line_strips3d.hpp