Rerun C++ SDK
Loading...
Searching...
No Matches
map_zoom.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/map_zoom.fbs".
3
4#pragma once
5
6#include "../../blueprint/components/zoom_level.hpp"
7#include "../../collection.hpp"
8#include "../../component_batch.hpp"
9#include "../../component_column.hpp"
10#include "../../indicator_component.hpp"
11#include "../../result.hpp"
12
13#include <cstdint>
14#include <optional>
15#include <utility>
16#include <vector>
17
18namespace rerun::blueprint::archetypes {
19 /// **Archetype**: Configuration of the map view zoom level.
20 struct MapZoom {
21 /// Zoom level for the map.
22 ///
23 /// Zoom level follow the [`OpenStreetMap` definition](https://wiki.openstreetmap.org/wiki/Zoom_levels).
24 std::optional<ComponentBatch> zoom;
25
26 public:
27 static constexpr const char IndicatorComponentName[] =
28 "rerun.blueprint.components.MapZoomIndicator";
29
30 /// Indicator component, used to identify the archetype when converting to a list of components.
32 /// The name of the archetype as used in `ComponentDescriptor`s.
33 static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.MapZoom";
34
35 /// `ComponentDescriptor` for the `zoom` field.
36 static constexpr auto Descriptor_zoom = ComponentDescriptor(
37 ArchetypeName, "zoom",
39 );
40
41 public:
42 MapZoom() = default;
43 MapZoom(MapZoom&& other) = default;
44 MapZoom(const MapZoom& other) = default;
45 MapZoom& operator=(const MapZoom& other) = default;
46 MapZoom& operator=(MapZoom&& other) = default;
47
49 : zoom(ComponentBatch::from_loggable(std::move(_zoom), Descriptor_zoom).value_or_throw()
50 ) {}
51
52 /// Update only some specific fields of a `MapZoom`.
54 return MapZoom();
55 }
56
57 /// Clear all the fields of a `MapZoom`.
59
60 /// Zoom level for the map.
61 ///
62 /// Zoom level follow the [`OpenStreetMap` definition](https://wiki.openstreetmap.org/wiki/Zoom_levels).
64 zoom = ComponentBatch::from_loggable(_zoom, Descriptor_zoom).value_or_throw();
65 return std::move(*this);
66 }
67
68 /// Partitions the component data into multiple sub-batches.
69 ///
70 /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
71 /// instead, via `ComponentBatch::partitioned`.
72 ///
73 /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
74 ///
75 /// The specified `lengths` must sum to the total length of the component batch.
77
78 /// Partitions the component data into unit-length sub-batches.
79 ///
80 /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
81 /// where `n` is automatically guessed.
83 };
84
85} // namespace rerun::blueprint::archetypes
86
87namespace rerun {
88 /// \private
89 template <typename T>
90 struct AsComponents;
91
92 /// \private
93 template <>
94 struct AsComponents<blueprint::archetypes::MapZoom> {
95 /// Serialize all set component batches.
96 static Result<Collection<ComponentBatch>> as_batches(
97 const blueprint::archetypes::MapZoom& archetype
98 );
99 };
100} // 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
Arrow-encoded data of a single batch of components together with a component descriptor.
Definition component_batch.hpp:28
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: Configuration of the map view zoom level.
Definition map_zoom.hpp:20
Collection< ComponentColumn > columns(const Collection< uint32_t > &lengths_)
Partitions the component data into multiple sub-batches.
Collection< ComponentColumn > columns()
Partitions the component data into unit-length sub-batches.
static MapZoom clear_fields()
Clear all the fields of a MapZoom.
static constexpr auto Descriptor_zoom
ComponentDescriptor for the zoom field.
Definition map_zoom.hpp:36
MapZoom with_zoom(const rerun::blueprint::components::ZoomLevel &_zoom) &&
Zoom level for the map.
Definition map_zoom.hpp:63
static constexpr const char ArchetypeName[]
The name of the archetype as used in ComponentDescriptors.
Definition map_zoom.hpp:33
static MapZoom update_fields()
Update only some specific fields of a MapZoom.
Definition map_zoom.hpp:53
std::optional< ComponentBatch > zoom
Zoom level for the map.
Definition map_zoom.hpp:24
Component: A zoom level determines how much of the world is visible on a map.
Definition zoom_level.hpp:15
Indicator component used by archetypes when converting them to component lists.
Definition indicator_component.hpp:32