Rerun C++ SDK
Loading...
Searching...
No Matches
quaternion.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/datatypes/quaternion.fbs".
3
4#pragma once
5
6#include "../rerun_sdk_export.hpp"
7#include "../result.hpp"
8
9#include <array>
10#include <cstdint>
11#include <memory>
12
13namespace arrow {
14 class Array;
15 class DataType;
16 class FixedSizeListBuilder;
17} // namespace arrow
18
19namespace rerun::datatypes {
20 /// **Datatype**: A Quaternion represented by 4 real numbers.
21 ///
22 /// Note: although the x,y,z,w components of the quaternion will be passed through to the
23 /// datastore as provided, when used in the Viewer Quaternions will always be normalized.
24 struct Quaternion {
25 std::array<float, 4> xyzw;
26
27 public: // START of extensions from quaternion_ext.cpp:
28 RERUN_SDK_EXPORT static const Quaternion IDENTITY;
29 RERUN_SDK_EXPORT static const Quaternion INVALID;
30
31 /// Construct Quaternion from x/y/z/w values.
32 static Quaternion from_xyzw(float x, float y, float z, float w) {
33 return Quaternion::from_xyzw({x, y, z, w});
34 }
35
36 /// Construct Quaternion from w/x/y/z values.
37 static Quaternion from_wxyz(float w, float x, float y, float z) {
38 return Quaternion::from_xyzw(x, y, z, w);
39 }
40
41 /// Construct Quaternion from x/y/z/w array.
42 static Quaternion from_xyzw(std::array<float, 4> xyzw_) {
43 Quaternion q;
44 q.xyzw = xyzw_;
45 return q;
46 }
47
48 /// Construct Quaternion from w/x/y/z array.
49 static Quaternion from_wxyz(std::array<float, 4> wxyz_) {
50 return Quaternion::from_xyzw(wxyz_[1], wxyz_[2], wxyz_[3], wxyz_[0]);
51 }
52
53 /// Construct Quaternion from x/y/z/w float pointer.
54 static Quaternion from_xyzw(const float* xyzw_) {
55 return Quaternion::from_xyzw(xyzw_[0], xyzw_[1], xyzw_[2], xyzw_[3]);
56 }
57
58 /// Construct Quaternion from w/x/y/z float pointer.
59 static Quaternion from_wxyz(const float* wxyz_) {
60 return Quaternion::from_xyzw(wxyz_[1], wxyz_[2], wxyz_[3], wxyz_[0]);
61 }
62
63 float x() const {
64 return xyzw[0];
65 }
66
67 float y() const {
68 return xyzw[1];
69 }
70
71 float z() const {
72 return xyzw[2];
73 }
74
75 float w() const {
76 return xyzw[3];
77 }
78
79 // END of extensions from quaternion_ext.cpp, start of generated code:
80
81 public:
82 Quaternion() = default;
83 };
84} // namespace rerun::datatypes
85
86namespace rerun {
87 template <typename T>
88 struct Loggable;
89
90 /// \private
91 template <>
92 struct Loggable<datatypes::Quaternion> {
93 static constexpr std::string_view ComponentType = "rerun.datatypes.Quaternion";
94
95 /// Returns the arrow data type this type corresponds to.
96 static const std::shared_ptr<arrow::DataType>& arrow_datatype();
97
98 /// Serializes an array of `rerun::datatypes::Quaternion` into an arrow array.
99 static Result<std::shared_ptr<arrow::Array>> to_arrow(
100 const datatypes::Quaternion* instances, size_t num_instances
101 );
102
103 /// Fills an arrow array builder with an array of this type.
104 static rerun::Error fill_arrow_array_builder(
105 arrow::FixedSizeListBuilder* builder, const datatypes::Quaternion* elements,
106 size_t num_elements
107 );
108 };
109} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:99
All built-in datatypes. See Types in the Rerun manual.
Definition rerun.hpp:82
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
Datatype: A Quaternion represented by 4 real numbers.
Definition quaternion.hpp:24
static Quaternion from_wxyz(const float *wxyz_)
Construct Quaternion from w/x/y/z float pointer.
Definition quaternion.hpp:59
static Quaternion from_wxyz(std::array< float, 4 > wxyz_)
Construct Quaternion from w/x/y/z array.
Definition quaternion.hpp:49
static Quaternion from_wxyz(float w, float x, float y, float z)
Construct Quaternion from w/x/y/z values.
Definition quaternion.hpp:37
static Quaternion from_xyzw(const float *xyzw_)
Construct Quaternion from x/y/z/w float pointer.
Definition quaternion.hpp:54
static Quaternion from_xyzw(float x, float y, float z, float w)
Construct Quaternion from x/y/z/w values.
Definition quaternion.hpp:32
static Quaternion from_xyzw(std::array< float, 4 > xyzw_)
Construct Quaternion from x/y/z/w array.
Definition quaternion.hpp:42