HSLColor.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: HSLColor
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Color.h>
#include <NDEVR/Angle.h>
#include <NDEVR/Vector.h>
namespace NDEVR
{
    class RGBColor;
    class ACIColor;
    class XYZColor;
    typedef sint04 HSLAngleType;
    /**----------------------------------------------------------------------------
    \brief The HSL (Hue, Saturation, Luminosity) color model defines a color space in 
        terms of three constituent components hue, brightness and luminosity
    // ----------------------------------------------------------------------------*/
    class HSLColor : public Color
    {
    public:
        Angle<HSLAngleType> hue;
        uint01 saturation;
        uint01 brightness;
        uint01 alpha;
    public:
        constexpr HSLColor()
            : hue(Constant<Angle<HSLAngleType>>::Invalid)
            , saturation(Constant<uint01>::Invalid)
            , brightness(Constant<uint01>::Invalid)
            , alpha(Constant<uint01>::Invalid)
        {}
        constexpr HSLColor(const HSLColor& color) = default;
        constexpr HSLColor(const Angle<HSLAngleType>& h, uint01 s, uint01 b, uint01 a = 255)
            : hue(h)
            , saturation(s)
            , brightness(b)
            , alpha(a)
        {}
 
        constexpr HSLColor(const Angle<HSLAngleType>& 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 HSLColor(const Angle<HSLAngleType>& 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 HSLColor(fltp08 h, fltp08 s, fltp08 b, fltp08 a = 1.0f)
            : hue(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 HSLColor(fltp04 h, fltp04 s, fltp04 b, fltp04 a = 1.0f)
            : hue(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))
        {}
        constexpr HSLColor(const Vector<4, fltp04>& color)
            : hue(Angle<HSLAngleType>(DEGREES, color[X]))
            , saturation(cast<uint01>((color[Y] > 1) ? 1 : ((color[Y] < 0) ? 0 : color[Y]) * 255))
            , brightness(cast<uint01>((color[Z] > 1) ? 1 : ((color[Z] < 0) ? 0 : color[Z]) * 255))
            , alpha(cast<uint01>(color[W] * 255))
        {}
        NDEVR_BASE_API explicit HSLColor(const ACIColor&);
        NDEVR_BASE_API explicit HSLColor(const RGBColor&);
        NDEVR_BASE_API explicit HSLColor(const XYZColor&);
        fltp04 getBF() const
        {
            return cast<fltp04>(brightness) / 255.0f;
        }
        fltp04 getSF() const
        {
            return cast<fltp04>(saturation) / 255.0f;
        }
        fltp04 getAF() const
        {
            return cast<fltp04>(alpha) / 255.0f;
        }
        
    };
    template<> constexpr HSLColor Constant<HSLColor>::Invalid = HSLColor();
    template<> constexpr HSLColor Constant<HSLColor>::Max = HSLColor(Constant<Angle<HSLAngleType>>::Max, 1.0f, 1.0f, 1.0f);
    template<> constexpr HSLColor Constant<HSLColor>::Min = HSLColor(Constant<Angle<HSLAngleType>>::Max, 0.0f, 0.0f, 0.0f);
}