From 1193f5eb4382f81feb553a2b25dcc31728137be2 Mon Sep 17 00:00:00 2001 From: Wumpf Date: Fri, 31 Jan 2025 17:52:31 +0000 Subject: [PATCH] Update the C++ docs --- ...ypes_2annotation__context_8hpp_source.html | 2 +- ...etypes_2near__clip__plane_8hpp_source.html | 2 +- .../main/archetypes_2scalar_8hpp_source.html | 4 +- ...etypes_2view__coordinates_8hpp_source.html | 2 +- ...hetypes_2visual__bounds2d_8hpp_source.html | 2 +- docs/cpp/main/arrows2d_8hpp_source.html | 2 +- docs/cpp/main/arrows3d_8hpp_source.html | 2 +- docs/cpp/main/as__components_8hpp_source.html | 131 +++-- docs/cpp/main/asset3d_8hpp_source.html | 2 +- docs/cpp/main/asset__video_8hpp_source.html | 2 +- docs/cpp/main/background_8hpp_source.html | 2 +- docs/cpp/main/bar__chart_8hpp_source.html | 2 +- docs/cpp/main/boxes2d_8hpp_source.html | 2 +- docs/cpp/main/boxes3d_8hpp_source.html | 2 +- docs/cpp/main/capsules3d_8hpp_source.html | 2 +- docs/cpp/main/clear_8hpp_source.html | 2 +- .../container__blueprint_8hpp_source.html | 2 +- .../main/dataframe__query_8hpp_source.html | 2 +- docs/cpp/main/deprecated.html | 120 +++++ docs/cpp/main/depth__image_8hpp_source.html | 2 +- docs/cpp/main/ellipsoids3d_8hpp_source.html | 2 +- docs/cpp/main/encoded__image_8hpp_source.html | 2 +- docs/cpp/main/force__center_8hpp_source.html | 2 +- .../force__collision__radius_8hpp_source.html | 2 +- docs/cpp/main/force__link_8hpp_source.html | 2 +- .../main/force__many__body_8hpp_source.html | 2 +- .../cpp/main/force__position_8hpp_source.html | 2 +- docs/cpp/main/functions_f.html | 3 +- docs/cpp/main/functions_func_f.html | 5 +- .../main/geo__line__strings_8hpp_source.html | 2 +- docs/cpp/main/geo__points_8hpp_source.html | 2 +- docs/cpp/main/graph__edges_8hpp_source.html | 2 +- docs/cpp/main/graph__nodes_8hpp_source.html | 2 +- docs/cpp/main/image_8hpp_source.html | 2 +- .../main/instance__poses3d_8hpp_source.html | 2 +- docs/cpp/main/line__grid3d_8hpp_source.html | 2 +- docs/cpp/main/line__strips2d_8hpp_source.html | 2 +- docs/cpp/main/line__strips3d_8hpp_source.html | 2 +- .../cpp/main/map__background_8hpp_source.html | 2 +- docs/cpp/main/map__zoom_8hpp_source.html | 2 +- docs/cpp/main/mesh3d_8hpp_source.html | 2 +- docs/cpp/main/navtreedata.js | 21 +- docs/cpp/main/navtreeindex0.js | 500 +++++++++--------- docs/cpp/main/navtreeindex1.js | 430 +++++++-------- docs/cpp/main/navtreeindex10.js | 500 +++++++++--------- docs/cpp/main/navtreeindex11.js | 437 +++++++-------- docs/cpp/main/navtreeindex2.js | 498 ++++++++--------- docs/cpp/main/navtreeindex3.js | 500 +++++++++--------- docs/cpp/main/navtreeindex4.js | 500 +++++++++--------- docs/cpp/main/navtreeindex5.js | 500 +++++++++--------- docs/cpp/main/navtreeindex6.js | 500 +++++++++--------- docs/cpp/main/navtreeindex7.js | 500 +++++++++--------- docs/cpp/main/navtreeindex8.js | 500 +++++++++--------- docs/cpp/main/navtreeindex9.js | 500 +++++++++--------- docs/cpp/main/pages.html | 1 + .../main/panel__blueprint_8hpp_source.html | 2 +- docs/cpp/main/pinhole_8hpp_source.html | 2 +- docs/cpp/main/plot__legend_8hpp_source.html | 2 +- docs/cpp/main/points2d_8hpp_source.html | 2 +- docs/cpp/main/points3d_8hpp_source.html | 2 +- .../main/recording__stream_8hpp_source.html | 6 +- docs/cpp/main/scalar__axis_8hpp_source.html | 2 +- docs/cpp/main/search/all_13.js | 90 ++-- docs/cpp/main/search/all_3.js | 267 +++++----- docs/cpp/main/search/all_5.js | 29 +- docs/cpp/main/search/all_8.js | 4 +- docs/cpp/main/search/all_c.js | 31 +- docs/cpp/main/search/all_d.js | 25 +- docs/cpp/main/search/functions_5.js | 39 +- docs/cpp/main/search/pages_1.js | 2 +- docs/cpp/main/search/pages_2.js | 2 +- docs/cpp/main/search/pages_3.js | 4 + docs/cpp/main/search/searchdata.js | 2 +- docs/cpp/main/search/variables_8.js | 4 +- .../main/segmentation__image_8hpp_source.html | 2 +- docs/cpp/main/series__line_8hpp_source.html | 2 +- docs/cpp/main/series__point_8hpp_source.html | 2 +- .../structrerun_1_1TimeColumn-members.html | 13 +- docs/cpp/main/structrerun_1_1TimeColumn.html | 56 ++ ...ructrerun_1_1archetypes_1_1AssetVideo.html | 2 +- ...structrerun_1_1archetypes_1_1Points3D.html | 2 +- .../structrerun_1_1archetypes_1_1Scalar.html | 4 +- ..._1_1archetypes_1_1VideoFrameReference.html | 2 +- docs/cpp/main/tensor_8hpp_source.html | 2 +- .../tensor__scalar__mapping_8hpp_source.html | 2 +- .../tensor__slice__selection_8hpp_source.html | 2 +- .../main/tensor__view__fit_8hpp_source.html | 2 +- docs/cpp/main/text__document_8hpp_source.html | 2 +- docs/cpp/main/text__log_8hpp_source.html | 2 +- docs/cpp/main/time__column_8hpp_source.html | 157 +++--- docs/cpp/main/transform3d_8hpp_source.html | 2 +- .../video__frame__reference_8hpp_source.html | 2 +- .../cpp/main/view__blueprint_8hpp_source.html | 2 +- docs/cpp/main/view__contents_8hpp_source.html | 2 +- .../main/viewport__blueprint_8hpp_source.html | 2 +- .../visible__time__ranges_8hpp_source.html | 2 +- 96 files changed, 3608 insertions(+), 3397 deletions(-) create mode 100644 docs/cpp/main/deprecated.html create mode 100644 docs/cpp/main/search/pages_3.js diff --git a/docs/cpp/main/archetypes_2annotation__context_8hpp_source.html b/docs/cpp/main/archetypes_2annotation__context_8hpp_source.html index a958119781ed5..4d641ba4024fd 100644 --- a/docs/cpp/main/archetypes_2annotation__context_8hpp_source.html +++ b/docs/cpp/main/archetypes_2annotation__context_8hpp_source.html @@ -252,7 +252,7 @@
147 template <>
148 struct AsComponents<archetypes::AnnotationContext> {
149 /// Serialize all set component batches.
-
150 static Result<std::vector<ComponentBatch>> serialize(
+
150 static Result<Collection<ComponentBatch>> as_batches(
151 const archetypes::AnnotationContext& archetype
152 );
153 };
diff --git a/docs/cpp/main/archetypes_2near__clip__plane_8hpp_source.html b/docs/cpp/main/archetypes_2near__clip__plane_8hpp_source.html index 7eaf5b1a44f28..3a4525c20be8c 100644 --- a/docs/cpp/main/archetypes_2near__clip__plane_8hpp_source.html +++ b/docs/cpp/main/archetypes_2near__clip__plane_8hpp_source.html @@ -204,7 +204,7 @@
99 template <>
100 struct AsComponents<blueprint::archetypes::NearClipPlane> {
101 /// Serialize all set component batches.
-
102 static Result<std::vector<ComponentBatch>> serialize(
+
102 static Result<Collection<ComponentBatch>> as_batches(
103 const blueprint::archetypes::NearClipPlane& archetype
104 );
105 };
diff --git a/docs/cpp/main/archetypes_2scalar_8hpp_source.html b/docs/cpp/main/archetypes_2scalar_8hpp_source.html index 0dd86d1cb88d0..96fc5e20ebde1 100644 --- a/docs/cpp/main/archetypes_2scalar_8hpp_source.html +++ b/docs/cpp/main/archetypes_2scalar_8hpp_source.html @@ -178,7 +178,7 @@
73 /// // Serialize to columns and send.
74 /// rec.send_columns(
75 /// "scalars",
-
76 /// rerun::TimeColumn::from_sequence_points("step", std::move(times)),
+
76 /// rerun::TimeColumn::from_sequence("step", std::move(times)),
77 /// rerun::Scalar().with_many_scalar(std::move(scalar_data)).columns()
78 /// );
79 /// }
@@ -262,7 +262,7 @@
157 template <>
158 struct AsComponents<archetypes::Scalar> {
159 /// Serialize all set component batches.
-
160 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Scalar& archetype);
+
160 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Scalar& archetype);
161 };
162} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/archetypes_2view__coordinates_8hpp_source.html b/docs/cpp/main/archetypes_2view__coordinates_8hpp_source.html index 653feef076148..fab2c57e990ce 100644 --- a/docs/cpp/main/archetypes_2view__coordinates_8hpp_source.html +++ b/docs/cpp/main/archetypes_2view__coordinates_8hpp_source.html @@ -488,7 +488,7 @@
383 template <>
384 struct AsComponents<archetypes::ViewCoordinates> {
385 /// Serialize all set component batches.
-
386 static Result<std::vector<ComponentBatch>> serialize(
+
386 static Result<Collection<ComponentBatch>> as_batches(
387 const archetypes::ViewCoordinates& archetype
388 );
389 };
diff --git a/docs/cpp/main/archetypes_2visual__bounds2d_8hpp_source.html b/docs/cpp/main/archetypes_2visual__bounds2d_8hpp_source.html index 516b8681fc74d..aaf4d4f2e4065 100644 --- a/docs/cpp/main/archetypes_2visual__bounds2d_8hpp_source.html +++ b/docs/cpp/main/archetypes_2visual__bounds2d_8hpp_source.html @@ -204,7 +204,7 @@
99 template <>
100 struct AsComponents<blueprint::archetypes::VisualBounds2D> {
101 /// Serialize all set component batches.
-
102 static Result<std::vector<ComponentBatch>> serialize(
+
102 static Result<Collection<ComponentBatch>> as_batches(
103 const blueprint::archetypes::VisualBounds2D& archetype
104 );
105 };
diff --git a/docs/cpp/main/arrows2d_8hpp_source.html b/docs/cpp/main/arrows2d_8hpp_source.html index 94f471ca9cacb..49a97a9e7ee2a 100644 --- a/docs/cpp/main/arrows2d_8hpp_source.html +++ b/docs/cpp/main/arrows2d_8hpp_source.html @@ -371,7 +371,7 @@
266 template <>
267 struct AsComponents<archetypes::Arrows2D> {
268 /// Serialize all set component batches.
-
269 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Arrows2D& archetype);
+
269 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Arrows2D& archetype);
270 };
271} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/arrows3d_8hpp_source.html b/docs/cpp/main/arrows3d_8hpp_source.html index 5223f3f9ff6a3..5156182dd343c 100644 --- a/docs/cpp/main/arrows3d_8hpp_source.html +++ b/docs/cpp/main/arrows3d_8hpp_source.html @@ -357,7 +357,7 @@
252 template <>
253 struct AsComponents<archetypes::Arrows3D> {
254 /// Serialize all set component batches.
-
255 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Arrows3D& archetype);
+
255 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Arrows3D& archetype);
256 };
257} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/as__components_8hpp_source.html b/docs/cpp/main/as__components_8hpp_source.html index f15734f7717ab..e86b6465ba27c 100644 --- a/docs/cpp/main/as__components_8hpp_source.html +++ b/docs/cpp/main/as__components_8hpp_source.html @@ -111,7 +111,7 @@
6#include "loggable.hpp"
7
8namespace rerun {
-
9 /// The AsComponents trait is used to convert a type into a list of serialized component.
+
9 /// The AsComponents trait is used to convert a type into a list of component batches.
10 ///
11 /// It is implemented for various built-in types as well as collections of components.
12 /// You can build your own archetypes by implementing this trait.
@@ -130,72 +130,71 @@
25 "It is implemented for all built-in archetypes as well as invidiual & collections of `rerun::ComponentBatch`."
26 "You can add your own implementation by specializing AsComponents<T> for your type T."
27 );
-
28
-
29 // TODO(andreas): List methods that the trait should implement.
-
30 };
-
31
-
32 // TODO(andreas): make these return collection?
-
33 // TODO(andreas): Now that we no longer rely on `Loggable` trait implementations here, `serialize` is a misnomer. Consider using `operator()` instead.
-
34
-
35 // Documenting the builtin generic `AsComponents` impls is too much clutter for the doc class overview.
-
36 /// \cond private
-
37
-
38 /// `AsComponents` for a `Collection<ComponentBatch>`.
-
39 template <>
-
40 struct AsComponents<Collection<ComponentBatch>> {
-
41 static Result<std::vector<ComponentBatch>> serialize(Collection<ComponentBatch> components
-
42 ) {
-
43 return Result<std::vector<ComponentBatch>>(std::move(components).to_vector());
-
44 }
-
45 };
-
46
-
47 /// `AsComponents` for a single `ComponentBatch`.
-
48 template <>
-
49 struct AsComponents<ComponentBatch> {
-
50 static Result<std::vector<ComponentBatch>> serialize(ComponentBatch components) {
-
51 return Result<std::vector<ComponentBatch>>({std::move(components)});
-
52 }
-
53 };
-
54
-
55 /// `AsComponents` for a `Collection<ComponentBatch>` wrapped in a `Result`, forwarding errors for convenience.
-
56 template <>
-
57 struct AsComponents<Result<Collection<ComponentBatch>>> {
-
58 static Result<std::vector<ComponentBatch>> serialize(
-
59 Result<Collection<ComponentBatch>> components
-
60 ) {
-
61 RR_RETURN_NOT_OK(components.error);
-
62 return Result<std::vector<ComponentBatch>>(std::move(components.value).to_vector());
-
63 }
-
64 };
-
65
-
66 /// `AsComponents` for a `Collection<ComponentBatch>` individually wrapped in `Result`, forwarding errors for convenience.
-
67 template <>
-
68 struct AsComponents<Collection<Result<ComponentBatch>>> {
-
69 static Result<std::vector<ComponentBatch>> serialize(
-
70 Collection<Result<ComponentBatch>> components
-
71 ) {
-
72 std::vector<ComponentBatch> result;
-
73 result.reserve(components.size());
-
74 for (auto& component : components) {
-
75 RR_RETURN_NOT_OK(component.error);
-
76 result.push_back(std::move(component.value));
-
77 }
-
78 return Result<std::vector<ComponentBatch>>(std::move(result));
-
79 }
-
80 };
-
81
-
82 /// `AsComponents` for a single `ComponentBatch` wrapped in a `Result`, forwarding errors for convenience.
-
83 template <>
-
84 struct AsComponents<Result<ComponentBatch>> {
-
85 static Result<std::vector<ComponentBatch>> serialize(Result<ComponentBatch> components) {
-
86 RR_RETURN_NOT_OK(components.error);
-
87 return Result<std::vector<ComponentBatch>>({std::move(components.value)});
-
88 }
-
89 };
-
90
-
91 /// \endcond
-
92} // namespace rerun
+
28
+
29 /// Converts the type `T` into a collection of `ComponentBatch`s.
+
30 static Result<Collection<ComponentBatch>> as_batches(const T& archetype);
+
31 };
+
32
+
33 // Documenting the builtin generic `AsComponents` impls is too much clutter for the doc class overview.
+
34 /// \cond private
+
35
+
36 /// `AsComponents` for a `Collection<ComponentBatch>`.
+
37 template <>
+
38 struct AsComponents<Collection<ComponentBatch>> {
+
39 static Result<Collection<ComponentBatch>> as_batches(Collection<ComponentBatch> components
+
40 ) {
+
41 return components;
+
42 }
+
43 };
+
44
+
45 /// `AsComponents` for a single `ComponentBatch`.
+
46 template <>
+
47 struct AsComponents<ComponentBatch> {
+
48 static Result<Collection<ComponentBatch>> as_batches(ComponentBatch components) {
+
49 return rerun::take_ownership(std::move(components));
+
50 }
+
51 };
+
52
+
53 /// `AsComponents` for a `Collection<ComponentBatch>` wrapped in a `Result`, forwarding errors for convenience.
+
54 template <>
+
55 struct AsComponents<Result<Collection<ComponentBatch>>> {
+
56 static Result<Collection<ComponentBatch>> as_batches(
+
57 Result<Collection<ComponentBatch>> components
+
58 ) {
+
59 RR_RETURN_NOT_OK(components.error);
+
60 return components.value;
+
61 }
+
62 };
+
63
+
64 /// `AsComponents` for a `Collection<ComponentBatch>` individually wrapped in `Result`, forwarding errors for convenience.
+
65 template <>
+
66 struct AsComponents<Collection<Result<ComponentBatch>>> {
+
67 static Result<Collection<ComponentBatch>> as_batches(
+
68 Collection<Result<ComponentBatch>> components
+
69 ) {
+
70 std::vector<ComponentBatch> result;
+
71 result.reserve(components.size());
+
72 for (auto& component : components) {
+
73 RR_RETURN_NOT_OK(component.error);
+
74 result.push_back(std::move(component.value));
+
75 }
+
76 return rerun::take_ownership(std::move(result));
+
77 }
+
78 };
+
79
+
80 /// `AsComponents` for a single `ComponentBatch` wrapped in a `Result`, forwarding errors for convenience.
+
81 template <>
+
82 struct AsComponents<Result<ComponentBatch>> {
+
83 static Result<Collection<ComponentBatch>> as_batches(Result<ComponentBatch> components) {
+
84 RR_RETURN_NOT_OK(components.error);
+
85 return rerun::take_ownership(std::move(components.value));
+
86 }
+
87 };
+
88
+
89 /// \endcond
+
90} // namespace rerun
rerun
All Rerun C++ types and functions are in the rerun namespace or one of its nested namespaces.
Definition rerun.hpp:23
+
rerun::take_ownership
Collection< TElement > take_ownership(std::vector< TElement > data)
Takes ownership of a temporary std::vector, moving it into the collection.
Definition collection.hpp:481
diff --git a/docs/cpp/main/asset3d_8hpp_source.html b/docs/cpp/main/asset3d_8hpp_source.html index a352d15f665fc..c8c0b3fe2133e 100644 --- a/docs/cpp/main/asset3d_8hpp_source.html +++ b/docs/cpp/main/asset3d_8hpp_source.html @@ -339,7 +339,7 @@
234 template <>
235 struct AsComponents<archetypes::Asset3D> {
236 /// Serialize all set component batches.
-
237 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Asset3D& archetype);
+
237 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Asset3D& archetype);
238 };
239} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/asset__video_8hpp_source.html b/docs/cpp/main/asset__video_8hpp_source.html index e1ca0f275106a..4ab68503e4dc0 100644 --- a/docs/cpp/main/asset__video_8hpp_source.html +++ b/docs/cpp/main/asset__video_8hpp_source.html @@ -367,7 +367,7 @@
262 template <>
263 struct AsComponents<archetypes::AssetVideo> {
264 /// Serialize all set component batches.
-
265 static Result<std::vector<ComponentBatch>> serialize(const archetypes::AssetVideo& archetype
+
265 static Result<Collection<ComponentBatch>> as_batches(const archetypes::AssetVideo& archetype
266 );
267 };
268} // namespace rerun
diff --git a/docs/cpp/main/background_8hpp_source.html b/docs/cpp/main/background_8hpp_source.html index 24157d5c24507..1572381a785d3 100644 --- a/docs/cpp/main/background_8hpp_source.html +++ b/docs/cpp/main/background_8hpp_source.html @@ -208,7 +208,7 @@
103 template <>
104 struct AsComponents<blueprint::archetypes::Background> {
105 /// Serialize all set component batches.
-
106 static Result<std::vector<ComponentBatch>> serialize(
+
106 static Result<Collection<ComponentBatch>> as_batches(
107 const blueprint::archetypes::Background& archetype
108 );
109 };
diff --git a/docs/cpp/main/bar__chart_8hpp_source.html b/docs/cpp/main/bar__chart_8hpp_source.html index db8640ff28c98..1117cd86ef8c4 100644 --- a/docs/cpp/main/bar__chart_8hpp_source.html +++ b/docs/cpp/main/bar__chart_8hpp_source.html @@ -361,7 +361,7 @@
256 template <>
257 struct AsComponents<archetypes::BarChart> {
258 /// Serialize all set component batches.
-
259 static Result<std::vector<ComponentBatch>> serialize(const archetypes::BarChart& archetype);
+
259 static Result<Collection<ComponentBatch>> as_batches(const archetypes::BarChart& archetype);
260 };
261} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/boxes2d_8hpp_source.html b/docs/cpp/main/boxes2d_8hpp_source.html index 6b74630cb85e9..e259094912443 100644 --- a/docs/cpp/main/boxes2d_8hpp_source.html +++ b/docs/cpp/main/boxes2d_8hpp_source.html @@ -395,7 +395,7 @@
290 template <>
291 struct AsComponents<archetypes::Boxes2D> {
292 /// Serialize all set component batches.
-
293 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Boxes2D& archetype);
+
293 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Boxes2D& archetype);
294 };
295} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/boxes3d_8hpp_source.html b/docs/cpp/main/boxes3d_8hpp_source.html index d7a84b55fe95a..565548696f72e 100644 --- a/docs/cpp/main/boxes3d_8hpp_source.html +++ b/docs/cpp/main/boxes3d_8hpp_source.html @@ -469,7 +469,7 @@
364 template <>
365 struct AsComponents<archetypes::Boxes3D> {
366 /// Serialize all set component batches.
-
367 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Boxes3D& archetype);
+
367 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Boxes3D& archetype);
368 };
369} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/capsules3d_8hpp_source.html b/docs/cpp/main/capsules3d_8hpp_source.html index 9e4596c675b54..b829880661e16 100644 --- a/docs/cpp/main/capsules3d_8hpp_source.html +++ b/docs/cpp/main/capsules3d_8hpp_source.html @@ -432,7 +432,7 @@
327 template <>
328 struct AsComponents<archetypes::Capsules3D> {
329 /// Serialize all set component batches.
-
330 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Capsules3D& archetype
+
330 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Capsules3D& archetype
331 );
332 };
333} // namespace rerun
diff --git a/docs/cpp/main/clear_8hpp_source.html b/docs/cpp/main/clear_8hpp_source.html index c7dd92166a0d6..3d0bdc6028692 100644 --- a/docs/cpp/main/clear_8hpp_source.html +++ b/docs/cpp/main/clear_8hpp_source.html @@ -280,7 +280,7 @@
175 template <>
176 struct AsComponents<archetypes::Clear> {
177 /// Serialize all set component batches.
-
178 static Result<std::vector<ComponentBatch>> serialize(const archetypes::Clear& archetype);
+
178 static Result<Collection<ComponentBatch>> as_batches(const archetypes::Clear& archetype);
179 };
180} // namespace rerun
rerun::Collection
Generic collection of elements that are roughly contiguous in memory.
Definition collection.hpp:49
diff --git a/docs/cpp/main/container__blueprint_8hpp_source.html b/docs/cpp/main/container__blueprint_8hpp_source.html index f2847d5a6e390..90a5cdd7fd6e6 100644 --- a/docs/cpp/main/container__blueprint_8hpp_source.html +++ b/docs/cpp/main/container__blueprint_8hpp_source.html @@ -354,7 +354,7 @@
249 template <>
250 struct AsComponents<blueprint::archetypes::ContainerBlueprint> {
251 /// Serialize all set component batches.
-
252 static Result<std::vector<ComponentBatch>> serialize(
+
252 static Result<Collection<ComponentBatch>> as_batches(
253 const blueprint::archetypes::ContainerBlueprint& archetype
254 );
255 };
diff --git a/docs/cpp/main/dataframe__query_8hpp_source.html b/docs/cpp/main/dataframe__query_8hpp_source.html index 3a68e19ed1df4..9a635a7959ffd 100644 --- a/docs/cpp/main/dataframe__query_8hpp_source.html +++ b/docs/cpp/main/dataframe__query_8hpp_source.html @@ -273,7 +273,7 @@
168 template <>
169 struct AsComponents<blueprint::archetypes::DataframeQuery> {
170 /// Serialize all set component batches.
-
171 static Result<std::vector<ComponentBatch>> serialize(
+
171 static Result<Collection<ComponentBatch>> as_batches(
172 const blueprint::archetypes::DataframeQuery& archetype
173 );
174 };
diff --git a/docs/cpp/main/deprecated.html b/docs/cpp/main/deprecated.html new file mode 100644 index 0000000000000..1f79f3ec05df2 --- /dev/null +++ b/docs/cpp/main/deprecated.html @@ -0,0 +1,120 @@ + + + + + + + + + Rerun C++ SDK: Deprecated List + + + + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
Rerun C++ SDK +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Deprecated List
+
+
+
+
Member rerun::TimeColumn::from_sequence_points (std::string timeline_name, Collection< int64_t > sequence_points, SortingStatus sorting_status=SortingStatus::Unknown)
+
Use from_sequence instead.
+
+
+
+
+ + + + diff --git a/docs/cpp/main/depth__image_8hpp_source.html b/docs/cpp/main/depth__image_8hpp_source.html index 1aa192d803462..c4e2d4dd9908e 100644 --- a/docs/cpp/main/depth__image_8hpp_source.html +++ b/docs/cpp/main/depth__image_8hpp_source.html @@ -522,7 +522,7 @@
417 template <>
418 struct AsComponents<archetypes::DepthImage> {
419 /// Serialize all set component batches.
-
420 static Result<std::vector<ComponentBatch>> serialize(const archetypes::DepthImage& archetype
+
420 static Result<Collection<ComponentBatch>> as_batches(const archetypes::DepthImage& archetype
421 );
422 };
423} // namespace rerun
diff --git a/docs/cpp/main/ellipsoids3d_8hpp_source.html b/docs/cpp/main/ellipsoids3d_8hpp_source.html index 8ca7b205079f1..89309faabf610 100644 --- a/docs/cpp/main/ellipsoids3d_8hpp_source.html +++ b/docs/cpp/main/ellipsoids3d_8hpp_source.html @@ -482,7 +482,7 @@
377 template <>
378 struct AsComponents<archetypes::Ellipsoids3D> {
379 /// Serialize all set component batches.
-
380 static Result<std::vector<ComponentBatch>> serialize(
+
380 static Result<Collection<ComponentBatch>> as_batches(
381 const archetypes::Ellipsoids3D& archetype
382 );
383 };
diff --git a/docs/cpp/main/encoded__image_8hpp_source.html b/docs/cpp/main/encoded__image_8hpp_source.html index fc2b4c84e79e0..619322ff2678e 100644 --- a/docs/cpp/main/encoded__image_8hpp_source.html +++ b/docs/cpp/main/encoded__image_8hpp_source.html @@ -348,7 +348,7 @@
243 template <>
244 struct AsComponents<archetypes::EncodedImage> {
245 /// Serialize all set component batches.
-
246 static Result<std::vector<ComponentBatch>> serialize(
+
246 static Result<Collection<ComponentBatch>> as_batches(
247 const archetypes::EncodedImage& archetype
248 );
249 };
diff --git a/docs/cpp/main/force__center_8hpp_source.html b/docs/cpp/main/force__center_8hpp_source.html index 902b1efcf8f83..a3f30765b44db 100644 --- a/docs/cpp/main/force__center_8hpp_source.html +++ b/docs/cpp/main/force__center_8hpp_source.html @@ -210,7 +210,7 @@
105 template <>
106 struct AsComponents<blueprint::archetypes::ForceCenter> {
107 /// Serialize all set component batches.
-
108 static Result<std::vector<ComponentBatch>> serialize(
+
108 static Result<Collection<ComponentBatch>> as_batches(
109 const blueprint::archetypes::ForceCenter& archetype
110 );
111 };
diff --git a/docs/cpp/main/force__collision__radius_8hpp_source.html b/docs/cpp/main/force__collision__radius_8hpp_source.html index 025bfce97797e..41c52badc51ad 100644 --- a/docs/cpp/main/force__collision__radius_8hpp_source.html +++ b/docs/cpp/main/force__collision__radius_8hpp_source.html @@ -236,7 +236,7 @@
131 template <>
132 struct AsComponents<blueprint::archetypes::ForceCollisionRadius> {
133 /// Serialize all set component batches.
-
134 static Result<std::vector<ComponentBatch>> serialize(
+
134 static Result<Collection<ComponentBatch>> as_batches(
135 const blueprint::archetypes::ForceCollisionRadius& archetype
136 );
137 };
diff --git a/docs/cpp/main/force__link_8hpp_source.html b/docs/cpp/main/force__link_8hpp_source.html index 92ee20334edc5..83e9dd8b6b2b8 100644 --- a/docs/cpp/main/force__link_8hpp_source.html +++ b/docs/cpp/main/force__link_8hpp_source.html @@ -231,7 +231,7 @@
126 template <>
127 struct AsComponents<blueprint::archetypes::ForceLink> {
128 /// Serialize all set component batches.
-
129 static Result<std::vector<ComponentBatch>> serialize(
+
129 static Result<Collection<ComponentBatch>> as_batches(
130 const blueprint::archetypes::ForceLink& archetype
131 );
132 };
diff --git a/docs/cpp/main/force__many__body_8hpp_source.html b/docs/cpp/main/force__many__body_8hpp_source.html index 63c7f8f532482..c85b35afda4d2 100644 --- a/docs/cpp/main/force__many__body_8hpp_source.html +++ b/docs/cpp/main/force__many__body_8hpp_source.html @@ -219,7 +219,7 @@
114 template <>
115 struct AsComponents<blueprint::archetypes::ForceManyBody> {
116 /// Serialize all set component batches.
-
117 static Result<std::vector<ComponentBatch>> serialize(
+
117 static Result<Collection<ComponentBatch>> as_batches(
118 const blueprint::archetypes::ForceManyBody& archetype
119 );
120 };
diff --git a/docs/cpp/main/force__position_8hpp_source.html b/docs/cpp/main/force__position_8hpp_source.html index 8c1873c927043..03fa00a93562e 100644 --- a/docs/cpp/main/force__position_8hpp_source.html +++ b/docs/cpp/main/force__position_8hpp_source.html @@ -227,7 +227,7 @@
122 template <>
123 struct AsComponents<blueprint::archetypes::ForcePosition> {
124 /// Serialize all set component batches.
-
125 static Result<std::vector<ComponentBatch>> serialize(
+
125 static Result<Collection<ComponentBatch>> as_batches(
126 const blueprint::archetypes::ForcePosition& archetype
127 );
128 };
diff --git a/docs/cpp/main/functions_f.html b/docs/cpp/main/functions_f.html index b56f571c8748b..2393251538475 100644 --- a/docs/cpp/main/functions_f.html +++ b/docs/cpp/main/functions_f.html @@ -134,7 +134,7 @@

- f -