// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/rust/reflection.rs
#![allow(clippy::too_many_lines)]
#![allow(clippy::wildcard_imports)]
#![allow(unused_imports)]
use re_types::blueprint::components::*;
use re_types::components::*;
use re_types_blueprint::blueprint::components::*;
use re_types_core::components::*;
use re_types_core::{
reflection::{
ArchetypeFieldReflection, ArchetypeReflection, ArchetypeReflectionMap, ComponentReflection,
ComponentReflectionMap, Reflection,
},
ArchetypeName, ComponentName, Loggable, LoggableBatch as _, SerializationError,
};
/// Generates reflection about all known components.
///
/// Call only once and reuse the results.
pub fn generate_reflection() -> Result<Reflection, SerializationError> {
re_tracing::profile_function!();
Ok(Reflection {
components: generate_component_reflection()?,
archetypes: generate_archetype_reflection(),
})
}
/// Generates reflection about all known components.
///
/// Call only once and reuse the results.
fn generate_component_reflection() -> Result<ComponentReflectionMap, SerializationError> {
re_tracing::profile_function!();
let array = [
(
<ActiveTab as Loggable>::name(),
ComponentReflection {
docstring_md: "The active tab in a tabbed container.",
placeholder: Some(ActiveTab::default().to_arrow()?),
},
),
(
<AutoLayout as Loggable>::name(),
ComponentReflection {
docstring_md: "Whether the viewport layout is determined automatically.",
placeholder: Some(AutoLayout::default().to_arrow()?),
},
),
(
<AutoSpaceViews as Loggable>::name(),
ComponentReflection {
docstring_md: "Whether or not space views should be created automatically.",
placeholder: Some(AutoSpaceViews::default().to_arrow()?),
},
),
(
<BackgroundKind as Loggable>::name(),
ComponentReflection {
docstring_md: "The type of the background in a view.",
placeholder: Some(BackgroundKind::default().to_arrow()?),
},
),
(
<ColumnShare as Loggable>::name(),
ComponentReflection {
docstring_md: "The layout share of a column in the container.",
placeholder: Some(ColumnShare::default().to_arrow()?),
},
),
(
<ContainerKind as Loggable>::name(),
ComponentReflection {
docstring_md: "The kind of a blueprint container (tabs, grid, …).",
placeholder: Some(ContainerKind::default().to_arrow()?),
},
),
(
<Corner2D as Loggable>::name(),
ComponentReflection {
docstring_md: "One of four 2D corners, typically used to align objects.",
placeholder: Some(Corner2D::default().to_arrow()?),
},
),
(
<GridColumns as Loggable>::name(),
ComponentReflection {
docstring_md: "How many columns a grid container should have.",
placeholder: Some(GridColumns::default().to_arrow()?),
},
),
(
<IncludedContent as Loggable>::name(),
ComponentReflection {
docstring_md: "All the contents in the container.",
placeholder: Some(IncludedContent::default().to_arrow()?),
},
),
(
<IncludedSpaceView as Loggable>::name(),
ComponentReflection {
docstring_md: "The unique id of a space view, used to refer to views in containers.",
placeholder: Some(IncludedSpaceView::default().to_arrow()?),
},
),
(
<Interactive as Loggable>::name(),
ComponentReflection {
docstring_md: "Whether the entity can be interacted with.\n\nNon interactive components are still visible, but mouse interactions in the view are disabled.",
placeholder: Some(Interactive::default().to_arrow()?),
},
),
(
<LatestAtQueries as Loggable>::name(),
ComponentReflection {
docstring_md: "Configuration for latest at queries.\n\nNote: configuration as saved on a per-timeline basis.",
placeholder: Some(LatestAtQueries::default().to_arrow()?),
},
),
(
<LockRangeDuringZoom as Loggable>::name(),
ComponentReflection {
docstring_md: "Indicate whether the range should be locked when zooming in on the data.\n\nDefault is `false`, i.e. zoom will change the visualized range.",
placeholder: Some(LockRangeDuringZoom::default().to_arrow()?),
},
),
(
<PanelState as Loggable>::name(),
ComponentReflection {
docstring_md: "Tri-state for panel controls.",
placeholder: Some(PanelState::default().to_arrow()?),
},
),
(
<QueryExpression as Loggable>::name(),
ComponentReflection {
docstring_md: "An individual query expression used to filter a set of [`datatypes.EntityPath`](https://rerun.io/docs/reference/types/datatypes/entity_path)s.\n\nEach expression is either an inclusion or an exclusion expression.\nInclusions start with an optional `+` and exclusions must start with a `-`.\n\nMultiple expressions are combined together as part of `SpaceViewContents`.\n\nThe `/**` suffix matches the whole subtree, i.e. self and any child, recursively\n(`/world/**` matches both `/world` and `/world/car/driver`).\nOther uses of `*` are not (yet) supported.",
placeholder: Some(QueryExpression::default().to_arrow()?),
},
),
(
<QueryKind as Loggable>::name(),
ComponentReflection {
docstring_md: "The kind of query displayed by the dataframe view",
placeholder: Some(QueryKind::default().to_arrow()?),
},
),
(
<RootContainer as Loggable>::name(),
ComponentReflection {
docstring_md: "The container that sits at the root of a viewport.",
placeholder: Some(RootContainer::default().to_arrow()?),
},
),
(
<RowShare as Loggable>::name(),
ComponentReflection {
docstring_md: "The layout share of a row in the container.",
placeholder: Some(RowShare::default().to_arrow()?),
},
),
(
<SortKey as Loggable>::name(),
ComponentReflection {
docstring_md: "Primary element by which to group by in a temporal data table.",
placeholder: Some(SortKey::default().to_arrow()?),
},
),
(
<SortOrder as Loggable>::name(),
ComponentReflection {
docstring_md: "Sort order for data table.",
placeholder: Some(SortOrder::default().to_arrow()?),
},
),
(
<SpaceViewClass as Loggable>::name(),
ComponentReflection {
docstring_md: "The class identifier of view, e.g. `\"2D\"`, `\"TextLog\"`, ….",
placeholder: Some(SpaceViewClass::default().to_arrow()?),
},
),
(
<SpaceViewMaximized as Loggable>::name(),
ComponentReflection {
docstring_md: "Whether a space view is maximized.",
placeholder: Some(SpaceViewMaximized::default().to_arrow()?),
},
),
(
<SpaceViewOrigin as Loggable>::name(),
ComponentReflection {
docstring_md: "The origin of a `SpaceView`.",
placeholder: Some(SpaceViewOrigin::default().to_arrow()?),
},
),
(
<TensorDimensionIndexSlider as Loggable>::name(),
ComponentReflection {
docstring_md: "Show a slider for the index of some dimension of a slider.",
placeholder: Some(TensorDimensionIndexSlider::default().to_arrow()?),
},
),
(
<TimeRangeQueries as Loggable>::name(),
ComponentReflection {
docstring_md: "Configuration for time range queries.\n\nNote: configuration as saved on a per-timeline basis.",
placeholder: Some(TimeRangeQueries::default().to_arrow()?),
},
),
(
<TimelineName as Loggable>::name(),
ComponentReflection {
docstring_md: "A timeline identified by its name.",
placeholder: Some(TimelineName::default().to_arrow()?),
},
),
(
<ViewFit as Loggable>::name(),
ComponentReflection {
docstring_md: "Determines whether an image or texture should be scaled to fit the viewport.",
placeholder: Some(ViewFit::default().to_arrow()?),
},
),
(
<ViewerRecommendationHash as Loggable>::name(),
ComponentReflection {
docstring_md: "Hash of a viewer recommendation.\n\nThe formation of this hash is considered an internal implementation detail of the viewer.",
placeholder: Some(ViewerRecommendationHash::default().to_arrow()?),
},
),
(
<Visible as Loggable>::name(),
ComponentReflection {
docstring_md: "Whether the container, view, entity or instance is currently visible.",
placeholder: Some(Visible::default().to_arrow()?),
},
),
(
<VisibleTimeRange as Loggable>::name(),
ComponentReflection {
docstring_md: "The range of values on a given timeline that will be included in a view's query.\n\nRefer to `VisibleTimeRanges` archetype for more information.",
placeholder: Some(VisibleTimeRange::default().to_arrow()?),
},
),
(
<VisualBounds2D as Loggable>::name(),
ComponentReflection {
docstring_md: "Visual bounds in 2D space used for `Spatial2DView`.",
placeholder: Some(VisualBounds2D::default().to_arrow()?),
},
),
(
<VisualizerOverrides as Loggable>::name(),
ComponentReflection {
docstring_md: "Override the visualizers for an entity.\n\nThis component is a stop-gap mechanism based on the current implementation details\nof the visualizer system. It is not intended to be a long-term solution, but provides\nenough utility to be useful in the short term.\n\nThe long-term solution is likely to be based off: <https://github.com/rerun-io/rerun/issues/6626>\n\nThis can only be used as part of blueprints. It will have no effect if used\nin a regular entity.",
placeholder: Some(VisualizerOverrides::default().to_arrow()?),
},
),
(
<AggregationPolicy as Loggable>::name(),
ComponentReflection {
docstring_md: "Policy for aggregation of multiple scalar plot values.\n\nThis is used for lines in plots when the X axis distance of individual points goes below a single pixel,\ni.e. a single pixel covers more than one tick worth of data. It can greatly improve performance\n(and readability) in such situations as it prevents overdraw.",
placeholder: Some(AggregationPolicy::default().to_arrow()?),
},
),
(
<AlbedoFactor as Loggable>::name(),
ComponentReflection {
docstring_md: "A color multiplier, usually applied to a whole entity, e.g. a mesh.",
placeholder: Some(AlbedoFactor::default().to_arrow()?),
},
),
(
<AnnotationContext as Loggable>::name(),
ComponentReflection {
docstring_md: "The annotation context provides additional information on how to display entities.\n\nEntities can use [`datatypes.ClassId`](https://rerun.io/docs/reference/types/datatypes/class_id)s and [`datatypes.KeypointId`](https://rerun.io/docs/reference/types/datatypes/keypoint_id)s to provide annotations, and\nthe labels and colors will be looked up in the appropriate\nannotation context. We use the *first* annotation context we find in the\npath-hierarchy when searching up through the ancestors of a given entity\npath.",
placeholder: Some(AnnotationContext::default().to_arrow()?),
},
),
(
<AxisLength as Loggable>::name(),
ComponentReflection {
docstring_md: "The length of an axis in local units of the space.",
placeholder: Some(AxisLength::default().to_arrow()?),
},
),
(
<Blob as Loggable>::name(),
ComponentReflection {
docstring_md: "A binary blob of data.",
placeholder: Some(Blob::default().to_arrow()?),
},
),
(
<ClassId as Loggable>::name(),
ComponentReflection {
docstring_md: "A 16-bit ID representing a type of semantic class.",
placeholder: Some(ClassId::default().to_arrow()?),
},
),
(
<ClearIsRecursive as Loggable>::name(),
ComponentReflection {
docstring_md: "Configures how a clear operation should behave - recursive or not.",
placeholder: Some(ClearIsRecursive::default().to_arrow()?),
},
),
(
<Color as Loggable>::name(),
ComponentReflection {
docstring_md: "An RGBA color with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.\n\nThe color is stored as a 32-bit integer, where the most significant\nbyte is `R` and the least significant byte is `A`.",
placeholder: Some(Color::default().to_arrow()?),
},
),
(
<Colormap as Loggable>::name(),
ComponentReflection {
docstring_md: "Colormap for mapping scalar values within a given range to a color.\n\nThis provides a number of popular pre-defined colormaps.\nIn the future, the Rerun Viewer will allow users to define their own colormaps,\nbut currently the Viewer is limited to the types defined here.",
placeholder: Some(Colormap::default().to_arrow()?),
},
),
(
<DepthMeter as Loggable>::name(),
ComponentReflection {
docstring_md: "The world->depth map scaling factor.\n\nThis measures how many depth map units are in a world unit.\nFor instance, if a depth map uses millimeters and the world uses meters,\nthis value would be `1000`.\n\nNote that the only effect on 2D views is the physical depth values shown when hovering the image.\nIn 3D views on the other hand, this affects where the points of the point cloud are placed.",
placeholder: Some(DepthMeter::default().to_arrow()?),
},
),
(
<DisconnectedSpace as Loggable>::name(),
ComponentReflection {
docstring_md: "Spatially disconnect this entity from its parent.\n\nSpecifies that the entity path at which this is logged is spatially disconnected from its parent,\nmaking it impossible to transform the entity path into its parent's space and vice versa.\nIt *only* applies to space views that work with spatial transformations, i.e. 2D & 3D space views.\nThis is useful for specifying that a subgraph is independent of the rest of the scene.",
placeholder: Some(DisconnectedSpace::default().to_arrow()?),
},
),
(
<DrawOrder as Loggable>::name(),
ComponentReflection {
docstring_md: "Draw order of 2D elements. Higher values are drawn on top of lower values.\n\nAn entity can have only a single draw order component.\nWithin an entity draw order is governed by the order of the components.\n\nDraw order for entities with the same draw order is generally undefined.",
placeholder: Some(DrawOrder::default().to_arrow()?),
},
),
(
<FillMode as Loggable>::name(),
ComponentReflection {
docstring_md: "How a geometric shape is drawn and colored.",
placeholder: Some(FillMode::default().to_arrow()?),
},
),
(
<FillRatio as Loggable>::name(),
ComponentReflection {
docstring_md: "How much a primitive fills out the available space.\n\nUsed for instance to scale the points of the point cloud created from [`archetypes.DepthImage`](https://rerun.io/docs/reference/types/archetypes/depth_image) projection in 3D views.\nValid range is from 0 to max float although typically values above 1.0 are not useful.\n\nDefaults to 1.0.",
placeholder: Some(FillRatio::default().to_arrow()?),
},
),
(
<GammaCorrection as Loggable>::name(),
ComponentReflection {
docstring_md: "A gamma correction value to be used with a scalar value or color.\n\nUsed to adjust the gamma of a color or scalar value between 0 and 1 before rendering.\n`new_value = old_value ^ gamma`\n\nValid range is from 0 (excluding) to max float.\nDefaults to 1.0 unless otherwise specified.",
placeholder: Some(GammaCorrection::default().to_arrow()?),
},
),
(
<HalfSize2D as Loggable>::name(),
ComponentReflection {
docstring_md: "Half-size (radius) of a 2D box.\n\nMeasured in its local coordinate system.\n\nThe box extends both in negative and positive direction along each axis.\nNegative sizes indicate that the box is flipped along the respective axis, but this has no effect on how it is displayed.",
placeholder: Some(HalfSize2D::default().to_arrow()?),
},
),
(
<HalfSize3D as Loggable>::name(),
ComponentReflection {
docstring_md: "Half-size (radius) of a 3D box.\n\nMeasured in its local coordinate system.\n\nThe box extends both in negative and positive direction along each axis.\nNegative sizes indicate that the box is flipped along the respective axis, but this has no effect on how it is displayed.",
placeholder: Some(HalfSize3D::default().to_arrow()?),
},
),
(
<ImageBuffer as Loggable>::name(),
ComponentReflection {
docstring_md: "A buffer that is known to store image data.\n\nTo interpret the contents of this buffer, see, [`components.ImageFormat`](https://rerun.io/docs/reference/types/components/image_format).",
placeholder: Some(ImageBuffer::default().to_arrow()?),
},
),
(
<ImageFormat as Loggable>::name(),
ComponentReflection {
docstring_md: "The metadata describing the contents of a [`components.ImageBuffer`](https://rerun.io/docs/reference/types/components/image_buffer).",
placeholder: Some(ImageFormat::default().to_arrow()?),
},
),
(
<ImagePlaneDistance as Loggable>::name(),
ComponentReflection {
docstring_md: "The distance from the camera origin to the image plane when the projection is shown in a 3D viewer.\n\nThis is only used for visualization purposes, and does not affect the projection itself.",
placeholder: Some(ImagePlaneDistance::default().to_arrow()?),
},
),
(
<KeypointId as Loggable>::name(),
ComponentReflection {
docstring_md: "A 16-bit ID representing a type of semantic keypoint within a class.",
placeholder: Some(KeypointId::default().to_arrow()?),
},
),
(
<LineStrip2D as Loggable>::name(),
ComponentReflection {
docstring_md: "A line strip in 2D space.\n\nA line strip is a list of points connected by line segments. It can be used to draw\napproximations of smooth curves.\n\nThe points will be connected in order, like so:\n```text\n 2------3 5\n / \\ /\n0----1 \\ /\n 4\n```",
placeholder: Some(LineStrip2D::default().to_arrow()?),
},
),
(
<LineStrip3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A line strip in 3D space.\n\nA line strip is a list of points connected by line segments. It can be used to draw\napproximations of smooth curves.\n\nThe points will be connected in order, like so:\n```text\n 2------3 5\n / \\ /\n0----1 \\ /\n 4\n```",
placeholder: Some(LineStrip3D::default().to_arrow()?),
},
),
(
<MagnificationFilter as Loggable>::name(),
ComponentReflection {
docstring_md: "Filter used when magnifying an image/texture such that a single pixel/texel is displayed as multiple pixels on screen.",
placeholder: Some(MagnificationFilter::default().to_arrow()?),
},
),
(
<MarkerShape as Loggable>::name(),
ComponentReflection {
docstring_md: "The visual appearance of a point in e.g. a 2D plot.",
placeholder: Some(MarkerShape::default().to_arrow()?),
},
),
(
<MarkerSize as Loggable>::name(),
ComponentReflection {
docstring_md: "Radius of a marker of a point in e.g. a 2D plot, measured in UI points.",
placeholder: Some(MarkerSize::default().to_arrow()?),
},
),
(
<MediaType as Loggable>::name(),
ComponentReflection {
docstring_md: "A standardized media type (RFC2046, formerly known as MIME types), encoded as a string.\n\nThe complete reference of officially registered media types is maintained by the IANA and can be\nconsulted at <https://www.iana.org/assignments/media-types/media-types.xhtml>.",
placeholder: Some(MediaType::default().to_arrow()?),
},
),
(
<Name as Loggable>::name(),
ComponentReflection {
docstring_md: "A display name, typically for an entity or a item like a plot series.",
placeholder: Some(Name::default().to_arrow()?),
},
),
(
<Opacity as Loggable>::name(),
ComponentReflection {
docstring_md: "Degree of transparency ranging from 0.0 (fully transparent) to 1.0 (fully opaque).\n\nThe final opacity value may be a result of multiplication with alpha values as specified by other color sources.\nUnless otherwise specified, the default value is 1.",
placeholder: Some(Opacity::default().to_arrow()?),
},
),
(
<PinholeProjection as Loggable>::name(),
ComponentReflection {
docstring_md: "Camera projection, from image coordinates to view coordinates.\n\nChild from parent.\nImage coordinates from camera view coordinates.\n\nExample:\n```text\n1496.1 0.0 980.5\n 0.0 1496.1 744.5\n 0.0 0.0 1.0\n```",
placeholder: Some(PinholeProjection::default().to_arrow()?),
},
),
(
<PoseRotationAxisAngle as Loggable>::name(),
ComponentReflection {
docstring_md: "3D rotation represented by a rotation around a given axis that doesn't propagate in the transform hierarchy.",
placeholder: Some(PoseRotationAxisAngle::default().to_arrow()?),
},
),
(
<PoseRotationQuat as Loggable>::name(),
ComponentReflection {
docstring_md: "A 3D rotation expressed as a quaternion that doesn't propagate in the transform hierarchy.\n\nNote: although the x,y,z,w components of the quaternion will be passed through to the\ndatastore as provided, when used in the Viewer, quaternions will always be normalized.",
placeholder: Some(PoseRotationQuat::default().to_arrow()?),
},
),
(
<PoseScale3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A 3D scale factor that doesn't propagate in the transform hierarchy.\n\nA scale of 1.0 means no scaling.\nA scale of 2.0 means doubling the size.\nEach component scales along the corresponding axis.",
placeholder: Some(PoseScale3D::default().to_arrow()?),
},
),
(
<PoseTransformMat3x3 as Loggable>::name(),
ComponentReflection {
docstring_md: "A 3x3 transformation matrix Matrix that doesn't propagate in the transform hierarchy.\n\n3x3 matrixes are able to represent any affine transformation in 3D space,\ni.e. rotation, scaling, shearing, reflection etc.\n\nMatrices in Rerun are stored as flat list of coefficients in column-major order:\n```text\n column 0 column 1 column 2\n -------------------------------------------------\nrow 0 | flat_columns[0] flat_columns[3] flat_columns[6]\nrow 1 | flat_columns[1] flat_columns[4] flat_columns[7]\nrow 2 | flat_columns[2] flat_columns[5] flat_columns[8]\n```",
placeholder: Some(PoseTransformMat3x3::default().to_arrow()?),
},
),
(
<PoseTranslation3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A translation vector in 3D space that doesn't propagate in the transform hierarchy.",
placeholder: Some(PoseTranslation3D::default().to_arrow()?),
},
),
(
<Position2D as Loggable>::name(),
ComponentReflection {
docstring_md: "A position in 2D space.",
placeholder: Some(Position2D::default().to_arrow()?),
},
),
(
<Position3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A position in 3D space.",
placeholder: Some(Position3D::default().to_arrow()?),
},
),
(
<Radius as Loggable>::name(),
ComponentReflection {
docstring_md: "The radius of something, e.g. a point.\n\nInternally, positive values indicate scene units, whereas negative values\nare interpreted as UI points.\n\nUI points are independent of zooming in Views, but are sensitive to the application UI scaling.\nat 100% UI scaling, UI points are equal to pixels\nThe Viewer's UI scaling defaults to the OS scaling which typically is 100% for full HD screens and 200% for 4k screens.",
placeholder: Some(Radius::default().to_arrow()?),
},
),
(
<Range1D as Loggable>::name(),
ComponentReflection {
docstring_md: "A 1D range, specifying a lower and upper bound.",
placeholder: Some(Range1D::default().to_arrow()?),
},
),
(
<Resolution as Loggable>::name(),
ComponentReflection {
docstring_md: "Pixel resolution width & height, e.g. of a camera sensor.\n\nTypically in integer units, but for some use cases floating point may be used.",
placeholder: Some(Resolution::default().to_arrow()?),
},
),
(
<RotationAxisAngle as Loggable>::name(),
ComponentReflection {
docstring_md: "3D rotation represented by a rotation around a given axis.",
placeholder: Some(RotationAxisAngle::default().to_arrow()?),
},
),
(
<RotationQuat as Loggable>::name(),
ComponentReflection {
docstring_md: "A 3D rotation expressed as a quaternion.\n\nNote: although the x,y,z,w components of the quaternion will be passed through to the\ndatastore as provided, when used in the Viewer, quaternions will always be normalized.",
placeholder: Some(RotationQuat::default().to_arrow()?),
},
),
(
<Scalar as Loggable>::name(),
ComponentReflection {
docstring_md: "A scalar value, encoded as a 64-bit floating point.\n\nUsed for time series plots.",
placeholder: Some(Scalar::default().to_arrow()?),
},
),
(
<Scale3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A 3D scale factor.\n\nA scale of 1.0 means no scaling.\nA scale of 2.0 means doubling the size.\nEach component scales along the corresponding axis.",
placeholder: Some(Scale3D::default().to_arrow()?),
},
),
(
<StrokeWidth as Loggable>::name(),
ComponentReflection {
docstring_md: "The width of a stroke specified in UI points.",
placeholder: Some(StrokeWidth::default().to_arrow()?),
},
),
(
<TensorData as Loggable>::name(),
ComponentReflection {
docstring_md: "An N-dimensional array of numbers.\n\nThe number of dimensions and their respective lengths is specified by the `shape` field.\nThe dimensions are ordered from outermost to innermost. For example, in the common case of\na 2D RGB Image, the shape would be `[height, width, channel]`.\n\nThese dimensions are combined with an index to look up values from the `buffer` field,\nwhich stores a contiguous array of typed values.",
placeholder: Some(TensorData::default().to_arrow()?),
},
),
(
<TensorDimensionIndexSelection as Loggable>::name(),
ComponentReflection {
docstring_md: "Specifies a concrete index on a tensor dimension.",
placeholder: Some(TensorDimensionIndexSelection::default().to_arrow()?),
},
),
(
<TensorHeightDimension as Loggable>::name(),
ComponentReflection {
docstring_md: "Specifies which dimension to use for height.",
placeholder: Some(TensorHeightDimension::default().to_arrow()?),
},
),
(
<TensorWidthDimension as Loggable>::name(),
ComponentReflection {
docstring_md: "Specifies which dimension to use for width.",
placeholder: Some(TensorWidthDimension::default().to_arrow()?),
},
),
(
<Texcoord2D as Loggable>::name(),
ComponentReflection {
docstring_md: "A 2D texture UV coordinate.\n\nTexture coordinates specify a position on a 2D texture.\nA range from 0-1 covers the entire texture in the respective dimension.\nUnless configured otherwise, the texture repeats outside of this range.\nRerun uses top-left as the origin for UV coordinates.\n\n 0 U 1\n0 + --------- →\n | .\nV | .\n | .\n1 ↓ . . . . . .\n\nThis is the same convention as in Vulkan/Metal/DX12/WebGPU, but (!) unlike OpenGL,\nwhich places the origin at the bottom-left.",
placeholder: Some(Texcoord2D::default().to_arrow()?),
},
),
(
<Text as Loggable>::name(),
ComponentReflection {
docstring_md: "A string of text, e.g. for labels and text documents.",
placeholder: Some(Text::default().to_arrow()?),
},
),
(
<TextLogLevel as Loggable>::name(),
ComponentReflection {
docstring_md: "The severity level of a text log message.\n\nRecommended to be one of:\n* `\"CRITICAL\"`\n* `\"ERROR\"`\n* `\"WARN\"`\n* `\"INFO\"`\n* `\"DEBUG\"`\n* `\"TRACE\"`",
placeholder: Some(TextLogLevel::default().to_arrow()?),
},
),
(
<TransformMat3x3 as Loggable>::name(),
ComponentReflection {
docstring_md: "A 3x3 transformation matrix Matrix.\n\n3x3 matrixes are able to represent any affine transformation in 3D space,\ni.e. rotation, scaling, shearing, reflection etc.\n\nMatrices in Rerun are stored as flat list of coefficients in column-major order:\n```text\n column 0 column 1 column 2\n -------------------------------------------------\nrow 0 | flat_columns[0] flat_columns[3] flat_columns[6]\nrow 1 | flat_columns[1] flat_columns[4] flat_columns[7]\nrow 2 | flat_columns[2] flat_columns[5] flat_columns[8]\n```",
placeholder: Some(TransformMat3x3::default().to_arrow()?),
},
),
(
<TransformRelation as Loggable>::name(),
ComponentReflection {
docstring_md: "Specifies relation a spatial transform describes.",
placeholder: Some(TransformRelation::default().to_arrow()?),
},
),
(
<Translation3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A translation vector in 3D space.",
placeholder: Some(Translation3D::default().to_arrow()?),
},
),
(
<TriangleIndices as Loggable>::name(),
ComponentReflection {
docstring_md: "The three indices of a triangle in a triangle mesh.",
placeholder: Some(TriangleIndices::default().to_arrow()?),
},
),
(
<Vector2D as Loggable>::name(),
ComponentReflection {
docstring_md: "A vector in 2D space.",
placeholder: Some(Vector2D::default().to_arrow()?),
},
),
(
<Vector3D as Loggable>::name(),
ComponentReflection {
docstring_md: "A vector in 3D space.",
placeholder: Some(Vector3D::default().to_arrow()?),
},
),
(
<ViewCoordinates as Loggable>::name(),
ComponentReflection {
docstring_md: "How we interpret the coordinate system of an entity/space.\n\nFor instance: What is \"up\"? What does the Z axis mean? Is this right-handed or left-handed?\n\nThe three coordinates are always ordered as [x, y, z].\n\nFor example [Right, Down, Forward] means that the X axis points to the right, the Y axis points\ndown, and the Z axis points forward.\n\nThe following constants are used to represent the different directions:\n * Up = 1\n * Down = 2\n * Right = 3\n * Left = 4\n * Forward = 5\n * Back = 6",
placeholder: Some(ViewCoordinates::default().to_arrow()?),
},
),
];
Ok(ComponentReflectionMap::from_iter(array))
}
/// Generates reflection about all known archetypes.
///
/// Call only once and reuse the results.
fn generate_archetype_reflection() -> ArchetypeReflectionMap {
re_tracing::profile_function!();
let array = [
(
ArchetypeName::new("rerun.archetypes.InstancePoses3D"),
ArchetypeReflection {
display_name: "Instance poses 3D",
docstring_md: "One or more transforms between the current entity and its parent. Unlike [`archetypes.Transform3D`](https://rerun.io/docs/reference/types/archetypes/transform3d), it is *not* propagated in the transform hierarchy.\n\nIf both [`archetypes.InstancePoses3D`](https://rerun.io/docs/reference/types/archetypes/instance_poses3d) and [`archetypes.Transform3D`](https://rerun.io/docs/reference/types/archetypes/transform3d) are present,\nfirst the tree propagating [`archetypes.Transform3D`](https://rerun.io/docs/reference/types/archetypes/transform3d) is applied, then [`archetypes.InstancePoses3D`](https://rerun.io/docs/reference/types/archetypes/instance_poses3d).\n\nCurrently, many visualizers support only a single instance transform per entity.\nCheck archetype documentations for details - if not otherwise specified, only the first instance transform is applied.\n\nFrom the point of view of the entity's coordinate system,\nall components are applied in the inverse order they are listed here.\nE.g. if both a translation and a max3x3 transform are present,\nthe 3x3 matrix is applied first, followed by the translation.\n\n## Example\n\n### Regular & instance transforms in tandem\n```ignore\nuse rerun::{\n demo_util::grid,\n external::{anyhow, glam},\n};\n\nfn main() -> anyhow::Result<()> {\n let rec =\n rerun::RecordingStreamBuilder::new(\"rerun_example_instance_pose3d_combined\").spawn()?;\n\n rec.set_time_sequence(\"frame\", 0);\n\n // Log a box and points further down in the hierarchy.\n rec.log(\n \"world/box\",\n &rerun::Boxes3D::from_half_sizes([[1.0, 1.0, 1.0]]),\n )?;\n rec.log(\n \"world/box/points\",\n &rerun::Points3D::new(grid(glam::Vec3::splat(-10.0), glam::Vec3::splat(10.0), 10)),\n )?;\n\n for i in 0..180 {\n rec.set_time_sequence(\"frame\", i);\n\n // Log a regular transform which affects both the box and the points.\n rec.log(\n \"world/box\",\n &rerun::Transform3D::from_rotation(rerun::RotationAxisAngle {\n axis: [0.0, 0.0, 1.0].into(),\n angle: rerun::Angle::from_degrees(i as f32 * 2.0),\n }),\n )?;\n\n // Log an instance pose which affects only the box.\n let translation = [0.0, 0.0, (i as f32 * 0.1 - 5.0).abs() - 5.0];\n rec.log(\n \"world/box\",\n &rerun::InstancePoses3D::new().with_translations([translation]),\n )?;\n }\n\n Ok(())\n}\n```\n<center>\n<picture>\n <source media=\"(max-width: 480px)\" srcset=\"https://static.rerun.io/leaf_transform3d/41674f0082d6de489f8a1cd1583f60f6b5820ddf/480w.png\">\n <source media=\"(max-width: 768px)\" srcset=\"https://static.rerun.io/leaf_transform3d/41674f0082d6de489f8a1cd1583f60f6b5820ddf/768w.png\">\n <source media=\"(max-width: 1024px)\" srcset=\"https://static.rerun.io/leaf_transform3d/41674f0082d6de489f8a1cd1583f60f6b5820ddf/1024w.png\">\n <source media=\"(max-width: 1200px)\" srcset=\"https://static.rerun.io/leaf_transform3d/41674f0082d6de489f8a1cd1583f60f6b5820ddf/1200w.png\">\n <img src=\"https://static.rerun.io/leaf_transform3d/41674f0082d6de489f8a1cd1583f60f6b5820ddf/full.png\" width=\"640\">\n</picture>\n</center>",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.components.PoseTranslation3D".into(), display_name :
"Translations", docstring_md : "Translation vectors.", },
ArchetypeFieldReflection { component_name :
"rerun.components.PoseRotationAxisAngle".into(), display_name :
"Rotation axis angles", docstring_md : "Rotations via axis + angle.",
}, ArchetypeFieldReflection { component_name :
"rerun.components.PoseRotationQuat".into(), display_name :
"Quaternions", docstring_md : "Rotations via quaternion.", },
ArchetypeFieldReflection { component_name :
"rerun.components.PoseScale3D".into(), display_name : "Scales",
docstring_md : "Scaling factors.", }, ArchetypeFieldReflection {
component_name : "rerun.components.PoseTransformMat3x3".into(),
display_name : "Mat 3x 3", docstring_md :
"3x3 transformation matrices.", },
],
},
),
(
ArchetypeName::new("rerun.archetypes.Transform3D"),
ArchetypeReflection {
display_name: "Transform 3D",
docstring_md: "A transform between two 3D spaces, i.e. a pose.\n\nFrom the point of view of the entity's coordinate system,\nall components are applied in the inverse order they are listed here.\nE.g. if both a translation and a max3x3 transform are present,\nthe 3x3 matrix is applied first, followed by the translation.\n\nWhenever you log this archetype, it will write all components, even if you do not explicitly set them.\nThis means that if you first log a transform with only a translation, and then log one with only a rotation,\nit will be resolved to a transform with only a rotation.\n\n## Examples\n\n### Variety of 3D transforms\n```ignore\nuse std::f32::consts::TAU;\n\nfn main() -> Result<(), Box<dyn std::error::Error>> {\n let rec = rerun::RecordingStreamBuilder::new(\"rerun_example_transform3d\").spawn()?;\n\n let arrow = rerun::Arrows3D::from_vectors([(0.0, 1.0, 0.0)]).with_origins([(0.0, 0.0, 0.0)]);\n\n rec.log(\"base\", &arrow)?;\n\n rec.log(\n \"base/translated\",\n &rerun::Transform3D::from_translation([1.0, 0.0, 0.0]),\n )?;\n\n rec.log(\"base/translated\", &arrow)?;\n\n rec.log(\n \"base/rotated_scaled\",\n &rerun::Transform3D::from_rotation_scale(\n rerun::RotationAxisAngle::new([0.0, 0.0, 1.0], rerun::Angle::from_radians(TAU / 8.0)),\n rerun::Scale3D::from(2.0),\n ),\n )?;\n\n rec.log(\"base/rotated_scaled\", &arrow)?;\n\n Ok(())\n}\n```\n<center>\n<picture>\n <source media=\"(max-width: 480px)\" srcset=\"https://static.rerun.io/transform3d_simple/141368b07360ce3fcb1553079258ae3f42bdb9ac/480w.png\">\n <source media=\"(max-width: 768px)\" srcset=\"https://static.rerun.io/transform3d_simple/141368b07360ce3fcb1553079258ae3f42bdb9ac/768w.png\">\n <source media=\"(max-width: 1024px)\" srcset=\"https://static.rerun.io/transform3d_simple/141368b07360ce3fcb1553079258ae3f42bdb9ac/1024w.png\">\n <source media=\"(max-width: 1200px)\" srcset=\"https://static.rerun.io/transform3d_simple/141368b07360ce3fcb1553079258ae3f42bdb9ac/1200w.png\">\n <img src=\"https://static.rerun.io/transform3d_simple/141368b07360ce3fcb1553079258ae3f42bdb9ac/full.png\" width=\"640\">\n</picture>\n</center>\n\n### Transform hierarchy\n```ignore\nfn main() -> Result<(), Box<dyn std::error::Error>> {\n let rec = rerun::RecordingStreamBuilder::new(\"rerun_example_transform3d_hierarchy\").spawn()?;\n\n // TODO(#5521): log two space views as in the python example\n\n rec.set_time_seconds(\"sim_time\", 0.0);\n\n // Planetary motion is typically in the XY plane.\n rec.log_static(\"/\", &rerun::ViewCoordinates::RIGHT_HAND_Z_UP)?;\n\n // Setup points, all are in the center of their own space:\n rec.log(\n \"sun\",\n &rerun::Points3D::new([[0.0, 0.0, 0.0]])\n .with_radii([1.0])\n .with_colors([rerun::Color::from_rgb(255, 200, 10)]),\n )?;\n rec.log(\n \"sun/planet\",\n &rerun::Points3D::new([[0.0, 0.0, 0.0]])\n .with_radii([0.4])\n .with_colors([rerun::Color::from_rgb(40, 80, 200)]),\n )?;\n rec.log(\n \"sun/planet/moon\",\n &rerun::Points3D::new([[0.0, 0.0, 0.0]])\n .with_radii([0.15])\n .with_colors([rerun::Color::from_rgb(180, 180, 180)]),\n )?;\n\n // Draw fixed paths where the planet & moon move.\n let d_planet = 6.0;\n let d_moon = 3.0;\n let angles = (0..=100).map(|i| i as f32 * 0.01 * std::f32::consts::TAU);\n let circle: Vec<_> = angles.map(|angle| [angle.sin(), angle.cos()]).collect();\n rec.log(\n \"sun/planet_path\",\n &rerun::LineStrips3D::new([rerun::LineStrip3D::from_iter(\n circle\n .iter()\n .map(|p| [p[0] * d_planet, p[1] * d_planet, 0.0]),\n )]),\n )?;\n rec.log(\n \"sun/planet/moon_path\",\n &rerun::LineStrips3D::new([rerun::LineStrip3D::from_iter(\n circle.iter().map(|p| [p[0] * d_moon, p[1] * d_moon, 0.0]),\n )]),\n )?;\n\n // Movement via transforms.\n for i in 0..(6 * 120) {\n let time = i as f32 / 120.0;\n rec.set_time_seconds(\"sim_time\", time);\n let r_moon = time * 5.0;\n let r_planet = time * 2.0;\n\n rec.log(\n \"sun/planet\",\n &rerun::Transform3D::from_translation_rotation(\n [r_planet.sin() * d_planet, r_planet.cos() * d_planet, 0.0],\n rerun::RotationAxisAngle {\n axis: [1.0, 0.0, 0.0].into(),\n angle: rerun::Angle::from_degrees(20.0),\n },\n ),\n )?;\n rec.log(\n \"sun/planet/moon\",\n &rerun::Transform3D::from_translation([\n r_moon.cos() * d_moon,\n r_moon.sin() * d_moon,\n 0.0,\n ])\n .with_relation(rerun::TransformRelation::ChildFromParent),\n )?;\n }\n\n Ok(())\n}\n```\n<center>\n<picture>\n <source media=\"(max-width: 480px)\" srcset=\"https://static.rerun.io/transform_hierarchy/cb7be7a5a31fcb2efc02ba38e434849248f87554/480w.png\">\n <source media=\"(max-width: 768px)\" srcset=\"https://static.rerun.io/transform_hierarchy/cb7be7a5a31fcb2efc02ba38e434849248f87554/768w.png\">\n <source media=\"(max-width: 1024px)\" srcset=\"https://static.rerun.io/transform_hierarchy/cb7be7a5a31fcb2efc02ba38e434849248f87554/1024w.png\">\n <source media=\"(max-width: 1200px)\" srcset=\"https://static.rerun.io/transform_hierarchy/cb7be7a5a31fcb2efc02ba38e434849248f87554/1200w.png\">\n <img src=\"https://static.rerun.io/transform_hierarchy/cb7be7a5a31fcb2efc02ba38e434849248f87554/full.png\" width=\"640\">\n</picture>\n</center>",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.components.Translation3D".into(), display_name :
"Translation", docstring_md : "Translation vector.", },
ArchetypeFieldReflection { component_name :
"rerun.components.RotationAxisAngle".into(), display_name :
"Rotation axis angle", docstring_md : "Rotation via axis + angle.",
}, ArchetypeFieldReflection { component_name :
"rerun.components.RotationQuat".into(), display_name : "Quaternion",
docstring_md : "Rotation via quaternion.", },
ArchetypeFieldReflection { component_name :
"rerun.components.Scale3D".into(), display_name : "Scale",
docstring_md : "Scaling factor.", }, ArchetypeFieldReflection {
component_name : "rerun.components.TransformMat3x3".into(),
display_name : "Mat 3x 3", docstring_md :
"3x3 transformation matrix.", }, ArchetypeFieldReflection {
component_name : "rerun.components.TransformRelation".into(),
display_name : "Relation", docstring_md :
"Specifies the relation this transform establishes between this entity and its parent.",
}, ArchetypeFieldReflection { component_name :
"rerun.components.AxisLength".into(), display_name : "Axis length",
docstring_md :
"Visual length of the 3 axes.\n\nThe length is interpreted in the local coordinate system of the transform.\nIf the transform is scaled, the axes will be scaled accordingly.",
},
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.Background"),
ArchetypeReflection {
display_name: "Background",
docstring_md: "Configuration for the background of a view.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.BackgroundKind".into(), display_name :
"Kind", docstring_md : "The type of the background.", },
ArchetypeFieldReflection { component_name : "rerun.components.Color"
.into(), display_name : "Color", docstring_md :
"Color used for the `SolidColor` background type.", },
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.DataframeQuery"),
ArchetypeReflection {
display_name: "Dataframe query",
docstring_md: "The query for the dataframe view.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.TimelineName".into(), display_name :
"Timeline", docstring_md :
"The timeline for this query.\n\nIf unset, use the time panel's timeline and a latest at query, ignoring all other components of this archetype.",
}, ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.QueryKind".into(), display_name : "Kind",
docstring_md : "Kind of query: latest-at or range.", },
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.LatestAtQueries".into(), display_name :
"Latest at queries", docstring_md :
"Configuration for latest-at queries.\n\nNote: configuration as saved on a per-timeline basis.",
}, ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.TimeRangeQueries".into(), display_name :
"Time range queries", docstring_md :
"Configuration for the time range queries.\n\nNote: configuration as saved on a per-timeline basis.",
},
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.PlotLegend"),
ArchetypeReflection {
display_name: "Plot legend",
docstring_md: "Configuration for the legend of a plot.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.Corner2D".into(), display_name :
"Corner", docstring_md :
"To what corner the legend is aligned.\n\nDefaults to the right bottom corner.",
}, ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.Visible".into(), display_name :
"Visible", docstring_md :
"Whether the legend is shown at all.\n\nTrue by default.", },
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.ScalarAxis"),
ArchetypeReflection {
display_name: "Scalar axis",
docstring_md: "Configuration for the scalar axis of a plot.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.components.Range1D".into(), display_name : "Range",
docstring_md :
"The range of the axis.\n\nIf unset, the range well be automatically determined based on the queried data.",
}, ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.LockRangeDuringZoom".into(), display_name
: "Zoom lock", docstring_md :
"If enabled, the Y axis range will remain locked to the specified range when zooming.",
},
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.TensorScalarMapping"),
ArchetypeReflection {
display_name: "Tensor scalar mapping",
docstring_md: "Configures how tensor scalars are mapped to color.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.components.MagnificationFilter".into(), display_name :
"Mag filter", docstring_md :
"Filter used when zooming in on the tensor.\n\nNote that the filter is applied to the scalar values *before* they are mapped to color.",
}, ArchetypeFieldReflection { component_name :
"rerun.components.Colormap".into(), display_name : "Colormap",
docstring_md : "How scalar values map to colors.", },
ArchetypeFieldReflection { component_name :
"rerun.components.GammaCorrection".into(), display_name : "Gamma",
docstring_md :
"Gamma exponent applied to normalized values before mapping to color.\n\nRaises the normalized values to the power of this value before mapping to color.\nActs like an inverse brightness. Defaults to 1.0.",
},
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.TensorSliceSelection"),
ArchetypeReflection {
display_name: "Tensor slice selection",
docstring_md: "Specifies a 2D slice of a tensor.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.components.TensorWidthDimension".into(), display_name :
"Width", docstring_md :
"Which dimension to map to width.\n\nIf not specified, the height will be determined automatically based on the name and index of the dimension.",
}, ArchetypeFieldReflection { component_name :
"rerun.components.TensorHeightDimension".into(), display_name :
"Height", docstring_md :
"Which dimension to map to height.\n\nIf not specified, the height will be determined automatically based on the name and index of the dimension.",
}, ArchetypeFieldReflection { component_name :
"rerun.components.TensorDimensionIndexSelection".into(), display_name
: "Indices", docstring_md :
"Selected indices for all other dimensions.\n\nIf any of the here listed dimensions is equal to `width` or `height`, it will be ignored.",
}, ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.TensorDimensionIndexSlider".into(),
display_name : "Slider", docstring_md :
"Any dimension listed here will have a slider for the index.\n\nEdits to the sliders will directly manipulate dimensions on the `indices` list.\nIf any of the here listed dimensions is equal to `width` or `height`, it will be ignored.\nIf not specified, adds slides for any dimension in `indices`.",
},
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.TensorViewFit"),
ArchetypeReflection {
display_name: "Tensor view fit",
docstring_md: "Configures how a selected tensor slice is shown on screen.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.ViewFit".into(), display_name :
"Scaling", docstring_md : "How the image is scaled to fit the view.",
},
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.TimeRangeTableOrder"),
ArchetypeReflection {
display_name: "Time range table order",
docstring_md: "Ordering of the time range table of the dataframe view",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.SortKey".into(), display_name :
"Sort key", docstring_md : "The primary sort key", },
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.SortOrder".into(), display_name :
"Sort order", docstring_md : "The sort order", },
],
},
),
(
ArchetypeName::new("rerun.blueprint.archetypes.VisualBounds2D"),
ArchetypeReflection {
display_name: "Visual bounds 2D",
docstring_md: "Controls the visual bounds of a 2D view.\n\nEverything within these bounds are guaranteed to be visible.\nSomethings outside of these bounds may also be visible due to letterboxing.\n\nIf no visual bounds are set, it will be determined automatically,\nbased on the bounding-box of the data or other camera information present in the view.",
fields: vec![
ArchetypeFieldReflection { component_name :
"rerun.blueprint.components.VisualBounds2D".into(), display_name :
"Range", docstring_md :
"Controls the visible range of a 2D view.\n\nUse this to control pan & zoom of the view.",
},
],
},
),
];
ArchetypeReflectionMap::from_iter(array)
}