Rerun C++ SDK
|
Archetype: 3D ellipsoids or spheres. More...
#include <rerun/archetypes/ellipsoids3d.hpp>
Public Member Functions | |
Ellipsoids3D (Ellipsoids3D &&other)=default | |
Ellipsoids3D (const Ellipsoids3D &other)=default | |
Ellipsoids3D & | operator= (const Ellipsoids3D &other)=default |
Ellipsoids3D & | operator= (Ellipsoids3D &&other)=default |
Ellipsoids3D | with_half_sizes (const Collection< rerun::components::HalfSize3D > &_half_sizes) && |
For each ellipsoid, half of its size on its three axes. | |
Ellipsoids3D | with_centers (const Collection< rerun::components::PoseTranslation3D > &_centers) && |
Optional center positions of the ellipsoids. | |
Ellipsoids3D | with_rotation_axis_angles (const Collection< rerun::components::PoseRotationAxisAngle > &_rotation_axis_angles) && |
Rotations via axis + angle. | |
Ellipsoids3D | with_quaternions (const Collection< rerun::components::PoseRotationQuat > &_quaternions) && |
Rotations via quaternion. | |
Ellipsoids3D | with_colors (const Collection< rerun::components::Color > &_colors) && |
Optional colors for the ellipsoids. | |
Ellipsoids3D | with_line_radii (const Collection< rerun::components::Radius > &_line_radii) && |
Optional radii for the lines used when the ellipsoid is rendered as a wireframe. | |
Ellipsoids3D | with_fill_mode (const rerun::components::FillMode &_fill_mode) && |
Optionally choose whether the ellipsoids are drawn with lines or solid. | |
Ellipsoids3D | with_many_fill_mode (const Collection< rerun::components::FillMode > &_fill_mode) && |
This method makes it possible to pack multiple fill_mode in a single component batch. | |
Ellipsoids3D | with_labels (const Collection< rerun::components::Text > &_labels) && |
Optional text labels for the ellipsoids. | |
Ellipsoids3D | with_show_labels (const rerun::components::ShowLabels &_show_labels) && |
Whether the text labels should be shown. | |
Ellipsoids3D | 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. | |
Ellipsoids3D | with_class_ids (const Collection< rerun::components::ClassId > &_class_ids) && |
Optional class ID for the ellipsoids. | |
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 Ellipsoids3D | from_radii (const std::vector< float > &sizes) |
Creates new Ellipsoids3D that are spheres, with half_sizes created from radii. | |
static Ellipsoids3D | from_centers_and_radii (const std::vector< datatypes::Vec3D > ¢ers, const std::vector< float > &radii) |
Creates new Ellipsoids3D that are spheres, with half_sizes and centers created from centers and radii. | |
static Ellipsoids3D | from_half_sizes (Collection< components::HalfSize3D > half_sizes) |
Creates new Ellipsoids3D with half_sizes centered around the local origin. | |
static Ellipsoids3D | from_centers_and_half_sizes (Collection< components::PoseTranslation3D > centers, Collection< components::HalfSize3D > half_sizes) |
Creates new Ellipsoids3D with centers and half_sizes . | |
static Ellipsoids3D | update_fields () |
Update only some specific fields of a Ellipsoids3D . | |
static Ellipsoids3D | clear_fields () |
Clear all the fields of a Ellipsoids3D . | |
Public Attributes | |
std::optional< ComponentBatch > | half_sizes |
For each ellipsoid, half of its size on its three axes. | |
std::optional< ComponentBatch > | centers |
Optional center positions of the ellipsoids. | |
std::optional< ComponentBatch > | rotation_axis_angles |
Rotations via axis + angle. | |
std::optional< ComponentBatch > | quaternions |
Rotations via quaternion. | |
std::optional< ComponentBatch > | colors |
Optional colors for the ellipsoids. | |
std::optional< ComponentBatch > | line_radii |
Optional radii for the lines used when the ellipsoid is rendered as a wireframe. | |
std::optional< ComponentBatch > | fill_mode |
Optionally choose whether the ellipsoids are drawn with lines or solid. | |
std::optional< ComponentBatch > | labels |
Optional text labels for the ellipsoids. | |
std::optional< ComponentBatch > | show_labels |
Whether the text labels should be shown. | |
std::optional< ComponentBatch > | class_ids |
Optional class ID for the ellipsoids. | |
Static Public Attributes | |
static constexpr const char | ArchetypeName [] = "rerun.archetypes.Ellipsoids3D" |
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_rotation_axis_angles |
ComponentDescriptor for the rotation_axis_angles field. | |
static constexpr auto | Descriptor_quaternions |
ComponentDescriptor for the quaternions field. | |
static constexpr auto | Descriptor_colors |
ComponentDescriptor for the colors field. | |
static constexpr auto | Descriptor_line_radii |
ComponentDescriptor for the line_radii field. | |
static constexpr auto | Descriptor_fill_mode |
ComponentDescriptor for the fill_mode 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. | |
Archetype: 3D ellipsoids or spheres.
This archetype is for ellipsoids or spheres whose size is a key part of the data (e.g. a bounding sphere). For points whose radii are for the sake of visualization, use archetypes::Points3D
instead.
If there's more instance poses than half sizes, the last ellipsoid/sphere's orientation will be repeated for the remaining poses. Orienting and placing ellipsoids/spheres forms a separate transform that is applied prior to archetypes::InstancePoses3D
and archetypes::Transform3D
.
|
inline |
For each ellipsoid, half of its size on its three axes.
If all components are equal, then it is a sphere with that radius.
|
inline |
Optional center positions of the ellipsoids.
If not specified, the centers will be at (0, 0, 0).
|
inline |
Rotations via axis + angle.
If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system.
|
inline |
Rotations via quaternion.
If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system.
|
inline |
This method makes it possible to pack multiple fill_mode
in a single component batch.
This only makes sense when used in conjunction with columns
. with_fill_mode
should be used when logging a single row's worth of data.
|
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.
|
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.
|
inline |
Optional class ID for the ellipsoids.
The class ID provides colors and labels if not specified explicitly.
Collection< ComponentColumn > rerun::archetypes::Ellipsoids3D::columns | ( | const Collection< uint32_t > & | lengths_ | ) |
Partitions the component data into multiple sub-batches.
Specifically, this transforms the existing ComponentBatch
data into ComponentColumn
s 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.
Collection< ComponentColumn > rerun::archetypes::Ellipsoids3D::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.
std::optional<ComponentBatch> rerun::archetypes::Ellipsoids3D::half_sizes |
For each ellipsoid, half of its size on its three axes.
If all components are equal, then it is a sphere with that radius.
std::optional<ComponentBatch> rerun::archetypes::Ellipsoids3D::centers |
Optional center positions of the ellipsoids.
If not specified, the centers will be at (0, 0, 0).
std::optional<ComponentBatch> rerun::archetypes::Ellipsoids3D::rotation_axis_angles |
Rotations via axis + angle.
If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system.
std::optional<ComponentBatch> rerun::archetypes::Ellipsoids3D::quaternions |
Rotations via quaternion.
If no rotation is specified, the axes of the ellipsoid align with the axes of the local coordinate system.
std::optional<ComponentBatch> rerun::archetypes::Ellipsoids3D::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.
std::optional<ComponentBatch> rerun::archetypes::Ellipsoids3D::class_ids |
Optional class ID for the ellipsoids.
The class ID provides colors and labels if not specified explicitly.
|
staticconstexpr |
ComponentDescriptor
for the half_sizes
field.
|
staticconstexpr |
ComponentDescriptor
for the centers
field.
|
staticconstexpr |
ComponentDescriptor
for the rotation_axis_angles
field.
|
staticconstexpr |
ComponentDescriptor
for the quaternions
field.
|
staticconstexpr |
ComponentDescriptor
for the colors
field.
|
staticconstexpr |
ComponentDescriptor
for the line_radii
field.
|
staticconstexpr |
ComponentDescriptor
for the fill_mode
field.
|
staticconstexpr |
ComponentDescriptor
for the labels
field.
|
staticconstexpr |
ComponentDescriptor
for the show_labels
field.
|
staticconstexpr |
ComponentDescriptor
for the class_ids
field.