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
use std::sync::Arc;
use crate::{
ComponentBatch, ComponentName, DeserializationResult, MaybeOwnedComponentBatch,
SerializationResult, _Backtrace,
};
#[allow(unused_imports)] // used in docstrings
use crate::{Component, Loggable, LoggableBatch};
// ---
/// An archetype is a high-level construct that represents a set of [`Component`]s that usually
/// play well with each other (i.e. they compose nicely).
///
/// Internally, it is no different than a collection of components, but working at that higher
/// layer of abstraction opens opportunities for nicer APIs & tools that wouldn't be possible
/// otherwise.
///
/// E.g. consider the `crate::archetypes::Points3D` archetype, which represents the set of
/// components to consider when working with a 3D point cloud within Rerun.
pub trait Archetype {
/// The associated indicator component, whose presence indicates that the high-level
/// archetype-based APIs were used to log the data.
///
/// ## Internal representation
///
/// Indicator components are always unit-length null arrays.
/// Their names follow the pattern `rerun.components.{ArchetypeName}Indicator`, e.g.
/// `rerun.components.Points3DIndicator`.
///
/// Since null arrays aren't actually arrays and we don't actually have any data to shuffle
/// around per-se, we can't implement the usual [`Loggable`] traits.
/// For this reason, indicator components directly implement [`LoggableBatch`] instead, and
/// bypass the entire iterator machinery.
//
// TODO(rust-lang/rust#29661): We'd like to just default this to the right thing which is
// pretty much always `A::Indicator`, but defaults are unstable.
// type Indicator: ComponentBatch = A::Indicator;
type Indicator: 'static + ComponentBatch + Default;
/// The fully-qualified name of this archetype, e.g. `rerun.archetypes.Points2D`.
fn name() -> ArchetypeName;
/// Readable name for displaying in ui.
fn display_name() -> &'static str;
// ---
// TODO(cmc): Should we also generate and return static IntSets?
/// Creates a [`ComponentBatch`] out of the associated [`Self::Indicator`] component.
///
/// This allows for associating arbitrary indicator components with arbitrary data.
/// Check out the `manual_indicator` API example to see what's possible.
#[inline]
fn indicator() -> MaybeOwnedComponentBatch<'static> {
MaybeOwnedComponentBatch::Owned(Box::<<Self as Archetype>::Indicator>::default())
}
/// Returns the names of all components that _must_ be provided by the user when constructing
/// this archetype.
fn required_components() -> std::borrow::Cow<'static, [ComponentName]>;
/// Returns the names of all components that _should_ be provided by the user when constructing
/// this archetype.
#[inline]
fn recommended_components() -> std::borrow::Cow<'static, [ComponentName]> {
std::borrow::Cow::Owned(vec![Self::indicator().name()])
}
/// Returns the names of all components that _may_ be provided by the user when constructing
/// this archetype.
#[inline]
fn optional_components() -> std::borrow::Cow<'static, [ComponentName]> {
std::borrow::Cow::Borrowed(&[])
}
/// Returns the names of all components that must, should and may be provided by the user when
/// constructing this archetype.
///
/// The default implementation always does the right thing, at the cost of some runtime
/// allocations.
/// If you know all your components statically, you can override this method to get rid of the
/// extra allocations.
#[inline]
fn all_components() -> std::borrow::Cow<'static, [ComponentName]> {
[
Self::required_components().into_owned(),
Self::recommended_components().into_owned(),
Self::optional_components().into_owned(),
]
.into_iter()
.flatten()
.collect::<Vec<_>>()
.into()
}
// ---
/// Given an iterator of Arrow arrays and their respective field metadata, deserializes them
/// into this archetype.
///
/// Arrow arrays that are unknown to this [`Archetype`] will simply be ignored and a warning
/// logged to stderr.
#[inline]
fn from_arrow(
data: impl IntoIterator<Item = (arrow2::datatypes::Field, Box<dyn ::arrow2::array::Array>)>,
) -> DeserializationResult<Self>
where
Self: Sized,
{
Self::from_arrow_components(
data.into_iter()
.map(|(field, array)| (field.name.into(), array)),
)
}
/// Given an iterator of Arrow arrays and their respective `ComponentNames`, deserializes them
/// into this archetype.
///
/// Arrow arrays that are unknown to this [`Archetype`] will simply be ignored and a warning
/// logged to stderr.
#[inline]
fn from_arrow_components(
data: impl IntoIterator<Item = (ComponentName, Box<dyn ::arrow2::array::Array>)>,
) -> DeserializationResult<Self>
where
Self: Sized,
{
_ = data; // NOTE: do this here to avoid breaking users' autocomplete snippets
Err(crate::DeserializationError::NotImplemented {
fqname: Self::name().to_string(),
backtrace: _Backtrace::new_unresolved(),
})
}
}
/// Indicates that the archetype has the `attr.rust.generate_field_info`
/// attribute, meaning it will have runtime reflection data available for it.
pub trait ArchetypeReflectionMarker {}
// ---
re_string_interner::declare_new_type!(
/// The fully-qualified name of an [`Archetype`], e.g. `rerun.archetypes.Points3D`.
pub struct ArchetypeName;
);
impl ArchetypeName {
/// Returns the fully-qualified name, e.g. `rerun.archetypes.Points3D`.
///
/// This is the default `Display` implementation for [`ArchetypeName`].
#[inline]
pub fn full_name(&self) -> &'static str {
self.0.as_str()
}
/// Returns the unqualified name, e.g. `Points3D`.
///
/// Used for most UI elements.
///
/// ```
/// # use re_types_core::ArchetypeName;
/// assert_eq!(ArchetypeName::from("rerun.archetypes.Points3D").short_name(), "Points3D");
/// ```
#[inline]
pub fn short_name(&self) -> &'static str {
let full_name = self.0.as_str();
if let Some(short_name) = full_name.strip_prefix("rerun.archetypes.") {
short_name
} else if let Some(short_name) = full_name.strip_prefix("rerun.blueprint.archetypes.") {
short_name
} else if let Some(short_name) = full_name.strip_prefix("rerun.") {
short_name
} else {
full_name
}
}
}
// ---
/// A generic [indicator component] that can be specialized for any [`Archetype`].
///
/// ```ignore
/// type MyArchetypeIndicator = GenericIndicatorComponent<MyArchetype>;
/// ```
///
/// [indicator component]: [`Archetype::Indicator`]
#[derive(Debug, Clone, Copy)]
pub struct GenericIndicatorComponent<A: Archetype> {
_phantom: std::marker::PhantomData<A>,
}
impl<A: Archetype> GenericIndicatorComponent<A> {
pub const DEFAULT: Self = Self {
_phantom: std::marker::PhantomData::<A>,
};
}
impl<A: Archetype> Default for GenericIndicatorComponent<A> {
fn default() -> Self {
Self::DEFAULT
}
}
impl<A: Archetype> crate::LoggableBatch for GenericIndicatorComponent<A> {
type Name = ComponentName;
#[inline]
fn name(&self) -> Self::Name {
format!("{}Indicator", A::name().full_name())
.replace("archetypes", "components")
.into()
}
#[inline]
fn num_instances(&self) -> usize {
1
}
#[inline]
fn arrow_field(&self) -> arrow2::datatypes::Field {
let name = self.name().to_string();
arrow2::datatypes::Field::new(
name.clone(),
arrow2::datatypes::DataType::Extension(
name,
Arc::new(arrow2::datatypes::DataType::Null),
None,
),
false,
)
}
#[inline]
fn to_arrow(&self) -> SerializationResult<Box<dyn arrow2::array::Array>> {
Ok(
arrow2::array::NullArray::new(arrow2::datatypes::DataType::Null, self.num_instances())
.boxed(),
)
}
}
impl<A: Archetype> crate::ComponentBatch for GenericIndicatorComponent<A> {}
// ---
/// An arbitrary named [indicator component].
///
/// [indicator component]: [`Archetype::Indicator`]
#[derive(Debug, Clone, Copy)]
pub struct NamedIndicatorComponent(pub ComponentName);
impl NamedIndicatorComponent {
#[inline]
pub fn as_batch(&self) -> MaybeOwnedComponentBatch<'_> {
MaybeOwnedComponentBatch::Ref(self)
}
#[inline]
pub fn to_batch(self) -> MaybeOwnedComponentBatch<'static> {
MaybeOwnedComponentBatch::Owned(Box::new(self))
}
}
impl crate::LoggableBatch for NamedIndicatorComponent {
type Name = ComponentName;
#[inline]
fn name(&self) -> Self::Name {
self.0
}
#[inline]
fn num_instances(&self) -> usize {
1
}
#[inline]
fn arrow_field(&self) -> arrow2::datatypes::Field {
let name = self.name().to_string();
arrow2::datatypes::Field::new(
name.clone(),
arrow2::datatypes::DataType::Extension(
name,
Arc::new(arrow2::datatypes::DataType::Null),
None,
),
false,
)
}
#[inline]
fn to_arrow(&self) -> SerializationResult<Box<dyn arrow2::array::Array>> {
Ok(
arrow2::array::NullArray::new(arrow2::datatypes::DataType::Null, self.num_instances())
.boxed(),
)
}
}
impl crate::ComponentBatch for NamedIndicatorComponent {}