Struct rerun::sdk::prelude::ClassDescription

pub struct ClassDescription {
    pub info: AnnotationInfo,
    pub keypoint_annotations: Vec<AnnotationInfo>,
    pub keypoint_connections: Vec<KeypointPair>,
}

Datatype: The description of a semantic Class.

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

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

Keypoints within the class can also be decorated with skeletal edges. Keypoint-connections are pairs of components::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 datatypes::AnnotationInfo.

Fields

info: AnnotationInfo

The datatypes::AnnotationInfo for the class.

keypoint_annotations: Vec<AnnotationInfo>

The datatypes::AnnotationInfo for all of the keypoints.

keypoint_connections: Vec<KeypointPair>

The connections between keypoints.

Trait Implementations

impl Clone for ClassDescription

fn clone(&self) -> ClassDescription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClassDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ClassDescription

fn default() -> ClassDescription

Returns the “default value” for a type.

impl From<(u16, &str)> for ClassDescription

fn from(value: (u16, &str)) -> ClassDescription

Converts to this type from the input type.

impl From<(u16, &str, Rgba32)> for ClassDescription

fn from(value: (u16, &str, Rgba32)) -> ClassDescription

Converts to this type from the input type.

impl From<AnnotationInfo> for ClassDescription

fn from(info: AnnotationInfo) -> ClassDescription

Converts to this type from the input type.

impl From<ClassDescription> for ClassDescriptionMapElem

fn from(class_description: ClassDescription) -> ClassDescriptionMapElem

Converts to this type from the input type.

impl Loggable for ClassDescription

type Name = DatatypeName

fn name() -> <ClassDescription as Loggable>::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, ClassDescription>>>> ) -> Result<Box<dyn Array>, SerializationError>

where ClassDescription: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Option<ClassDescription>>, DeserializationError>

where ClassDescription: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow( data: &(dyn Array + 'static) ) -> Result<Vec<Self>, DeserializationError>

Given an Arrow array, deserializes it into a collection of Loggables.

impl PartialEq for ClassDescription

fn eq(&self, other: &ClassDescription) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for ClassDescription

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl Eq for ClassDescription

impl StructuralPartialEq for ClassDescription