SceneConditions.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2025 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <array>
#include <chrono>
#include <cmath>
#include <ctime>
#include <iomanip>
#include <memory>
#include <optional>
#include <set>
#include <sstream>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
#include "Zivid/DataModel/Detail/Detail.h"
#include "Zivid/DataModel/NodeType.h"
#include "Zivid/DataModel/Traits.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Detail/TypeTraits.h"
#include "Zivid/Range.h"
 
#ifdef _MSC_VER
#    pragma warning(push)
#    pragma warning(disable : 4251) // "X needs to have dll-interface to be used by clients of class Y."
#endif
 
namespace Zivid
{
 
 
    // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
    class ZIVID_CORE_EXPORT SceneConditions
    {
    public:
        static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
        static constexpr const char *path{ "" };
 
        static constexpr const char *name{ "SceneConditions" };
 
        static constexpr const char *description{
            R"description(A description of the ambient conditions detected by the camera.
)description"
        };
 
        static constexpr size_t version{ 2 };
 
#ifndef NO_DOC
        template<size_t>
        struct Version;
 
        using LatestVersion = Zivid::SceneConditions;
 
        // Short identifier. This value is not guaranteed to be universally unique
        // Todo(ZIVID-2808): Move this to internal DataModelExt header
        static constexpr std::array<uint8_t, 3> binaryId{ 'c', 's', 'c' };
 
#endif
 
 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT AmbientLight
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
            static constexpr const char *path{ "AmbientLight" };
 
            static constexpr const char *name{ "AmbientLight" };
 
            static constexpr const char *description{ R"description(The ambient light detected by the camera.
)description" };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT FlickerClassification
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "AmbientLight/FlickerClassification" };
 
                static constexpr const char *name{ "FlickerClassification" };
 
                static constexpr const char *description{
                    R"description(A classification of the detected ambient light flicker, if any.
The values `grid50hz` and `grid60hz` indicate that ambient
light matching a 50 Hz or 60 Hz power grid was detected in the
scene. In those cases it is recommended to use Ambient Light
Adaptation for better point cloud quality. The value
`unknownFlicker` indicates that some significant time-varying
ambient light was detected, but it was not possible to
determine the frequency. `otherFlicker` indicates that ambient
light of a particular frequency was detected but it did not
match the characteristics of a standard power grid.
)description"
                };
 
                enum class ValueType
                {
                    noFlicker,
                    unknownFlicker,
                    grid50hz,
                    grid60hz,
                    otherFlicker
                };
                static const FlickerClassification noFlicker;      
                static const FlickerClassification unknownFlicker; 
                static const FlickerClassification grid50hz;       
                static const FlickerClassification grid60hz;       
                static const FlickerClassification otherFlicker;   
 
                static std::set<ValueType> validValues()
                {
                    return { ValueType::noFlicker,
                             ValueType::unknownFlicker,
                             ValueType::grid50hz,
                             ValueType::grid60hz,
                             ValueType::otherFlicker };
                }
 
                FlickerClassification() = default;
 
                explicit constexpr FlickerClassification(ValueType value)
                    : m_value{ verifyValue(value) }
                {}
 
                ValueType value() const;
 
                std::string toString() const;
 
                friend std::ostream &operator<<(std::ostream &stream, const FlickerClassification::ValueType &value)
                {
                    return stream << FlickerClassification{ value }.toString();
                }
 
                bool operator==(const FlickerClassification &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const FlickerClassification &other) const
                {
                    return m_value != other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const FlickerClassification &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                constexpr ValueType static verifyValue(const ValueType &value)
                {
                    return value == ValueType::noFlicker || value == ValueType::unknownFlicker
                                   || value == ValueType::grid50hz || value == ValueType::grid60hz
                                   || value == ValueType::otherFlicker
                               ? value
                               : throw std::invalid_argument{
                                     "Invalid value: FlickerClassification{ "
                                     + std::to_string(static_cast<std::underlying_type<ValueType>::type>(value)) + " }"
                                 };
                }
 
                ValueType m_value{ ValueType::unknownFlicker };
 
                friend struct DataModel::Detail::Befriend<FlickerClassification>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT FlickerFrequency
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "AmbientLight/FlickerFrequency" };
 
                static constexpr const char *name{ "FlickerFrequency" };
 
                static constexpr const char *description{
                    R"description(This field contains the actual frequency unless the
classification is `noFlicker` or `unknownFlicker`.
)description"
                };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                FlickerFrequency() = default;
 
                explicit constexpr FlickerFrequency(double value)
                    : m_opt{ value }
                {}
 
                double value() const;
 
                bool hasValue() const;
 
                void reset();
 
                std::string toString() const;
 
                bool operator==(const FlickerFrequency &other) const
                {
                    return m_opt == other.m_opt;
                }
 
                bool operator!=(const FlickerFrequency &other) const
                {
                    return m_opt != other.m_opt;
                }
 
                bool operator<(const FlickerFrequency &other) const
                {
                    return m_opt < other.m_opt;
                }
 
                bool operator>(const FlickerFrequency &other) const
                {
                    return m_opt > other.m_opt;
                }
 
                bool operator<=(const FlickerFrequency &other) const
                {
                    return m_opt <= other.m_opt;
                }
 
                bool operator>=(const FlickerFrequency &other) const
                {
                    return m_opt >= other.m_opt;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const FlickerFrequency &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                std::optional<double> m_opt;
 
                friend struct DataModel::Detail::Befriend<FlickerFrequency>;
            };
 
            using Descendants = std::tuple<
                SceneConditions::AmbientLight::FlickerClassification,
                SceneConditions::AmbientLight::FlickerFrequency>;
 
            AmbientLight();
 
#ifndef NO_DOC
            template<
                typename... Args,
                typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0,
                typename std::enable_if<
                    Zivid::Detail::TypeTraits::AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>::
                        value,
                    int>::type = 0>
#else
            template<typename... Args>
#endif
            explicit AmbientLight(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to AmbientLight(...). "
                    "Types should be listed at most once.");
 
                set(std::forward<Args>(args)...);
            }
 
#ifndef NO_DOC
            template<typename... Args, typename std::enable_if<sizeof...(Args) >= 2, int>::type = 0>
#else
            template<typename... Args>
#endif
            void set(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
                static_assert(
                    AllArgsAreDescendantNodes::value, "All arguments passed to set(...) must be descendant nodes.");
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to set(...). "
                    "Types should be listed at most once.");
 
                Zivid::DataModel::Detail::invokeSetWithEachArgument(*this, std::forward<Args>(args)...);
            }
 
#ifndef NO_DOC
            template<typename... Args, typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0>
#else
            template<typename... Args>
#endif
            AmbientLight copyWith(Args &&...args) const
            {
                using namespace Zivid::Detail::TypeTraits;
 
                using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
                static_assert(
                    AllArgsAreDescendantNodes::value,
                    "All arguments passed to copyWith(...) must be descendant nodes.");
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to copyWith(...). "
                    "Types should be listed at most once.");
 
                auto copy{ *this };
                copy.set(std::forward<Args>(args)...);
                return copy;
            }
 
            const FlickerClassification &flickerClassification() const
            {
                return m_flickerClassification;
            }
 
            FlickerClassification &flickerClassification()
            {
                return m_flickerClassification;
            }
 
            AmbientLight &set(const FlickerClassification &value)
            {
                m_flickerClassification = value;
                return *this;
            }
 
            const FlickerFrequency &flickerFrequency() const
            {
                return m_flickerFrequency;
            }
 
            FlickerFrequency &flickerFrequency()
            {
                return m_flickerFrequency;
            }
 
            AmbientLight &set(const FlickerFrequency &value)
            {
                m_flickerFrequency = value;
                return *this;
            }
 
            template<
                typename T,
                typename std::enable_if<
                    std::is_same<T, SceneConditions::AmbientLight::FlickerClassification>::value,
                    int>::type = 0>
            const SceneConditions::AmbientLight::FlickerClassification &get() const
            {
                return m_flickerClassification;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, SceneConditions::AmbientLight::FlickerFrequency>::value, int>::
                    type = 0>
            const SceneConditions::AmbientLight::FlickerFrequency &get() const
            {
                return m_flickerFrequency;
            }
 
            template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
            const SceneConditions::AmbientLight::FlickerClassification &get() const
            {
                return m_flickerClassification;
            }
 
            template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
            const SceneConditions::AmbientLight::FlickerFrequency &get() const
            {
                return m_flickerFrequency;
            }
 
            template<typename F>
            void forEach(const F &f) const
            {
                f(m_flickerClassification);
                f(m_flickerFrequency);
            }
 
            template<typename F>
            void forEach(const F &f)
            {
                f(m_flickerClassification);
                f(m_flickerFrequency);
            }
 
            bool operator==(const AmbientLight &other) const;
 
            bool operator!=(const AmbientLight &other) const;
 
            std::string toString() const;
 
            friend std::ostream &operator<<(std::ostream &stream, const AmbientLight &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            void setFromString(const std::string &fullPath, const std::string &value);
 
            std::string getString(const std::string &fullPath) const;
 
            FlickerClassification m_flickerClassification;
            FlickerFrequency m_flickerFrequency;
 
            friend struct DataModel::Detail::Befriend<AmbientLight>;
        };
 
        using Descendants = std::tuple<
            SceneConditions::AmbientLight,
            SceneConditions::AmbientLight::FlickerClassification,
            SceneConditions::AmbientLight::FlickerFrequency>;
 
        SceneConditions();
 
        explicit SceneConditions(const std::string &fileName);
 
        [[nodiscard]] static SceneConditions fromSerialized(const std::string &value);
 
        std::string serialize() const;
 
#ifndef NO_DOC
        template<
            typename... Args,
            typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0,
            typename std::enable_if<
                Zivid::Detail::TypeTraits::AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>::value,
                int>::type = 0>
#else
        template<typename... Args>
#endif
        explicit SceneConditions(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to SceneConditions(...). "
                "Types should be listed at most once.");
 
            set(std::forward<Args>(args)...);
        }
 
#ifndef NO_DOC
        template<typename... Args, typename std::enable_if<sizeof...(Args) >= 2, int>::type = 0>
#else
        template<typename... Args>
#endif
        void set(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
            static_assert(
                AllArgsAreDescendantNodes::value, "All arguments passed to set(...) must be descendant nodes.");
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to set(...). "
                "Types should be listed at most once.");
 
            Zivid::DataModel::Detail::invokeSetWithEachArgument(*this, std::forward<Args>(args)...);
        }
 
#ifndef NO_DOC
        template<typename... Args, typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0>
#else
        template<typename... Args>
#endif
        SceneConditions copyWith(Args &&...args) const
        {
            using namespace Zivid::Detail::TypeTraits;
 
            using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
            static_assert(
                AllArgsAreDescendantNodes::value, "All arguments passed to copyWith(...) must be descendant nodes.");
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to copyWith(...). "
                "Types should be listed at most once.");
 
            auto copy{ *this };
            copy.set(std::forward<Args>(args)...);
            return copy;
        }
 
        const AmbientLight &ambientLight() const
        {
            return m_ambientLight;
        }
 
        AmbientLight &ambientLight()
        {
            return m_ambientLight;
        }
 
        SceneConditions &set(const AmbientLight &value)
        {
            m_ambientLight = value;
            return *this;
        }
 
        SceneConditions &set(const AmbientLight::FlickerClassification &value)
        {
            m_ambientLight.set(value);
            return *this;
        }
 
        SceneConditions &set(const AmbientLight::FlickerFrequency &value)
        {
            m_ambientLight.set(value);
            return *this;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, SceneConditions::AmbientLight>::value, int>::type = 0>
        const SceneConditions::AmbientLight &get() const
        {
            return m_ambientLight;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, SceneConditions::AmbientLight::FlickerClassification>::value, int>::
                type = 0>
        const SceneConditions::AmbientLight::FlickerClassification &get() const
        {
            return m_ambientLight.get<SceneConditions::AmbientLight::FlickerClassification>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, SceneConditions::AmbientLight::FlickerFrequency>::value, int>::
                type = 0>
        const SceneConditions::AmbientLight::FlickerFrequency &get() const
        {
            return m_ambientLight.get<SceneConditions::AmbientLight::FlickerFrequency>();
        }
 
        template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
        const SceneConditions::AmbientLight &get() const
        {
            return m_ambientLight;
        }
 
        template<typename F>
        void forEach(const F &f) const
        {
            f(m_ambientLight);
        }
 
        template<typename F>
        void forEach(const F &f)
        {
            f(m_ambientLight);
        }
 
        bool operator==(const SceneConditions &other) const;
 
        bool operator!=(const SceneConditions &other) const;
 
        std::string toString() const;
 
        friend std::ostream &operator<<(std::ostream &stream, const SceneConditions &value)
        {
            return stream << value.toString();
        }
 
        void save(const std::string &fileName) const;
 
        void load(const std::string &fileName);
 
    private:
        void setFromString(const std::string &value);
 
        void setFromString(const std::string &fullPath, const std::string &value);
 
        std::string getString(const std::string &fullPath) const;
 
        AmbientLight m_ambientLight;
 
        friend struct DataModel::Detail::Befriend<SceneConditions>;
    };
 
#ifndef NO_DOC
    template<>
    struct SceneConditions::Version<2>
    {
        using Type = SceneConditions;
    };
#endif
 
} // namespace Zivid
 
#ifndef NO_DOC
namespace Zivid::Detail
{
 
    ZIVID_CORE_EXPORT void save(const Zivid::SceneConditions &dataModel, std::ostream &ostream);
    ZIVID_CORE_EXPORT void load(Zivid::SceneConditions &dataModel, std::istream &istream);
 
    ZIVID_CORE_EXPORT std::vector<uint8_t> serializeToBinaryVector(const Zivid::SceneConditions &source);
    ZIVID_CORE_EXPORT void deserializeFromBinaryVector(Zivid::SceneConditions &dest, const std::vector<uint8_t> &data);
 
} // namespace Zivid::Detail
#endif
 
#ifdef _MSC_VER
#    pragma warning(pop)
#endif
 
#ifndef NO_DOC
#    if !(defined(_MSC_VER) && (_MSC_VER <= 1900))
namespace std // NOLINT
{
 
    template<>
    struct tuple_size<Zivid::SceneConditions::AmbientLight> : integral_constant<size_t, 2>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::SceneConditions::AmbientLight>
    {
        static_assert(i < tuple_size<Zivid::SceneConditions::AmbientLight>::value, "Index must be less than 2");
 
        using type // NOLINT
            = decltype(declval<Zivid::SceneConditions::AmbientLight>().get<i>());
    };
 
    template<>
    struct tuple_size<Zivid::SceneConditions> : integral_constant<size_t, 1>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::SceneConditions>
    {
        static_assert(i < tuple_size<Zivid::SceneConditions>::value, "Index must be less than 1");
 
        using type // NOLINT
            = decltype(declval<Zivid::SceneConditions>().get<i>());
    };
 
} // namespace std
#    endif
#endif
 
// If we have access to the DataModel library, automatically include internal DataModel
// header. This header is necessary for serialization and deserialization.
#if defined(__has_include) && !defined(NO_DOC)
#    if __has_include("Zivid/SceneConditionsInternal.h") && __has_include("Zivid/DataModelNodeMetaData.h")
#        include "Zivid/SceneConditionsInternal.h"
#    endif
#endif