Archetype: A 2D point cloud with positions and optional colors, radii, labels, etc. More...

#include <rerun/archetypes/points2d.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
	Points2D (Points2D &&other)=default

	Points2D (const Points2D &other)=default

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

Points2D &	operator= (Points2D &&other)=default

	Points2D (Collection< rerun::components::Position2D > _positions)

Points2D	with_positions (const Collection< rerun::components::Position2D > &_positions) &&
	All the 2D positions at which the point cloud shows points.

Points2D	with_radii (const Collection< rerun::components::Radius > &_radii) &&
	Optional radii for the points, effectively turning them into circles.

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

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

Points2D	with_show_labels (const rerun::components::ShowLabels &_show_labels) &&
	Optional choice of whether the text labels should be shown by default.

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

Points2D	with_draw_order (const rerun::components::DrawOrder &_draw_order) &&
	An optional floating point value that specifies the 2D drawing order.

Points2D	with_many_draw_order (const Collection< rerun::components::DrawOrder > &_draw_order) &&
	This method makes it possible to pack multiple `draw_order` in a single component batch.

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

Points2D	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 Points2D	update_fields ()
	Update only some specific fields of a `Points2D`.

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

Public Attributes
std::optional< ComponentBatch >	positions
	All the 2D 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
	Optional choice of whether the text labels should be shown by default.

std::optional< ComponentBatch >	draw_order
	An optional floating point value that specifies the 2D drawing order.

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	IndicatorComponentName [] = "rerun.components.Points2DIndicator"

static constexpr const char	ArchetypeName [] = "rerun.archetypes.Points2D"
	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_draw_order
	`ComponentDescriptor` for the `draw_order` 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.

Detailed Description

Archetype: A 2D point cloud with positions and optional colors, radii, labels, etc.

Examples

Randomly distributed 2D points with varying color and radius

#include <rerun.hpp>
 
#include <algorithm>
#include <random>
#include <vector>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_points2d_random");
    rec.spawn().exit_on_failure();
 
    std::default_random_engine gen;
    std::uniform_real_distribution<float> dist_pos(-3.0f, 3.0f);
    std::uniform_real_distribution<float> dist_radius(0.1f, 1.0f);
    // On MSVC uint8_t distributions are not supported.
    std::uniform_int_distribution<int> dist_color(0, 255);
 
    std::vector<rerun::Position2D> points2d(10);
    std::generate(points2d.begin(), points2d.end(), [&] {
        return rerun::Position2D(dist_pos(gen), dist_pos(gen));
    });
    std::vector<rerun::Color> colors(10);
    std::generate(colors.begin(), colors.end(), [&] {
        return rerun::Color(
            static_cast<uint8_t>(dist_color(gen)),
            static_cast<uint8_t>(dist_color(gen)),
            static_cast<uint8_t>(dist_color(gen))
        );
    });
    std::vector<rerun::Radius> radii(10);
    std::generate(radii.begin(), radii.end(), [&] { return dist_radius(gen); });
 
    rec.log("random", rerun::Points2D(points2d).with_colors(colors).with_radii(radii));
 
    // TODO(#5520): log VisualBounds2D
}

Log points with radii given in UI points

#include <rerun.hpp>
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_points2d_ui_radius");
    rec.spawn().exit_on_failure();
 
    // Two blue points with scene unit radii of 0.1 and 0.3.
    rec.log(
        "scene_units",
        rerun::Points2D({{0.0f, 0.0f}, {0.0f, 1.0f}})
            // By default, radii are interpreted as world-space units.
            .with_radii({0.1f, 0.3f})
            .with_colors(rerun::Color(0, 0, 255))
    );
 
    // Two red points with ui point radii of 40 and 60.
    // UI points are independent of zooming in Views, but are sensitive to the application UI scaling.
    // For 100% ui scaling, UI points are equal to pixels.
    rec.log(
        "ui_points",
        rerun::Points2D({{1.0f, 0.0f}, {1.0f, 1.0f}})
            // rerun::Radius::ui_points produces radii that the viewer interprets as given in ui points.
            .with_radii({
                rerun::Radius::ui_points(40.0f),
                rerun::Radius::ui_points(60.0f),
            })
            .with_colors(rerun::Color(255, 0, 0))
    );
 
    // TODO(#5521): log VisualBounds2D
}

Member Function Documentation

◆ with_labels()

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

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.

◆ with_many_show_labels()

Points2D rerun::archetypes::Points2D::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_draw_order()

Points2D rerun::archetypes::Points2D::with_draw_order ( const rerun::components::DrawOrder & _draw_order ) &&

inline

An optional floating point value that specifies the 2D drawing order.

Objects with higher values are drawn on top of those with lower values.

◆ with_many_draw_order()

Points2D rerun::archetypes::Points2D::with_many_draw_order ( const Collection< rerun::components::DrawOrder > & _draw_order ) &&

inline

This method makes it possible to pack multiple draw_order in a single component batch.

This only makes sense when used in conjunction with columns. with_draw_order should be used when logging a single row's worth of data.

◆ with_class_ids()

Points2D rerun::archetypes::Points2D::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.

◆ with_keypoint_ids()

Points2D rerun::archetypes::Points2D::with_keypoint_ids ( const Collection< rerun::components::KeypointId > & _keypoint_ids ) &&

inline

Optional keypoint IDs for the points, identifying them within a class.

If keypoint IDs are passed in but no components::ClassIds 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.

◆ columns() [1/2]

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

◆ labels

std::optional<ComponentBatch> rerun::archetypes::Points2D::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.

◆ draw_order

std::optional<ComponentBatch> rerun::archetypes::Points2D::draw_order

An optional floating point value that specifies the 2D drawing order.

Objects with higher values are drawn on top of those with lower values.

◆ class_ids

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

Optional class Ids for the points.

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

◆ keypoint_ids

std::optional<ComponentBatch> rerun::archetypes::Points2D::keypoint_ids

Optional keypoint IDs for the points, identifying them within a class.

If keypoint IDs are passed in but no components::ClassIds 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.

◆ Descriptor_positions

constexpr auto rerun::archetypes::Points2D::Descriptor_positions

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "positions",
            Loggable<rerun::components::Position2D>::Descriptor.component_name
        )

ComponentDescriptor for the positions field.

◆ Descriptor_radii

constexpr auto rerun::archetypes::Points2D::Descriptor_radii

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "radii", Loggable<rerun::components::Radius>::Descriptor.component_name
        )

ComponentDescriptor for the radii field.

◆ Descriptor_colors

constexpr auto rerun::archetypes::Points2D::Descriptor_colors

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "colors", Loggable<rerun::components::Color>::Descriptor.component_name
        )

ComponentDescriptor for the colors field.

◆ Descriptor_labels

constexpr auto rerun::archetypes::Points2D::Descriptor_labels

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "labels", Loggable<rerun::components::Text>::Descriptor.component_name
        )

ComponentDescriptor for the labels field.

◆ Descriptor_show_labels

constexpr auto rerun::archetypes::Points2D::Descriptor_show_labels

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "show_labels",
            Loggable<rerun::components::ShowLabels>::Descriptor.component_name
        )

ComponentDescriptor for the show_labels field.

◆ Descriptor_draw_order

constexpr auto rerun::archetypes::Points2D::Descriptor_draw_order

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "draw_order",
            Loggable<rerun::components::DrawOrder>::Descriptor.component_name
        )

ComponentDescriptor for the draw_order field.

◆ Descriptor_class_ids

constexpr auto rerun::archetypes::Points2D::Descriptor_class_ids

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "class_ids",
            Loggable<rerun::components::ClassId>::Descriptor.component_name
        )

ComponentDescriptor for the class_ids field.

◆ Descriptor_keypoint_ids

constexpr auto rerun::archetypes::Points2D::Descriptor_keypoint_ids

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "keypoint_ids",
            Loggable<rerun::components::KeypointId>::Descriptor.component_name
        )

ComponentDescriptor for the keypoint_ids field.

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

rerun/archetypes/points2d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Examples

Randomly distributed 2D points with varying color and radius

Log points with radii given in UI points

Member Function Documentation

◆ with_labels()

◆ with_many_show_labels()

◆ with_draw_order()

◆ with_many_draw_order()

◆ with_class_ids()

◆ with_keypoint_ids()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ labels

◆ draw_order

◆ class_ids

◆ keypoint_ids

◆ Descriptor_positions

◆ Descriptor_radii

◆ Descriptor_colors

◆ Descriptor_labels

◆ Descriptor_show_labels

◆ Descriptor_draw_order

◆ Descriptor_class_ids

◆ Descriptor_keypoint_ids