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_sdk_types/definitions/rerun/components/fill_mode.fbs".
3
4#pragma once
5
6#include "../result.hpp"
7
8#include <cstdint>
9#include <memory>
10
11namespace arrow {
12 /// \private
13 template <typename T>
14 class NumericBuilder;
15
16 class Array;
17 class DataType;
18 class UInt8Type;
19 using UInt8Builder = NumericBuilder<UInt8Type>;
20} // namespace arrow
21
22namespace rerun::components {
23 /// **Component**: How a geometric shape is drawn and colored.
24 enum class FillMode : uint8_t {
25
26 /// Lines are drawn around the parts of the shape which directly correspond to the logged data.
27 ///
28 /// Examples of what this means:
29 ///
30 /// * An `archetypes::Ellipsoids3D` will draw three axis-aligned ellipses that are cross-sections
31 /// of each ellipsoid, each of which displays two out of three of the sizes of the ellipsoid.
32 /// * For `archetypes::Boxes3D`, it is the edges of the box, identical to `components::FillMode::DenseWireframe`.
34
35 /// Many lines are drawn to represent the surface of the shape in a see-through fashion.
36 ///
37 /// Examples of what this means:
38 ///
39 /// * An `archetypes::Ellipsoids3D` will draw a wireframe triangle mesh that approximates each
40 /// ellipsoid.
41 /// * For `archetypes::Boxes3D`, it is the edges of the box, identical to `components::FillMode::MajorWireframe`.
43
44 /// The surface of the shape is filled in with a solid color. No lines are drawn.
45 Solid = 3,
46
47 /// The surface of the shape is filled in with a transparent color, with major wireframe lines on top.
48 ///
49 /// This gives a good default appearance that shows both the shape's surface and its structure.
51 };
52} // namespace rerun::components
53
54namespace rerun {
55 template <typename T>
56 struct Loggable;
57
58 /// \private
59 template <>
60 struct Loggable<components::FillMode> {
61 static constexpr std::string_view ComponentType = "rerun.components.FillMode";
62
63 /// Returns the arrow data type this type corresponds to.
64 static const std::shared_ptr<arrow::DataType>& arrow_datatype();
65
66 /// Serializes an array of `rerun::components::FillMode` into an arrow array.
67 static Result<std::shared_ptr<arrow::Array>> to_arrow(
68 const components::FillMode* instances, size_t num_instances
69 );
70
71 /// Fills an arrow array builder with an array of this type.
72 static rerun::Error fill_arrow_array_builder(
73 arrow::UInt8Builder* builder, const components::FillMode* elements, size_t num_elements
74 );
75 };
76} // namespace rerun
Status outcome object (success or error) returned for fallible operations.
Definition error.hpp:103
All built-in components. See Types in the Rerun manual.
Definition rerun.hpp:79
FillMode
Component: How a geometric shape is drawn and colored.
Definition fill_mode.hpp:24
@ TransparentFillMajorWireframe
The surface of the shape is filled in with a transparent color, with major wireframe lines on top.
@ 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