Rerun C++ SDK
Loading...
Searching...
No Matches
table_cell_kind.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/build/re_type_definitions/rerun/blueprint/components/table_cell_kind.def.rs".
3
4#pragma once
5
6#include "../../result.hpp"
7
8#include <cstdint>
9#include <memory>
10
11namespace arrow {
12 /// \private
13 template <typename T>
14 class NumericBuilder;
15
16 class Array;
17 class DataType;
18 class UInt8Type;
19 using UInt8Builder = NumericBuilder<UInt8Type>;
20} // namespace arrow
21
22namespace rerun::blueprint::components {
23 /// **Component**: How a table column value is rendered.
24 ///
25 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
26 ///
27 enum class TableCellKind : uint8_t {
28
29 /// Infer the renderer from the component or Arrow datatype.
30 Auto = 1,
31
32 /// Render a Rerun URI as an interactive link.
33 Link = 2,
34
35 /// Render an image blob as a thumbnail.
36 Thumbnail = 3,
37
38 /// Render a boolean as a flag.
39 ///
40 /// Card layouts place the first flag field in the special flag position and
41 /// currently support at most one flag field.
42 Flag = 4,
43
44 /// Render a recording reference as embedded views.
45 ///
46 /// The column must also have `archetypes::TableColumnPreview` configuration with at least one view.
47 /// All preview columns use the shared `archetypes::PreviewsConfig`.
48 Preview = 5,
49
50 /// Interpret scalar `i32` values as `rerun.cloud.v1alpha1.EntryKind` enum values and render their human-readable names.
51 ///
52 /// Unknown numeric values are rendered as `Unknown EntryKind`.
53 EntryKind = 6,
54 };
55} // namespace rerun::blueprint::components
56
57namespace rerun {
58 template <typename T>
59 struct Loggable;
60
61 /// \private
62 template <>
63 struct Loggable<blueprint::components::TableCellKind> {
64 static constexpr std::string_view ComponentType =
65 "rerun.blueprint.components.TableCellKind";
66
67 /// Returns the arrow data type this type corresponds to.
68 static const std::shared_ptr<arrow::DataType>& arrow_data_type();
69
70 /// Serializes an array of `rerun::blueprint:: components::TableCellKind` into an arrow array.
71 static Result<std::shared_ptr<arrow::Array>> to_arrow(
72 const blueprint::components::TableCellKind* instances, size_t num_instances
73 );
74
75 /// Fills an arrow array builder with an array of this type.
76 static rerun::Error fill_arrow_array_builder(
77 arrow::UInt8Builder* builder, const blueprint::components::TableCellKind* elements,
78 size_t num_elements
79 );
80 };
81} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:103
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:26