1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/rust/api.rs
// Based on "crates/store/re_types/definitions/rerun/archetypes/points2d.fbs".
#![allow(unused_imports)]
#![allow(unused_parens)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::cloned_instead_of_copied)]
#![allow(clippy::map_flatten)]
#![allow(clippy::needless_question_mark)]
#![allow(clippy::new_without_default)]
#![allow(clippy::redundant_closure)]
#![allow(clippy::too_many_arguments)]
#![allow(clippy::too_many_lines)]
use ::re_types_core::external::arrow2;
use ::re_types_core::ComponentName;
use ::re_types_core::SerializationResult;
use ::re_types_core::{ComponentBatch, MaybeOwnedComponentBatch};
use ::re_types_core::{DeserializationError, DeserializationResult};
/// **Archetype**: A 2D point cloud with positions and optional colors, radii, labels, etc.
///
/// ## Examples
///
/// ### Randomly distributed 2D points with varying color and radius
/// ```ignore
/// 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(())
/// }
/// ```
/// <center>
/// <picture>
/// <source media="(max-width: 480px)" srcset="https://static.rerun.io/point2d_random/8e8ac75373677bd72bd3f56a15e44fcab309a168/480w.png">
/// <source media="(max-width: 768px)" srcset="https://static.rerun.io/point2d_random/8e8ac75373677bd72bd3f56a15e44fcab309a168/768w.png">
/// <source media="(max-width: 1024px)" srcset="https://static.rerun.io/point2d_random/8e8ac75373677bd72bd3f56a15e44fcab309a168/1024w.png">
/// <source media="(max-width: 1200px)" srcset="https://static.rerun.io/point2d_random/8e8ac75373677bd72bd3f56a15e44fcab309a168/1200w.png">
/// <img src="https://static.rerun.io/point2d_random/8e8ac75373677bd72bd3f56a15e44fcab309a168/full.png" width="640">
/// </picture>
/// </center>
///
/// ### Log points with radii given in UI points
/// ```ignore
/// 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(())
/// }
/// ```
/// <center>
/// <picture>
/// <source media="(max-width: 480px)" srcset="https://static.rerun.io/point2d_ui_radius/ce804fc77300d89c348b4ab5960395171497b7ac/480w.png">
/// <source media="(max-width: 768px)" srcset="https://static.rerun.io/point2d_ui_radius/ce804fc77300d89c348b4ab5960395171497b7ac/768w.png">
/// <source media="(max-width: 1024px)" srcset="https://static.rerun.io/point2d_ui_radius/ce804fc77300d89c348b4ab5960395171497b7ac/1024w.png">
/// <source media="(max-width: 1200px)" srcset="https://static.rerun.io/point2d_ui_radius/ce804fc77300d89c348b4ab5960395171497b7ac/1200w.png">
/// <img src="https://static.rerun.io/point2d_ui_radius/ce804fc77300d89c348b4ab5960395171497b7ac/full.png" width="640">
/// </picture>
/// </center>
#[derive(Clone, Debug, PartialEq)]
pub struct Points2D {
/// All the 2D positions at which the point cloud shows points.
pub positions: Vec<crate::components::Position2D>,
/// Optional radii for the points, effectively turning them into circles.
pub radii: Option<Vec<crate::components::Radius>>,
/// Optional colors for the points.
pub colors: Option<Vec<crate::components::Color>>,
/// 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.
pub labels: Option<Vec<crate::components::Text>>,
/// Optional choice of whether the text labels should be shown by default.
pub show_labels: Option<crate::components::ShowLabels>,
/// 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 draw_order: Option<crate::components::DrawOrder>,
/// Optional class Ids for the points.
///
/// The [`components::ClassId`][crate::components::ClassId] provides colors and labels if not specified explicitly.
pub class_ids: Option<Vec<crate::components::ClassId>>,
/// Optional keypoint IDs for the points, identifying them within a class.
///
/// If keypoint IDs are passed in but no [`components::ClassId`][crate::components::ClassId]s were specified, the [`components::ClassId`][crate::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.
pub keypoint_ids: Option<Vec<crate::components::KeypointId>>,
}
impl ::re_types_core::SizeBytes for Points2D {
#[inline]
fn heap_size_bytes(&self) -> u64 {
self.positions.heap_size_bytes()
+ self.radii.heap_size_bytes()
+ self.colors.heap_size_bytes()
+ self.labels.heap_size_bytes()
+ self.show_labels.heap_size_bytes()
+ self.draw_order.heap_size_bytes()
+ self.class_ids.heap_size_bytes()
+ self.keypoint_ids.heap_size_bytes()
}
#[inline]
fn is_pod() -> bool {
<Vec<crate::components::Position2D>>::is_pod()
&& <Option<Vec<crate::components::Radius>>>::is_pod()
&& <Option<Vec<crate::components::Color>>>::is_pod()
&& <Option<Vec<crate::components::Text>>>::is_pod()
&& <Option<crate::components::ShowLabels>>::is_pod()
&& <Option<crate::components::DrawOrder>>::is_pod()
&& <Option<Vec<crate::components::ClassId>>>::is_pod()
&& <Option<Vec<crate::components::KeypointId>>>::is_pod()
}
}
static REQUIRED_COMPONENTS: once_cell::sync::Lazy<[ComponentName; 1usize]> =
once_cell::sync::Lazy::new(|| ["rerun.components.Position2D".into()]);
static RECOMMENDED_COMPONENTS: once_cell::sync::Lazy<[ComponentName; 3usize]> =
once_cell::sync::Lazy::new(|| {
[
"rerun.components.Radius".into(),
"rerun.components.Color".into(),
"rerun.components.Points2DIndicator".into(),
]
});
static OPTIONAL_COMPONENTS: once_cell::sync::Lazy<[ComponentName; 5usize]> =
once_cell::sync::Lazy::new(|| {
[
"rerun.components.Text".into(),
"rerun.components.ShowLabels".into(),
"rerun.components.DrawOrder".into(),
"rerun.components.ClassId".into(),
"rerun.components.KeypointId".into(),
]
});
static ALL_COMPONENTS: once_cell::sync::Lazy<[ComponentName; 9usize]> =
once_cell::sync::Lazy::new(|| {
[
"rerun.components.Position2D".into(),
"rerun.components.Radius".into(),
"rerun.components.Color".into(),
"rerun.components.Points2DIndicator".into(),
"rerun.components.Text".into(),
"rerun.components.ShowLabels".into(),
"rerun.components.DrawOrder".into(),
"rerun.components.ClassId".into(),
"rerun.components.KeypointId".into(),
]
});
impl Points2D {
/// The total number of components in the archetype: 1 required, 3 recommended, 5 optional
pub const NUM_COMPONENTS: usize = 9usize;
}
/// Indicator component for the [`Points2D`] [`::re_types_core::Archetype`]
pub type Points2DIndicator = ::re_types_core::GenericIndicatorComponent<Points2D>;
impl ::re_types_core::Archetype for Points2D {
type Indicator = Points2DIndicator;
#[inline]
fn name() -> ::re_types_core::ArchetypeName {
"rerun.archetypes.Points2D".into()
}
#[inline]
fn display_name() -> &'static str {
"Points 2D"
}
#[inline]
fn indicator() -> MaybeOwnedComponentBatch<'static> {
static INDICATOR: Points2DIndicator = Points2DIndicator::DEFAULT;
MaybeOwnedComponentBatch::Ref(&INDICATOR)
}
#[inline]
fn required_components() -> ::std::borrow::Cow<'static, [ComponentName]> {
REQUIRED_COMPONENTS.as_slice().into()
}
#[inline]
fn recommended_components() -> ::std::borrow::Cow<'static, [ComponentName]> {
RECOMMENDED_COMPONENTS.as_slice().into()
}
#[inline]
fn optional_components() -> ::std::borrow::Cow<'static, [ComponentName]> {
OPTIONAL_COMPONENTS.as_slice().into()
}
#[inline]
fn all_components() -> ::std::borrow::Cow<'static, [ComponentName]> {
ALL_COMPONENTS.as_slice().into()
}
#[inline]
fn from_arrow_components(
arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn arrow2::array::Array>)>,
) -> DeserializationResult<Self> {
re_tracing::profile_function!();
use ::re_types_core::{Loggable as _, ResultExt as _};
let arrays_by_name: ::std::collections::HashMap<_, _> = arrow_data
.into_iter()
.map(|(name, array)| (name.full_name(), array))
.collect();
let positions = {
let array = arrays_by_name
.get("rerun.components.Position2D")
.ok_or_else(DeserializationError::missing_data)
.with_context("rerun.archetypes.Points2D#positions")?;
<crate::components::Position2D>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#positions")?
.into_iter()
.map(|v| v.ok_or_else(DeserializationError::missing_data))
.collect::<DeserializationResult<Vec<_>>>()
.with_context("rerun.archetypes.Points2D#positions")?
};
let radii = if let Some(array) = arrays_by_name.get("rerun.components.Radius") {
Some({
<crate::components::Radius>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#radii")?
.into_iter()
.map(|v| v.ok_or_else(DeserializationError::missing_data))
.collect::<DeserializationResult<Vec<_>>>()
.with_context("rerun.archetypes.Points2D#radii")?
})
} else {
None
};
let colors = if let Some(array) = arrays_by_name.get("rerun.components.Color") {
Some({
<crate::components::Color>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#colors")?
.into_iter()
.map(|v| v.ok_or_else(DeserializationError::missing_data))
.collect::<DeserializationResult<Vec<_>>>()
.with_context("rerun.archetypes.Points2D#colors")?
})
} else {
None
};
let labels = if let Some(array) = arrays_by_name.get("rerun.components.Text") {
Some({
<crate::components::Text>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#labels")?
.into_iter()
.map(|v| v.ok_or_else(DeserializationError::missing_data))
.collect::<DeserializationResult<Vec<_>>>()
.with_context("rerun.archetypes.Points2D#labels")?
})
} else {
None
};
let show_labels = if let Some(array) = arrays_by_name.get("rerun.components.ShowLabels") {
<crate::components::ShowLabels>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#show_labels")?
.into_iter()
.next()
.flatten()
} else {
None
};
let draw_order = if let Some(array) = arrays_by_name.get("rerun.components.DrawOrder") {
<crate::components::DrawOrder>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#draw_order")?
.into_iter()
.next()
.flatten()
} else {
None
};
let class_ids = if let Some(array) = arrays_by_name.get("rerun.components.ClassId") {
Some({
<crate::components::ClassId>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#class_ids")?
.into_iter()
.map(|v| v.ok_or_else(DeserializationError::missing_data))
.collect::<DeserializationResult<Vec<_>>>()
.with_context("rerun.archetypes.Points2D#class_ids")?
})
} else {
None
};
let keypoint_ids = if let Some(array) = arrays_by_name.get("rerun.components.KeypointId") {
Some({
<crate::components::KeypointId>::from_arrow_opt(&**array)
.with_context("rerun.archetypes.Points2D#keypoint_ids")?
.into_iter()
.map(|v| v.ok_or_else(DeserializationError::missing_data))
.collect::<DeserializationResult<Vec<_>>>()
.with_context("rerun.archetypes.Points2D#keypoint_ids")?
})
} else {
None
};
Ok(Self {
positions,
radii,
colors,
labels,
show_labels,
draw_order,
class_ids,
keypoint_ids,
})
}
}
impl ::re_types_core::AsComponents for Points2D {
fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>> {
re_tracing::profile_function!();
use ::re_types_core::Archetype as _;
[
Some(Self::indicator()),
Some((&self.positions as &dyn ComponentBatch).into()),
self.radii
.as_ref()
.map(|comp_batch| (comp_batch as &dyn ComponentBatch).into()),
self.colors
.as_ref()
.map(|comp_batch| (comp_batch as &dyn ComponentBatch).into()),
self.labels
.as_ref()
.map(|comp_batch| (comp_batch as &dyn ComponentBatch).into()),
self.show_labels
.as_ref()
.map(|comp| (comp as &dyn ComponentBatch).into()),
self.draw_order
.as_ref()
.map(|comp| (comp as &dyn ComponentBatch).into()),
self.class_ids
.as_ref()
.map(|comp_batch| (comp_batch as &dyn ComponentBatch).into()),
self.keypoint_ids
.as_ref()
.map(|comp_batch| (comp_batch as &dyn ComponentBatch).into()),
]
.into_iter()
.flatten()
.collect()
}
}
impl ::re_types_core::ArchetypeReflectionMarker for Points2D {}
impl Points2D {
/// Create a new `Points2D`.
#[inline]
pub fn new(
positions: impl IntoIterator<Item = impl Into<crate::components::Position2D>>,
) -> Self {
Self {
positions: positions.into_iter().map(Into::into).collect(),
radii: None,
colors: None,
labels: None,
show_labels: None,
draw_order: None,
class_ids: None,
keypoint_ids: None,
}
}
/// Optional radii for the points, effectively turning them into circles.
#[inline]
pub fn with_radii(
mut self,
radii: impl IntoIterator<Item = impl Into<crate::components::Radius>>,
) -> Self {
self.radii = Some(radii.into_iter().map(Into::into).collect());
self
}
/// Optional colors for the points.
#[inline]
pub fn with_colors(
mut self,
colors: impl IntoIterator<Item = impl Into<crate::components::Color>>,
) -> Self {
self.colors = Some(colors.into_iter().map(Into::into).collect());
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.
#[inline]
pub fn with_labels(
mut self,
labels: impl IntoIterator<Item = impl Into<crate::components::Text>>,
) -> Self {
self.labels = Some(labels.into_iter().map(Into::into).collect());
self
}
/// Optional choice of whether the text labels should be shown by default.
#[inline]
pub fn with_show_labels(
mut self,
show_labels: impl Into<crate::components::ShowLabels>,
) -> Self {
self.show_labels = Some(show_labels.into());
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.
#[inline]
pub fn with_draw_order(mut self, draw_order: impl Into<crate::components::DrawOrder>) -> Self {
self.draw_order = Some(draw_order.into());
self
}
/// Optional class Ids for the points.
///
/// The [`components::ClassId`][crate::components::ClassId] provides colors and labels if not specified explicitly.
#[inline]
pub fn with_class_ids(
mut self,
class_ids: impl IntoIterator<Item = impl Into<crate::components::ClassId>>,
) -> Self {
self.class_ids = Some(class_ids.into_iter().map(Into::into).collect());
self
}
/// Optional keypoint IDs for the points, identifying them within a class.
///
/// If keypoint IDs are passed in but no [`components::ClassId`][crate::components::ClassId]s were specified, the [`components::ClassId`][crate::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.
#[inline]
pub fn with_keypoint_ids(
mut self,
keypoint_ids: impl IntoIterator<Item = impl Into<crate::components::KeypointId>>,
) -> Self {
self.keypoint_ids = Some(keypoint_ids.into_iter().map(Into::into).collect());
self
}
}