optical_density.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/optical_density.def.rs".
 
#pragma once
 
#include "../encodings/float32.hpp"
#include "../result.hpp"
 
#include <cstdint>
#include <memory>
 
namespace rerun::components {
    /// **Component**: Dimensionless natural-log optical depth.
    ///
    /// High values lead to more opaque surfaces, lower to more transparent ones.
    /// More accurately, a value of 1 attenuates light to `exp(-1)` over the reference distance.
    struct OpticalDensity {
        rerun::encodings::Float32 optical_density;
 
      public:
        OpticalDensity() = default;
 
        OpticalDensity(rerun::encodings::Float32 optical_density_)
            : optical_density(optical_density_) {}
 
        OpticalDensity& operator=(rerun::encodings::Float32 optical_density_) {
            optical_density = optical_density_;
            return *this;
        }
 
        OpticalDensity(float value_) : optical_density(value_) {}
 
        OpticalDensity& operator=(float value_) {
            optical_density = value_;
            return *this;
        }
 
        /// Cast to the underlying Float32 encoding
        operator rerun::encodings::Float32() const {
            return optical_density;
        }
    };
} // namespace rerun::components
 
namespace rerun {
    static_assert(sizeof(rerun::encodings::Float32) == sizeof(components::OpticalDensity));
 
    /// \private
    template <>
    struct Loggable<components::OpticalDensity> {
        static constexpr std::string_view ComponentType = "rerun.components.OpticalDensity";
 
        /// 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::OpticalDensity` into an arrow array.
        static Result<std::shared_ptr<arrow::Array>> to_arrow(
            const components::OpticalDensity* 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->optical_density,
                    num_instances
                );
            }
        }
    };
} // namespace rerun