table_blueprint.hpp

// DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/cpp/mod.rs
// Based on "crates/store/re_sdk_types/definitions/rerun/blueprint/archetypes/table_blueprint.fbs".
 
#pragma once
 
#include "../../blueprint/components/column_name.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 configuring the styling of a table.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct TableBlueprint {
        /// The name of the column that contains recording URIs for segment previews.
        ///
        /// Every row can at most preview a single segment.
        ///
        /// For the preview, the rest of the blueprint data is read it as it would be with regular recording blueprints,
        /// meaning that the regular structure of `archetypes::ViewportBlueprint`, and `archetypes::ViewBlueprint` structure applies.
        /// However, this mostly ignores layout container types as well as automatic spawning.
        std::optional<ComponentBatch> segment_preview_column;
 
        /// The name of the boolean column used for flag/annotation toggles.
        ///
        /// Must be set for flagging to be available. The named column must exist in the
        /// table and be of boolean type.
        /// Additionally, the table must be remote and have another column with
        /// `rerun:is_table_index` metadata since flag changes are persisted to the server
        /// via upsert.
        std::optional<ComponentBatch> flag_column;
 
        /// The name of the column to use as the card title in grid view.
        ///
        /// If unset, the first visible string column is used as the title.
        std::optional<ComponentBatch> grid_view_card_title;
 
        /// The name of the column containing URLs to open when a card is clicked in grid view.
        ///
        /// If unset, defaults to the first URL column in the table that points to the same
        /// Rerun server. If no such column exists, no URL is associated with cards and
        /// clicking them does not navigate anywhere.
        std::optional<ComponentBatch> url_column;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.blueprint.archetypes.TableBlueprint";
 
        /// `ComponentDescriptor` for the `segment_preview_column` field.
        static constexpr auto Descriptor_segment_preview_column = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:segment_preview_column",
            Loggable<rerun::blueprint::components::ColumnName>::ComponentType
        );
        /// `ComponentDescriptor` for the `flag_column` field.
        static constexpr auto Descriptor_flag_column = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:flag_column",
            Loggable<rerun::blueprint::components::ColumnName>::ComponentType
        );
        /// `ComponentDescriptor` for the `grid_view_card_title` field.
        static constexpr auto Descriptor_grid_view_card_title = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:grid_view_card_title",
            Loggable<rerun::blueprint::components::ColumnName>::ComponentType
        );
        /// `ComponentDescriptor` for the `url_column` field.
        static constexpr auto Descriptor_url_column = ComponentDescriptor(
            ArchetypeName, "TableBlueprint:url_column",
            Loggable<rerun::blueprint::components::ColumnName>::ComponentType
        );
 
      public:
        TableBlueprint() = default;
        TableBlueprint(TableBlueprint&& other) = default;
        TableBlueprint(const TableBlueprint& other) = default;
        TableBlueprint& operator=(const TableBlueprint& other) = default;
        TableBlueprint& operator=(TableBlueprint&& other) = default;
 
        /// Update only some specific fields of a `TableBlueprint`.
        static TableBlueprint update_fields() {
            return TableBlueprint();
        }
 
        /// Clear all the fields of a `TableBlueprint`.
        static TableBlueprint clear_fields();
 
        /// The name of the column that contains recording URIs for segment previews.
        ///
        /// Every row can at most preview a single segment.
        ///
        /// For the preview, the rest of the blueprint data is read it as it would be with regular recording blueprints,
        /// meaning that the regular structure of `archetypes::ViewportBlueprint`, and `archetypes::ViewBlueprint` structure applies.
        /// However, this mostly ignores layout container types as well as automatic spawning.
        TableBlueprint with_segment_preview_column(
            const rerun::blueprint::components::ColumnName& _segment_preview_column
        ) && {
            segment_preview_column = ComponentBatch::from_loggable(
                                         _segment_preview_column,
                                         Descriptor_segment_preview_column
            )
                                         .value_or_throw();
            return std::move(*this);
        }
 
        /// The name of the boolean column used for flag/annotation toggles.
        ///
        /// Must be set for flagging to be available. The named column must exist in the
        /// table and be of boolean type.
        /// Additionally, the table must be remote and have another column with
        /// `rerun:is_table_index` metadata since flag changes are persisted to the server
        /// via upsert.
        TableBlueprint with_flag_column(const rerun::blueprint::components::ColumnName& _flag_column
        ) && {
            flag_column = ComponentBatch::from_loggable(_flag_column, Descriptor_flag_column)
                              .value_or_throw();
            return std::move(*this);
        }
 
        /// The name of the column to use as the card title in grid view.
        ///
        /// If unset, the first visible string column is used as the title.
        TableBlueprint with_grid_view_card_title(
            const rerun::blueprint::components::ColumnName& _grid_view_card_title
        ) && {
            grid_view_card_title = ComponentBatch::from_loggable(
                                       _grid_view_card_title,
                                       Descriptor_grid_view_card_title
            )
                                       .value_or_throw();
            return std::move(*this);
        }
 
        /// The name of the column containing URLs to open when a card is clicked in grid view.
        ///
        /// If unset, defaults to the first URL column in the table that points to the same
        /// Rerun server. If no such column exists, no URL is associated with cards and
        /// clicking them does not navigate anywhere.
        TableBlueprint with_url_column(const rerun::blueprint::components::ColumnName& _url_column
        ) && {
            url_column =
                ComponentBatch::from_loggable(_url_column, Descriptor_url_column).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::TableBlueprint> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const blueprint::archetypes::TableBlueprint& archetype
        );
    };
} // namespace rerun