Archetype: 3D arrows with optional colors, radii, labels, etc. More...

#include <rerun/archetypes/arrows3d.hpp>

Public Member Functions
	Arrows3D (Arrows3D &&other)=default

	Arrows3D (const Arrows3D &other)=default

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

Arrows3D &	operator= (Arrows3D &&other)=default

Arrows3D	with_vectors (const Collection< rerun::components::Vector3D > &_vectors) &&
	All the vectors for each arrow in the batch.

Arrows3D	with_origins (const Collection< rerun::components::Position3D > &_origins) &&
	All the origin (base) positions for each arrow in the batch.

Arrows3D	with_radii (const Collection< rerun::components::Radius > &_radii) &&
	Optional radii for the arrows.

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

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

Arrows3D	with_show_labels (const rerun::components::ShowLabels &_show_labels) &&
	Whether the text labels should be shown.

Arrows3D	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.

Arrows3D	with_class_ids (const Collection< rerun::components::ClassId > &_class_ids) &&
	Optional class Ids for the points.

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 Arrows3D	from_vectors (Collection< components::Vector3D > vectors_)
	Creates new 3D arrows pointing in the given directions, with a base at the origin (0, 0, 0).

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

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

Public Attributes
std::optional< ComponentBatch >	vectors
	All the vectors for each arrow in the batch.

std::optional< ComponentBatch >	origins
	All the origin (base) positions for each arrow in the batch.

std::optional< ComponentBatch >	radii
	Optional radii for the arrows.

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

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

std::optional< ComponentBatch >	show_labels
	Whether the text labels should be shown.

std::optional< ComponentBatch >	class_ids
	Optional class Ids for the points.

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

static constexpr auto	Descriptor_vectors
	`ComponentDescriptor` for the `vectors` field.

static constexpr auto	Descriptor_origins
	`ComponentDescriptor` for the `origins` field.

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

static constexpr auto	Descriptor_colors
	`ComponentDescriptor` for the `colors` 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_class_ids
	`ComponentDescriptor` for the `class_ids` field.

Detailed Description

Archetype: 3D arrows with optional colors, radii, labels, etc.

Example

Simple batch of 3D arrows

#include <rerun.hpp>
 
#include <cmath>
#include <vector>
 
constexpr float TAU = 6.28318530717958647692528676655900577f;
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_arrow3d");
    rec.spawn().exit_on_failure();
 
    std::vector<rerun::Position3D> origins;
    std::vector<rerun::Vector3D> vectors;
    std::vector<rerun::Color> colors;
 
    for (int i = 0; i <100; ++i) {
        origins.push_back({0, 0, 0});
 
        float angle = TAU * static_cast<float>(i) * 0.01f;
        float length = static_cast<float>(log2(i + 1));
        vectors.push_back({length * sinf(angle), 0.0, length * cosf(angle)});
 
        uint8_t c = static_cast<uint8_t>(round(angle / TAU * 255.0f));
        colors.push_back({static_cast<uint8_t>(255 - c), c, 128, 128});
    }
 
    rec.log(
        "arrows",
        rerun::Arrows3D::from_vectors(vectors).with_origins(origins).with_colors(colors)
    );
}

Member Function Documentation

◆ with_origins()

Arrows3D rerun::archetypes::Arrows3D::with_origins ( const Collection< rerun::components::Position3D > & _origins ) &&

inline

All the origin (base) positions for each arrow in the batch.

If no origins are set, (0, 0, 0) is used as the origin for each arrow.

◆ with_radii()

Arrows3D rerun::archetypes::Arrows3D::with_radii ( const Collection< rerun::components::Radius > & _radii ) &&

inline

Optional radii for the arrows.

The shaft is rendered as a line with radius = 0.5 * radius. The tip is rendered with height = 2.0 * radius and radius = 1.0 * radius.

◆ with_labels()

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

inline

Optional text labels for the arrows.

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_show_labels()

Arrows3D rerun::archetypes::Arrows3D::with_show_labels ( const rerun::components::ShowLabels & _show_labels ) &&

inline

Whether the text labels should be shown.

If not set, labels will automatically appear when there is exactly one label for this entity or the number of instances on this entity is under a certain threshold.

◆ with_many_show_labels()

Arrows3D rerun::archetypes::Arrows3D::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_class_ids()

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

inline

Optional class Ids for the points.

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

◆ columns() [1/2]

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

◆ origins

std::optional<ComponentBatch> rerun::archetypes::Arrows3D::origins

All the origin (base) positions for each arrow in the batch.

If no origins are set, (0, 0, 0) is used as the origin for each arrow.

◆ radii

std::optional<ComponentBatch> rerun::archetypes::Arrows3D::radii

Optional radii for the arrows.

The shaft is rendered as a line with radius = 0.5 * radius. The tip is rendered with height = 2.0 * radius and radius = 1.0 * radius.

◆ labels

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

Optional text labels for the arrows.

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.

◆ show_labels

std::optional<ComponentBatch> rerun::archetypes::Arrows3D::show_labels

Whether the text labels should be shown.

If not set, labels will automatically appear when there is exactly one label for this entity or the number of instances on this entity is under a certain threshold.

◆ class_ids

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

Optional class Ids for the points.

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

◆ Descriptor_vectors

constexpr auto rerun::archetypes::Arrows3D::Descriptor_vectors

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:vectors", Loggable<rerun::components::Vector3D>::ComponentType
        )

ComponentDescriptor for the vectors field.

◆ Descriptor_origins

constexpr auto rerun::archetypes::Arrows3D::Descriptor_origins

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:origins",
            Loggable<rerun::components::Position3D>::ComponentType
        )

ComponentDescriptor for the origins field.

◆ Descriptor_radii

constexpr auto rerun::archetypes::Arrows3D::Descriptor_radii

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:radii", Loggable<rerun::components::Radius>::ComponentType
        )

ComponentDescriptor for the radii field.

◆ Descriptor_colors

constexpr auto rerun::archetypes::Arrows3D::Descriptor_colors

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:colors", Loggable<rerun::components::Color>::ComponentType
        )

ComponentDescriptor for the colors field.

◆ Descriptor_labels

constexpr auto rerun::archetypes::Arrows3D::Descriptor_labels

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:labels", Loggable<rerun::components::Text>::ComponentType
        )

ComponentDescriptor for the labels field.

◆ Descriptor_show_labels

constexpr auto rerun::archetypes::Arrows3D::Descriptor_show_labels

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:show_labels",
            Loggable<rerun::components::ShowLabels>::ComponentType
        )

ComponentDescriptor for the show_labels field.

◆ Descriptor_class_ids

constexpr auto rerun::archetypes::Arrows3D::Descriptor_class_ids

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "Arrows3D:class_ids", Loggable<rerun::components::ClassId>::ComponentType
        )

ComponentDescriptor for the class_ids field.

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

rerun/archetypes/arrows3d.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Example

Simple batch of 3D arrows

Member Function Documentation

◆ with_origins()

◆ with_radii()

◆ with_labels()

◆ with_show_labels()

◆ with_many_show_labels()

◆ with_class_ids()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ origins

◆ radii

◆ labels

◆ show_labels

◆ class_ids

◆ Descriptor_vectors

◆ Descriptor_origins

◆ Descriptor_radii

◆ Descriptor_colors

◆ Descriptor_labels

◆ Descriptor_show_labels

◆ Descriptor_class_ids