Struct rerun::archetypes::Boxes2D

pub struct Boxes2D {
    pub half_sizes: Option<SerializedComponentBatch>,
    pub centers: Option<SerializedComponentBatch>,
    pub colors: Option<SerializedComponentBatch>,
    pub radii: Option<SerializedComponentBatch>,
    pub labels: Option<SerializedComponentBatch>,
    pub show_labels: Option<SerializedComponentBatch>,
    pub draw_order: Option<SerializedComponentBatch>,
    pub class_ids: Option<SerializedComponentBatch>,
}

Archetype: 2D boxes with half-extents and optional center, colors etc.

Example

Simple 2D boxes

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

    rec.log(
        "simple",
        &rerun::Boxes2D::from_mins_and_sizes([(-1., -1.)], [(2., 2.)]),
    )?;

    Ok(())
}

Fields

half_sizes: Option<SerializedComponentBatch>

All half-extents that make up the batch of boxes.

centers: Option<SerializedComponentBatch>

Optional center positions of the boxes.

colors: Option<SerializedComponentBatch>

Optional colors for the boxes.

radii: Option<SerializedComponentBatch>

Optional radii for the lines that make up the boxes.

labels: Option<SerializedComponentBatch>

Optional text labels for the boxes.

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.

The default for 2D boxes is 10.0.

class_ids: Option<SerializedComponentBatch>

Optional components::ClassIds for the boxes.

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

Implementations

impl Boxes2D

pub fn descriptor_half_sizes() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::half_sizes.

pub fn descriptor_centers() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::centers.

pub fn descriptor_colors() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::colors.

pub fn descriptor_radii() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::radii.

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 Boxes2D

pub const NUM_COMPONENTS: usize = 9usize

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

impl Boxes2D

pub fn update_fields() -> Boxes2D

Update only some specific fields of a Boxes2D.

pub fn clear_fields() -> Boxes2D

Clear all the fields of a Boxes2D.

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_half_sizes( self, half_sizes: impl IntoIterator<Item = impl Into<HalfSize2D>>, ) -> Boxes2D

All half-extents that make up the batch of boxes.

pub fn with_centers( self, centers: impl IntoIterator<Item = impl Into<Position2D>>, ) -> Boxes2D

Optional center positions of the boxes.

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

Optional colors for the boxes.

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

Optional radii for the lines that make up the boxes.

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

Optional text labels for the boxes.

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

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

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

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

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

The default for 2D boxes is 10.0.

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

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

Optional components::ClassIds for the boxes.

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

impl Boxes2D

pub fn from_half_sizes( half_sizes: impl IntoIterator<Item = impl Into<HalfSize2D>>, ) -> Boxes2D

Creates new Boxes2D with Self::half_sizes centered around the local origin.

pub fn from_centers_and_half_sizes( centers: impl IntoIterator<Item = impl Into<Position2D>>, half_sizes: impl IntoIterator<Item = impl Into<HalfSize2D>>, ) -> Boxes2D

Creates new Boxes2D with Self::centers and Self::half_sizes.

pub fn from_sizes(sizes: impl IntoIterator<Item = impl Into<Vec2D>>) -> Boxes2D

Creates new Boxes2D with Self::half_sizes created from (full) sizes.

TODO(#3285): Does not preserve data as-is and instead creates half-sizes from the input data.

pub fn from_centers_and_sizes( centers: impl IntoIterator<Item = impl Into<Position2D>>, sizes: impl IntoIterator<Item = impl Into<Vec2D>>, ) -> Boxes2D

Creates new Boxes2D with Self::centers and Self::half_sizes created from centers and (full) sizes.

TODO(#3285): Does not preserve data as-is and instead creates half-sizes from the input data.

pub fn from_mins_and_sizes( mins: impl IntoIterator<Item = impl Into<Vec2D>>, sizes: impl IntoIterator<Item = impl Into<Vec2D>>, ) -> Boxes2D

Creates new Boxes2D with Self::centers and Self::half_sizes created from minimums and (full) sizes.

TODO(#3285): Does not preserve data as-is and instead creates centers and half-sizes from the input data.

Trait Implementations

impl Archetype for Boxes2D

type Indicator = GenericIndicatorComponent<Boxes2D>

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

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 Boxes2D

fn clone(&self) -> Boxes2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boxes2D

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

Formats the value using the given formatter.

impl Default for Boxes2D

fn default() -> Boxes2D

Returns the “default value” for a type.

impl PartialEq for Boxes2D

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

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 Boxes2D

impl StructuralPartialEq for Boxes2D