plot_interaction.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/build/re_type_definitions/rerun/blueprint/archetypes/plot_interaction.def.rs".
 
#pragma once
 
#include "../../blueprint/components/points_display.hpp"
#include "../../blueprint/components/tooltip_mode.hpp"
#include "../../collection.hpp"
#include "../../component_batch.hpp"
#include "../../component_column.hpp"
#include "../../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::blueprint::archetypes {
    /// **Archetype**: Configuration for plot interaction behavior.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct PlotInteraction {
        /// How the tooltip behaves when hovering over the plot.
        std::optional<ComponentBatch> tooltip_mode;
 
        /// When data point markers are displayed on line series.
        std::optional<ComponentBatch> points_display;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.PlotInteraction";
 
        /// `ComponentDescriptor` for the `tooltip_mode` field.
        static constexpr auto Descriptor_tooltip_mode = ComponentDescriptor(
            ArchetypeName, "PlotInteraction:tooltip_mode",
            Loggable<rerun::blueprint::components::TooltipMode>::ComponentType
        );
        /// `ComponentDescriptor` for the `points_display` field.
        static constexpr auto Descriptor_points_display = ComponentDescriptor(
            ArchetypeName, "PlotInteraction:points_display",
            Loggable<rerun::blueprint::components::PointsDisplay>::ComponentType
        );
 
      public:
        PlotInteraction() = default;
        PlotInteraction(PlotInteraction&& other) = default;
        PlotInteraction(const PlotInteraction& other) = default;
        PlotInteraction& operator=(const PlotInteraction& other) = default;
        PlotInteraction& operator=(PlotInteraction&& other) = default;
 
        /// Update only some specific fields of a `PlotInteraction`.
        static PlotInteraction update_fields() {
            return PlotInteraction();
        }
 
        /// Clear all the fields of a `PlotInteraction`.
        static PlotInteraction clear_fields();
 
        /// How the tooltip behaves when hovering over the plot.
        PlotInteraction with_tooltip_mode(
            const rerun::blueprint::components::TooltipMode& _tooltip_mode
        ) && {
            tooltip_mode = ComponentBatch::from_loggable(_tooltip_mode, Descriptor_tooltip_mode)
                               .value_or_throw();
            return std::move(*this);
        }
 
        /// When data point markers are displayed on line series.
        PlotInteraction with_points_display(
            const rerun::blueprint::components::PointsDisplay& _points_display
        ) && {
            points_display =
                ComponentBatch::from_loggable(_points_display, Descriptor_points_display)
                    .value_or_throw();
            return std::move(*this);
        }
 
        /// Partitions the component data into multiple sub-batches.
        ///
        /// Specifically, this transforms the existing `ComponentBatch` data into `ComponentColumn`s
        /// instead, via `ComponentBatch::partitioned`.
        ///
        /// This makes it possible to use `RecordingStream::send_columns` to send columnar data directly into Rerun.
        ///
        /// The specified `lengths` must sum to the total length of the component batch.
        Collection<ComponentColumn> columns(const Collection<uint32_t>& lengths_);
 
        /// Partitions the component data into unit-length sub-batches.
        ///
        /// This is semantically similar to calling `columns` with `std::vector<uint32_t>(n, 1)`,
        /// where `n` is automatically guessed.
        Collection<ComponentColumn> columns();
    };
 
} // namespace rerun::blueprint::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<blueprint::archetypes::PlotInteraction> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::PlotInteraction& archetype
        );
    };
} // namespace rerun