Rerun C++ SDK
Loading...
Searching...
No Matches
opacity.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/opacity.fbs".
3
4#pragma once
5
6#include "../datatypes/float32.hpp"
7#include "../result.hpp"
8
9#include <cstdint>
10#include <memory>
11
12namespace rerun::components {
13 /// **Component**: Degree of transparency ranging from 0.0 (fully transparent) to 1.0 (fully opaque).
14 ///
15 /// The final opacity value may be a result of multiplication with alpha values as specified by other color sources.
16 /// Unless otherwise specified, the default value is 1.
17 struct Opacity {
19
20 public:
21 Opacity() = default;
22
23 Opacity(rerun::datatypes::Float32 opacity_) : opacity(opacity_) {}
24
25 Opacity& operator=(rerun::datatypes::Float32 opacity_) {
26 opacity = opacity_;
27 return *this;
28 }
29
30 Opacity(float value_) : opacity(value_) {}
31
32 Opacity& operator=(float value_) {
33 opacity = value_;
34 return *this;
35 }
36
37 /// Cast to the underlying Float32 datatype
38 operator rerun::datatypes::Float32() const {
39 return opacity;
40 }
41 };
42} // namespace rerun::components
43
44namespace rerun {
45 static_assert(sizeof(rerun::datatypes::Float32) == sizeof(components::Opacity));
46
47 /// \private
48 template <>
49 struct Loggable<components::Opacity> {
50 static constexpr const char Name[] = "rerun.components.Opacity";
51
52 /// Returns the arrow data type this type corresponds to.
53 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
54 return Loggable<rerun::datatypes::Float32>::arrow_datatype();
55 }
56
57 /// Serializes an array of `rerun::components::Opacity` into an arrow array.
58 static Result<std::shared_ptr<arrow::Array>> to_arrow(
59 const components::Opacity* instances, size_t num_instances
60 ) {
61 if (num_instances == 0) {
62 return Loggable<rerun::datatypes::Float32>::to_arrow(nullptr, 0);
63 } else if (instances == nullptr) {
64 return rerun::Error(
65 ErrorCode::UnexpectedNullArgument,
66 "Passed array instances is null when num_elements> 0."
67 );
68 } else {
69 return Loggable<rerun::datatypes::Float32>::to_arrow(
70 &instances->opacity,
71 num_instances
72 );
73 }
74 }
75 };
76} // 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:79
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:22
Component: Degree of transparency ranging from 0.0 (fully transparent) to 1.0 (fully opaque).
Definition opacity.hpp:17
Datatype: A single-precision 32-bit IEEE 754 floating point number.
Definition float32.hpp:24