Struct re_components::context::AnnotationContext

pub struct AnnotationContext {
    pub class_map: HashMap<ClassId, ClassDescription>,
}

The AnnotationContext provides additional information on how to display entities.

Entities can use ClassIds and KeypointIds to provide annotations, and the labels and colors will be looked up in the appropriate AnnotationContext. We use the first annotation context we find in the path-hierarchy when searching up through the ancestors of a given entity path.

use re_components::AnnotationContext;
use arrow2_convert::field::ArrowField;
use arrow2::datatypes::{DataType, Field};

assert_eq!(
    AnnotationContext::data_type(),
    DataType::List(Box::new(Field::new(
        "item",
        DataType::Struct(vec![
            Field::new("class_id", DataType::UInt16, false),
            Field::new(
                "class_description",
                DataType::Struct(vec![
                    Field::new(
                        "info",
                        DataType::Struct(vec![
                            Field::new("id", DataType::UInt16, false),
                            Field::new("label", DataType::Utf8, true),
                            Field::new("color", DataType::UInt32, true),
                        ]),
                        false
                    ),
                    Field::new(
                        "keypoint_map",
                        DataType::List(Box::new(Field::new(
                            "item",
                            DataType::Struct(vec![
                                Field::new("id", DataType::UInt16, false),
                                Field::new("label", DataType::Utf8, true),
                                Field::new("color", DataType::UInt32, true),
                            ]),
                            false
                        ))),
                        false
                    ),
                    Field::new(
                        "keypoint_connections",
                        DataType::List(Box::new(Field::new(
                            "item",
                            DataType::Struct(vec![
                                Field::new("keypoint0", DataType::UInt16, false),
                                Field::new("keypoint1", DataType::UInt16, false),
                            ]),
                            false
                        ))),
                        false
                    ),
                ]),
                false
            )
        ]),
        false
    )))
);

Fields

class_map: HashMap<ClassId, ClassDescription>

Trait Implementations

impl ArrowDeserialize for AnnotationContext

type ArrayType = <Vec<ClassMapElemArrow, Global> as ArrowDeserialize>::ArrayType

The arrow2::Array type corresponding to this field

fn arrow_deserialize( v: <&Self::ArrayType as IntoIterator>::Item ) -> Option<<Self as ArrowField>::Type>

Deserialize this field from arrow

impl ArrowField for AnnotationContext

type Type = AnnotationContext

This should be Self except when implementing large offset and fixed placeholder types. For the later, it should refer to the actual type. For example when the placeholder type is LargeString, this should be String.

fn data_type() -> DataType

The DataType

impl ArrowSerialize for AnnotationContext

type MutableArrayType = <Vec<ClassMapElemArrow, Global> as ArrowSerialize>::MutableArrayType

The arrow2::array::MutableArray that holds this value

fn new_array() -> Self::MutableArrayType

Create a new mutable array

fn arrow_serialize(v: &Self, array: &mut Self::MutableArrayType) -> Result<()>

Serialize this field to arrow

impl Clone for AnnotationContext

fn clone(&self) -> AnnotationContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnnotationContext

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

Formats the value using the given formatter.

impl Default for AnnotationContext

fn default() -> AnnotationContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnnotationContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a AnnotationContext> for Cow<'a, AnnotationContext>

fn from(value: &'a AnnotationContext) -> Self

Converts to this type from the input type.

impl From<&AnnotationContext> for Vec<ClassMapElemArrow>

fn from(v: &AnnotationContext) -> Self

Converts to this type from the input type.

impl<'a> From<AnnotationContext> for Cow<'a, AnnotationContext>

fn from(value: AnnotationContext) -> Self

Converts to this type from the input type.

impl From<Vec<ClassMapElemArrow, Global>> for AnnotationContext

fn from(v: Vec<ClassMapElemArrow>) -> Self

Converts to this type from the input type.

impl LegacyComponent for AnnotationContext

fn legacy_name() -> ComponentName

The name of the component.

fn field() -> Field

Create a Field for this LegacyComponent.

impl Loggable for AnnotationContext

type Name = ComponentName

type Item<'a> = <&'a <AnnotationContext as ArrowDeserialize>::ArrayType as IntoIterator>::Item

type Iter<'a> = <&'a <AnnotationContext as ArrowDeserialize>::ArrayType as IntoIterator>::IntoIter

fn name() -> Self::Name

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

fn to_arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType.

fn try_to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, _extension_wrapper: Option<&str> ) -> SerializationResult<Box<dyn Array>>where Self: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn try_iter_from_arrow( data: &dyn Array ) -> DeserializationResult<Self::Iter<'_>>where Self: Sized,

Given an Arrow array, deserializes it into a iterator of Loggable::Items.

fn convert_item_to_self(item: Self::Item<'_>) -> Option<Self>

Convert a Loggable::Item into an optional Loggable

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, extension_wrapper: Option<&str> ) -> Box<dyn Array, Global>where Self: Clone + 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn try_to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, extension_wrapper: Option<&str> ) -> Result<Box<dyn Array, Global>, SerializationError>where Self: Clone + 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, extension_wrapper: Option<&str> ) -> Box<dyn Array, Global>where Self: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::to_arrow_datatype.

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

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

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

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

fn from_arrow_opt(data: &(dyn Array + 'static)) -> Vec<Option<Self>, Global>

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

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

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

impl PartialEq<AnnotationContext> for AnnotationContext

fn eq(&self, other: &AnnotationContext) -> 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 Serialize for AnnotationContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Component for AnnotationContext

impl Eq for AnnotationContext

impl StructuralEq for AnnotationContext

impl StructuralPartialEq for AnnotationContext