Struct rerun::LineStrips3D

pub struct LineStrips3D {
    pub strips: Vec<LineStrip3D>,
    pub radii: Option<Vec<Radius>>,
    pub colors: Option<Vec<Color>>,
    pub labels: Option<Vec<Text>>,
    pub show_labels: Option<ShowLabels>,
    pub class_ids: Option<Vec<ClassId>>,
}

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

Examples

Many strips

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

    let strip1 = [[0., 0., 2.], [1., 0., 2.], [1., 1., 2.], [0., 1., 2.]];
    let strip2 = [
        [0., 0., 0.],
        [0., 0., 1.],
        [1., 0., 0.],
        [1., 0., 1.],
        [1., 1., 0.],
        [1., 1., 1.],
        [0., 1., 0.],
        [0., 1., 1.],
    ];
    rec.log(
        "strips",
        &rerun::LineStrips3D::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"]),
    )?;

    Ok(())
}

Lines with scene & UI radius each

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

    // A blue line with a scene unit radii of 0.01.
    let points = [[0., 0., 0.], [0., 0., 1.], [1., 0., 0.], [1., 0., 1.]];
    rec.log(
        "scene_unit_line",
        &rerun::LineStrips3D::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., 0.], [3., 0., 1.], [4., 0., 0.], [4., 0., 1.]];
    rec.log(
        "ui_points_line",
        &rerun::LineStrips3D::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)]),
    )?;

    Ok(())
}

Fields

strips: Vec<LineStrip3D>

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

radii: Option<Vec<Radius>>

Optional radii for the line strips.

colors: Option<Vec<Color>>

Optional colors for the line strips.

labels: Option<Vec<Text>>

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<ShowLabels>

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

class_ids: Option<Vec<ClassId>>

Optional components::ClassIds for the lines.

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

Implementations

impl LineStrips3D

pub const NUM_COMPONENTS: usize = 7usize

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

impl LineStrips3D

pub fn new( strips: impl IntoIterator<Item = impl Into<LineStrip3D>> ) -> LineStrips3D

Create a new LineStrips3D.

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

Optional radii for the line strips.

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

Optional colors for the line strips.

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

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

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

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

Optional components::ClassIds for the lines.

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

Trait Implementations

impl Archetype for LineStrips3D

type Indicator = GenericIndicatorComponent<LineStrips3D>

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() -> MaybeOwnedComponentBatch<'static>

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

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

Returns the names of all components that must be provided by the user when constructing this archetype.

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

Returns the names of all components that should be provided by the user when constructing this archetype.

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

Returns the names of all components that may be provided by the user when constructing this archetype.

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

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<LineStrips3D, DeserializationError>

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

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<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 LineStrips3D

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

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

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

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

impl Clone for LineStrips3D

fn clone(&self) -> LineStrips3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LineStrips3D

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

Formats the value using the given formatter.

impl PartialEq for LineStrips3D

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

fn heap_size_bytes(&self) -> u64

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

fn is_pod() -> bool

Is Self just plain old data?

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.

impl ArchetypeReflectionMarker for LineStrips3D

impl StructuralPartialEq for LineStrips3D