Struct re_types::archetypes::Points2D
source · pub struct Points2D {
pub positions: 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>,
pub keypoint_ids: Option<SerializedComponentBatch>,
}
Expand description
Archetype: A 2D point cloud with positions and optional colors, radii, labels, etc.
§Examples
§Randomly distributed 2D points with varying color and radius
use rand::{distributions::Uniform, Rng as _};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let rec = rerun::RecordingStreamBuilder::new("rerun_example_points2d_random").spawn()?;
let mut rng = rand::thread_rng();
let dist = Uniform::new(-3., 3.);
rec.log(
"random",
&rerun::Points2D::new((0..10).map(|_| (rng.sample(dist), rng.sample(dist))))
.with_colors((0..10).map(|_| rerun::Color::from_rgb(rng.gen(), rng.gen(), rng.gen())))
.with_radii((0..10).map(|_| rng.gen::<f32>())),
)?;
// TODO(#5521): log VisualBounds2D
Ok(())
}

§Log points with radii given in UI points
fn main() -> Result<(), Box<dyn std::error::Error>> {
let rec = rerun::RecordingStreamBuilder::new("rerun_example_points2d_ui_radius").spawn()?;
// Two blue points with scene unit radii of 0.1 and 0.3.
rec.log(
"scene_units",
&rerun::Points2D::new([(0.0, 0.0), (0.0, 1.0)])
// By default, radii are interpreted as world-space units.
.with_radii([0.1, 0.3])
.with_colors([rerun::Color::from_rgb(0, 0, 255)]),
)?;
// Two red points with ui point radii of 40 and 60.
// UI points are independent of zooming in Views, but are sensitive to the application UI scaling.
// For 100% ui scaling, UI points are equal to pixels.
rec.log(
"ui_points",
&rerun::Points2D::new([(1.0, 0.0), (1.0, 1.0)])
// rerun::Radius::new_ui_points produces a radius that the viewer interprets as given in ui points.
.with_radii([
rerun::Radius::new_ui_points(40.0),
rerun::Radius::new_ui_points(60.0),
])
.with_colors([rerun::Color::from_rgb(255, 0, 0)]),
)?;
// TODO(#5521): log VisualBounds2D
Ok(())
}

Fields§
§positions: Option<SerializedComponentBatch>
All the 2D positions at which the point cloud shows points.
radii: Option<SerializedComponentBatch>
Optional radii for the points, effectively turning them into circles.
colors: Option<SerializedComponentBatch>
Optional colors for the points.
labels: Option<SerializedComponentBatch>
Optional text labels for the points.
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.
keypoint_ids: Option<SerializedComponentBatch>
Optional keypoint IDs for the points, identifying them within a class.
If keypoint IDs are passed in but no components::ClassId
s were specified, the components::ClassId
will
default to 0.
This is useful to identify points within a single classification (which is identified
with class_id
).
E.g. the classification might be ‘Person’ and the keypoints refer to joints on a
detected skeleton.
Implementations§
source§impl Points2D
impl Points2D
sourcepub fn descriptor_positions() -> ComponentDescriptor
pub fn descriptor_positions() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::positions
.
sourcepub fn descriptor_radii() -> ComponentDescriptor
pub fn descriptor_radii() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::radii
.
sourcepub fn descriptor_colors() -> ComponentDescriptor
pub fn descriptor_colors() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::colors
.
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_draw_order() -> ComponentDescriptor
pub fn descriptor_draw_order() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::draw_order
.
sourcepub fn descriptor_class_ids() -> ComponentDescriptor
pub fn descriptor_class_ids() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::class_ids
.
sourcepub fn descriptor_keypoint_ids() -> ComponentDescriptor
pub fn descriptor_keypoint_ids() -> ComponentDescriptor
Returns the ComponentDescriptor
for Self::keypoint_ids
.
sourcepub fn descriptor_indicator() -> ComponentDescriptor
pub fn descriptor_indicator() -> ComponentDescriptor
Returns the ComponentDescriptor
for the associated indicator component.
source§impl Points2D
impl Points2D
sourcepub const NUM_COMPONENTS: usize = 9usize
pub const NUM_COMPONENTS: usize = 9usize
The total number of components in the archetype: 1 required, 3 recommended, 5 optional
source§impl Points2D
impl Points2D
sourcepub fn new(positions: impl IntoIterator<Item = impl Into<Position2D>>) -> Self
pub fn new(positions: impl IntoIterator<Item = impl Into<Position2D>>) -> Self
Create a new Points2D
.
sourcepub fn update_fields() -> Self
pub fn update_fields() -> Self
Update only some specific fields of a Points2D
.
sourcepub fn clear_fields() -> Self
pub fn clear_fields() -> Self
Clear all the fields of a Points2D
.
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_positions(
self,
positions: impl IntoIterator<Item = impl Into<Position2D>>,
) -> Self
pub fn with_positions( self, positions: impl IntoIterator<Item = impl Into<Position2D>>, ) -> Self
All the 2D positions at which the point cloud shows points.
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 points, effectively turning them into circles.
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 points.
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 points.
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_draw_order(self, draw_order: impl Into<DrawOrder>) -> Self
pub fn with_draw_order(self, draw_order: impl Into<DrawOrder>) -> Self
An optional floating point value that specifies the 2D drawing order.
Objects with higher values are drawn on top of those with lower values.
sourcepub fn with_many_draw_order(
self,
draw_order: impl IntoIterator<Item = impl Into<DrawOrder>>,
) -> Self
pub fn with_many_draw_order( self, draw_order: impl IntoIterator<Item = impl Into<DrawOrder>>, ) -> Self
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.
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 class Ids for the points.
The components::ClassId
provides colors and labels if not specified explicitly.
sourcepub fn with_keypoint_ids(
self,
keypoint_ids: impl IntoIterator<Item = impl Into<KeypointId>>,
) -> Self
pub fn with_keypoint_ids( self, keypoint_ids: impl IntoIterator<Item = impl Into<KeypointId>>, ) -> Self
Optional keypoint IDs for the points, identifying them within a class.
If keypoint IDs are passed in but no components::ClassId
s were specified, the components::ClassId
will
default to 0.
This is useful to identify points within a single classification (which is identified
with class_id
).
E.g. the classification might be ‘Person’ and the keypoints refer to joints on a
detected skeleton.
Trait Implementations§
source§impl Archetype for Points2D
impl Archetype for Points2D
§type Indicator = GenericIndicatorComponent<Points2D>
type Indicator = GenericIndicatorComponent<Points2D>
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 Points2D
impl AsComponents for Points2D
source§fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>
fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>
SerializedComponentBatch
es. Read moresource§impl PartialEq for Points2D
impl PartialEq for Points2D
source§impl SizeBytes for Points2D
impl SizeBytes for Points2D
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 Points2D
impl StructuralPartialEq for Points2D
Auto Trait Implementations§
impl Freeze for Points2D
impl !RefUnwindSafe for Points2D
impl Send for Points2D
impl Sync for Points2D
impl Unpin for Points2D
impl !UnwindSafe for Points2D
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