color.h

Go to the documentation of this file.

/*
* Copyright 2016 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.
*/

#pragma once

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

namespace Kaim
{

class Color
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_VisualSystem)

public:
    Color() : r(0), g(0), b(0), a(255) {} 
    Color(const Color& c) { Set(c.r, c.g, c.b, c.a); }
    Color(const Color& c, KyUInt8 a) { Set(c.r, c.g, c.b, a); }
    Color(KyUInt8 r, KyUInt8 g, KyUInt8 b, KyUInt8 a = 255) { Set(r, g, b, a); } 
    Color(KyUInt32 rgba) { Set(rgba >> 24, (rgba >> 16) & 0xFF, (rgba >> 8) & 0xFF, rgba & 0xFF); }

    static Color Fade(Color c, KyFloat32 fade) { return Color(KyUInt8(c.r * fade), KyUInt8(c.g * fade), KyUInt8(c.b * fade), c.a); }

    bool IsVisible()     const { return a != 0;   } 
    bool IsOpaque()      const { return a == 255; } 
    bool IsTransparent() const { return a != 255; } 

    bool operator==(const Color& c) const { return r == c.r && g == c.g && b == c.b && a == c.a; }
    bool operator!=(const Color& c) const { return !operator==(c); }

    void Set(KyUInt8 r_, KyUInt8 g_, KyUInt8 b_, KyUInt8 a_ = 255) { r = r_;  g = g_;  b = b_;  a = a_; }
    void Set(const Color& c, KyUInt8 a_) { r = c.r; g = c.g; b = c.b; a = a_; }

    void SetFloat(KyFloat32 r_, KyFloat32 g_, KyFloat32 b_, KyFloat32 a_ = 1.0f)
    {
        Set(KyUInt8(r_ * 255.0f), KyUInt8(g_ * 255.0f), KyUInt8(b_ * 255.0f), KyUInt8(a_ * 255.0f));
    }

public:
    KyUInt8 r; 
    KyUInt8 g; 
    KyUInt8 b; 
    KyUInt8 a; 

public:
    static Color GetDistinctColor(KyUInt32 index);

    static Color GetDistinctColor(const KyUInt32 index, const Color* customPalette, KyUInt32 nbColorsInPalette);

    // White, Grey, Back
    static const KyUInt32 White = 0xFFFFFFFF;
    static const KyUInt32 LightGrey = 0xD3D3D3FF;
    static const KyUInt32 Grey = 0x808080FF;
    static const KyUInt32 DimGrey = 0x696969FF;
    static const KyUInt32 Black = 0x000000FF;

    // Main colors
    static const KyUInt32 Red = 0xFF0000FF;
    static const KyUInt32 Green = 0x00FF00FF; // aka CSS Lime
    static const KyUInt32 Blue = 0x0000FFFF;
    static const KyUInt32 Magenta = 0xFF00FFFF; // aka CSS Fuchsia
    static const KyUInt32 Cyan = 0x00FFFFFF;
    static const KyUInt32 Yellow = 0xFFFF00FF;
    static const KyUInt32 Orange = 0xFFA500FF;

    // Red-Yellow
    static const KyUInt32 Khaki = 0xF0E68CFF;
    static const KyUInt32 Tan = 0xD2B48CFF;
    static const KyUInt32 Chocolate = 0xD2691EFF;
    static const KyUInt32 Salmon = 0xFA8072FF;
    static const KyUInt32 OrangeRed = 0xFF4500FF;
    static const KyUInt32 Brown = 0xA52A2AFF;

    // Greens
    static const KyUInt32 GreenYellow = 0xADFF2FFF;
    static const KyUInt32 LightGreen = 0x90EE90FF;
    static const KyUInt32 LightSeaGreen = 0x20B2AAFF;
    static const KyUInt32 DarkSeaGreen = 0x8FBC8FFF;
    static const KyUInt32 Teal = 0x008080FF;

    // Blues-Aquas
    static const KyUInt32 SkyBlue = 0x87CEEBFF;
    static const KyUInt32 DeepSkyBlue = 0x00BFFFFF;
    static const KyUInt32 RoyalBlue = 0x4169E1FF;
    static const KyUInt32 MediumBlue = 0x0000CDFF; // the default NavMesh color

    // Magentas
    static const KyUInt32 Violet = 0xEE82EEFF;
    static const KyUInt32 HotPink = 0xFF69B4FF;
    static const KyUInt32 MediumPurple = 0x9370DBFF;
    static const KyUInt32 Purple = 0x800080FF;

    // Invisible
    static const KyUInt32 TransparentBlack = 0xFFFFFF00;
    static const KyUInt32 Invisible = 0xFFFFFF00;
};

inline void SwapEndianness(Endianness::Target, Color&) {} // nothing to swap

typedef KY_DEPRECATED(Color VisualColor); // VisualColor deprecated since 2.17.0, use Color instead

}