visualcolor.h

Go to the documentation of this file.

/*
* Copyright 2015 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/


// primary contact: GUAL - secondary contact: MAMU
#ifndef Navigation_VisualColor_H
#define Navigation_VisualColor_H

#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/base/endianness.h"

namespace Kaim
{

class VisualColor
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_VisualSystem)

public:
    KY_INLINE static VisualColor Inactive() { return VisualColor::TransparentBlack; }

    VisualColor() : m_r(0), m_g(0), m_b(0), m_a(255) {}

    VisualColor(KyUInt8 r, KyUInt8 g, KyUInt8 b, KyUInt8 a = 255 ) { Set(r, g, b, a); }

    VisualColor(const VisualColor& color) { Set(color.m_r, color.m_g, color.m_b, color.m_a); }

    VisualColor(const VisualColor& color, KyFloat32 a) { Set(color.m_r, color.m_g, color.m_b, (KyUInt8)(a * 255.0f)); }

    VisualColor(const VisualColor& color, KyUInt8 a) { Set(color.m_r, color.m_g, color.m_b, a); }


    bool operator==(const VisualColor& other) const
    {
        return m_r == other.m_r && m_g == other.m_g && m_b == other.m_b && m_a == other.m_a;
    }

    bool operator!=(const VisualColor& other) const
    {
        return !(operator==(other));
    }

    void Set(KyUInt8 r, KyUInt8 g, KyUInt8 b, KyUInt8 a = 255)
    {
        m_r = r;
        m_g = g;
        m_b = b;
        m_a = a;
    }

    void SetFloat(KyFloat32 r, KyFloat32 g, KyFloat32 b, KyFloat32 a = 1.0f)
    {
        m_r = (KyUInt8)(r * 255.0f);
        m_g = (KyUInt8)(g * 255.0f);
        m_b = (KyUInt8)(b * 255.0f);
        m_a = (KyUInt8)(a * 255.0f);
    }

public:
    KyUInt8 m_r; 
    KyUInt8 m_g; 
    KyUInt8 m_b; 
    KyUInt8 m_a; 

public:
    static const VisualColor AliceBlue;         
    static const VisualColor AntiqueWhite;      
    static const VisualColor Aqua;              
    static const VisualColor Aquamarine;        
    static const VisualColor Azure;             
    static const VisualColor Beige;             
    static const VisualColor Bisque;            
    static const VisualColor Black;             
    static const VisualColor BlanchedAlmond;    
    static const VisualColor Blue;              
    static const VisualColor BlueViolet;        
    static const VisualColor Brown;             
    static const VisualColor BurlyWood;         
    static const VisualColor CadetBlue;         
    static const VisualColor Chartreuse;        
    static const VisualColor Chocolate;         
    static const VisualColor Coral;             
    static const VisualColor CornflowerBlue;    
    static const VisualColor Cornsilk;          
    static const VisualColor Crimson;           
    static const VisualColor Cyan;              
    static const VisualColor DarkBlue;          
    static const VisualColor DarkCyan;          
    static const VisualColor DarkGoldenrod;     
    static const VisualColor DarkGray;          
    static const VisualColor DarkGreen;         
    static const VisualColor DarkKhaki;         
    static const VisualColor DarkMagenta;       
    static const VisualColor DarkOliveGreen;    
    static const VisualColor DarkOrange;        
    static const VisualColor DarkOrchid;        
    static const VisualColor DarkRed;           
    static const VisualColor DarkSalmon;        
    static const VisualColor DarkSeaGreen;      
    static const VisualColor DarkSlateBlue;     
    static const VisualColor DarkSlateGray;     
    static const VisualColor DarkTurquoise;     
    static const VisualColor DarkViolet;        
    static const VisualColor DeepPink;          
    static const VisualColor DeepSkyBlue;       
    static const VisualColor DimGray;           
    static const VisualColor DodgerBlue;        
    static const VisualColor Firebrick;         
    static const VisualColor FloralWhite;       
    static const VisualColor ForestGreen;       
    static const VisualColor Fuchsia;           
    static const VisualColor Gainsboro;         
    static const VisualColor GhostWhite;        
    static const VisualColor Gold;              
    static const VisualColor Goldenrod;         
    static const VisualColor Gray;              
    static const VisualColor Green;             
    static const VisualColor GreenYellow;       
    static const VisualColor Honeydew;          
    static const VisualColor HotPink;           
    static const VisualColor IndianRed;         
    static const VisualColor Indigo;            
    static const VisualColor Ivory;             
    static const VisualColor Khaki;             
    static const VisualColor Lavender;          
    static const VisualColor LavenderBlush;     
    static const VisualColor LawnGreen;         
    static const VisualColor LemonChiffon;      
    static const VisualColor LightBlue;         
    static const VisualColor LightCoral;        
    static const VisualColor LightCyan;         
    static const VisualColor LightGoldenrodYellow; 
    static const VisualColor LightGray;         
    static const VisualColor LightGreen;        
    static const VisualColor LightPink;         
    static const VisualColor LightSalmon;       
    static const VisualColor LightSeaGreen;     
    static const VisualColor LightSkyBlue;      
    static const VisualColor LightSlateGray;    
    static const VisualColor LightSteelBlue;    
    static const VisualColor LightYellow;       
    static const VisualColor Lime;              
    static const VisualColor LimeGreen;         
    static const VisualColor Linen;             
    static const VisualColor Magenta;           
    static const VisualColor Maroon;            
    static const VisualColor MediumAquamarine;  
    static const VisualColor MediumBlue;        
    static const VisualColor MediumOrchid;      
    static const VisualColor MediumPurple;      
    static const VisualColor MediumSeaGreen;    
    static const VisualColor MediumSlateBlue;   
    static const VisualColor MediumSpringGreen; 
    static const VisualColor MediumTurquoise;   
    static const VisualColor MediumVioletRed;   
    static const VisualColor MidnightBlue;      
    static const VisualColor MintCream;         
    static const VisualColor MistyRose;         
    static const VisualColor Moccasin;          
    static const VisualColor NavajoWhite;       
    static const VisualColor Navy;              
    static const VisualColor OldLace;           
    static const VisualColor Olive;             
    static const VisualColor OliveDrab;         
    static const VisualColor Orange;            
    static const VisualColor OrangeRed;         
    static const VisualColor Orchid;            
    static const VisualColor PaleGoldenrod;     
    static const VisualColor PaleGreen;         
    static const VisualColor PaleTurquoise;     
    static const VisualColor PaleVioletRed;     
    static const VisualColor PapayaWhip;        
    static const VisualColor PeachPuff;         
    static const VisualColor Peru;              
    static const VisualColor Pink;              
    static const VisualColor Plum;              
    static const VisualColor PowderBlue;        
    static const VisualColor Purple;            
    static const VisualColor Red;               
    static const VisualColor RosyBrown;         
    static const VisualColor RoyalBlue;         
    static const VisualColor SaddleBrown;       
    static const VisualColor Salmon;            
    static const VisualColor SandyBrown;        
    static const VisualColor SeaGreen;          
    static const VisualColor SeaShell;          
    static const VisualColor Sienna;            
    static const VisualColor Silver;            
    static const VisualColor SkyBlue;           
    static const VisualColor SlateBlue;         
    static const VisualColor SlateGray;         
    static const VisualColor Snow;              
    static const VisualColor SpringGreen;       
    static const VisualColor SteelBlue;         
    static const VisualColor Tan;               
    static const VisualColor Teal;              
    static const VisualColor Thistle;           
    static const VisualColor Tomato;            
    static const VisualColor TransparentBlack;  
    static const VisualColor TransparentWhite;  
    static const VisualColor Turquoise;         
    static const VisualColor Violet;            
    static const VisualColor Wheat;             
    static const VisualColor White;             
    static const VisualColor WhiteSmoke;        
    static const VisualColor Yellow;            
    static const VisualColor YellowGreen;       

public:
    static const VisualColor& GetDistinctColor(KyUInt32 index);

    static const VisualColor& GetDistinctColorWithoutRed(const KyUInt32 index);

    static const VisualColor& GetDistinctColor(KyUInt32 index, KyUInt32 nbColorsInPalette);

    static const VisualColor& GetDistinctColor(const KyUInt32 index, const VisualColor* customPalette, KyUInt32 nbColorsInPalette);
};

inline void SwapEndianness(Endianness::Target /*e*/, VisualColor& /*self*/)
{
    // nothing to swap
}

}

#endif //Navigation_VisualColor_H