Struct re_types::archetypes::Boxes3D

pub struct Boxes3D {
    pub half_sizes: Vec<HalfSizes3D>,
    pub centers: Option<Vec<Position3D>>,
    pub rotations: Option<Vec<Rotation3D>>,
    pub colors: Option<Vec<Color>>,
    pub radii: Option<Vec<Radius>>,
    pub labels: Option<Vec<Text>>,
    pub class_ids: Option<Vec<ClassId>>,
}

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

Example

Batch of 3D boxes

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

    rec.log(
        "batch",
        &rerun::Boxes3D::from_centers_and_half_sizes(
            [(2.0, 0.0, 0.0), (-2.0, 0.0, 0.0), (0.0, 0.0, 2.0)],
            [(2.0, 2.0, 1.0), (1.0, 1.0, 0.5), (2.0, 0.5, 1.0)],
        )
        .with_rotations([
            rerun::Rotation3D::IDENTITY,
            rerun::Quaternion::from_xyzw([0.0, 0.0, 0.382683, 0.923880]).into(), // 45 degrees around Z
            rerun::RotationAxisAngle::new((0.0, 1.0, 0.0), rerun::Angle::Degrees(30.0)).into(),
        ])
        .with_radii([0.025])
        .with_colors([
            rerun::Color::from_rgb(255, 0, 0),
            rerun::Color::from_rgb(0, 255, 0),
            rerun::Color::from_rgb(0, 0, 255),
        ])
        .with_labels(["red", "green", "blue"]),
    )?;

    Ok(())
}

Fields

half_sizes: Vec<HalfSizes3D>

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

centers: Option<Vec<Position3D>>

Optional center positions of the boxes.

rotations: Option<Vec<Rotation3D>>

Optional rotations of the boxes.

colors: Option<Vec<Color>>

Optional colors for the boxes.

radii: Option<Vec<Radius>>

Optional radii for the lines that make up the boxes.

labels: Option<Vec<Text>>

Optional text labels for the boxes.

class_ids: Option<Vec<ClassId>>

Optional ClassIds for the boxes.

The class ID provides colors and labels if not specified explicitly.

Implementations

impl Boxes3D

pub const NUM_COMPONENTS: usize = 8usize

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

impl Boxes3D

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

Optional center positions of the boxes.

pub fn with_rotations( self, rotations: impl IntoIterator<Item = impl Into<Rotation3D>> ) -> Self

Optional rotations of the boxes.

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

Optional colors for the boxes.

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

Optional radii for the lines that make up the boxes.

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

Optional text labels for the boxes.

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

Optional ClassIds for the boxes.

The class ID provides colors and labels if not specified explicitly.

impl Boxes3D

pub fn from_half_sizes( half_sizes: impl IntoIterator<Item = impl Into<HalfSizes3D>> ) -> Self

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

pub fn from_centers_and_half_sizes( centers: impl IntoIterator<Item = impl Into<Position3D>>, half_sizes: impl IntoIterator<Item = impl Into<HalfSizes3D>> ) -> Self

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

pub fn from_sizes(sizes: impl IntoIterator<Item = impl Into<Vec3D>>) -> Self

Creates new Boxes3D 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<Position3D>>, sizes: impl IntoIterator<Item = impl Into<Vec3D>> ) -> Self

Creates new Boxes3D 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<Vec3D>>, sizes: impl IntoIterator<Item = impl Into<Vec3D>> ) -> Self

Creates new Boxes3D 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 Boxes3D

type Indicator = GenericIndicatorComponent<Boxes3D>

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 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>)> ) -> DeserializationResult<Self>

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 Boxes3D

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 Boxes3D

fn clone(&self) -> Boxes3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boxes3D

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

Formats the value using the given formatter.

impl PartialEq for Boxes3D

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

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 StructuralPartialEq for Boxes3D