Components

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.

  • AggregationPolicy: Policy for aggregation of multiple scalar plot values.
  • AlbedoFactor: A color multiplier, usually applied to a whole entity, e.g. a mesh.
  • AnnotationContext: The annotation context 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: The world->depth map scaling factor.
  • DisconnectedSpace: Spatially disconnect this entity from its parent.
  • DrawOrder: Draw order of 2D elements. Higher values are drawn on top of lower values.
  • FillMode: How a geometric shape is drawn and colored.
  • FillRatio: How much a primitive fills out the available space.
  • GammaCorrection: A gamma correction value to be used with a scalar value or color.
  • HalfSize2D: Half-size (radius) of a 2D box.
  • HalfSize3D: Half-size (radius) of a 3D box.
  • ImageBuffer: A buffer that is known to store image data.
  • ImageFormat: The metadata describing the contents of a components.ImageBuffer.
  • 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.
  • MagnificationFilter: Filter used when magnifying an image/texture such that a single pixel/texel is displayed as multiple pixels on screen.
  • MarkerShape: The visual appearance of a point in e.g. a 2D plot.
  • MarkerSize: Radius of a marker of a point in e.g. a 2D plot, measured in UI points.
  • MediaType: A standardized media type (RFC2046, formerly known as MIME types), encoded as a string.
  • Name: A display name, typically for an entity or a item like a plot series.
  • Opacity: Degree of transparency ranging from 0.0 (fully transparent) to 1.0 (fully opaque).
  • PinholeProjection: Camera projection, from image coordinates to view coordinates.
  • PoseRotationAxisAngle: 3D rotation represented by a rotation around a given axis that doesn't propagate in the transform hierarchy.
  • PoseRotationQuat: A 3D rotation expressed as a quaternion that doesn't propagate in the transform hierarchy.
  • PoseScale3D: A 3D scale factor that doesn't propagate in the transform hierarchy.
  • PoseTransformMat3x3: A 3x3 transformation matrix Matrix that doesn't propagate in the transform hierarchy.
  • PoseTranslation3D: A translation vector in 3D space that doesn't propagate in the transform hierarchy.
  • Position2D: A position in 2D space.
  • Position3D: A position in 3D space.
  • Radius: The radius of something, e.g. a point.
  • Range1D: A 1D range, specifying a lower and upper bound.
  • Resolution: Pixel resolution width & height, e.g. of a camera sensor.
  • RotationAxisAngle: 3D rotation represented by a rotation around a given axis.
  • RotationQuat: A 3D rotation expressed as a quaternion.
  • Scalar: A scalar value, encoded as a 64-bit floating point.
  • Scale3D: A 3D scale factor.
  • StrokeWidth: The width of a stroke specified in UI points.
  • TensorData: An N-dimensional array of numbers.
  • TensorDimensionIndexSelection: Specifies a concrete index on a tensor dimension.
  • TensorHeightDimension: Specifies which dimension to use for height.
  • TensorWidthDimension: Specifies which dimension to use for width.
  • 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.
  • TransformMat3x3: A 3x3 transformation matrix Matrix.
  • TransformRelation: Specifies relation a spatial transform describes.
  • Translation3D: A translation vector in 3D space.
  • TriangleIndices: The three indices of a triangle in 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.