Skip to content

Latest commit

 

History

History
57 lines (51 loc) · 4.53 KB

components.md

File metadata and controls

57 lines (51 loc) · 4.53 KB
title order
Components
2

Components are the fundamental unit of logging in Rerun. This page lists all built-in components.

An entity can only ever contain a single array of any given component type. If you log the same component several times on an entity, the last value (or array of values) will overwrite the previous.

For more information on the relationship between archetypes and components, check out the concept page on Entities and Components.

  • AnnotationContext: The AnnotationContext provides additional information on how to display entities.
  • AxisLength: The length of an axis in local units of the space.
  • Blob: A binary blob of data.
  • ClassId: A 16-bit ID representing a type of semantic class.
  • ClearIsRecursive: Configures how a clear operation should behave - recursive or not.
  • Color: An RGBA color with unmultiplied/separate alpha, in sRGB gamma space with linear alpha.
  • Colormap: Colormap for mapping scalar values within a given range to a color.
  • DepthMeter: A component indicating how long a meter is, expressed in native units.
  • DisconnectedSpace: Spatially disconnect this entity from its parent.
  • DrawOrder: Draw order used for the display order of 2D elements.
  • HalfSizes2D: Half-sizes (extents) of a 2D box along its local axis, starting at its local origin/center.
  • HalfSizes3D: Half-sizes (extents) of a 3D box along its local axis, starting at its local origin/center.
  • ImagePlaneDistance: The distance from the camera origin to the image plane when the projection is shown in a 3D viewer.
  • KeypointId: A 16-bit ID representing a type of semantic keypoint within a class.
  • LineStrip2D: A line strip in 2D space.
  • LineStrip3D: A line strip in 3D space.
  • MarkerShape: Shape of a marker.
  • MarkerSize: Size of a marker in UI points.
  • Material: Material properties of a mesh.
  • MediaType: A standardized media type (RFC2046, formerly known as MIME types), encoded as a utf8 string.
  • Name: A display name, typically for an entity or a item like a plot series.
  • OutOfTreeTransform3D: An out-of-tree affine transform between two 3D spaces, represented in a given direction.
  • PinholeProjection: Camera projection, from image coordinates to view coordinates.
  • Position2D: A position in 2D space.
  • Position3D: A position in 3D space.
  • Radius: A Radius component.
  • Range1D: A 1D range, specifying a lower and upper bound.
  • Resolution: Pixel resolution width & height, e.g. of a camera sensor.
  • Rotation3D: A 3D rotation, represented either by a quaternion or a rotation around axis.
  • Scalar: A double-precision scalar.
  • StrokeWidth: The width of a stroke specified in UI points.
  • TensorData: A multi-dimensional Tensor of data.
  • Texcoord2D: A 2D texture UV coordinate.
  • Text: A string of text, e.g. for labels and text documents.
  • TextLogLevel: The severity level of a text log message.
  • Transform3D: An affine transform between two 3D spaces, represented in a given direction.
  • TriangleIndices: The three indices of a triangle mesh.
  • Vector2D: A vector in 2D space.
  • Vector3D: A vector in 3D space.
  • ViewCoordinates: How we interpret the coordinate system of an entity/space.
  • VisualizerOverrides: The name of a visualizer.