Rerun C++ SDK
Loading...
Searching...
No Matches
visualizer_overrides.hpp
1// DO NOT EDIT! This file was auto-generated by crates/re_types_builder/src/codegen/cpp/mod.rs
2// Based on "crates/re_types/definitions/rerun/blueprint/components/visualizer_overrides.fbs".
3
4#pragma once
5
6#include "../../collection.hpp"
7#include "../../result.hpp"
8
9#include <cstdint>
10#include <memory>
11#include <string>
12#include <utility>
13
14namespace arrow {
15 class Array;
16 class DataType;
17 class ListBuilder;
18} // namespace arrow
19
20namespace rerun::blueprint::components {
21 /// **Component**: Override the visualizers for an entity.
22 ///
23 /// This component is a stop-gap mechanism based on the current implementation details
24 /// of the visualizer system. It is not intended to be a long-term solution, but provides
25 /// enough utility to be useful in the short term.
26 ///
27 /// The long-term solution is likely to be based off: <https://github.com/rerun-io/rerun/issues/6626>
28 ///
29 /// This can only be used as part of blueprints. It will have no effect if used
30 /// in a regular entity.
32 /// Names of the visualizers that should be active.
33 ///
34 /// The built-in visualizers are:
35 /// - BarChart
36 /// - Arrows2D
37 /// - Arrows3D
38 /// - Asset3D
39 /// - Boxes2D
40 /// - Boxes3D
41 /// - Cameras
42 /// - DepthImage
43 /// - Image
44 /// - Lines2D
45 /// - Lines3D
46 /// - Mesh3D
47 /// - Points2D
48 /// - Points3D
49 /// - Transform3DArrows
50 /// - Tensor
51 /// - TextDocument
52 /// - TextLog
53 /// - SegmentationImage
54 /// - SeriesLine
55 /// - SeriesPoint
57
58 public:
59 VisualizerOverrides() = default;
60
62 : visualizers(std::move(visualizers_)) {}
63
65 visualizers = std::move(visualizers_);
66 return *this;
67 }
68 };
69} // namespace rerun::blueprint::components
70
71namespace rerun {
72 template <typename T>
73 struct Loggable;
74
75 /// \private
76 template <>
77 struct Loggable<blueprint::components::VisualizerOverrides> {
78 static constexpr const char Name[] = "rerun.blueprint.components.VisualizerOverrides";
79
80 /// Returns the arrow data type this type corresponds to.
81 static const std::shared_ptr<arrow::DataType>& arrow_datatype();
82
83 /// Serializes an array of `rerun::blueprint:: components::VisualizerOverrides` into an arrow array.
84 static Result<std::shared_ptr<arrow::Array>> to_arrow(
85 const blueprint::components::VisualizerOverrides* instances, size_t num_instances
86 );
87
88 /// Fills an arrow array builder with an array of this type.
89 static rerun::Error fill_arrow_array_builder(
90 arrow::ListBuilder* builder, const blueprint::components::VisualizerOverrides* elements,
91 size_t num_elements
92 );
93 };
94} // namespace rerun
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:46
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:88
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:21
Component: Override the visualizers for an entity.
Definition visualizer_overrides.hpp:31
rerun::Collection< std::string > visualizers
Names of the visualizers that should be active.
Definition visualizer_overrides.hpp:56