Expand description
User-facing data types, component types, and archetypes.
The SDK is responsible for submitting component columns that conforms to these schemas. The schemas are additionally documented in doctests.
§Feature flags
arrow_datagen
— Enables thedatagen
module, which exposes a number of tools for generating random data for tests and benchmarks.ecolor
— Enable conversionsglam
— Add support for some math operations usingglam
.image
— Integration with theimage
crate, plus JPEG support..serde
— Enable (de)serialization using serde.
Re-exports§
pub use self::context::AnnotationContext;
pub use self::context::AnnotationInfo;
pub use self::context::ClassDescription;
pub use self::coordinates::ViewCoordinates;
Modules§
- context
- coordinates
- datagen
- Generate random data for tests and benchmarks.
- external
Structs§
- Arrow3D
- A 3D Arrow
- Box3D
- A 3D bounding box represented by it’s half-lengths
- ClassId
- A 16-bit ID representing a type of semantic class.
- ColorRGBA
- An RGBA color tuple with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
- Decoded
Tensor - A thin wrapper around a
Tensor
that is guaranteed to not be compressed (never a jpeg). - Disconnected
Space - Specifies that the entity path at which this is logged is disconnected from its parent.
- Draw
Order - Draw order used for the display order of 2D elements.
- Encoded
Mesh3D - Compressed/encoded mesh format
- Fast
Fixed Size Array Iter - Fast
Fixed Size List Array - Fixed
Size Array Field arrow2_convert
helper for fields of type[T; SIZE]
- Instance
Key - A unique numeric identifier for each individual instance within a batch.
- Keypoint
Id - A 16-bit ID representing a type of semantic keypoint within a class.
- Label
- A String label component
- Line
Strip2D - A Line Strip of 2D points
- Line
Strip3D - A Line Strip of 3D points
- Mat3x3
- A 3x3 column-major Matrix made up of 3 Vecs
- MeshId
- A unique id per
Mesh3D
. - Pinhole
- Camera perspective projection (a.k.a. intrinsics).
- Point2D
- A point in 2D space.
- Point3D
- A point in 3D space.
- Quaternion
- A Quaternion represented by 4 real numbers.
- Radius
- A Radius component
- RawMesh3D
- A raw “triangle soup” mesh.
- Rotation
Axis Angle - 3D rotation represented by a rotation around a given axis.
- Scalar
- A double-precision scalar.
- Scalar
Plot Props - Additional properties of a scalar when rendered as a plot.
- Tensor
- A Multi-dimensional Tensor.
- Tensor
Dimension - Flattened
Tensor
data payload - Tensor
Id - A unique id per
Tensor
. - TextBox
- A text element intended to be displayed in a text-box
- Text
Entry - A text entry component, comprised of a text body and its log level.
- Transform3D
- An affine transform between two 3D spaces, represented in a given direction.
- Translation
AndMat3 - Representation of a affine transform via a 3x3 affine matrix paired with a translation.
- Translation
Rotation Scale3D - Representation of an affine transform via separate translation, rotation & scale.
- Vec2D
- A vector in 2D space.
- Vec3D
- A vector in 3D space.
- Vec4D
- A vector in 4D space.
Enums§
- Angle
- Angle in either radians or degrees.
- Field
Error - From
File Error - Errors from
data_cell_from_file_path
anddata_cell_from_mesh_file_path
. - Mesh3D
- A Generic 3D Mesh.
- Mesh
Format - The format of a binary mesh file, e.g. GLTF, GLB, OBJ
- Rect2D
- A rectangle in 2D space.
- Rotation3D
- A 3D rotation.
- Scale3D
- 3D scaling factor, part of a transform representation.
- Tensor
Cast Error - Tensor
Data - Flattened
Tensor
data payload - Tensor
Data Meaning - How to interpret the contents of a tensor.
- Tensor
Data Type - The data types supported by a
crate::Tensor
. - Tensor
Element - The data that can be stored in a
crate::Tensor
. - Tensor
Image Load Error - Errors when loading
Tensor
from theimage
crate. - Tensor
Image Save Error - Errors when converting
Tensor
toimage
images. - Transform3D
Repr - Representation of a 3D affine transform.
Traits§
- Legacy
Component - A type that can used as a Component of an Entity.
- Tensor
Data Type Trait
Functions§
- data_
cell_ from_ file_ path - Read the file at the given path.
- data_
cell_ from_ mesh_ file_ path - Read the mesh file at the given path.
- iter_
registered_ field_ types - Iterate over the registered field types