Rerun C++ SDK
Loading...
Searching...
No Matches
fill_mode.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/fill_mode.fbs".
3
4#pragma once
5
6#include "../component_descriptor.hpp"
7#include "../result.hpp"
8
9#include <cstdint>
10#include <memory>
11
12namespace arrow {
13 /// \private
14 template <typename T>
15 class NumericBuilder;
16
17 class Array;
18 class DataType;
19 class UInt8Type;
20 using UInt8Builder = NumericBuilder<UInt8Type>;
21} // namespace arrow
22
23namespace rerun::components {
24 /// **Component**: How a geometric shape is drawn and colored.
25 enum class FillMode : uint8_t {
26
27 /// Lines are drawn around the parts of the shape which directly correspond to the logged data.
28 ///
29 /// Examples of what this means:
30 ///
31 /// * An `archetypes::Ellipsoids3D` will draw three axis-aligned ellipses that are cross-sections
32 /// of each ellipsoid, each of which displays two out of three of the sizes of the ellipsoid.
33 /// * For `archetypes::Boxes3D`, it is the edges of the box, identical to `components::FillMode::DenseWireframe`.
35
36 /// Many lines are drawn to represent the surface of the shape in a see-through fashion.
37 ///
38 /// Examples of what this means:
39 ///
40 /// * An `archetypes::Ellipsoids3D` will draw a wireframe triangle mesh that approximates each
41 /// ellipsoid.
42 /// * For `archetypes::Boxes3D`, it is the edges of the box, identical to `components::FillMode::MajorWireframe`.
44
45 /// The surface of the shape is filled in with a solid color. No lines are drawn.
46 Solid = 3,
47 };
48} // namespace rerun::components
49
50namespace rerun {
51 template <typename T>
52 struct Loggable;
53
54 /// \private
55 template <>
56 struct Loggable<components::FillMode> {
57 static constexpr ComponentDescriptor Descriptor = "rerun.components.FillMode";
58
59 /// Returns the arrow data type this type corresponds to.
60 static const std::shared_ptr<arrow::DataType>& arrow_datatype();
61
62 /// Serializes an array of `rerun::components::FillMode` into an arrow array.
63 static Result<std::shared_ptr<arrow::Array>> to_arrow(
64 const components::FillMode* instances, size_t num_instances
65 );
66
67 /// Fills an arrow array builder with an array of this type.
68 static rerun::Error fill_arrow_array_builder(
69 arrow::UInt8Builder* builder, const components::FillMode* elements, size_t num_elements
70 );
71 };
72} // 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
FillMode
Component: How a geometric shape is drawn and colored.
Definition fill_mode.hpp:25
@ Solid
The surface of the shape is filled in with a solid color. No lines are drawn.
@ DenseWireframe
Many lines are drawn to represent the surface of the shape in a see-through fashion.
@ MajorWireframe
Lines are drawn around the parts of the shape which directly correspond to the logged data.
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23