Struct rerun::sdk::archetypes::Arrows3D

pub struct Arrows3D {
    pub vectors: Vec<Vector3D>,
    pub origins: Option<Vec<Position3D>>,
    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 arrows with optional colors, radii, labels, etc.

Example

Simple batch of 3D arrows

use std::f32::consts::TAU;

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

    let origins = vec![rerun::Position3D::ZERO; 100];
    let (vectors, colors): (Vec<_>, Vec<_>) = (0..100)
        .map(|i| {
            let angle = TAU * i as f32 * 0.01;
            let length = ((i + 1) as f32).log2();
            let c = (angle / TAU * 255.0).round() as u8;
            (
                rerun::Vector3D::from([(length * angle.sin()), 0.0, (length * angle.cos())]),
                rerun::Color::from_unmultiplied_rgba(255 - c, c, 128, 128),
            )
        })
        .unzip();

    rec.log(
        "arrows",
        &rerun::Arrows3D::from_vectors(vectors)
            .with_origins(origins)
            .with_colors(colors),
    )?;

    Ok(())
}

Fields

vectors: Vec<Vector3D>

All the vectors for each arrow in the batch.

origins: Option<Vec<Position3D>>

All the origin (base) positions for each arrow in the batch.

If no origins are set, (0, 0, 0) is used as the origin for each arrow.

radii: Option<Vec<Radius>>

Optional radii for the arrows.

The shaft is rendered as a line with radius = 0.5 * radius. The tip is rendered with height = 2.0 * radius and radius = 1.0 * radius.

colors: Option<Vec<Color>>

Optional colors for the points.

labels: Option<Vec<Text>>

Optional text labels for the arrows.

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 class Ids for the points.

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

Implementations

impl Arrows3D

pub const NUM_COMPONENTS: usize = 8usize

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

impl Arrows3D

pub fn with_origins( self, origins: impl IntoIterator<Item = impl Into<Position3D>> ) -> Arrows3D

All the origin (base) positions for each arrow in the batch.

If no origins are set, (0, 0, 0) is used as the origin for each arrow.

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

Optional radii for the arrows.

The shaft is rendered as a line with radius = 0.5 * radius. The tip is rendered with height = 2.0 * radius and radius = 1.0 * radius.

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

Optional colors for the points.

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

Optional text labels for the arrows.

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

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

Optional class Ids for the points.

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

impl Arrows3D

pub fn from_vectors( vectors: impl IntoIterator<Item = impl Into<Vector3D>> ) -> Arrows3D

Creates new 3D arrows pointing in the given directions, with a base at the origin (0, 0, 0).

Trait Implementations

impl Archetype for Arrows3D

type Indicator = GenericIndicatorComponent<Arrows3D>

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<Arrows3D, 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 Arrows3D

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 Arrows3D

fn clone(&self) -> Arrows3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arrows3D

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

Formats the value using the given formatter.

impl PartialEq for Arrows3D

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

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 Arrows3D

impl StructuralPartialEq for Arrows3D