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 "../../result.hpp"
11
12#include <cstdint>
13#include <optional>
14#include <utility>
15#include <vector>
16
17namespace rerun::blueprint::archetypes {
18 /// **Archetype**: Configuration of the map view zoom level.
19 ///
20 /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
21 ///
22 struct MapZoom {
23 /// Zoom level for the map.
24 ///
25 /// Zoom level follow the [`OpenStreetMap` definition](https://wiki.openstreetmap.org/wiki/Zoom_levels).
26 std::optional<ComponentBatch> zoom;
27
28 public:
29 /// The name of the archetype as used in `ComponentDescriptor`s.
30 static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.MapZoom";
31
32 /// `ComponentDescriptor` for the `zoom` field.
33 static constexpr auto Descriptor_zoom = ComponentDescriptor(
34 ArchetypeName, "MapZoom:zoom",
36 );
37
38 public:
39 MapZoom() = default;
40 MapZoom(MapZoom&& other) = default;
41 MapZoom(const MapZoom& other) = default;
42 MapZoom& operator=(const MapZoom& other) = default;
43 MapZoom& operator=(MapZoom&& other) = default;
44
46 : zoom(ComponentBatch::from_loggable(std::move(_zoom), Descriptor_zoom).value_or_throw()
47 ) {}
48
49 /// Update only some specific fields of a `MapZoom`.
51 return MapZoom();
52 }
53
54 /// Clear all the fields of a `MapZoom`.
56
57 /// Zoom level for the map.
58 ///
59 /// Zoom level follow the [`OpenStreetMap` definition](https://wiki.openstreetmap.org/wiki/Zoom_levels).
61 zoom = ComponentBatch::from_loggable(_zoom, Descriptor_zoom).value_or_throw();
62 return std::move(*this);
63 }
64
65 /// Partitions the component data into multiple sub-batches.
66 ///
67 /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
68 /// instead, via `ComponentBatch::partitioned`.
69 ///
70 /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
71 ///
72 /// The specified `lengths` must sum to the total length of the component batch.
74
75 /// Partitions the component data into unit-length sub-batches.
76 ///
77 /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
78 /// where `n` is automatically guessed.
80 };
81
82} // namespace rerun::blueprint::archetypes
83
84namespace rerun {
85 /// \private
86 template <typename T>
87 struct AsComponents;
88
89 /// \private
90 template <>
91 struct AsComponents<blueprint::archetypes::MapZoom> {
92 /// Serialize all set component batches.
93 static Result<Collection<ComponentBatch>> as_batches(
94 const blueprint::archetypes::MapZoom& archetype
95 );
96 };
97} // 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)
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:16
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:22
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:33
MapZoom with_zoom(const rerun::blueprint::components::ZoomLevel &_zoom) &&
Zoom level for the map.
Definition map_zoom.hpp:60
static constexpr const char ArchetypeName[]
The name of the archetype as used in ComponentDescriptors.
Definition map_zoom.hpp:30
static MapZoom update_fields()
Update only some specific fields of a MapZoom.
Definition map_zoom.hpp:50
std::optional< ComponentBatch > zoom
Zoom level for the map.
Definition map_zoom.hpp:26
Component: A zoom level determines how much of the world is visible on a map.
Definition zoom_level.hpp:17