A color representation with 4 components: red, green, blue, alpha. More...

#include <color4d.h>

Public Member Functions
	COLOR4D ()

constexpr	COLOR4D (double aRed, double aGreen, double aBlue, double aAlpha)

	COLOR4D (EDA_COLOR_T aColor)

COLOR4D &	FromCSSRGBA (int aRed, int aGreen, int aBlue, double aAlpha=1.0)
	Initialize the color from a RGBA value with 0-255 red/green/blue and 0-1 alpha. More...

void	ToHSL (double &aOutHue, double &aOutSaturation, double &aOutValue) const
	Converts current color (stored in RGB) to HSL format. More...

void	FromHSL (double aInHue, double aInSaturation, double aInLightness)
	Change currently used color to the one given by hue, saturation and lightness parameters. More...

COLOR4D &	Brighten (double aFactor)
	Makes the color brighter by a given factor. More...

COLOR4D &	Darken (double aFactor)
	Makes the color darker by a given factor. More...

COLOR4D &	Invert ()
	Makes the color inverted, alpha remains the same. More...

COLOR4D &	Saturate (double aFactor)
	Saturates the color to a given factor (in HSV model) More...

COLOR4D	Brightened (double aFactor) const
	Return a color that is brighter by a given factor, without modifying object. More...

COLOR4D	Darkened (double aFactor) const
	Return a color that is darker by a given factor, without modifying object. More...

COLOR4D	Mix (const COLOR4D &aColor, double aFactor) const
	Return a color that is mixed with the input by a factor. More...

COLOR4D	WithAlpha (double aAlpha) const
	Return a color with the same color, but the given alpha. More...

COLOR4D	Inverted () const
	Returns an inverted color, alpha remains the same. More...

double	GetBrightness () const
	Returns the brightness value of the color ranged from 0.0 to 1.0. More...

void	ToHSV (double &aOutHue, double &aOutSaturation, double &aOutValue, bool aAlwaysDefineHue=false) const
	Convert current color (stored in RGB) to HSV format. More...

void	FromHSV (double aInH, double aInS, double aInV)
	Changes currently used color to the one given by hue, saturation and value parameters. More...

Static Public Member Functions
static EDA_COLOR_T	FindNearestLegacyColor (int aR, int aG, int aB)
	Returns a legacy color ID that is closest to the given 8-bit RGB values. More...

Public Attributes
double	r
	Red component. More...

double	g
	Green component. More...

double	b
	Blue component. More...

double	a
	Alpha component. More...

Static Public Attributes
static const COLOR4D	UNSPECIFIED
	For legacy support; used as a value to indicate color hasn't been set yet. More...

static const COLOR4D	WHITE

static const COLOR4D	BLACK

static const COLOR4D	CLEAR

Detailed Description

A color representation with 4 components: red, green, blue, alpha.

Definition at line 98 of file color4d.h.

Constructor & Destructor Documentation

◆ COLOR4D() [1/3]

KIGFX::COLOR4D::COLOR4D ( )

inline

Definition at line 102 of file color4d.h.

               :
         r( 0 ), g( 0 ), b( 0 ), a( 1.0 )
     {
     }

Referenced by Brightened(), Darkened(), Inverted(), Mix(), and WithAlpha().

◆ COLOR4D() [2/3]

constexpr KIGFX::COLOR4D::COLOR4D	(	double	aRed,
		double	aGreen,
		double	aBlue,
		double	aAlpha
	)

inline

Parameters

aRed	is the red component [0.0 .. 1.0].
aGreen	is the green component [0.0 .. 1.0].
aBlue	is the blue component [0.0 .. 1.0].
aAlpha	is the alpha value [0.0 .. 1.0].

Definition at line 113 of file color4d.h.

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

References a, b, g, and r.

◆ COLOR4D() [3/3]

COLOR4D::COLOR4D ( EDA_COLOR_T aColor )

Parameters

aColor is one of KiCad's palette colors.

See also: EDA_COLOR_T

Definition at line 76 of file color4d.cpp.

 {
     if( aColor <= UNSPECIFIED_COLOR || aColor >= NBCOLORS )
     {
         *this = COLOR4D::UNSPECIFIED;
         return;
     }
 
     r = colorRefs()[aColor].m_Red / 255.0;
     g = colorRefs()[aColor].m_Green / 255.0;
     b = colorRefs()[aColor].m_Blue / 255.0;
     a = 1.0;
 }

References a, b, colorRefs(), g, StructColors::m_Blue, StructColors::m_Green, StructColors::m_Red, NBCOLORS, r, and UNSPECIFIED.

Member Function Documentation

◆ Brighten()

COLOR4D& KIGFX::COLOR4D::Brighten ( double aFactor )

inline

Makes the color brighter by a given factor.

Parameters

aFactor Specifies how bright the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D& Brightened color.

Definition at line 204 of file color4d.h.

     {
         assert( 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;
     }

References b, g, and r.

Referenced by KIGFX::PCB_RENDER_SETTINGS::GetColor().

◆ Brightened()

COLOR4D KIGFX::COLOR4D::Brightened ( double aFactor ) const

inline

Return a color that is brighter by a given factor, without modifying object.

Parameters

aFactor Specifies how bright the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D Highlighted color.

Definition at line 257 of file color4d.h.

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

References a, b, COLOR4D(), g, and r.

Referenced by KIGFX::DS_RENDER_SETTINGS::DS_RENDER_SETTINGS(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), COLOR_SWATCH::MakeBitmap(), and KIGFX::RENDER_SETTINGS::update().

◆ Darken()

COLOR4D& KIGFX::COLOR4D::Darken ( double aFactor )

inline

Makes the color darker by a given factor.

Parameters

aFactor Specifies how dark the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D& Darkened color.

Definition at line 221 of file color4d.h.

     {
         assert( aFactor >= 0.0 && aFactor <= 1.0 );
 
         r = r * ( 1.0 - aFactor );
         g = g * ( 1.0 - aFactor );
         b = b * ( 1.0 - aFactor );
 
         return *this;
     }

References b, g, and r.

Referenced by KIGFX::PCB_RENDER_SETTINGS::GetColor().

◆ Darkened()

COLOR4D KIGFX::COLOR4D::Darkened ( double aFactor ) const

inline

Return a color that is darker by a given factor, without modifying object.

Parameters

aFactor Specifies how dark the color should become (valid values: 0.0 .. 1.0).

Returns: COLOR4D Darkened color.

Definition at line 271 of file color4d.h.

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

References a, b, COLOR4D(), g, and r.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), COLOR_SWATCH::MakeBitmap(), KIGFX::RENDER_SETTINGS::update(), and EDIT_POINTS::ViewDraw().

◆ FindNearestLegacyColor()

EDA_COLOR_T COLOR4D::FindNearestLegacyColor	(	int	aR,
		int	aG,
		int	aB
	)

static

Returns a legacy color ID that is closest to the given 8-bit RGB values.

Definition at line 440 of file color4d.cpp.

 {
     EDA_COLOR_T candidate = EDA_COLOR_T::BLACK;
 
     /* Find the 'nearest' color in the palette. This is fun. There is
        a gazilion of metrics for the color space and no one of the
        useful one is in the RGB color space. Who cares, this is a CAD,
        not a photosomething...
 
        I hereby declare that the distance is the sum of the square of the
        component difference. Think about the RGB color cube. Now get the
        euclidean distance, but without the square root... for ordering
        purposes it's the same, obviously. Also each component can't be
        less of the target one, since I found this currently work better...
        */
     int nearest_distance = 255 * 255 * 3 + 1; // Can't beat this
 
     for( EDA_COLOR_T trying = EDA_COLOR_T::BLACK; trying < EDA_COLOR_T::NBCOLORS;
             trying = static_cast<EDA_COLOR_T>( int( trying ) + 1 ) )
     {
         const StructColors &c = colorRefs()[trying];
         int distance = (aR - c.m_Red) * (aR - c.m_Red) +
                        (aG - c.m_Green) * (aG - c.m_Green) +
                        (aB - c.m_Blue) * (aB - c.m_Blue);
 
         if( distance < nearest_distance && c.m_Red >= aR &&
             c.m_Green >= aG && c.m_Blue >= aB )
         {
             nearest_distance = distance;
             candidate = trying;
         }
     }
 
     return candidate;
 }

References BLACK, colorRefs(), distance(), StructColors::m_Blue, StructColors::m_Green, StructColors::m_Red, and NBCOLORS.

◆ FromCSSRGBA()

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

Initialize the color from a RGBA value with 0-255 red/green/blue and 0-1 alpha.

Suitable for taking the values directly from the "CSS syntax" from ToWxString.

Returns: this color.

Definition at line 476 of file color4d.cpp.

 {
     r = std::max( 0, std::min( 255, aRed ) ) / 255.0;
     g = std::max( 0, std::min( 255, aGreen ) ) / 255.0;
     b = std::max( 0, std::min( 255, aBlue ) ) / 255.0;
     a = std::max( 0.0, std::min( 1.0, aAlpha ) );
 
     return *this;
 }

References a, b, g, and r.

Referenced by GetColorFromInt().

◆ FromHSL()

void COLOR4D::FromHSL	(	double	aInHue,
		double	aInSaturation,
		double	aInLightness
	)

Change currently used color to the one given by hue, saturation and lightness parameters.

Parameters

aInHue	is hue component, in degrees (0.0 - 360.0).
aInSaturation	is saturation component (0.0 - 1.0).
aInLightness	is lightness component (0.0 - 1.0).

Definition at line 252 of file color4d.cpp.

 {
     const auto P = ( 1.0 - std::abs( 2.0 * aInLightness - 1.0 ) ) * aInSaturation;
     const auto scaled_hue = aInHue / 60.0;
     const auto Q = P * ( 1.0 - std::abs( std::fmod( scaled_hue, 2.0 ) - 1.0 ) );
 
     r = g = b = aInLightness - P / 2.0;
 
     if (scaled_hue < 1.0)
     {
         r += P;
         g += Q;
     }
     else if (scaled_hue < 2.0)
     {
         r += Q;
         g += P;
     }
     else if (scaled_hue < 3.0)
     {
         g += P;
         b += Q;
     }
     else if (scaled_hue < 4.0)
     {
         g += Q;
         b += P;
     }
     else if (scaled_hue < 5.0)
     {
         r += Q;
         b += P;
     }
     else
     {
         r += P;
         b += Q;
     }
 }

References b, g, and r.

Referenced by BOOST_AUTO_TEST_CASE().

◆ FromHSV()

void COLOR4D::FromHSV	(	double	aInH,
		double	aInS,
		double	aInV
	)

Changes currently used color to the one given by hue, saturation and value parameters.

Parameters

aInH	is hue component, in degrees.
aInS	is saturation component.
aInV	is value component.

Definition at line 346 of file color4d.cpp.

 {
     if( aInS <= 0.0 )
     {
         r = aInV;
         g = aInV;
         b = aInV;
         return;
     }
 
     double hh = aInH;
 
     while( hh >= 360.0 )
         hh -= 360.0;
 
     /* Hue in degrees (0...360) is coded according to this table
      * 0 or 360 : red
      * 60 : yellow
      * 120 : green
      * 180 : cyan
      * 240 : blue
      * 300 : magenta
     */
     hh /= 60.0;
 
     int i = (int) hh;
     double ff = hh - i;
 
     double p = aInV * ( 1.0 - aInS );
     double q = aInV * ( 1.0 - ( aInS * ff ) );
     double t = aInV * ( 1.0 - ( aInS * ( 1.0 - ff ) ) );
 
     switch( i )
     {
     case 0:
         r = aInV;
         g = t;
         b = p;
         break;
 
     case 1:
         r = q;
         g = aInV;
         b = p;
         break;
 
     case 2:
         r = p;
         g = aInV;
         b = t;
         break;
 
     case 3:
         r = p;
         g = q;
         b = aInV;
         break;
 
     case 4:
         r = t;
         g = p;
         b = aInV;
         break;
 
     case 5:
     default:
         r = aInV;
         g = p;
         b = q;
         break;
     }
 }

References b, g, and r.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_COLOR_PICKER::OnChangeBrightness(), DIALOG_COLOR_PICKER::OnChangeEditHue(), DIALOG_COLOR_PICKER::OnChangeEditSat(), Saturate(), and DIALOG_COLOR_PICKER::setHSvaluesFromCursor().

◆ GetBrightness()

double KIGFX::COLOR4D::GetBrightness ( ) const

inline

Returns the brightness value of the color ranged from 0.0 to 1.0.

Returns: The brightness value.

Definition at line 322 of file color4d.h.

     {
         // Weighted W3C formula
         return r * 0.299 + g * 0.587 + b * 0.117;
     }

References b, g, and r.

Referenced by KIGFX::PREVIEW::GetShadowColor(), GRHaloText(), KIGFX::DS_RENDER_SETTINGS::IsBackgroundDark(), KIGFX::SCH_RENDER_SETTINGS::IsBackgroundDark(), KIGFX::PCB_RENDER_SETTINGS::IsBackgroundDark(), and COLOR_SWATCH::MakeBitmap().

◆ Invert()

COLOR4D& KIGFX::COLOR4D::Invert ( )

inline

Makes the color inverted, alpha remains the same.

Returns: COLOR4D& Inverted color.

Definition at line 237 of file color4d.h.

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

References b, g, and r.

◆ Inverted()

COLOR4D KIGFX::COLOR4D::Inverted ( ) const

inline

Returns an inverted color, alpha remains the same.

Returns: COLOR4D& Inverted color.

Definition at line 312 of file color4d.h.

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

References a, b, COLOR4D(), g, and r.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadColors().

◆ Mix()

COLOR4D KIGFX::COLOR4D::Mix	(	const COLOR4D &	aColor,
		double	aFactor
	)		const

inline

Return a color that is mixed with the input by a factor.

Parameters

aFactor Specifies how much of the original color to keep (valid values: 0.0 .. 1.0).

Returns: COLOR4D Mixed color.

Definition at line 284 of file color4d.h.

     {
         assert( 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 );
     }

References a, b, COLOR4D(), g, and r.

Referenced by KIGFX::RENDER_SETTINGS::update().

◆ Saturate()

COLOR4D & COLOR4D::Saturate ( double aFactor )

Saturates the color to a given factor (in HSV model)

Definition at line 420 of file color4d.cpp.

 {
     // One can saturate a color only when r, v, b are not equal
     if( r == g && r == b )
         return *this;
 
     double h, s, v;
 
     ToHSV( h, s, v, true );
     FromHSV( h, aFactor, 1.0 );
 
     return *this;
 }

References b, FromHSV(), g, r, and ToHSV().

◆ ToHSL()

void COLOR4D::ToHSL	(	double &	aOutHue,
		double &	aOutSaturation,
		double &	aOutValue
	)		const

Converts current color (stored in RGB) to HSL format.

Parameters

aOutHue	is the conversion result for hue component, in degrees 0 ... 360.0.
aOutSaturation	is the conversion result for saturation component (0 ... 1.0).
aOutLightness	is conversion result for value component (0 ... 1.0).

Note: saturation is set to 0.0 for black color if r = g = b,

Definition at line 221 of file color4d.cpp.

 {
     auto min = std::min( r, std::min( g, b ) );
     auto max = std::max( r, std::max( g, b ) );
     auto diff = max - min;
 
     aOutLightness = ( max + min ) / 2.0;
 
     if( aOutLightness >= 1.0 )
         aOutSaturation = 0.0;
     else
         aOutSaturation = diff / ( 1.0 - std::abs( 2.0 * aOutLightness - 1.0 ) );
 
     double hue;
 
     if( diff <= 0.0 )
         hue = 0.0;
     else if( max == r )
         hue = ( g - b ) / diff;
     else if( max == g )
         hue = ( b - r ) / diff + 2.0;
     else
         hue = ( r - g ) / diff + 4.0;
 
     aOutHue = hue > 0.0 ? hue * 60.0 : hue * 60.0 + 360.0;
 
     while( aOutHue < 0.0 )
         aOutHue += 360.0;
 }

References b, g, and r.

Referenced by PNS_TUNE_STATUS_POPUP::UpdateStatus().

◆ ToHSV()

void COLOR4D::ToHSV	(	double &	aOutHue,
		double &	aOutSaturation,
		double &	aOutValue,
		bool	aAlwaysDefineHue = `false`
	)		const

Convert current color (stored in RGB) to HSV format.

Parameters

aOutHue	is the conversion result for hue component, in degrees 0 ... 360.0.
aOutSaturation	is the conversion result for saturation component (0 ... 1.0).
aOutValue	is conversion result for value component (0 ... 1.0).
aAlwaysDefineHue	controls the way hue is defined when r = v = b

Note: saturation is set to 0.0 for black color (r = v = b = 0), and if r = v = b, hue is set to 0.0 if aAlwaysDefineHue = true, and set to NAN if aAlwaysDefineHue = false. this option is useful to convert a 4D color to a legacy color, because Red has hue = 0, therefore aAlwaysDefineHue = false makes difference between Red and Gray colors.

Definition at line 293 of file color4d.cpp.

 {
     double min, max, delta;
 
     min = r < g ? r : g;
     min = min < b ? min : b;
 
     max = r > g ? r : g;
     max = max > b ? max : b;
 
     aOutValue = max;                    // value
     delta = max - min;
 
     if( max > 0.0 )
     {
         aOutSaturation = ( delta / max );
     }
     else    // for black color (r = g = b = 0 )  saturation is set to 0.
     {
         aOutSaturation = 0.0;
         aOutHue = aAlwaysDefineHue ? 0.0 : NAN;
         return;
     }
 
     /* Hue in degrees (0...360) is coded according to this table
      * 0 or 360 : red
      * 60 : yellow
      * 120 : green
      * 180 : cyan
      * 240 : blue
      * 300 : magenta
     */
     if( delta != 0.0 )
     {
         if( r >= max )
             aOutHue = ( g - b ) / delta;          // between yellow & magenta
         else if( g >= max )
             aOutHue = 2.0 + ( b - r ) / delta;    // between cyan & yellow
         else
             aOutHue = 4.0 + ( r - g ) / delta;    // between magenta & cyan
 
         aOutHue *= 60.0;                          // degrees
 
         if( aOutHue < 0.0 )
             aOutHue += 360.0;
     }
     else   // delta = 0 means r = g = b. hue is set to 0.0
     {
         aOutHue = aAlwaysDefineHue ? 0.0 : NAN;
     }
 }

References b, g, and r.

Referenced by DIALOG_COLOR_PICKER::buttColorClick(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_COLOR_PICKER::OnColorValueText(), DIALOG_COLOR_PICKER::OnResetButton(), DIALOG_COLOR_PICKER::onRGBMouseDrag(), Saturate(), and DIALOG_COLOR_PICKER::SetEditVals().

◆ WithAlpha()

COLOR4D KIGFX::COLOR4D::WithAlpha ( double aAlpha ) const

inline

Return a color with the same color, but the given alpha.

Parameters

aAlpha specifies the alpha of the new color

Returns: COLOR4D color with that alpha

Definition at line 300 of file color4d.h.

      {
          assert( aAlpha >= 0.0 && aAlpha <= 1.0 );
 
          return COLOR4D( r, g, b, aAlpha );
      }

References b, COLOR4D(), g, and r.

Referenced by deemphasise(), LAYER_SELECTOR::DrawColorSwatch(), BOARD_PRINTOUT::DrawPage(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), COLOR_SWATCH::MakeBitmap(), PCB_GRID_HELPER::PCB_GRID_HELPER(), PCB_EDIT_FRAME::PrepareLayerIndicator(), KIGFX::SCH_PAINTER::setDeviceColors(), and EDIT_POINTS::ViewDraw().

Member Data Documentation

◆ a

double KIGFX::COLOR4D::a

Alpha component.

Definition at line 361 of file color4d.h.

◆ b

double KIGFX::COLOR4D::b

Blue component.

Definition at line 360 of file color4d.h.

◆ BLACK

const COLOR4D COLOR4D::BLACK

static

Definition at line 368 of file color4d.h.

Referenced by KIGFX::ANTIALIASING_SUPERSAMPLING::Begin(), KIGFX::ANTIALIASING_SMAA::Begin(), KIGFX::OPENGL_GAL::ClearTarget(), KIGFX::CAIRO_GAL::ClearTarget(), KIGFX::OPENGL_COMPOSITOR::CreateBuffer(), KIGFX::GERBVIEW_RENDER_SETTINGS::GERBVIEW_RENDER_SETTINGS(), and KIGFX::ANTIALIASING_SMAA::Present().

◆ CLEAR

const COLOR4D COLOR4D::CLEAR

static

Definition at line 369 of file color4d.h.

Referenced by KIGFX::PCB_PAINTER::draw(), and KIGFX::PCB_RENDER_SETTINGS::GetColor().

◆ g

double KIGFX::COLOR4D::g

Green component.

Definition at line 359 of file color4d.h.

◆ r

double KIGFX::COLOR4D::r

Red component.

Definition at line 358 of file color4d.h.

◆ UNSPECIFIED

const COLOR4D COLOR4D::UNSPECIFIED

static

For legacy support; used as a value to indicate color hasn't been set yet.

Definition at line 364 of file color4d.h.

Referenced by COLOR4D(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors().

◆ WHITE

const COLOR4D COLOR4D::WHITE

static

Definition at line 367 of file color4d.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ COLOR4D() [1/3]

◆ COLOR4D() [2/3]

◆ COLOR4D() [3/3]

Member Function Documentation

◆ Brighten()

◆ Brightened()

◆ Darken()

◆ Darkened()

◆ FindNearestLegacyColor()

◆ FromCSSRGBA()

◆ FromHSL()

◆ FromHSV()

◆ GetBrightness()

◆ Invert()

◆ Inverted()

◆ Mix()

◆ Saturate()

◆ ToHSL()

◆ ToHSV()

◆ WithAlpha()

Member Data Documentation

◆ a

◆ b

◆ BLACK

◆ CLEAR

◆ g

◆ r

◆ UNSPECIFIED

◆ WHITE