component_source_kind.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/blueprint/encodings/visualizer_component_mapping.def.rs".
 
#pragma once
 
#include "../../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace arrow {
    /// \private
    template <typename T>
    class NumericBuilder;
 
    class Array;
    class DataType;
    class UInt8Type;
    using UInt8Builder = NumericBuilder<UInt8Type>;
} // namespace arrow
 
namespace rerun::blueprint::encodings {
    /// **Encoding**: What kind of source to use for a visualizer component mapping.
    enum class ComponentSourceKind : uint8_t {
 
        /// Use an explicit selection defined by `source_component`.
        ///
        /// May or may not make use of a selector string.
        ///
        /// Selecting a source component that is not found on the entity is an error.
        SourceComponent = 1,
 
        /// Use a timeless override value that is defined in the blueprint.
        ///
        /// The override value is stored on the same entity as the visualizer instruction
        /// and uses the `target` as its component name.
        ///
        /// Selecting this source without an override value for the target component is an error.
        Override = 2,
 
        /// Default as specified on the view's blueprint.
        ///
        /// If the view doesn't specify a default for the target component name,
        /// a heuristically determined value will be used instead.
        Default = 3,
 
        /// Resolve the value from class and keypoint IDs using the recording's annotation context.
        ///
        /// If the annotation context does not provide a value, default values are used instead.
        /// (Any overlapping recording values for the target component are ignored.)
        ///
        /// This is only available for visualizers that support annotation context.
        /// Selecting it for an unsupported component is an error.
        AnnotationContext = 4,
    };
} // namespace rerun::blueprint::encodings
 
namespace rerun {
    template <typename T>
    struct Loggable;
 
    /// \private
    template <>
    struct Loggable<blueprint::encodings::ComponentSourceKind> {
        static constexpr std::string_view ComponentType =
            "rerun.blueprint.encodings.ComponentSourceKind";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type();
 
        /// Serializes an array of `rerun::blueprint:: encodings::ComponentSourceKind` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const blueprint::encodings::ComponentSourceKind* instances, size_t num_instances
        );
 
        /// Fills an arrow array builder with an array of this type.
        static rerun::Error fill_arrow_array_builder(
            arrow::UInt8Builder* builder, const blueprint::encodings::ComponentSourceKind* elements,
            size_t num_elements
        );
    };
} // namespace rerun