XYZColor.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: XYZColor
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "Color.h"
#include <NDEVR/Vector.h>
namespace NDEVR
{
    class RGBColor;
    class ACIColor;
    class LABColor;
    class HSBColor;
    class HSLColor;
    /**----------------------------------------------------------------------------
    \brief In opposition to the previous models, the CIE XYZ model defines an absolute
        color space. 
    It is also known as the CIE 1931 XYZ color space and stands for:
        X, which can be compared to red Ranges from 0 to 0.9505
        Y, which can be compared to green Ranges from 0 to 1.0
        Z, which can be compared to blue Ranges from 0 to 1.089
    ----------------------------------------------------------------------------*/
    class XYZColor : public Vector<4, fltp04>, public Color
    {
    public:
        constexpr XYZColor()
            : Vector<4, fltp04>(Constant<fltp04>::Invalid)
        {}
        constexpr explicit XYZColor(const Vector<4, fltp04>& color)
            : Vector<4, fltp04>(color)
        {}
        constexpr XYZColor(fltp04 x, fltp04 y, fltp04 z, fltp04 a = 1.0f)
            : Vector<4, fltp04>(
               clip(x, 0.0f, 0.9505f)
            ,  clip(y, 0.0f, 1.0f)
            ,  clip(z, 0.0f, 1.0f)
            , a)
        {}
        explicit NDEVR_BASE_API XYZColor(const RGBColor&);
        explicit NDEVR_BASE_API XYZColor(const ACIColor&);
        explicit NDEVR_BASE_API XYZColor(const LABColor&);
        explicit NDEVR_BASE_API XYZColor(const HSBColor&);
        explicit NDEVR_BASE_API XYZColor(const HSLColor&);
        void setX(fltp04 x)
        {
            m_values[X] = (x > 0.9505f) ? 0.9505f : ((x < 0.0f) ? 0.0f : x);
        }
        void setY(fltp04 y)
        {
            m_values[Y] = (y > 1.0000f) ? 1.0000f : ((y < 0.0f) ? 0.0f : y);
        }
        void setZ(fltp04 z)
        {
            m_values[Z] = (z > 1.0890f) ? 1.0890f : ((z < 0.0f) ? 0.0f : z);
        }
        void setA(fltp04 a)
        {
            m_values[W] = a;
        }
        static XYZColor getD65() 
        {
            static XYZColor D65(95.047f, 100.0f, 108.883f);
            return D65;
        }
    };
    template<>
    constexpr const XYZColor Constant<XYZColor>::Invalid = XYZColor();
    template<>
    constexpr const XYZColor Constant<XYZColor>::Max = XYZColor(Constant<fltp04>::Max, Constant<fltp04>::Max, Constant<fltp04>::Max);
    template<>
    constexpr const XYZColor Constant<XYZColor>::Min = XYZColor(Constant<fltp04>::Min, Constant<fltp04>::Min, Constant<fltp04>::Min);
}