Rerun C++ SDK
Loading...
Searching...
No Matches
show_labels.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/components/show_labels.fbs".
3
4#pragma once
5
6#include "../component_descriptor.hpp"
7#include "../datatypes/bool.hpp"
8#include "../result.hpp"
9
10#include <cstdint>
11#include <memory>
12
13namespace rerun::components {
14 /// **Component**: Whether the entity's `components::Text` label is shown.
15 ///
16 /// The main purpose of this component existing separately from the labels themselves
17 /// is to be overridden when desired, to allow hiding and showing from the viewer and
18 /// blueprints.
19 struct ShowLabels {
20 /// Whether the entity's `components::Text` label is shown.
22
23 public:
24 ShowLabels() = default;
25
26 ShowLabels(rerun::datatypes::Bool show_labels_) : show_labels(show_labels_) {}
27
28 ShowLabels& operator=(rerun::datatypes::Bool show_labels_) {
29 show_labels = show_labels_;
30 return *this;
31 }
32
33 ShowLabels(bool value_) : show_labels(value_) {}
34
35 ShowLabels& operator=(bool value_) {
36 show_labels = value_;
37 return *this;
38 }
39
40 /// Cast to the underlying Bool datatype
41 operator rerun::datatypes::Bool() const {
42 return show_labels;
43 }
44 };
45} // namespace rerun::components
46
47namespace rerun {
48 static_assert(sizeof(rerun::datatypes::Bool) == sizeof(components::ShowLabels));
49
50 /// \private
51 template <>
52 struct Loggable<components::ShowLabels> {
53 static constexpr ComponentDescriptor Descriptor = "rerun.components.ShowLabels";
54
55 /// Returns the arrow data type this type corresponds to.
56 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
57 return Loggable<rerun::datatypes::Bool>::arrow_datatype();
58 }
59
60 /// Serializes an array of `rerun::components::ShowLabels` into an arrow array.
61 static Result<std::shared_ptr<arrow::Array>> to_arrow(
62 const components::ShowLabels* instances, size_t num_instances
63 ) {
64 if (num_instances == 0) {
65 return Loggable<rerun::datatypes::Bool>::to_arrow(nullptr, 0);
66 } else if (instances == nullptr) {
67 return rerun::Error(
68 ErrorCode::UnexpectedNullArgument,
69 "Passed array instances is null when num_elements> 0."
70 );
71 } else {
72 return Loggable<rerun::datatypes::Bool>::to_arrow(
73 &instances->show_labels,
74 num_instances
75 );
76 }
77 }
78 };
79} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:95
All built-in components. See Types in the Rerun manual.
Definition rerun.hpp:80
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
Component: Whether the entity's components::Text label is shown.
Definition show_labels.hpp:19
rerun::datatypes::Bool show_labels
Whether the entity's components::Text label is shown.
Definition show_labels.hpp:21
Datatype: A single boolean.
Definition bool.hpp:20