draw_order.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/components/draw_order.def.rs".
 
#pragma once
 
#include "../encodings/float32.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace rerun::components {
    /// **Component**: Draw order of 2D elements. Higher values are drawn on top of lower values.
    ///
    /// An entity can have only a single draw order component.
    /// Within an entity draw order is governed by the order of the components.
    ///
    /// Draw order for entities with the same draw order is generally undefined.
    ///
    /// If no draw order is set, the viewer uses these defaults:
    /// * -20: `archetypes::DepthImage`, `archetypes::EncodedDepthImage`
    /// * -15: `archetypes::VideoFrameReference`, `archetypes::VideoStream`
    /// * -10: `archetypes::Image`, `archetypes::EncodedImage`, `archetypes::GridMap`
    /// * 0: `archetypes::SegmentationImage`
    /// * 10: `archetypes::Boxes2D`, `archetypes::Ellipses2D`
    /// * 20: `archetypes::Arrows2D`, `archetypes::LineStrips2D`
    /// * 30: `archetypes::Points2D`
    ///
    /// For example, to draw an image on top of a segmentation image, give the image a draw order above 0.
    struct DrawOrder {
        rerun::encodings::Float32 value;
 
      public:
        DrawOrder() = default;
 
        DrawOrder(rerun::encodings::Float32 value_) : value(value_) {}
 
        DrawOrder& operator=(rerun::encodings::Float32 value_) {
            value = value_;
            return *this;
        }
 
        DrawOrder(float value_) : value(value_) {}
 
        DrawOrder& operator=(float value_) {
            value = value_;
            return *this;
        }
 
        /// Cast to the underlying Float32 encoding
        operator rerun::encodings::Float32() const {
            return value;
        }
    };
} // namespace rerun::components
 
namespace rerun {
    static_assert(sizeof(rerun::encodings::Float32) == sizeof(components::DrawOrder));
 
    /// \private
    template <>
    struct Loggable<components::DrawOrder> {
        static constexpr std::string_view ComponentType = "rerun.components.DrawOrder";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_data_type() {
            return Loggable<rerun::encodings::Float32>::arrow_data_type();
        }
 
        /// Serializes an array of `rerun::components::DrawOrder` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const components::DrawOrder* instances, size_t num_instances
        ) {
            if (num_instances == 0) {
                return Loggable<rerun::encodings::Float32>::to_arrow(nullptr, 0);
            } else if (instances == nullptr) {
                return rerun::Error(
                    ErrorCode::UnexpectedNullArgument,
                    "Passed array instances is null when num_elements> 0."
                );
            } else {
                return Loggable<rerun::encodings::Float32>::to_arrow(
                    &instances->value,
                    num_instances
                );
            }
        }
    };
} // namespace rerun