Rerun C++ SDK
No Matches
rerun::datatypes::ClassDescription Struct Reference

Datatype: The description of a semantic Class. More...

#include <rerun/datatypes/class_description.hpp>

Public Member Functions

 ClassDescription (uint16_t id, std::optional< std::string > label=std::nullopt, std::optional< datatypes::Rgba32 > color=std::nullopt)
 Create a new ClassDescription from a single annotation info.
 ClassDescription (AnnotationInfo info_, Collection< AnnotationInfo > keypoint_annotations_={}, Collection< KeypointPair > keypoint_connections_={})

Public Attributes

rerun::datatypes::AnnotationInfo info
 The AnnotationInfo for the class.
rerun::Collection< rerun::datatypes::AnnotationInfokeypoint_annotations
 The AnnotationInfo for all of the keypoints.
rerun::Collection< rerun::datatypes::KeypointPairkeypoint_connections
 The connections between keypoints.

Detailed Description

Datatype: The description of a semantic Class.

If an entity is annotated with a corresponding ClassId, Rerun will use the attached AnnotationInfo to derive labels and colors.

Keypoints within an annotation class can similarly be annotated with a KeypointId in which case we should defer to the label and color for the AnnotationInfo specifically associated with the Keypoint.

Keypoints within the class can also be decorated with skeletal edges. Keypoint-connections are pairs of KeypointIds. If an edge is defined, and both keypoints exist within the instance of the class, then the keypoints should be connected with an edge. The edge should be labeled and colored as described by the class's AnnotationInfo.

The documentation for this struct was generated from the following file: