visualizer_component_mapping.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/store/re_sdk_types/definitions/rerun/blueprint/datatypes/visualizer_component_mapping.fbs".
 
#pragma once
 
#include "../../datatypes/utf8.hpp"
#include "../../result.hpp"
#include "component_source_kind.hpp"
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
 
namespace arrow {
    class Array;
    class DataType;
    class StructBuilder;
} // namespace arrow
 
namespace rerun::blueprint::datatypes {
    /// **Datatype**: Associate components of an entity to components of a visualizer.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct VisualizerComponentMapping {
        /// Target component name which is being mapped to.
        ///
        /// This represents a "slot" on the visualizer.
        rerun::datatypes::Utf8 target;
 
        /// What kind of source to pick.
        rerun::blueprint::datatypes::ComponentSourceKind source_kind;
 
        /// Component selector for mapping.
        ///
        /// Defaults to `target` if not specified.
        std::optional<std::string> source_component;
 
        /// Optional selector string using jq-like syntax to pick a specific field on `source_component`.
        ///
        /// ⚠ TODO(RR-3308): Not fully implemented yet.
        ///
        /// Example: ".x" picks a field called "x" from the `source_component` if present.
        ///
        /// Defaults to empty string if not specified.
        std::optional<std::string> selector;
 
      public:
        VisualizerComponentMapping() = default;
    };
} // namespace rerun::blueprint::datatypes
 
namespace rerun {
    template <typename T>
    struct Loggable;
 
    /// \private
    template <>
    struct Loggable<blueprint::datatypes::VisualizerComponentMapping> {
        static constexpr std::string_view ComponentType =
            "rerun.blueprint.datatypes.VisualizerComponentMapping";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_datatype();
 
        /// Serializes an array of `rerun::blueprint:: datatypes::VisualizerComponentMapping` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const blueprint::datatypes::VisualizerComponentMapping* 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 blueprint::datatypes::VisualizerComponentMapping* elements, size_t num_elements
        );
    };
} // namespace rerun