HSBColor.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: HSBColor
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Angle.h>
#include <NDEVR/Vector.h>
#include <NDEVR/Buffer.h>
namespace NDEVR
{
    class RGBColor;
    class ACIColor;
    class LABColor;
    class XYZColor;
    typedef sint04 HSBAngleType;
    /**----------------------------------------------------------------------------
    \brief The HSB (Hue, Saturation, Brightness) color model defines a color space in
        terms of three constituent components hue, brightness and brightness
 
    Hue: the color type (such as red, blue, or yellow).
        Ranges from 0 to 360 (each value corresponds to one color:
        0 is red, 45 is a shade of orange and 55 is a shade of yellow).
 
    Saturation: the saturation of the color.
 
    Brightness: the brightness of the color.
        Ranges from 0 to 100% (0 is always black; depending on the saturation, 100 may be white or a more or less saturated color).
    // ----------------------------------------------------------------------------*/
    class HSBColor
    {
    public:
        Angle<HSBAngleType> hue;
        uint01 saturation;
        uint01 brightness;
        uint01 alpha;
    public:
        HSBColor()
        {}
        constexpr HSBColor(const Angle<HSBAngleType>& h, uint01 s, uint01 b, uint01 a = 255)
            : hue(h)
            , saturation(s)
            , brightness(b)
            , alpha(a)
        {}
 
        constexpr HSBColor(const Angle<HSBAngleType>& h, fltp08 s, fltp08 b, fltp08 a = 1.0)
            : hue(h)
            , saturation(cast<uint01>((s > 1) ? 1 : ((s < 0) ? 0 : s) * 255))
            , brightness(cast<uint01>((b > 1) ? 1 : ((b < 0) ? 0 : b) * 255))
            , alpha(cast<uint01>(a *255))
        {}
 
        constexpr HSBColor(const Angle<HSBAngleType>& h, fltp04 s, fltp04 b, fltp04 a = 1.0f)
            : hue(h)
            , saturation(cast<uint01>((s > 1) ? 1 : ((s < 0) ? 0 : s) * 255))
            , brightness(cast<uint01>((b > 1) ? 1 : ((b < 0) ? 0 : b) * 255))
            , alpha(cast<uint01>(a * 255))
        {}
 
        constexpr HSBColor(fltp08 h, fltp08 s, fltp08 b, fltp08 a = 1.0f)
            : hue(Angle<sint01>(DEGREES, cast<fltp04>(h)))
            , saturation(cast<uint01>((s > 1) ? 1 : ((s < 0) ? 0 : s) * 255))
            , brightness(cast<uint01>((b > 1) ? 1 : ((b < 0) ? 0 : b) * 255))
            , alpha(cast<uint01>(a * 255))
        {}
 
        constexpr HSBColor(fltp04 h, fltp04 s, fltp04 b, fltp04 a = 1.0f)
            : hue(Angle<sint01>(DEGREES, h))
            , saturation(cast<uint01>((s > 1) ? 1 : ((s < 0) ? 0 : s) * 255))
            , brightness(cast<uint01>((b > 1) ? 1 : ((b < 0) ? 0 : b) * 255))
            , alpha(cast<uint01>(a * 255))
        {}
        NDEVR_BASE_API explicit HSBColor(const Vector<4, fltp04>& color);
        NDEVR_BASE_API explicit HSBColor(const ACIColor&);
        NDEVR_BASE_API explicit HSBColor(const RGBColor&);
        NDEVR_BASE_API explicit HSBColor(const XYZColor&);
 
        fltp04 getBF() const
        {
            return cast<fltp04>(brightness) / 255.0f;
        }
        fltp04 getBS() const
        {
            return cast<fltp04>(saturation) / 255.0f;
        }
        fltp04 getAF() const
        {
            return cast<fltp04>(alpha) / 255.0f;
        }
        NDEVR_BASE_API static HSBColor ConvertColor(const LABColor& current_color, const Buffer<std::pair<LABColor, LABColor>, uint04, ObjectAllocator<true>>& pairs, bool preserve_brightness, bool preserve_alpha);
    };
    template<>
    constexpr const HSBColor Constant<HSBColor>::Invalid = HSBColor(Constant<Angle<HSBAngleType>>::Invalid, Constant<uint01>::Invalid, Constant<uint01>::Invalid, Constant<uint01>::Invalid);
    template<>
    constexpr const HSBColor Constant<HSBColor>::Max = HSBColor(Constant<Angle<HSBAngleType>>::Max, Constant<uint01>::Max, Constant<uint01>::Max, Constant<uint01>::Max);
    template<>
    constexpr const HSBColor Constant<HSBColor>::Min = HSBColor(Constant<Angle<HSBAngleType>>::Min, Constant<uint01>::Min, Constant<uint01>::Min, Constant<uint01>::Min);
}