chore: import upstream snapshot with attribution

2026-07-13 13:05:14 +08:00
commit 2a547be7fe
7904 changed files with 1000926 additions and 0 deletions
@@ -0,0 +1,95 @@
+/// Demonstrates how to implement custom archetypes and components, and extend existing ones.
+
+#include <rerun.hpp>
+#include <rerun/demo_utils.hpp>
+
+/// A custom component type.
+struct Confidence {
+    float value;
+};
+
+template <>
+struct rerun::Loggable<Confidence> {
+    static constexpr std::string_view ComponentType = "user.Confidence";
+
+    static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
+        return rerun::Loggable<rerun::Float32>::arrow_datatype();
+    }
+
+    // TODO(#4257) should take a rerun::Collection instead of pointer and size.
+    static rerun::Result<std::shared_ptr<arrow::Array>> to_arrow(
+        const Confidence* instances, size_t num_instances
+    ) {
+        return rerun::Loggable<rerun::Float32>::to_arrow(
+            reinterpret_cast<const rerun::Float32*>(instances),
+            num_instances
+        );
+    }
+};
+
+/// A custom archetype that extends Rerun's builtin `rerun::Points3D` archetype with a custom component.
+struct CustomPoints3D {
+    rerun::Points3D points;
+    // Using a rerun::Collection is not strictly necessary, you could also use an std::vector for example,
+    // but useful for avoiding allocations since `rerun::Collection` can borrow data from other containers.
+    std::optional<rerun::Collection<Confidence>> confidences;
+};
+
+template <>
+struct rerun::AsComponents<CustomPoints3D> {
+    static Result<rerun::Collection<ComponentBatch>> as_batches(
+        const CustomPoints3D& archetype
+    ) {
+        auto batches =
+            AsComponents<rerun::Points3D>::as_batches(archetype.points)
+                .value_or_throw()
+                .to_vector();
+
+        // Add custom confidence components if present.
+        if (archetype.confidences) {
+            auto descriptor =
+                rerun::ComponentDescriptor("user.CustomPoints3D:confidences")
+                    .or_with_archetype("user.CustomPoints3D")
+                    .or_with_component_type(
+                        rerun::Loggable<Confidence>::ComponentType
+                    );
+            batches.push_back(ComponentBatch::from_loggable(
+                                  *archetype.confidences,
+                                  descriptor
+            )
+                                  .value_or_throw());
+        }
+
+        return rerun::take_ownership(std::move(batches));
+    }
+};
+
+// ---
+
+int main(int argc, char* argv[]) {
+    const auto rec = rerun::RecordingStream("rerun_example_custom_data");
+    rec.spawn().exit_on_failure();
+
+    auto grid = rerun::demo::grid3d<rerun::Position3D, float>(-5.0f, 5.0f, 3);
+
+    rec.log(
+        "left/my_confident_point_cloud",
+        CustomPoints3D{
+            rerun::Points3D(grid),
+            Confidence{42.0f},
+        }
+    );
+
+    std::vector<Confidence> confidences;
+    for (auto i = 0; i < 27; ++i) {
+        confidences.emplace_back(Confidence{static_cast<float>(i)});
+    }
+
+    rec.log(
+        "right/my_polarized_point_cloud",
+        CustomPoints3D{
+            rerun::Points3D(grid),
+            confidences,
+        }
+    );
+}