Rerun C++ SDK
Loading...
Searching...
No Matches
arrows2d.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_types/definitions/rerun/archetypes/arrows2d.fbs".
3
4#pragma once
5
6#include "../collection.hpp"
7#include "../component_batch.hpp"
8#include "../component_column.hpp"
9#include "../components/class_id.hpp"
10#include "../components/color.hpp"
11#include "../components/draw_order.hpp"
12#include "../components/position2d.hpp"
13#include "../components/radius.hpp"
14#include "../components/show_labels.hpp"
15#include "../components/text.hpp"
16#include "../components/vector2d.hpp"
17#include "../result.hpp"
18
19#include <cstdint>
20#include <optional>
21#include <utility>
22#include <vector>
23
24namespace rerun::archetypes {
25 /// **Archetype**: 2D arrows with optional colors, radii, labels, etc.
26 ///
27 /// ## Example
28 ///
29 /// ### Simple batch of 2D arrows
30 /// ![image](https://static.rerun.io/arrow2d_simple/59f044ccc03f7bc66ee802288f75706618b29a6e/full.png)
31 ///
32 /// ```cpp
33 /// #include <rerun.hpp>
34 ///
35 /// int main() {
36 /// const auto rec = rerun::RecordingStream("rerun_example_arrow2d");
37 /// rec.spawn().exit_on_failure();
38 ///
39 /// rec.log(
40 /// "arrows",
41 /// rerun::Arrows2D::from_vectors({{1.0f, 0.0f}, {0.0f, -1.0f}, {-0.7f, 0.7f}})
42 /// .with_radii(0.025f)
43 /// .with_origins({{0.25f, 0.0f}, {0.25f, 0.0f}, {-0.1f, -0.1f}})
44 /// .with_colors({{255, 0, 0}, {0, 255, 0}, {127, 0, 255}})
45 /// .with_labels({"right", "up", "left-down"})
46 /// );
47 /// }
48 /// ```
49 struct Arrows2D {
50 /// All the vectors for each arrow in the batch.
51 std::optional<ComponentBatch> vectors;
52
53 /// All the origin (base) positions for each arrow in the batch.
54 ///
55 /// If no origins are set, (0, 0) is used as the origin for each arrow.
56 std::optional<ComponentBatch> origins;
57
58 /// Optional radii for the arrows.
59 ///
60 /// The shaft is rendered as a line with `radius = 0.5 * radius`.
61 /// The tip is rendered with `height = 2.0 * radius` and `radius = 1.0 * radius`.
62 std::optional<ComponentBatch> radii;
63
64 /// Optional colors for the points.
65 std::optional<ComponentBatch> colors;
66
67 /// Optional text labels for the arrows.
68 ///
69 /// If there's a single label present, it will be placed at the center of the entity.
70 /// Otherwise, each instance will have its own label.
71 std::optional<ComponentBatch> labels;
72
73 /// Whether the text labels should be shown.
74 ///
75 /// If not set, labels will automatically appear when there is exactly one label for this entity
76 /// or the number of instances on this entity is under a certain threshold.
77 std::optional<ComponentBatch> show_labels;
78
79 /// An optional floating point value that specifies the 2D drawing order.
80 ///
81 /// Objects with higher values are drawn on top of those with lower values.
82 std::optional<ComponentBatch> draw_order;
83
84 /// Optional class Ids for the points.
85 ///
86 /// The `components::ClassId` provides colors and labels if not specified explicitly.
87 std::optional<ComponentBatch> class_ids;
88
89 public:
90 /// The name of the archetype as used in `ComponentDescriptor`s.
91 static constexpr const char ArchetypeName[] = "rerun.archetypes.Arrows2D";
92
93 /// `ComponentDescriptor` for the `vectors` field.
94 static constexpr auto Descriptor_vectors = ComponentDescriptor(
96 );
97 /// `ComponentDescriptor` for the `origins` field.
98 static constexpr auto Descriptor_origins = ComponentDescriptor(
99 ArchetypeName, "Arrows2D:origins",
101 );
102 /// `ComponentDescriptor` for the `radii` field.
103 static constexpr auto Descriptor_radii = ComponentDescriptor(
105 );
106 /// `ComponentDescriptor` for the `colors` field.
107 static constexpr auto Descriptor_colors = ComponentDescriptor(
109 );
110 /// `ComponentDescriptor` for the `labels` field.
111 static constexpr auto Descriptor_labels = ComponentDescriptor(
113 );
114 /// `ComponentDescriptor` for the `show_labels` field.
116 ArchetypeName, "Arrows2D:show_labels",
118 );
119 /// `ComponentDescriptor` for the `draw_order` field.
121 ArchetypeName, "Arrows2D:draw_order",
123 );
124 /// `ComponentDescriptor` for the `class_ids` field.
127 );
128
129 public: // START of extensions from arrows2d_ext.cpp:
130 /// Creates new 2D arrows pointing in the given directions, with a base at the origin (0, 0).
132 return Arrows2D().with_vectors(vectors_);
133 }
134
135 // END of extensions from arrows2d_ext.cpp, start of generated code:
136
137 public:
138 Arrows2D() = default;
139 Arrows2D(Arrows2D&& other) = default;
140 Arrows2D(const Arrows2D& other) = default;
141 Arrows2D& operator=(const Arrows2D& other) = default;
142 Arrows2D& operator=(Arrows2D&& other) = default;
143
144 /// Update only some specific fields of a `Arrows2D`.
146 return Arrows2D();
147 }
148
149 /// Clear all the fields of a `Arrows2D`.
151
152 /// All the vectors for each arrow in the batch.
154 vectors = ComponentBatch::from_loggable(_vectors, Descriptor_vectors).value_or_throw();
155 return std::move(*this);
156 }
157
158 /// All the origin (base) positions for each arrow in the batch.
159 ///
160 /// If no origins are set, (0, 0) is used as the origin for each arrow.
162 origins = ComponentBatch::from_loggable(_origins, Descriptor_origins).value_or_throw();
163 return std::move(*this);
164 }
165
166 /// Optional radii for the arrows.
167 ///
168 /// The shaft is rendered as a line with `radius = 0.5 * radius`.
169 /// The tip is rendered with `height = 2.0 * radius` and `radius = 1.0 * radius`.
171 radii = ComponentBatch::from_loggable(_radii, Descriptor_radii).value_or_throw();
172 return std::move(*this);
173 }
174
175 /// Optional colors for the points.
177 colors = ComponentBatch::from_loggable(_colors, Descriptor_colors).value_or_throw();
178 return std::move(*this);
179 }
180
181 /// Optional text labels for the arrows.
182 ///
183 /// If there's a single label present, it will be placed at the center of the entity.
184 /// Otherwise, each instance will have its own label.
186 labels = ComponentBatch::from_loggable(_labels, Descriptor_labels).value_or_throw();
187 return std::move(*this);
188 }
189
190 /// Whether the text labels should be shown.
191 ///
192 /// If not set, labels will automatically appear when there is exactly one label for this entity
193 /// or the number of instances on this entity is under a certain threshold.
196 .value_or_throw();
197 return std::move(*this);
198 }
199
200 /// This method makes it possible to pack multiple `show_labels` in a single component batch.
201 ///
202 /// This only makes sense when used in conjunction with `columns`. `with_show_labels` should
203 /// be used when logging a single row's worth of data.
205 ) && {
207 .value_or_throw();
208 return std::move(*this);
209 }
210
211 /// An optional floating point value that specifies the 2D drawing order.
212 ///
213 /// Objects with higher values are drawn on top of those with lower values.
215 draw_order =
216 ComponentBatch::from_loggable(_draw_order, Descriptor_draw_order).value_or_throw();
217 return std::move(*this);
218 }
219
220 /// This method makes it possible to pack multiple `draw_order` in a single component batch.
221 ///
222 /// This only makes sense when used in conjunction with `columns`. `with_draw_order` should
223 /// be used when logging a single row's worth of data.
225 ) && {
226 draw_order =
227 ComponentBatch::from_loggable(_draw_order, Descriptor_draw_order).value_or_throw();
228 return std::move(*this);
229 }
230
231 /// Optional class Ids for the points.
232 ///
233 /// The `components::ClassId` provides colors and labels if not specified explicitly.
235 class_ids =
236 ComponentBatch::from_loggable(_class_ids, Descriptor_class_ids).value_or_throw();
237 return std::move(*this);
238 }
239
240 /// Partitions the component data into multiple sub-batches.
241 ///
242 /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
243 /// instead, via `ComponentBatch::partitioned`.
244 ///
245 /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
246 ///
247 /// The specified `lengths` must sum to the total length of the component batch.
249
250 /// Partitions the component data into unit-length sub-batches.
251 ///
252 /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
253 /// where `n` is automatically guessed.
255 };
256
257} // namespace rerun::archetypes
258
259namespace rerun {
260 /// \private
261 template <typename T>
262 struct AsComponents;
263
264 /// \private
265 template <>
266 struct AsComponents<archetypes::Arrows2D> {
267 /// Serialize all set component batches.
268 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Arrows2D& archetype);
269 };
270} // namespace rerun
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
A class for representing either a usable value, or an error.
Definition result.hpp:14
All built-in archetypes. See Types in the Rerun manual.
Definition rerun.hpp:76
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
static Result< ComponentBatch > from_loggable(const rerun::Collection< T > &components, const ComponentDescriptor &descriptor)
Creates a new component batch from a collection of component instances.
Definition component_batch.hpp:46
A ComponentDescriptor fully describes the semantics of a column of data.
Definition component_descriptor.hpp:16
The Loggable trait is used by all built-in implementation of rerun::AsComponents to serialize a colle...
Definition loggable.hpp:11
Archetype: 2D arrows with optional colors, radii, labels, etc.
Definition arrows2d.hpp:49
Arrows2D with_colors(const Collection< rerun::components::Color > &_colors) &&
Optional colors for the points.
Definition arrows2d.hpp:176
static Arrows2D clear_fields()
Clear all the fields of a Arrows2D.
Arrows2D with_draw_order(const rerun::components::DrawOrder &_draw_order) &&
An optional floating point value that specifies the 2D drawing order.
Definition arrows2d.hpp:214
static constexpr auto Descriptor_radii
ComponentDescriptor for the radii field.
Definition arrows2d.hpp:103
static constexpr const char ArchetypeName[]
The name of the archetype as used in ComponentDescriptors.
Definition arrows2d.hpp:91
static constexpr auto Descriptor_vectors
ComponentDescriptor for the vectors field.
Definition arrows2d.hpp:94
std::optional< ComponentBatch > labels
Optional text labels for the arrows.
Definition arrows2d.hpp:71
static constexpr auto Descriptor_show_labels
ComponentDescriptor for the show_labels field.
Definition arrows2d.hpp:115
static Arrows2D from_vectors(Collection< components::Vector2D > vectors_)
Creates new 2D arrows pointing in the given directions, with a base at the origin (0,...
Definition arrows2d.hpp:131
Arrows2D with_show_labels(const rerun::components::ShowLabels &_show_labels) &&
Whether the text labels should be shown.
Definition arrows2d.hpp:194
Arrows2D with_vectors(const Collection< rerun::components::Vector2D > &_vectors) &&
All the vectors for each arrow in the batch.
Definition arrows2d.hpp:153
Collection< ComponentColumn > columns(const Collection< uint32_t > &lengths_)
Partitions the component data into multiple sub-batches.
static constexpr auto Descriptor_labels
ComponentDescriptor for the labels field.
Definition arrows2d.hpp:111
static constexpr auto Descriptor_origins
ComponentDescriptor for the origins field.
Definition arrows2d.hpp:98
std::optional< ComponentBatch > radii
Optional radii for the arrows.
Definition arrows2d.hpp:62
static Arrows2D update_fields()
Update only some specific fields of a Arrows2D.
Definition arrows2d.hpp:145
std::optional< ComponentBatch > class_ids
Optional class Ids for the points.
Definition arrows2d.hpp:87
static constexpr auto Descriptor_colors
ComponentDescriptor for the colors field.
Definition arrows2d.hpp:107
std::optional< ComponentBatch > origins
All the origin (base) positions for each arrow in the batch.
Definition arrows2d.hpp:56
Arrows2D with_class_ids(const Collection< rerun::components::ClassId > &_class_ids) &&
Optional class Ids for the points.
Definition arrows2d.hpp:234
Arrows2D with_many_show_labels(const Collection< rerun::components::ShowLabels > &_show_labels) &&
This method makes it possible to pack multiple show_labels in a single component batch.
Definition arrows2d.hpp:204
std::optional< ComponentBatch > colors
Optional colors for the points.
Definition arrows2d.hpp:65
std::optional< ComponentBatch > draw_order
An optional floating point value that specifies the 2D drawing order.
Definition arrows2d.hpp:82
Arrows2D with_many_draw_order(const Collection< rerun::components::DrawOrder > &_draw_order) &&
This method makes it possible to pack multiple draw_order in a single component batch.
Definition arrows2d.hpp:224
Collection< ComponentColumn > columns()
Partitions the component data into unit-length sub-batches.
Arrows2D with_labels(const Collection< rerun::components::Text > &_labels) &&
Optional text labels for the arrows.
Definition arrows2d.hpp:185
std::optional< ComponentBatch > vectors
All the vectors for each arrow in the batch.
Definition arrows2d.hpp:51
static constexpr auto Descriptor_draw_order
ComponentDescriptor for the draw_order field.
Definition arrows2d.hpp:120
static constexpr auto Descriptor_class_ids
ComponentDescriptor for the class_ids field.
Definition arrows2d.hpp:125
std::optional< ComponentBatch > show_labels
Whether the text labels should be shown.
Definition arrows2d.hpp:77
Arrows2D with_radii(const Collection< rerun::components::Radius > &_radii) &&
Optional radii for the arrows.
Definition arrows2d.hpp:170
Arrows2D with_origins(const Collection< rerun::components::Position2D > &_origins) &&
All the origin (base) positions for each arrow in the batch.
Definition arrows2d.hpp:161
Component: Draw order of 2D elements.
Definition draw_order.hpp:19
Component: Whether the entity's components::Text label is shown.
Definition show_labels.hpp:18