table_column_preview.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/table_column_preview.def.rs".
 
#pragma once
 
#include "../../blueprint/components/included_content.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**: Blueprint for previewing recording references from a table column.
    ///
    /// This archetype is stored on the same layout-specific column entity as `archetypes::TableColumn`.
    /// Table columns use `/table/layouts/table/columns/{column_name}`.
    /// Card fields use `/table/layouts/cards/fields/{column_name}`.
    /// Shared preview configuration is stored as `archetypes::PreviewsConfig` at `/table`.
    ///
    /// A column uses this payload only when its `TableCellKind::Preview` is set.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct TableColumnPreview {
        /// The views rendered for the preview, in display order.
        ///
        /// Each `components::IncludedContent` must reference a `archetypes::ViewBlueprint` at `/view/{view_id}`.
        /// View contents, properties, defaults, and overrides remain at their regular blueprint paths.
        std::optional<ComponentBatch> views;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] =
            "rerun.blueprint.archetypes.TableColumnPreview";
 
        /// `ComponentDescriptor` for the `views` field.
        static constexpr auto Descriptor_views = ComponentDescriptor(
            ArchetypeName, "TableColumnPreview:views",
            Loggable<rerun::blueprint::components::IncludedContent>::ComponentType
        );
 
      public:
        TableColumnPreview() = default;
        TableColumnPreview(TableColumnPreview&& other) = default;
        TableColumnPreview(const TableColumnPreview& other) = default;
        TableColumnPreview& operator=(const TableColumnPreview& other) = default;
        TableColumnPreview& operator=(TableColumnPreview&& other) = default;
 
        explicit TableColumnPreview(Collection<rerun::blueprint::components::IncludedContent> _views
        )
            : views(ComponentBatch::from_loggable(std::move(_views), Descriptor_views)
                        .value_or_throw()) {}
 
        /// Update only some specific fields of a `TableColumnPreview`.
        static TableColumnPreview update_fields() {
            return TableColumnPreview();
        }
 
        /// Clear all the fields of a `TableColumnPreview`.
        static TableColumnPreview clear_fields();
 
        /// The views rendered for the preview, in display order.
        ///
        /// Each `components::IncludedContent` must reference a `archetypes::ViewBlueprint` at `/view/{view_id}`.
        /// View contents, properties, defaults, and overrides remain at their regular blueprint paths.
        TableColumnPreview with_views(
            const Collection<rerun::blueprint::components::IncludedContent>& _views
        ) && {
            views = ComponentBatch::from_loggable(_views, Descriptor_views).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::TableColumnPreview> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::TableColumnPreview& archetype
        );
    };
} // namespace rerun