Rerun C++ SDK
Loading...
Searching...
No Matches
plot_legend.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/blueprint/archetypes/plot_legend.fbs".
3
4#pragma once
5
6#include "../../blueprint/components/corner2d.hpp"
7#include "../../collection.hpp"
8#include "../../component_batch.hpp"
9#include "../../component_column.hpp"
10#include "../../components/visible.hpp"
11#include "../../result.hpp"
12
13#include <cstdint>
14#include <optional>
15#include <utility>
16#include <vector>
17
18namespace rerun::blueprint::archetypes {
19 /// **Archetype**: Configuration for the legend of a plot.
20 ///
21 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
22 ///
23 struct PlotLegend {
24 /// To what corner the legend is aligned.
25 ///
26 /// Defaults to the right bottom corner.
27 std::optional<ComponentBatch> corner;
28
29 /// Whether the legend is shown at all.
30 ///
31 /// True by default.
32 std::optional<ComponentBatch> visible;
33
34 public:
35 /// The name of the archetype as used in `ComponentDescriptor`s.
36 static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.PlotLegend";
37
38 /// `ComponentDescriptor` for the `corner` field.
39 static constexpr auto Descriptor_corner = ComponentDescriptor(
40 ArchetypeName, "PlotLegend:corner",
42 );
43 /// `ComponentDescriptor` for the `visible` field.
44 static constexpr auto Descriptor_visible = ComponentDescriptor(
46 );
47
48 public:
49 PlotLegend() = default;
50 PlotLegend(PlotLegend&& other) = default;
51 PlotLegend(const PlotLegend& other) = default;
52 PlotLegend& operator=(const PlotLegend& other) = default;
53 PlotLegend& operator=(PlotLegend&& other) = default;
54
55 /// Update only some specific fields of a `PlotLegend`.
57 return PlotLegend();
58 }
59
60 /// Clear all the fields of a `PlotLegend`.
62
63 /// To what corner the legend is aligned.
64 ///
65 /// Defaults to the right bottom corner.
66 PlotLegend with_corner(const rerun::blueprint::components::Corner2D& _corner) && {
67 corner = ComponentBatch::from_loggable(_corner, Descriptor_corner).value_or_throw();
68 return std::move(*this);
69 }
70
71 /// Whether the legend is shown at all.
72 ///
73 /// True by default.
75 visible = ComponentBatch::from_loggable(_visible, Descriptor_visible).value_or_throw();
76 return std::move(*this);
77 }
78
79 /// Partitions the component data into multiple sub-batches.
80 ///
81 /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
82 /// instead, via `ComponentBatch::partitioned`.
83 ///
84 /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
85 ///
86 /// The specified `lengths` must sum to the total length of the component batch.
88
89 /// Partitions the component data into unit-length sub-batches.
90 ///
91 /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
92 /// where `n` is automatically guessed.
94 };
95
96} // namespace rerun::blueprint::archetypes
97
98namespace rerun {
99 /// \private
100 template <typename T>
101 struct AsComponents;
102
103 /// \private
104 template <>
105 struct AsComponents<blueprint::archetypes::PlotLegend> {
106 /// Serialize all set component batches.
107 static Result<Collection<ComponentBatch>> as_batches(
108 const blueprint::archetypes::PlotLegend& archetype
109 );
110 };
111} // 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 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: Configuration for the legend of a plot.
Definition plot_legend.hpp:23
static constexpr const char ArchetypeName[]
The name of the archetype as used in ComponentDescriptors.
Definition plot_legend.hpp:36
static PlotLegend update_fields()
Update only some specific fields of a PlotLegend.
Definition plot_legend.hpp:56
PlotLegend with_visible(const rerun::components::Visible &_visible) &&
Whether the legend is shown at all.
Definition plot_legend.hpp:74
static constexpr auto Descriptor_visible
ComponentDescriptor for the visible field.
Definition plot_legend.hpp:44
std::optional< ComponentBatch > corner
To what corner the legend is aligned.
Definition plot_legend.hpp:27
std::optional< ComponentBatch > visible
Whether the legend is shown at all.
Definition plot_legend.hpp:32
Collection< ComponentColumn > columns(const Collection< uint32_t > &lengths_)
Partitions the component data into multiple sub-batches.
Collection< ComponentColumn > columns()
Partitions the component data into unit-length sub-batches.
static constexpr auto Descriptor_corner
ComponentDescriptor for the corner field.
Definition plot_legend.hpp:39
static PlotLegend clear_fields()
Clear all the fields of a PlotLegend.
PlotLegend with_corner(const rerun::blueprint::components::Corner2D &_corner) &&
To what corner the legend is aligned.
Definition plot_legend.hpp:66
Component: Whether the container, view, entity or instance is currently visible.
Definition visible.hpp:14