color4d.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * Color class
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <memory>
#include <kicommon.h>
#include <wx/debug.h>
#include <wx/colour.h>
#include <wx/string.h>
#include <hash.h>
#include <nlohmann/json_fwd.hpp>
 

enum EDA_COLOR_T
{
    UNSPECIFIED_COLOR = -1,
    BLACK = 0,
    DARKDARKGRAY,
    DARKGRAY,
    LIGHTGRAY,
    WHITE,
    LIGHTYELLOW,
    DARKBLUE,
    DARKGREEN,
    DARKCYAN,
    DARKRED,
    DARKMAGENTA,
    DARKBROWN,
    BLUE,
    GREEN,
    CYAN,
    RED,
    MAGENTA,
    BROWN,
    LIGHTBLUE,
    LIGHTGREEN,
    LIGHTCYAN,
    LIGHTRED,
    LIGHTMAGENTA,
    YELLOW,
    PUREBLUE,
    PUREGREEN,
    PURECYAN,
    PURERED,
    PUREMAGENTA,
    PUREYELLOW,
    LIGHTERORANGE,
    DARKORANGE,
    ORANGE,
    LIGHTORANGE,
    PUREORANGE,
    NBCOLORS,                     
    HIGHLIGHT_FLAG = ( 1 << 19 ),
    MASKCOLOR      =   31         
};
 
 
struct KICOMMON_API StructColors
{
    unsigned char m_Blue;
    unsigned char m_Green;
    unsigned char m_Red;
    EDA_COLOR_T   m_Numcolor;
    std::string   m_ColorName;
    EDA_COLOR_T   m_LightColor;
};

KICOMMON_API const StructColors* colorRefs();
 
 
namespace KIGFX
{
class KICOMMON_API COLOR4D
{
public:
    // Constructor (creates the Color 0,0,0,0)
    COLOR4D() :
        r( 0 ),
        g( 0 ),
        b( 0 ),
        a( 1.0 )
    {
    }

    COLOR4D( double aRed, double aGreen, double aBlue, double aAlpha ) :
        r( aRed ),
        g( aGreen ),
        b( aBlue ),
        a( aAlpha )
    {
        wxASSERT( r >= 0.0 && r <= 1.0 );
        wxASSERT( g >= 0.0 && g <= 1.0 );
        wxASSERT( b >= 0.0 && b <= 1.0 );
        wxASSERT( a >= 0.0 && a <= 1.0 );
    }

    COLOR4D( EDA_COLOR_T aColor );

    COLOR4D& FromCSSRGBA( int aRed, int aGreen, int aBlue, double aAlpha = 1.0 );

    COLOR4D( const wxString& aColorStr );

    COLOR4D( const wxColour& aColor );

    bool SetFromWxString( const wxString& aColorString );
 
    wxString ToCSSString() const;
 
    bool SetFromHexString( const wxString& aColorString );
    wxString ToHexString() const;
 
    wxColour ToColour() const;

    COLOR4D LegacyMix( const COLOR4D& aColor ) const;

    void ToHSL( double& aOutHue, double& aOutSaturation, double& aOutLightness ) const;

    void FromHSL( double aInHue, double aInSaturation, double aInLightness );

    COLOR4D& Brighten( double aFactor )
    {
        wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
 
        r = r * ( 1.0 - aFactor ) + aFactor;
        g = g * ( 1.0 - aFactor ) + aFactor;
        b = b * ( 1.0 - aFactor ) + aFactor;
 
        return *this;
    }

    COLOR4D& Darken( double aFactor )
    {
        wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
 
        r = r * ( 1.0 - aFactor );
        g = g * ( 1.0 - aFactor );
        b = b * ( 1.0 - aFactor );
 
        return *this;
    }

    COLOR4D& Invert()
    {
        r = ( 1.0 - r );
        g = ( 1.0 - g );
        b = ( 1.0 - b );
 
        return *this;
    }

    COLOR4D& Saturate( double aFactor );

    COLOR4D& Desaturate();

    COLOR4D Brightened( double aFactor ) const
    {
        wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
 
        return COLOR4D( r * ( 1.0 - aFactor ) + aFactor, g * ( 1.0 - aFactor ) + aFactor,
                        b * ( 1.0 - aFactor ) + aFactor, a );
    }

    COLOR4D Darkened( double aFactor ) const
    {
        wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
 
        return COLOR4D( r * ( 1.0 - aFactor ), g * ( 1.0 - aFactor ), b * ( 1.0 - aFactor ), a );
    }

    COLOR4D Mix( const COLOR4D& aColor, double aFactor ) const
    {
        wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
 
        return COLOR4D( aColor.r * ( 1.0 - aFactor ) + r * aFactor,
                        aColor.g * ( 1.0 - aFactor ) + g * aFactor,
                        aColor.b * ( 1.0 - aFactor ) + b * aFactor,
                        a );
    }

     COLOR4D WithAlpha( double aAlpha ) const
     {
         wxASSERT( aAlpha >= 0.0 && aAlpha <= 1.0 );
 
         return COLOR4D( r, g, b, aAlpha );
     }

    COLOR4D Inverted() const
    {
        return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
    }

    double GetBrightness() const
    {
        // Weighted W3C formula
        return r * 0.299 + g * 0.587 + b * 0.117;
    }

    void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue,
                bool aAlwaysDefineHue = false ) const;

    void FromHSV( double aInH, double aInS, double aInV );

    double Distance( const COLOR4D& other ) const;
 
    int Compare( const COLOR4D& aRhs ) const;

    double RelativeLuminance() const;

    static double ContrastRatio( const COLOR4D& aLeft, const COLOR4D& aRight );

    static EDA_COLOR_T FindNearestLegacyColor( int aR, int aG, int aB );
 
    // Color components: red, green, blue, alpha
    double r; 
    double g; 
    double b; 
    double a; 
 
    // Optional text for evaluated colors
    std::shared_ptr<wxString> m_text;

    static const COLOR4D UNSPECIFIED;
 
    // Declare a few color shortcuts that are used for comparisons frequently
    static const COLOR4D WHITE;
    static const COLOR4D BLACK;
    static const COLOR4D CLEAR;
};

KICOMMON_API bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );

KICOMMON_API bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
 
KICOMMON_API bool operator<( const COLOR4D& lhs, const COLOR4D& rhs );

KICOMMON_API std::ostream& operator<<( std::ostream& aStream, COLOR4D const& aColor );
 
// to allow json( COLOR4D )
KICOMMON_API void to_json( nlohmann::json& aJson, const COLOR4D& aColor );
 
// To allow json::get<COLOR4D>()
KICOMMON_API void from_json( const nlohmann::json& aJson, COLOR4D& aColor );
 
} // namespace KIGFX
 
template<>
struct KICOMMON_API std::hash<KIGFX::COLOR4D>
{
    std::size_t operator()( const KIGFX::COLOR4D& aColor ) const
    {
        return hash_val( aColor.r, aColor.b, aColor.g, aColor.a );
    }
};