Rerun C++ SDK
|
Archetype: A 3D point cloud with positions and optional colors, radii, labels, etc. More...
#include <rerun/archetypes/points3d.hpp>
Public Member Functions | |
Points3D (Points3D &&other)=default | |
Points3D (const Points3D &other)=default | |
Points3D & | operator= (const Points3D &other)=default |
Points3D & | operator= (Points3D &&other)=default |
Points3D (Collection< rerun::components::Position3D > _positions) | |
Points3D | with_positions (const Collection< rerun::components::Position3D > &_positions) && |
All the 3D positions at which the point cloud shows points. | |
Points3D | with_radii (const Collection< rerun::components::Radius > &_radii) && |
Optional radii for the points, effectively turning them into circles. | |
Points3D | with_colors (const Collection< rerun::components::Color > &_colors) && |
Optional colors for the points. | |
Points3D | with_labels (const Collection< rerun::components::Text > &_labels) && |
Optional text labels for the points. | |
Points3D | with_show_labels (const rerun::components::ShowLabels &_show_labels) && |
Whether the text labels should be shown. | |
Points3D | 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. | |
Points3D | with_class_ids (const Collection< rerun::components::ClassId > &_class_ids) && |
Optional class Ids for the points. | |
Points3D | with_keypoint_ids (const Collection< rerun::components::KeypointId > &_keypoint_ids) && |
Optional keypoint IDs for the points, identifying them within a class. | |
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 Points3D | update_fields () |
Update only some specific fields of a Points3D . | |
static Points3D | clear_fields () |
Clear all the fields of a Points3D . | |
Public Attributes | |
std::optional< ComponentBatch > | positions |
All the 3D positions at which the point cloud shows points. | |
std::optional< ComponentBatch > | radii |
Optional radii for the points, effectively turning them into circles. | |
std::optional< ComponentBatch > | colors |
Optional colors for the points. | |
std::optional< ComponentBatch > | labels |
Optional text labels for the points. | |
std::optional< ComponentBatch > | show_labels |
Whether the text labels should be shown. | |
std::optional< ComponentBatch > | class_ids |
Optional class Ids for the points. | |
std::optional< ComponentBatch > | keypoint_ids |
Optional keypoint IDs for the points, identifying them within a class. | |
Static Public Attributes | |
static constexpr const char | ArchetypeName [] = "rerun.archetypes.Points3D" |
The name of the archetype as used in ComponentDescriptor s. | |
static constexpr auto | Descriptor_positions |
ComponentDescriptor for the positions 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. | |
static constexpr auto | Descriptor_keypoint_ids |
ComponentDescriptor for the keypoint_ids field. | |
Archetype: A 3D point cloud with positions and optional colors, radii, labels, etc.
|
inline |
Optional text labels for the points.
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 |
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 Ids for the points.
The components::ClassId
provides colors and labels if not specified explicitly.
|
inline |
Optional keypoint IDs for the points, identifying them within a class.
If keypoint IDs are passed in but no components::ClassId
s were specified, the components::ClassId
will default to 0. This is useful to identify points within a single classification (which is identified with class_id
). E.g. the classification might be 'Person' and the keypoints refer to joints on a detected skeleton.
Collection< ComponentColumn > rerun::archetypes::Points3D::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::Points3D::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::Points3D::labels |
Optional text labels for the points.
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<ComponentBatch> rerun::archetypes::Points3D::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::Points3D::class_ids |
Optional class Ids for the points.
The components::ClassId
provides colors and labels if not specified explicitly.
std::optional<ComponentBatch> rerun::archetypes::Points3D::keypoint_ids |
Optional keypoint IDs for the points, identifying them within a class.
If keypoint IDs are passed in but no components::ClassId
s were specified, the components::ClassId
will default to 0. This is useful to identify points within a single classification (which is identified with class_id
). E.g. the classification might be 'Person' and the keypoints refer to joints on a detected skeleton.
|
staticconstexpr |
ComponentDescriptor
for the positions
field.
|
staticconstexpr |
ComponentDescriptor
for the radii
field.
|
staticconstexpr |
ComponentDescriptor
for the colors
field.
|
staticconstexpr |
ComponentDescriptor
for the labels
field.
|
staticconstexpr |
ComponentDescriptor
for the show_labels
field.
|
staticconstexpr |
ComponentDescriptor
for the class_ids
field.
|
staticconstexpr |
ComponentDescriptor
for the keypoint_ids
field.