Struct rerun::archetypes::LineStrips2D

pub struct LineStrips2D {
    pub strips: 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>,
}

Archetype: 2D line strips with positions and optional colors, radii, labels, etc.

Examples

line_strips2d_batch:

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

    let strip1 = [[0., 0.], [2., 1.], [4., -1.], [6., 0.]];
    #[rustfmt::skip]
    let strip2 = [[0., 3.], [1., 4.], [2., 2.], [3., 4.], [4., 2.], [5., 4.], [6., 3.]];
    rec.log(
        "strips",
        &rerun::LineStrips2D::new([strip1.to_vec(), strip2.to_vec()])
            .with_colors([0xFF0000FF, 0x00FF00FF])
            .with_radii([0.025, 0.005])
            .with_labels(["one strip here", "and one strip there"]),
    )?;

    // TODO(#5521): log VisualBounds2D

    Ok(())
}

Lines with scene & UI radius each

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

    // A blue line with a scene unit radii of 0.01.
    let points = [[0., 0.], [0., 1.], [1., 0.], [1., 1.]];
    rec.log(
        "scene_unit_line",
        &rerun::LineStrips2D::new([points])
            // By default, radii are interpreted as world-space units.
            .with_radii([0.01])
            .with_colors([rerun::Color::from_rgb(0, 0, 255)]),
    )?;

    // A red line with a ui point radii of 5.
    // 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.
    let points = [[3., 0.], [3., 1.], [4., 0.], [4., 1.]];
    rec.log(
        "ui_points_line",
        &rerun::LineStrips2D::new([points])
            // rerun::Radius::new_ui_points produces a radius that the viewer interprets as given in ui points.
            .with_radii([rerun::Radius::new_ui_points(5.0)])
            .with_colors([rerun::Color::from_rgb(255, 0, 0)]),
    )?;

    // TODO(#5520): log VisualBounds2D

    Ok(())
}

Fields

strips: Option<SerializedComponentBatch>

All the actual 2D line strips that make up the batch.

radii: Option<SerializedComponentBatch>

Optional radii for the line strips.

colors: Option<SerializedComponentBatch>

Optional colors for the line strips.

labels: Option<SerializedComponentBatch>

Optional text labels for the line strips.

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 of each line strip.

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

class_ids: Option<SerializedComponentBatch>

Optional components::ClassIds for the lines.

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

Implementations

impl LineStrips2D

pub fn descriptor_strips() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::strips.

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_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl LineStrips2D

pub const NUM_COMPONENTS: usize = 8usize

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

impl LineStrips2D

pub fn new( strips: impl IntoIterator<Item = impl Into<LineStrip2D>>, ) -> LineStrips2D

Create a new LineStrips2D.

pub fn update_fields() -> LineStrips2D

Update only some specific fields of a LineStrips2D.

pub fn clear_fields() -> LineStrips2D

Clear all the fields of a LineStrips2D.

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

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, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

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_strips( self, strips: impl IntoIterator<Item = impl Into<LineStrip2D>>, ) -> LineStrips2D

All the actual 2D line strips that make up the batch.

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

Optional radii for the line strips.

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

Optional colors for the line strips.

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

Optional text labels for the line strips.

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>, ) -> LineStrips2D

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>>, ) -> LineStrips2D

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>) -> LineStrips2D

An optional floating point value that specifies the 2D drawing order of each line strip.

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>>, ) -> LineStrips2D

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>>, ) -> LineStrips2D

Optional components::ClassIds for the lines.

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

Trait Implementations

impl Archetype for LineStrips2D

type Indicator = GenericIndicatorComponent<LineStrips2D>

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, Arc<dyn Array>)>, ) -> Result<LineStrips2D, DeserializationError>

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 LineStrips2D

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 LineStrips2D

fn clone(&self) -> LineStrips2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LineStrips2D

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

Formats the value using the given formatter.

impl Default for LineStrips2D

fn default() -> LineStrips2D

Returns the “default value” for a type.

impl PartialEq for LineStrips2D

fn eq(&self, other: &LineStrips2D) -> 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 LineStrips2D

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 LineStrips2D

impl StructuralPartialEq for LineStrips2D