Rerun C++ SDK
|
Archetype: 3D arrows with optional colors, radii, labels, etc. More...
#include <rerun/archetypes/arrows3d.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 | |
Arrows3D (Arrows3D &&other)=default | |
Arrows3D | with_origins (Collection< rerun::components::Position3D > _origins) && |
All the origin (base) positions for each arrow in the batch. | |
Arrows3D | with_radii (Collection< rerun::components::Radius > _radii) && |
Optional radii for the arrows. | |
Arrows3D | with_colors (Collection< rerun::components::Color > _colors) && |
Optional colors for the points. | |
Arrows3D | with_labels (Collection< rerun::components::Text > _labels) && |
Optional text labels for the arrows. | |
Arrows3D | with_class_ids (Collection< rerun::components::ClassId > _class_ids) && |
Optional class Ids for the points. | |
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). | |
Public Attributes | |
Collection< rerun::components::Vector3D > | vectors |
All the vectors for each arrow in the batch. | |
std::optional< Collection< rerun::components::Position3D > > | origins |
All the origin (base) positions for each arrow in the batch. | |
std::optional< Collection< rerun::components::Radius > > | radii |
Optional radii for the arrows. | |
std::optional< Collection< rerun::components::Color > > | colors |
Optional colors for the points. | |
std::optional< Collection< rerun::components::Text > > | labels |
Optional text labels for the arrows. | |
std::optional< Collection< rerun::components::ClassId > > | class_ids |
Optional class Ids for the points. | |
Static Public Attributes | |
static constexpr const char | IndicatorComponentName [] = "rerun.components.Arrows3DIndicator" |
Archetype: 3D arrows with optional colors, radii, labels, etc.
|
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.
|
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
.
|
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.
|
inline |
Optional class Ids for the points.
The components::ClassId
provides colors and labels if not specified explicitly.
std::optional<Collection<rerun::components::Position3D> > 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.
std::optional<Collection<rerun::components::Radius> > 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
.
std::optional<Collection<rerun::components::Text> > 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.
std::optional<Collection<rerun::components::ClassId> > rerun::archetypes::Arrows3D::class_ids |
Optional class Ids for the points.
The components::ClassId
provides colors and labels if not specified explicitly.