Rerun C++ SDK
Loading...
Searching...
No Matches
visualizer_component_mapping.hpp
1// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
2// Based on "crates/store/re_sdk_types/definitions/rerun/blueprint/datatypes/visualizer_component_mapping.fbs".
3
4#pragma once
5
6#include "../../datatypes/utf8.hpp"
7#include "../../result.hpp"
8#include "component_source_kind.hpp"
9
10#include <cstdint>
11#include <memory>
12#include <optional>
13#include <string>
14
15namespace arrow {
16 class Array;
17 class DataType;
18 class StructBuilder;
19} // namespace arrow
20
21namespace rerun::blueprint::datatypes {
22 /// **Datatype**: Associate components of an entity to components of a visualizer.
23 ///
24 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
25 ///
27 /// Target component name which is being mapped to.
28 ///
29 /// This represents a "slot" on the visualizer.
31
32 /// What kind of source to pick.
33 rerun::blueprint::datatypes::ComponentSourceKind source_kind;
34
35 /// Component selector for mapping.
36 ///
37 /// Defaults to `target` if not specified.
38 std::optional<std::string> source_component;
39
40 /// Optional selector string using jq-like syntax to pick a specific field on `source_component`.
41 ///
42 /// Example: ".x" picks a field called "x" from the `source_component` if present.
43 ///
44 /// Defaults to empty string if not specified.
45 std::optional<std::string> selector;
46
47 public:
49 };
50} // namespace rerun::blueprint::datatypes
51
52namespace rerun {
53 template <typename T>
54 struct Loggable;
55
56 /// \private
57 template <>
59 static constexpr std::string_view ComponentType =
60 "rerun.blueprint.datatypes.VisualizerComponentMapping";
61
62 /// Returns the arrow data type this type corresponds to.
63 static const std::shared_ptr<arrow::DataType>& arrow_datatype();
64
65 /// Serializes an array of `rerun::blueprint:: datatypes::VisualizerComponentMapping` into an arrow array.
67 const blueprint::datatypes::VisualizerComponentMapping* instances, size_t num_instances
68 );
69
70 /// Fills an arrow array builder with an array of this type.
71 static rerun::Error fill_arrow_array_builder(
72 arrow::StructBuilder* builder,
73 const blueprint::datatypes::VisualizerComponentMapping* elements, size_t num_elements
74 );
75 };
76} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:103
A class for representing either a usable value, or an error.
Definition result.hpp:14
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
A type of component that can be registered.
Definition component_type.hpp:19
The Loggable trait is used by all built-in implementation of rerun::AsComponents to serialize a colle...
Definition loggable.hpp:11
Datatype: Associate components of an entity to components of a visualizer.
Definition visualizer_component_mapping.hpp:26
std::optional< std::string > source_component
Component selector for mapping.
Definition visualizer_component_mapping.hpp:38
rerun::blueprint::datatypes::ComponentSourceKind source_kind
What kind of source to pick.
Definition visualizer_component_mapping.hpp:33
rerun::datatypes::Utf8 target
Target component name which is being mapped to.
Definition visualizer_component_mapping.hpp:30
std::optional< std::string > selector
Optional selector string using jq-like syntax to pick a specific field on source_component.
Definition visualizer_component_mapping.hpp:45
Datatype: A string of text, encoded as UTF-8.
Definition utf8.hpp:21