Rerun C++ SDK
Loading...
Searching...
No Matches
depth_meter.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/depth_meter.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**: The world->depth map scaling factor.
15 ///
16 /// This measures how many depth map units are in a world unit.
17 /// For instance, if a depth map uses millimeters and the world uses meters,
18 /// this value would be `1000`.
19 ///
20 /// Note that the only effect on 2D views is the physical depth values shown when hovering the image.
21 /// In 3D views on the other hand, this affects where the points of the point cloud are placed.
22 ///
23 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
24 ///
25 struct DepthMeter {
27
28 public:
29 DepthMeter() = default;
30
31 DepthMeter(rerun::datatypes::Float32 value_) : value(value_) {}
32
33 DepthMeter& operator=(rerun::datatypes::Float32 value_) {
34 value = value_;
35 return *this;
36 }
37
38 DepthMeter(float value_) : value(value_) {}
39
40 DepthMeter& operator=(float value_) {
41 value = value_;
42 return *this;
43 }
44
45 /// Cast to the underlying Float32 datatype
46 operator rerun::datatypes::Float32() const {
47 return value;
48 }
49 };
50} // namespace rerun::components
51
52namespace rerun {
53 static_assert(sizeof(rerun::datatypes::Float32) == sizeof(components::DepthMeter));
54
55 /// \private
56 template <>
57 struct Loggable<components::DepthMeter> {
58 static constexpr ComponentDescriptor Descriptor = "rerun.components.DepthMeter";
59
60 /// Returns the arrow data type this type corresponds to.
61 static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
62 return Loggable<rerun::datatypes::Float32>::arrow_datatype();
63 }
64
65 /// Serializes an array of `rerun::components::DepthMeter` into an arrow array.
66 static Result<std::shared_ptr<arrow::Array>> to_arrow(
67 const components::DepthMeter* instances, size_t num_instances
68 ) {
69 if (num_instances == 0) {
70 return Loggable<rerun::datatypes::Float32>::to_arrow(nullptr, 0);
71 } else if (instances == nullptr) {
72 return rerun::Error(
73 ErrorCode::UnexpectedNullArgument,
74 "Passed array instances is null when num_elements> 0."
75 );
76 } else {
77 return Loggable<rerun::datatypes::Float32>::to_arrow(
78 &instances->value,
79 num_instances
80 );
81 }
82 }
83 };
84} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:99
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:23
Component: The world->depth map scaling factor.
Definition depth_meter.hpp:25
Datatype: A single-precision 32-bit IEEE 754 floating point number.
Definition float32.hpp:25