state_change.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/archetypes/state_change.fbs".
 
#pragma once
 
#include "../collection.hpp"
#include "../component_batch.hpp"
#include "../component_column.hpp"
#include "../components/text.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <optional>
#include <utility>
#include <vector>
 
namespace rerun::archetypes {
    /// **Archetype**: A state change, representing a transition of an entity into a new state.
    ///
    /// Useful for representing discrete state machines, mode transitions, or
    /// state changes over time. Each logged `archetypes::StateChange` marks a new state
    /// at the given time. A `null` state is ignored by the state timeline view.
    ///
    /// The state timeline view displays these as horizontal colored lanes over time.
    ///
    /// ## Example
    ///
    /// ### State changes over time
    /// ![image](https://static.rerun.io/state_change/6654a13e984702b96547750469c368ce6e900c0f/full.png)
    ///
    /// ```cpp
    /// #include <rerun.hpp>
    ///
    /// int main(int argc, char* argv[]) {
    ///     const auto rec = rerun::RecordingStream("rerun_example_state_change");
    ///     rec.spawn().exit_on_failure();
    ///
    ///     rec.set_time_sequence("step", 0);
    ///     rec.log("door", rerun::StateChange().with_state("open"));
    ///
    ///     rec.set_time_sequence("step", 1);
    ///     rec.log("door", rerun::StateChange().with_state("closed"));
    ///
    ///     rec.set_time_sequence("step", 2);
    ///     rec.log("door", rerun::StateChange().with_state("open"));
    /// }
    /// ```
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct StateChange {
        /// The new state value.
        ///
        /// A `null` state is ignored, it can be used to partially update a multi-instance state array.
        /// An empty string is treated as state reset, and a gap is shown in the state timeline view.
        std::optional<ComponentBatch> state;
 
      public:
        /// The name of the archetype as used in `ComponentDescriptor`s.
        static constexpr const char ArchetypeName[] = "rerun.archetypes.StateChange";
 
        /// `ComponentDescriptor` for the `state` field.
        static constexpr auto Descriptor_state = ComponentDescriptor(
            ArchetypeName, "StateChange:state", Loggable<rerun::components::Text>::ComponentType
        );
 
      public:
        StateChange() = default;
        StateChange(StateChange&& other) = default;
        StateChange(const StateChange& other) = default;
        StateChange& operator=(const StateChange& other) = default;
        StateChange& operator=(StateChange&& other) = default;
 
        /// Update only some specific fields of a `StateChange`.
        static StateChange update_fields() {
            return StateChange();
        }
 
        /// Clear all the fields of a `StateChange`.
        static StateChange clear_fields();
 
        /// The new state value.
        ///
        /// A `null` state is ignored, it can be used to partially update a multi-instance state array.
        /// An empty string is treated as state reset, and a gap is shown in the state timeline view.
        StateChange with_state(const rerun::components::Text& _state) && {
            state = ComponentBatch::from_loggable(_state, Descriptor_state).value_or_throw();
            return std::move(*this);
        }
 
        /// This method makes it possible to pack multiple `state` in a single component batch.
        ///
        /// This only makes sense when used in conjunction with `columns`. `with_state` should
        /// be used when logging a single row's worth of data.
        StateChange with_many_state(const Collection<rerun::components::Text>& _state) && {
            state = ComponentBatch::from_loggable(_state, Descriptor_state).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::archetypes
 
namespace rerun {
    /// \private
    template <typename T>
    struct AsComponents;
 
    /// \private
    template <>
    struct AsComponents<archetypes::StateChange> {
        /// Serialize all set component batches.
        static Result<Collection<ComponentBatch>> as_batches(
            const archetypes::StateChange& archetype
        );
    };
} // namespace rerun