ACIColor.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: ACIColor
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Color.h>
#include <NDEVR/BaseValues.h>
namespace NDEVR
{
    class String;
    class TranslatedString;
    class RGBColor;
    class HSBColor;
    class XYZColor;
    class HSLColor;
    class LABColor;
 
    /** ----------------------------------------------------------------------------
    Class: ACIColor
 
    \brief ACI colors are the standard colors used in AutoCAD-based products. 
        Each color is identified by an ACI number, an integer from 1 through 255. 
 
    Standard color names are available only for colors 1 through 7. The colors are 
        assigned as follows: 0 Black, 1 Red, 2 Yellow, 3 Green, 4 Cyan, 5 Blue, 6 Magenta, 
        7 White 8 Dark Gray, 9 Light Gray 10-249 are shades of colors designed to provide a
        spectrum to see most things. 250-255 are shades of gray going from dark to light
    ----------------------------------------------------------------------------*/
    class ACIColor : public Color
    {
    public:
        ACIColor()
            : m_index(0)
        {}
        constexpr explicit ACIColor(uint01 color)
            : m_index(color)
        {};
        NDEVR_BASE_API explicit ACIColor(const RGBColor&);
        NDEVR_BASE_API explicit ACIColor(const HSBColor&);
        NDEVR_BASE_API explicit ACIColor(const HSLColor&);
        NDEVR_BASE_API explicit ACIColor(const XYZColor&);
        NDEVR_BASE_API explicit ACIColor(const LABColor&);
 
        NDEVR_BASE_API RGBColor getRBGAColor() const;
        NDEVR_BASE_API TranslatedString getName() const;
 
 
        uint01 getIndex() const { return m_index; }
    
        static const uint01 ASI_BLACK = 0;
        static const uint01 ASI_RED = 1;
        static const uint01 ASI_YELLOW = 2;
        static const uint01 ASI_GREEN = 3;
        static const uint01 ASI_TEAL = 4;
        static const uint01 ASI_BLUE = 5;
        static const uint01 ASI_PURPLE = 6;
        static const uint01 ASI_WHITE = 7;
    private:
        uint01 m_index;
        static const RGBColor CAD_INDEX[];
    };
    template<>
    constexpr const ACIColor Constant<ACIColor>::Invalid = ACIColor(7);
    template<>
    constexpr const ACIColor Constant<ACIColor>::Max = ACIColor(255);
    template<>
    constexpr const ACIColor Constant<ACIColor>::Min = ACIColor(7);//Duplicate white seems silly so we will reserve this value
}