Struct re_types::archetypes::Boxes3D
source · pub struct Boxes3D {
pub half_sizes: Option<SerializedComponentBatch>,
pub centers: Option<SerializedComponentBatch>,
pub rotation_axis_angles: Option<SerializedComponentBatch>,
pub quaternions: Option<SerializedComponentBatch>,
pub colors: Option<SerializedComponentBatch>,
pub radii: Option<SerializedComponentBatch>,
pub fill_mode: Option<SerializedComponentBatch>,
pub labels: Option<SerializedComponentBatch>,
pub show_labels: Option<SerializedComponentBatch>,
pub class_ids: Option<SerializedComponentBatch>,
}
Expand description
Archetype: 3D boxes with half-extents and optional center, rotations, colors etc.
Note that orienting and placing the box is handled via [archetypes.InstancePoses3D]
.
Some of its component are repeated here for convenience.
If there’s more instance poses than half sizes, the last half size will be repeated for the remaining poses.
§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_quaternions([
rerun::Quaternion::IDENTITY,
rerun::Quaternion::from_xyzw([0.0, 0.0, 0.382683, 0.923880]), // 45 degrees around Z
])
.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_fill_mode(rerun::FillMode::Solid)
.with_labels(["red", "green", "blue"]),
)?;
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.
If not specified, the centers will be at (0, 0, 0).
Note that this uses a components::PoseTranslation3D
which is also used by archetypes::InstancePoses3D
.
rotation_axis_angles: Option<SerializedComponentBatch>
Rotations via axis + angle.
If no rotation is specified, the axes of the boxes align with the axes of the local coordinate system.
Note that this uses a components::PoseRotationAxisAngle
which is also used by archetypes::InstancePoses3D
.
quaternions: Option<SerializedComponentBatch>
Rotations via quaternion.
If no rotation is specified, the axes of the boxes align with the axes of the local coordinate system.
Note that this uses a components::PoseRotationQuat
which is also used by archetypes::InstancePoses3D
.
colors: Option<SerializedComponentBatch>
Optional colors for the boxes.
radii: Option<SerializedComponentBatch>
Optional radii for the lines that make up the boxes.
fill_mode: Option<SerializedComponentBatch>
Optionally choose whether the boxes are drawn with lines or solid.
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.
class_ids: Option<SerializedComponentBatch>
Optional components::ClassId
s for the boxes.
The components::ClassId
provides colors and labels if not specified explicitly.
Implementations§
source§impl Boxes3D
impl Boxes3D
sourcepub fn descriptor_half_sizes() -> ComponentDescriptor
pub fn descriptor_half_sizes() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::half_sizes
.
sourcepub fn descriptor_centers() -> ComponentDescriptor
pub fn descriptor_centers() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::centers
.
sourcepub fn descriptor_rotation_axis_angles() -> ComponentDescriptor
pub fn descriptor_rotation_axis_angles() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::rotation_axis_angles
.
sourcepub fn descriptor_quaternions() -> ComponentDescriptor
pub fn descriptor_quaternions() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::quaternions
.
sourcepub fn descriptor_colors() -> ComponentDescriptor
pub fn descriptor_colors() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::colors
.
sourcepub fn descriptor_radii() -> ComponentDescriptor
pub fn descriptor_radii() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::radii
.
sourcepub fn descriptor_fill_mode() -> ComponentDescriptor
pub fn descriptor_fill_mode() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::fill_mode
.
sourcepub fn descriptor_labels() -> ComponentDescriptor
pub fn descriptor_labels() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::labels
.
sourcepub fn descriptor_show_labels() -> ComponentDescriptor
pub fn descriptor_show_labels() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::show_labels
.
sourcepub fn descriptor_class_ids() -> ComponentDescriptor
pub fn descriptor_class_ids() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::class_ids
.
sourcepub fn descriptor_indicator() -> ComponentDescriptor
pub fn descriptor_indicator() -> ComponentDescriptor
Returns the ComponentDescriptor
for the associated indicator component.
source§impl Boxes3D
impl Boxes3D
sourcepub const NUM_COMPONENTS: usize = 11usize
pub const NUM_COMPONENTS: usize = 11usize
The total number of components in the archetype: 1 required, 3 recommended, 7 optional
source§impl Boxes3D
impl Boxes3D
sourcepub(crate) fn new(
half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>,
) -> Self
pub(crate) fn new( half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>, ) -> Self
Create a new Boxes3D
.
sourcepub fn update_fields() -> Self
pub fn update_fields() -> Self
Update only some specific fields of a Boxes3D
.
sourcepub fn clear_fields() -> Self
pub fn clear_fields() -> Self
Clear all the fields of a Boxes3D
.
sourcepub fn columns<I>(
self,
_lengths: I,
) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
Partitions the component data into multiple sub-batches.
Specifically, this transforms the existing SerializedComponentBatch
es data into SerializedComponentColumn
s
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.
sourcepub fn columns_of_unit_batches(
self,
) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
pub fn columns_of_unit_batches( self, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>
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.
sourcepub fn with_half_sizes(
self,
half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>,
) -> Self
pub fn with_half_sizes( self, half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>, ) -> Self
All half-extents that make up the batch of boxes.
sourcepub fn with_centers(
self,
centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>,
) -> Self
pub fn with_centers( self, centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>, ) -> Self
Optional center positions of the boxes.
If not specified, the centers will be at (0, 0, 0).
Note that this uses a components::PoseTranslation3D
which is also used by archetypes::InstancePoses3D
.
sourcepub fn with_rotation_axis_angles(
self,
rotation_axis_angles: impl IntoIterator<Item = impl Into<PoseRotationAxisAngle>>,
) -> Self
pub fn with_rotation_axis_angles( self, rotation_axis_angles: impl IntoIterator<Item = impl Into<PoseRotationAxisAngle>>, ) -> Self
Rotations via axis + angle.
If no rotation is specified, the axes of the boxes align with the axes of the local coordinate system.
Note that this uses a components::PoseRotationAxisAngle
which is also used by archetypes::InstancePoses3D
.
sourcepub fn with_quaternions(
self,
quaternions: impl IntoIterator<Item = impl Into<PoseRotationQuat>>,
) -> Self
pub fn with_quaternions( self, quaternions: impl IntoIterator<Item = impl Into<PoseRotationQuat>>, ) -> Self
Rotations via quaternion.
If no rotation is specified, the axes of the boxes align with the axes of the local coordinate system.
Note that this uses a components::PoseRotationQuat
which is also used by archetypes::InstancePoses3D
.
sourcepub fn with_colors(
self,
colors: impl IntoIterator<Item = impl Into<Color>>,
) -> Self
pub fn with_colors( self, colors: impl IntoIterator<Item = impl Into<Color>>, ) -> Self
Optional colors for the boxes.
sourcepub fn with_radii(
self,
radii: impl IntoIterator<Item = impl Into<Radius>>,
) -> Self
pub fn with_radii( self, radii: impl IntoIterator<Item = impl Into<Radius>>, ) -> Self
Optional radii for the lines that make up the boxes.
sourcepub fn with_fill_mode(self, fill_mode: impl Into<FillMode>) -> Self
pub fn with_fill_mode(self, fill_mode: impl Into<FillMode>) -> Self
Optionally choose whether the boxes are drawn with lines or solid.
sourcepub fn with_many_fill_mode(
self,
fill_mode: impl IntoIterator<Item = impl Into<FillMode>>,
) -> Self
pub fn with_many_fill_mode( self, fill_mode: impl IntoIterator<Item = impl Into<FillMode>>, ) -> Self
This method makes it possible to pack multiple crate::components::FillMode
in a single component batch.
This only makes sense when used in conjunction with Self::columns
. Self::with_fill_mode
should
be used when logging a single row’s worth of data.
sourcepub fn with_labels(
self,
labels: impl IntoIterator<Item = impl Into<Text>>,
) -> Self
pub fn with_labels( self, labels: impl IntoIterator<Item = impl Into<Text>>, ) -> Self
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.
sourcepub fn with_show_labels(self, show_labels: impl Into<ShowLabels>) -> Self
pub fn with_show_labels(self, show_labels: impl Into<ShowLabels>) -> Self
Optional choice of whether the text labels should be shown by default.
sourcepub fn with_many_show_labels(
self,
show_labels: impl IntoIterator<Item = impl Into<ShowLabels>>,
) -> Self
pub fn with_many_show_labels( self, show_labels: impl IntoIterator<Item = impl Into<ShowLabels>>, ) -> Self
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.
sourcepub fn with_class_ids(
self,
class_ids: impl IntoIterator<Item = impl Into<ClassId>>,
) -> Self
pub fn with_class_ids( self, class_ids: impl IntoIterator<Item = impl Into<ClassId>>, ) -> Self
Optional components::ClassId
s for the boxes.
The components::ClassId
provides colors and labels if not specified explicitly.
source§impl Boxes3D
impl Boxes3D
sourcepub fn from_half_sizes(
half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>,
) -> Self
pub fn from_half_sizes( half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>, ) -> Self
Creates new Boxes3D
with Self::half_sizes
centered around the local origin.
sourcepub fn from_centers_and_half_sizes(
centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>,
half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>,
) -> Self
pub fn from_centers_and_half_sizes( centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>, half_sizes: impl IntoIterator<Item = impl Into<HalfSize3D>>, ) -> Self
Creates new Boxes3D
with Self::centers
and Self::half_sizes
.
sourcepub fn from_sizes(sizes: impl IntoIterator<Item = impl Into<Vec3D>>) -> Self
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.
sourcepub fn from_centers_and_sizes(
centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>,
sizes: impl IntoIterator<Item = impl Into<Vec3D>>,
) -> Self
pub fn from_centers_and_sizes( centers: impl IntoIterator<Item = impl Into<PoseTranslation3D>>, 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.
sourcepub fn from_mins_and_sizes(
mins: impl IntoIterator<Item = impl Into<Vec3D>>,
sizes: impl IntoIterator<Item = impl Into<Vec3D>>,
) -> Self
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§
source§impl Archetype for Boxes3D
impl Archetype for Boxes3D
§type Indicator = GenericIndicatorComponent<Boxes3D>
type Indicator = GenericIndicatorComponent<Boxes3D>
source§fn name() -> ArchetypeName
fn name() -> ArchetypeName
rerun.archetypes.Points2D
.source§fn display_name() -> &'static str
fn display_name() -> &'static str
source§fn required_components() -> Cow<'static, [ComponentDescriptor]>
fn required_components() -> Cow<'static, [ComponentDescriptor]>
source§fn recommended_components() -> Cow<'static, [ComponentDescriptor]>
fn recommended_components() -> Cow<'static, [ComponentDescriptor]>
source§fn optional_components() -> Cow<'static, [ComponentDescriptor]>
fn optional_components() -> Cow<'static, [ComponentDescriptor]>
source§fn all_components() -> Cow<'static, [ComponentDescriptor]>
fn all_components() -> Cow<'static, [ComponentDescriptor]>
source§fn from_arrow_components(
arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>,
) -> DeserializationResult<Self>
fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>
ComponentNames
, deserializes them
into this archetype. Read moresource§fn from_arrow(
data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>,
) -> Result<Self, DeserializationError>where
Self: Sized,
fn from_arrow(
data: impl IntoIterator<Item = (Field, Arc<dyn Array>)>,
) -> Result<Self, DeserializationError>where
Self: Sized,
source§impl AsComponents for Boxes3D
impl AsComponents for Boxes3D
source§fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>
fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>
SerializedComponentBatch
es. Read moresource§impl PartialEq for Boxes3D
impl PartialEq for Boxes3D
source§impl SizeBytes for Boxes3D
impl SizeBytes for Boxes3D
source§fn heap_size_bytes(&self) -> u64
fn heap_size_bytes(&self) -> u64
self
uses on the heap. Read moresource§fn total_size_bytes(&self) -> u64
fn total_size_bytes(&self) -> u64
self
in bytes, accounting for both stack and heap space.source§fn stack_size_bytes(&self) -> u64
fn stack_size_bytes(&self) -> u64
self
on the stack, in bytes. Read moreimpl ArchetypeReflectionMarker for Boxes3D
impl StructuralPartialEq for Boxes3D
Auto Trait Implementations§
impl Freeze for Boxes3D
impl !RefUnwindSafe for Boxes3D
impl Send for Boxes3D
impl Sync for Boxes3D
impl Unpin for Boxes3D
impl !UnwindSafe for Boxes3D
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more