Rerun C++ SDK
Loading...
Searching...
No Matches
force_center.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/blueprint/archetypes/force_center.fbs".
3
4#pragma once
5
6#include "../../blueprint/components/enabled.hpp"
7#include "../../blueprint/components/force_strength.hpp"
8#include "../../collection.hpp"
9#include "../../component_batch.hpp"
10#include "../../component_column.hpp"
11#include "../../indicator_component.hpp"
12#include "../../result.hpp"
13
14#include <cstdint>
15#include <optional>
16#include <utility>
17#include <vector>
18
19namespace rerun::blueprint::archetypes {
20 /// **Archetype**: Tries to move the center of mass of the graph to the origin.
21 struct ForceCenter {
22 /// Whether the center force is enabled.
23 ///
24 /// The center force tries to move the center of mass of the graph towards the origin.
25 std::optional<ComponentBatch> enabled;
26
27 /// The strength of the force.
28 std::optional<ComponentBatch> strength;
29
30 public:
31 static constexpr const char IndicatorComponentName[] =
32 "rerun.blueprint.components.ForceCenterIndicator";
33
34 /// Indicator component, used to identify the archetype when converting to a list of components.
36 /// The name of the archetype as used in `ComponentDescriptor`s.
37 static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.ForceCenter";
38
39 /// `ComponentDescriptor` for the `enabled` field.
40 static constexpr auto Descriptor_enabled = ComponentDescriptor(
41 ArchetypeName, "enabled",
43 );
44 /// `ComponentDescriptor` for the `strength` field.
46 ArchetypeName, "strength",
48 );
49
50 public:
51 ForceCenter() = default;
52 ForceCenter(ForceCenter&& other) = default;
53 ForceCenter(const ForceCenter& other) = default;
54 ForceCenter& operator=(const ForceCenter& other) = default;
55 ForceCenter& operator=(ForceCenter&& other) = default;
56
57 /// Update only some specific fields of a `ForceCenter`.
59 return ForceCenter();
60 }
61
62 /// Clear all the fields of a `ForceCenter`.
64
65 /// Whether the center force is enabled.
66 ///
67 /// The center force tries to move the center of mass of the graph towards the origin.
69 enabled = ComponentBatch::from_loggable(_enabled, Descriptor_enabled).value_or_throw();
70 return std::move(*this);
71 }
72
73 /// The strength of the force.
75 strength =
76 ComponentBatch::from_loggable(_strength, Descriptor_strength).value_or_throw();
77 return std::move(*this);
78 }
79
80 /// Partitions the component data into multiple sub-batches.
81 ///
82 /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
83 /// instead, via `ComponentBatch::partitioned`.
84 ///
85 /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
86 ///
87 /// The specified `lengths` must sum to the total length of the component batch.
89
90 /// Partitions the component data into unit-length sub-batches.
91 ///
92 /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
93 /// where `n` is automatically guessed.
95 };
96
97} // namespace rerun::blueprint::archetypes
98
99namespace rerun {
100 /// \private
101 template <typename T>
102 struct AsComponents;
103
104 /// \private
105 template <>
106 struct AsComponents<blueprint::archetypes::ForceCenter> {
107 /// Serialize all set component batches.
108 static Result<Collection<ComponentBatch>> as_batches(
110 );
111 };
112} // namespace rerun
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
A class for representing either a usable value, or an error.
Definition result.hpp:14
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
static Result< ComponentBatch > from_loggable(const rerun::Collection< T > &components, const ComponentDescriptor &descriptor=rerun::Loggable< T >::Descriptor)
Creates a new component batch from a collection of component instances.
Definition component_batch.hpp:46
A ComponentDescriptor fully describes the semantics of a column of data.
Definition component_descriptor.hpp:14
The Loggable trait is used by all built-in implementation of rerun::AsComponents to serialize a colle...
Definition loggable.hpp:11
Archetype: Tries to move the center of mass of the graph to the origin.
Definition force_center.hpp:21
static constexpr const char ArchetypeName[]
The name of the archetype as used in ComponentDescriptors.
Definition force_center.hpp:37
ForceCenter with_strength(const rerun::blueprint::components::ForceStrength &_strength) &&
The strength of the force.
Definition force_center.hpp:74
static constexpr auto Descriptor_enabled
ComponentDescriptor for the enabled field.
Definition force_center.hpp:40
Collection< ComponentColumn > columns()
Partitions the component data into unit-length sub-batches.
static ForceCenter clear_fields()
Clear all the fields of a ForceCenter.
static constexpr auto Descriptor_strength
ComponentDescriptor for the strength field.
Definition force_center.hpp:45
ForceCenter with_enabled(const rerun::blueprint::components::Enabled &_enabled) &&
Whether the center force is enabled.
Definition force_center.hpp:68
static ForceCenter update_fields()
Update only some specific fields of a ForceCenter.
Definition force_center.hpp:58
std::optional< ComponentBatch > enabled
Whether the center force is enabled.
Definition force_center.hpp:25
Collection< ComponentColumn > columns(const Collection< uint32_t > &lengths_)
Partitions the component data into multiple sub-batches.
std::optional< ComponentBatch > strength
The strength of the force.
Definition force_center.hpp:28
Component: Whether a procedure is enabled.
Definition enabled.hpp:15
Component: The strength of a given force.
Definition force_strength.hpp:17
Indicator component used by archetypes when converting them to component lists.
Definition indicator_component.hpp:32