Expand description
Archetype are the high-level things you can log, like Image, Points3D, etc.
All archetypes implement the Archetype trait.
Each archetype is a collection of homogeneous ComponentBatches.
For instance, the Points3D archetype contains a
batch of positions, a batch of colors, etc.
Each entity can consist of many archetypes, but usually each entity will only have one archetype.
A special archetype is Clear which resets all the components
of an already logged entity.
Structsยง
- Annotation
Context - Archetype: The annotation context provides additional information on how to display entities.
- Arrows2D
- Archetype: 2D arrows with optional colors, radii, labels, etc.
- Arrows3D
- Archetype: 3D arrows with optional colors, radii, labels, etc.
- Asset3D
- Archetype: A prepacked 3D asset (
.gltf,.glb,.obj,.stl, etc.). - Asset
Video - Archetype: A video binary.
- BarChart
- Archetype: A bar chart.
- Boxes2D
- Archetype: 2D boxes with half-extents and optional center, colors etc.
- Boxes3D
- Archetype: 3D boxes with half-extents and optional center, rotations, colors etc.
- Capsules3D
- Archetype: 3D capsules; cylinders with hemispherical caps.
- Clear
- Archetype: Empties all the components of an entity.
- Depth
Image - Archetype: A depth image, i.e. as captured by a depth camera.
- Ellipsoids3D
- Archetype: 3D ellipsoids or spheres.
- Encoded
Image - Archetype: An image encoded as e.g. a JPEG or PNG.
- GeoLine
Strings - Archetype: Geospatial line strings with positions expressed in EPSG:4326 altitude and longitude (North/East-positive degrees), and optional colors and radii.
- GeoPoints
- Archetype: Geospatial points with positions expressed in EPSG:4326 latitude and longitude (North/East-positive degrees), and optional colors and radii.
- Graph
Edges - Archetype: A list of edges in a graph.
- Graph
Nodes - Archetype: A list of nodes in a graph with optional labels, colors, etc.
- Image
- Archetype: A monochrome or color image.
- Instance
Poses3D - Archetype: One or more transforms between the current entity and its parent. Unlike
archetypes::Transform3D, it is not propagated in the transform hierarchy. - Line
Strips2D - Archetype: 2D line strips with positions and optional colors, radii, labels, etc.
- Line
Strips3D - Archetype: 3D line strips with positions and optional colors, radii, labels, etc.
- Mesh3D
- Archetype: A 3D triangle mesh as specified by its per-mesh and per-vertex properties.
- Pinhole
- Archetype: Camera perspective projection (a.k.a. intrinsics).
- Points2D
- Archetype: A 2D point cloud with positions and optional colors, radii, labels, etc.
- Points3D
- Archetype: A 3D point cloud with positions and optional colors, radii, labels, etc.
- Recording
Properties - Archetype: A list of properties associated with a recording.
- Scalar
Deprecated - Archetype: A double-precision scalar, e.g. for use for time-series plots.
- Scalars
- Archetype: One or more double-precision scalar values, e.g. for use for time-series plots.
- Segmentation
Image - Archetype: An image made up of integer
components::ClassIds. - Series
Line Deprecated - Archetype: Define the style properties for a line series in a chart.
- Series
Lines - Archetype: Define the style properties for one or more line series in a chart.
- Series
Point Deprecated - Archetype: Define the style properties for a point series in a chart.
- Series
Points - Archetype: Define the style properties for one or more point series (scatter plot) in a chart.
- Tensor
- Archetype: An N-dimensional array of numbers.
- Text
Document - Archetype: A text element intended to be displayed in its own text box.
- TextLog
- Archetype: A log entry in a text log, comprised of a text body and its log level.
- Transform3D
- Archetype: A transform between two 3D spaces, i.e. a pose.
- Video
Frame Reference - Archetype: References a single video frame.
- View
Coordinates - Archetype: How we interpret the coordinate system of an entity/space.