Struct rerun::archetypes::Arrows2D

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

Example

Simple batch of 2D arrows

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

    rec.log(
        "arrows",
        &rerun::Arrows2D::from_vectors([[1.0, 0.0], [0.0, -1.0], [-0.7, 0.7]])
            .with_radii([0.025])
            .with_origins([[0.25, 0.0], [0.25, 0.0], [-0.1, -0.1]])
            .with_colors([[255, 0, 0], [0, 255, 0], [127, 0, 255]])
            .with_labels(["right", "up", "left-down"]),
    )?;

    Ok(())
}

Fields

vectors: Option<SerializedComponentBatch>

All the vectors for each arrow in the batch.

origins: Option<SerializedComponentBatch>

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

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

radii: Option<SerializedComponentBatch>

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

Optional colors for the points.

labels: Option<SerializedComponentBatch>

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

Implementations

impl Arrows2D

pub fn descriptor_vectors() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::vectors.

pub fn descriptor_origins() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::origins.

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 Arrows2D

pub const NUM_COMPONENTS: usize = 9usize

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

impl Arrows2D

pub fn update_fields() -> Arrows2D

Update only some specific fields of a Arrows2D.

pub fn clear_fields() -> Arrows2D

Clear all the fields of a Arrows2D.

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_vectors( self, vectors: impl IntoIterator<Item = impl Into<Vector2D>>, ) -> Arrows2D

All the vectors for each arrow in the batch.

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

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

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

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

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

Optional colors for the points.

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

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

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

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

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

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

Optional class Ids for the points.

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

impl Arrows2D

pub fn from_vectors( vectors: impl IntoIterator<Item = impl Into<Vector2D>>, ) -> Arrows2D

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

Trait Implementations

impl Archetype for Arrows2D

type Indicator = GenericIndicatorComponent<Arrows2D>

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

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 Arrows2D

fn clone(&self) -> Arrows2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arrows2D

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

Formats the value using the given formatter.

impl Default for Arrows2D

fn default() -> Arrows2D

Returns the “default value” for a type.

impl PartialEq for Arrows2D

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

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 Arrows2D

impl StructuralPartialEq for Arrows2D