spherical_harmonics_degree.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/spherical_harmonics_degree.def.rs".
 
#pragma once
 
#include "../datatypes/uint32.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace rerun::components {
    /// **Component**: The highest spherical harmonics degree to evaluate when rendering, 0-3.
    ///
    /// `0` renders the view-independent base color only, and is the fastest.
    /// Each higher degree brings in more view-dependent detail, at the cost of fetching and
    /// evaluating more coefficients (`components::SphericalHarmonics3Rgb`):
    /// 3 of them for degree 1, 8 for degree 2, and all 15 for degree 3.
    ///
    /// Lowering this in the blueprint can make the rendering a lot faster.
    ///
    /// Defaults to 3, i.e. every coefficient the data has.
    ///
    /// ⚠ **This type is _unstable_ and may change significantly in a way that the data won't be backwards compatible.**
    ///
    struct SphericalHarmonicsDegree {
        rerun::datatypes::UInt32 degree;
 
      public:
        SphericalHarmonicsDegree() = default;
 
        SphericalHarmonicsDegree(rerun::datatypes::UInt32 degree_) : degree(degree_) {}
 
        SphericalHarmonicsDegree& operator=(rerun::datatypes::UInt32 degree_) {
            degree = degree_;
            return *this;
        }
 
        SphericalHarmonicsDegree(uint32_t value_) : degree(value_) {}
 
        SphericalHarmonicsDegree& operator=(uint32_t value_) {
            degree = value_;
            return *this;
        }
 
        /// Cast to the underlying UInt32 datatype
        operator rerun::datatypes::UInt32() const {
            return degree;
        }
    };
} // namespace rerun::components
 
namespace rerun {
    static_assert(sizeof(rerun::datatypes::UInt32) == sizeof(components::SphericalHarmonicsDegree));
 
    /// \private
    template <>
    struct Loggable<components::SphericalHarmonicsDegree> {
        static constexpr std::string_view ComponentType =
            "rerun.components.SphericalHarmonicsDegree";
 
        /// Returns the arrow data type this type corresponds to.
        static const std::shared_ptr<arrow::DataType>& arrow_datatype() {
            return Loggable<rerun::datatypes::UInt32>::arrow_datatype();
        }
 
        /// Serializes an array of `rerun::components::SphericalHarmonicsDegree` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const components::SphericalHarmonicsDegree* instances, size_t num_instances
        ) {
            if (num_instances == 0) {
                return Loggable<rerun::datatypes::UInt32>::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::datatypes::UInt32>::to_arrow(
                    &instances->degree,
                    num_instances
                );
            }
        }
    };
} // namespace rerun