annotation_info.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/encodings/annotation_info.def.rs".
 
#pragma once
 
#include "../result.hpp"
#include "rgba32.hpp"
#include "utf8.hpp"
 
#include <cstdint>
#include <memory>
#include <optional>
 
namespace arrow {
    class Array;
    class DataType;
    class StructBuilder;
} // namespace arrow
 
namespace rerun::encodings {
    /// **Encoding**: Annotation info annotating a class id or key-point id.
    ///
    /// Color and label will be used to annotate entities/keypoints which reference the id.
    /// The id refers either to a class or key-point id
    struct AnnotationInfo {
        /// `encodings::ClassId` or `encodings::KeypointId` to which this annotation info belongs.
        uint16_t id;
 
        /// The label that will be shown in the UI.
        std::optional<rerun::encodings::Utf8> label;
 
        /// The color that will be applied to the annotated entity.
        std::optional<rerun::encodings::Rgba32> color;
 
      public: // START of extensions from annotation_info_ext.cpp:
        AnnotationInfo(
            uint16_t _id, std::optional<std::string> _label = std::nullopt,
            std::optional<encodings::Rgba32> _color = std::nullopt
        )
            : id(_id), label(std::move(_label)), color(_color) {}
 
        AnnotationInfo(uint16_t _id, encodings::Rgba32 _color)
            : id(_id), label(std::nullopt), color(_color) {}
 
        // END of extensions from annotation_info_ext.cpp, start of generated code:
 
      public:
        AnnotationInfo() = default;
    };
} // namespace rerun::encodings
 
namespace rerun {
    template <typename T>
    struct Loggable;
 
    /// \private
    template <>
    struct Loggable<encodings::AnnotationInfo> {
        static constexpr std::string_view ComponentType = "rerun.encodings.AnnotationInfo";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type();
 
        /// Serializes an array of `rerun::encodings::AnnotationInfo` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const encodings::AnnotationInfo* instances, size_t num_instances
        );
 
        /// Fills an arrow array builder with an array of this type.
        static rerun::Error fill_arrow_array_builder(
            arrow::StructBuilder* builder, const encodings::AnnotationInfo* elements,
            size_t num_elements
        );
    };
} // namespace rerun