Rerun C++ SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
draw_order.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/draw_order.fbs".
3
4#pragma once
5
6#include "../component_descriptor.hpp"
7#include "../datatypes/float32.hpp"
8#include "../result.hpp"
9
10#include <cstdint>
11#include <memory>
12
13namespace rerun::components {
14 /// **Component**: Draw order of 2D elements. Higher values are drawn on top of lower values.
15 ///
16 /// An entity can have only a single draw order component.
17 /// Within an entity draw order is governed by the order of the components.
18 ///
19 /// Draw order for entities with the same draw order is generally undefined.
20 struct DrawOrder {
22
23 public:
24 DrawOrder() = default;
25
26 DrawOrder(rerun::datatypes::Float32 value_) : value(value_) {}
27
28 DrawOrder& operator=(rerun::datatypes::Float32 value_) {
29 value = value_;
30 return *this;
31 }
32
33 DrawOrder(float value_) : value(value_) {}
34
35 DrawOrder& operator=(float value_) {
36 value = value_;
37 return *this;
38 }
39
40 /// Cast to the underlying Float32 datatype
41 operator rerun::datatypes::Float32() const {
42 return value;
43 }
44 };
45} // namespace rerun::components
46
47namespace rerun {
48 static_assert(sizeof(rerun::datatypes::Float32) == sizeof(components::DrawOrder));
49
50 /// \private
51 template <>
52 struct Loggable<components::DrawOrder> {
53 static constexpr ComponentDescriptor Descriptor = "rerun.components.DrawOrder";
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::Float32>::arrow_datatype();
58 }
59
60 /// Serializes an array of `rerun::components::DrawOrder` into an arrow array.
61 static Result<std::shared_ptr<arrow::Array>> to_arrow(
62 const components::DrawOrder* instances, size_t num_instances
63 ) {
64 if (num_instances == 0) {
65 return Loggable<rerun::datatypes::Float32>::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::Float32>::to_arrow(
73 &instances->value,
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: Draw order of 2D elements.
Definition draw_order.hpp:20
Datatype: A single-precision 32-bit IEEE 754 floating point number.
Definition float32.hpp:25