peak_icv_opacity.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_icv/exceptions/peak_icv_exception.hpp>
#include <peak_icv/utils/peak_icv_printable.hpp>
 
#include <type_traits>
#include <cstdint>
#include <string>
 
namespace peak
{
namespace icv
{
class Opacity : public detail::IPrintable<Opacity>
{
public:
    constexpr explicit Opacity()
        : Opacity(maximum)
    {}
 
    constexpr explicit Opacity(uint32_t value)
        : m_value(value)
    {
        if (value > maximum)
        {
            throw OutOfRangeException(
                "Opacity value has to be within the range of " + std::to_string(minimum) + " to " + std::to_string(maximum) + ".");
        }
    }
 
    PEAK_COMMON_NO_DISCARD constexpr uint32_t GetValue() const
    {
        return m_value;
    }
 
    PEAK_COMMON_NO_DISCARD static constexpr uint32_t GetMinimum()
    {
        return minimum;
    }
 
    PEAK_COMMON_NO_DISCARD static constexpr uint32_t GetMaximum()
    {
        return maximum;
    }
 
    template <typename Opacity
        ,
        std::enable_if_t<std::is_integral<Opacity>::value, bool> = true
        >
    auto operator==(const Opacity& value) const
    {
        return static_cast<uint32_t>(value) == m_value;
    }
 
protected:
    void Print(detail::CommaSeperatedStream& stream) const override
    {
        stream << GetValue();
    }
 
private:
    static constexpr uint32_t minimum = 0;
    static constexpr uint32_t maximum = 100;
    uint32_t m_value{ maximum };
};
 
} /* namespace icv */
} /* namespace peak */