Struct re_types::archetypes::Points2D

pub struct Points2D {
    pub positions: Option<SerializedComponentBatch>,
    pub radii: Option<SerializedComponentBatch>,
    pub colors: Option<SerializedComponentBatch>,
    pub labels: Option<SerializedComponentBatch>,
    pub show_labels: Option<SerializedComponentBatch>,
    pub draw_order: Option<SerializedComponentBatch>,
    pub class_ids: Option<SerializedComponentBatch>,
    pub keypoint_ids: Option<SerializedComponentBatch>,
}

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

Examples

Randomly distributed 2D points with varying color and radius

use rand::{distributions::Uniform, Rng as _};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_points2d_random").spawn()?;

    let mut rng = rand::thread_rng();
    let dist = Uniform::new(-3., 3.);

    rec.log(
        "random",
        &rerun::Points2D::new((0..10).map(|_| (rng.sample(dist), rng.sample(dist))))
            .with_colors((0..10).map(|_| rerun::Color::from_rgb(rng.gen(), rng.gen(), rng.gen())))
            .with_radii((0..10).map(|_| rng.gen::<f32>())),
    )?;

    // TODO(#5521): log VisualBounds2D

    Ok(())
}

Log points with radii given in UI points

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_points2d_ui_radius").spawn()?;

    // Two blue points with scene unit radii of 0.1 and 0.3.
    rec.log(
        "scene_units",
        &rerun::Points2D::new([(0.0, 0.0), (0.0, 1.0)])
            // By default, radii are interpreted as world-space units.
            .with_radii([0.1, 0.3])
            .with_colors([rerun::Color::from_rgb(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::new([(1.0, 0.0), (1.0, 1.0)])
            // rerun::Radius::new_ui_points produces a radius that the viewer interprets as given in ui points.
            .with_radii([
                rerun::Radius::new_ui_points(40.0),
                rerun::Radius::new_ui_points(60.0),
            ])
            .with_colors([rerun::Color::from_rgb(255, 0, 0)]),
    )?;

    // TODO(#5521): log VisualBounds2D

    Ok(())
}

Fields

positions: Option<SerializedComponentBatch>

All the 2D positions at which the point cloud shows points.

radii: Option<SerializedComponentBatch>

Optional radii for the points, effectively turning them into circles.

colors: Option<SerializedComponentBatch>

Optional colors for the points.

labels: Option<SerializedComponentBatch>

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.

show_labels: Option<SerializedComponentBatch>

Optional choice of whether the text labels should be shown by default.

draw_order: Option<SerializedComponentBatch>

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: Option<SerializedComponentBatch>

Optional class Ids for the points.

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

keypoint_ids: Option<SerializedComponentBatch>

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.

Implementations

impl Points2D

pub fn descriptor_positions() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::positions.

pub fn descriptor_radii() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::radii.

pub fn descriptor_colors() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::colors.

pub fn descriptor_labels() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::labels.

pub fn descriptor_show_labels() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::show_labels.

pub fn descriptor_draw_order() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::draw_order.

pub fn descriptor_class_ids() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::class_ids.

pub fn descriptor_keypoint_ids() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::keypoint_ids.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl Points2D

pub const NUM_COMPONENTS: usize = 9usize

The total number of components in the archetype: 1 required, 3 recommended, 5 optional

impl Points2D

pub fn new(positions: impl IntoIterator<Item = impl Into<Position2D>>) -> Self

Create a new Points2D.

pub fn update_fields() -> Self

Update only some specific fields of a Points2D.

pub fn clear_fields() -> Self

Clear all the fields of a Points2D.

pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::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.

pub fn columns_of_unit_batches( self, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_positions( self, positions: impl IntoIterator<Item = impl Into<Position2D>>, ) -> Self

All the 2D positions at which the point cloud shows points.

pub fn with_radii( self, radii: impl IntoIterator<Item = impl Into<Radius>>, ) -> Self

Optional radii for the points, effectively turning them into circles.

pub fn with_colors( self, colors: impl IntoIterator<Item = impl Into<Color>>, ) -> Self

Optional colors for the points.

pub fn with_labels( self, labels: impl IntoIterator<Item = impl Into<Text>>, ) -> Self

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.

pub fn with_show_labels(self, show_labels: impl Into<ShowLabels>) -> Self

Optional choice of whether the text labels should be shown by default.

pub fn with_many_show_labels( self, show_labels: impl IntoIterator<Item = impl Into<ShowLabels>>, ) -> Self

This method makes it possible to pack multiple crate::components::ShowLabels in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_show_labels should be used when logging a single row’s worth of data.

pub fn with_draw_order(self, draw_order: impl Into<DrawOrder>) -> Self

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

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

pub fn with_many_draw_order( self, draw_order: impl IntoIterator<Item = impl Into<DrawOrder>>, ) -> Self

This method makes it possible to pack multiple crate::components::DrawOrder in a single component batch.

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

pub fn with_class_ids( self, class_ids: impl IntoIterator<Item = impl Into<ClassId>>, ) -> Self

Optional class Ids for the points.

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

pub fn with_keypoint_ids( self, keypoint_ids: impl IntoIterator<Item = impl Into<KeypointId>>, ) -> Self

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.

Trait Implementations

impl Archetype for Points2D

type Indicator = GenericIndicatorComponent<Points2D>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentDescriptor]>

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>, ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for Points2D

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

Exposes the object’s contents as a set of SerializedComponentBatches.

fn to_arrow(&self) -> Result<Vec<(Field, Arc<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for Points2D

fn clone(&self) -> Points2D

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Points2D

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Points2D

fn default() -> Points2D

Returns the “default value” for a type.

impl PartialEq for Points2D

fn eq(&self, other: &Points2D) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for Points2D

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for Points2D

impl StructuralPartialEq for Points2D