KIGFX::COLOR4D Class Reference

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

#include <color4d.h>

Public Member Functions
	COLOR4D ()
	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...
	COLOR4D (const wxString &aColorStr)
	Defines a color from a CSS or HTML-type string. More...
	COLOR4D (const wxColour &aColor)
bool	SetFromWxString (const wxString &aColorString)
	Set color values by parsing a string using wxColour::Set(). More...
wxString	ToCSSString () const
bool	SetFromHexString (const wxString &aColorString)
wxString	ToHexString () const
wxColour	ToColour () const
COLOR4D	LegacyMix (const COLOR4D &aColor) const
	Mix this COLOR4D with an input COLOR4D using the OR-mixing of legacy canvas. 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 &	Desaturate ()
	Removes color (in HSL 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...
double	Distance (const COLOR4D &other) const
	Returns the distance (in RGB space) between two colors. 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 101 of file color4d.h.

Constructor & Destructor Documentation

COLOR4D() [1/5]

KIGFX::COLOR4D::COLOR4D ( )

inline

Definition at line 105 of file color4d.h.

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

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

COLOR4D() [2/5]

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 119 of file color4d.h.

 :
 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 );
 }

References a, b, g, and r.

COLOR4D() [3/5]

COLOR4D::COLOR4D

(

EDA_COLOR_T

aColor

)

Parameters

aColor

is one of KiCad's palette colors.

See also

EDA_COLOR_T

Definition at line 83 of file color4d.cpp.

{
 if( aColor <= UNSPECIFIED_COLOR || aColor >= NBCOLORS )
 {
 *this = COLOR4D::UNSPECIFIED;
 return;
 }
 
 int candidate = 0;
 
 for( ; candidate < NBCOLORS; ++candidate )
 {
 if( colorRefs()[candidate].m_Numcolor == aColor )
 break;
 }
 
 if( candidate >= NBCOLORS )
 {
 *this = COLOR4D::UNSPECIFIED;
 return;
 }
 
 r = colorRefs()[candidate].m_Red / 255.0;
 g = colorRefs()[candidate].m_Green / 255.0;
 b = colorRefs()[candidate].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.

COLOR4D() [4/5]

COLOR4D::COLOR4D

(

const wxString &

aColorStr

)

Defines a color from a CSS or HTML-type string.

Parameters

aColorStr

input string

Definition at line 112 of file color4d.cpp.

{
 if( !SetFromHexString( aColorStr ) )
 SetFromWxString( aColorStr );
}

References SetFromHexString(), and SetFromWxString().

COLOR4D() [5/5]

COLOR4D::COLOR4D

(

const wxColour &

aColor

)

Parameters

aColor

is the color type used by wxWidgets.

Definition at line 119 of file color4d.cpp.

{
 r = aColor.Red() / 255.0;
 g = aColor.Green() / 255.0;
 b = aColor.Blue() / 255.0;
 a = aColor.Alpha() / 255.0;
}

References a, b, g, and r.

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 207 of file color4d.h.

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

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 266 of file color4d.h.

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

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

Referenced by KIGFX::SCH_PAINTER::drawDanglingSymbol(), KIGFX::SCH_PAINTER::drawPinDanglingSymbol(), KIGFX::DS_RENDER_SETTINGS::DS_RENDER_SETTINGS(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), COLOR_SWATCH::MakeBitmap(), KIGFX::RENDER_SETTINGS::update(), and EDIT_POINTS::ViewDraw().

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 224 of file color4d.h.

 {
 wxASSERT( 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 280 of file color4d.h.

 {
 wxASSERT( 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().

Desaturate()

COLOR4D & COLOR4D::Desaturate

(

)

Removes color (in HSL model)

Returns

greyscale version of color

Definition at line 510 of file color4d.cpp.

{
 // One can desaturate a color only when r, v, b are not equal
 if( r == g && r == b )
 return *this;
 
 double h, s, l;
 
 ToHSL( h, s, l );
 FromHSL( h, 0.0, l );
 
 return *this;
}

References b, FromHSL(), g, r, and ToHSL().

Referenced by KIGFX::SCH_PAINTER::draw(), LIB_PIN::PlotPinTexts(), LIB_SHAPE::print(), LIB_PIN::printPinTexts(), and KIGFX::SCH_PAINTER::setDeviceColors().

Distance()

double COLOR4D::Distance

(

const COLOR4D &

other

)

const

Returns the distance (in RGB space) between two colors.

Definition at line 531 of file color4d.cpp.

{
 return ( r - other.r ) * ( r - other.r )
 + ( g - other.g ) * ( g - other.g )
 + ( b - other.b ) * ( b - other.b );
}

References b, g, and r.

Referenced by 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 539 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 576 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 326 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 std::abs(), b, g, and r.

Referenced by BOOST_AUTO_TEST_CASE(), and Desaturate().

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 421 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 331 of file color4d.h.

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

References b, g, and r.

Referenced by RC_TREE_MODEL::GetAttr(), KIGFX::PREVIEW::GetShadowColor(), KIGFX::SCH_RENDER_SETTINGS::IsBackgroundDark(), KIGFX::DS_RENDER_SETTINGS::IsBackgroundDark(), KIGFX::PCB_RENDER_SETTINGS::IsBackgroundDark(), COLOR_SWATCH::MakeBitmap(), and EDIT_POINTS::ViewDraw().

Invert()

COLOR4D & KIGFX::COLOR4D::Invert ( )

inline

Makes the color inverted, alpha remains the same.

Returns

COLOR4D& Inverted color.

Definition at line 240 of file color4d.h.

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

References b, g, and r.

Referenced by EDIT_POINTS::ViewDraw().

Inverted()

COLOR4D KIGFX::COLOR4D::Inverted ( ) const

inline

Returns an inverted color, alpha remains the same.

Returns

COLOR4D& Inverted color.

Definition at line 321 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().

LegacyMix()

COLOR4D COLOR4D::LegacyMix

(

const COLOR4D &

aColor

)

const

Mix this COLOR4D with an input COLOR4D using the OR-mixing of legacy canvas.

Can be removed once legacy canvas is removed. Depends on wxColour for simplicity, but could be re-written to avoid this dependency if desired.

Parameters

aColor

The color to mix with this one

Definition at line 230 of file color4d.cpp.

{
 COLOR4D candidate;
 
 // Blend the two colors (i.e. OR the RGB values)
 candidate.r = ( (unsigned) ( 255.0 * r ) | (unsigned) ( 255.0 * aColor.r ) ) / 255.0,
 candidate.g = ( (unsigned) ( 255.0 * g ) | (unsigned) ( 255.0 * aColor.g ) ) / 255.0,
 candidate.b = ( (unsigned) ( 255.0 * b ) | (unsigned) ( 255.0 * aColor.b ) ) / 255.0,
 
 // the alpha channel can be reinitialized but what is the best value?
 candidate.a = ( aColor.a + a ) / 2;
 
 return candidate;
}

References a, b, g, and r.

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 293 of file color4d.h.

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

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

Referenced by KIGFX::SCH_PAINTER::draw(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), getBorderColour(), BOARD_ADAPTER::InitSettings(), WX_PANEL::OnPaint(), CURSOR::Plot(), LIB_PIN::PlotPinTexts(), LIB_SHAPE::print(), LIB_PIN::printPinTexts(), KIGFX::SCH_PAINTER::setDeviceColors(), SCINTILLA_TRICKS::setupStyles(), and KIGFX::RENDER_SETTINGS::update().

Saturate()

COLOR4D & COLOR4D::Saturate

(

double

aFactor

)

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

Definition at line 495 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().

SetFromHexString()

bool COLOR4D::SetFromHexString

(

const wxString &

aColorString

)

Definition at line 176 of file color4d.cpp.

{
 wxString str = aColorString;
 str.Trim( true );
 str.Trim( false );
 
 if( str.length() < 7 || str.GetChar( 0 ) != '#' )
 return false;
 
 unsigned long tmp;
 
 if( wxSscanf( str.wx_str() + 1, wxT( "%lx" ), &tmp ) != 1 )
 return false;
 
 if( str.length() >= 9 )
 {
 r = ( (tmp >> 24) & 0xFF ) / 255.0;
 g = ( (tmp >> 16) & 0xFF ) / 255.0;
 b = ( (tmp >> 8) & 0xFF ) / 255.0;
 a = ( tmp & 0xFF ) / 255.0;
 }
 else
 {
 r = ( (tmp >> 16) & 0xFF ) / 255.0;
 g = ( (tmp >> 8) & 0xFF ) / 255.0;
 b = ( tmp & 0xFF ) / 255.0;
 a = 1.0;
 }
 
 return true;
}

References a, b, g, and r.

Referenced by COLOR4D(), and DIALOG_COLOR_PICKER::OnColorValueText().

SetFromWxString()

bool COLOR4D::SetFromWxString

(

const wxString &

aColorString

)

Set color values by parsing a string using wxColour::Set().

Parameters

aColorString

is a color string that wxColour can understand.

Returns

true if color was set successfully.

Definition at line 128 of file color4d.cpp.

{
 wxColour c;
 
 if( c.Set( aColorString ) )
 {
 r = c.Red() / 255.0;
 g = c.Green() / 255.0;
 b = c.Blue() / 255.0;
 a = c.Alpha() / 255.0;
 
 return true;
 }
 
 return false;
}

References a, b, g, and r.

Referenced by GRID_CELL_COLOR_SELECTOR::BeginEdit(), COLOR4D(), KIGFX::from_json(), and NET_GRID_TABLE::SetValue().

ToColour()

wxColour COLOR4D::ToColour

(

)

const

Definition at line 219 of file color4d.cpp.

{
 using CHAN_T = wxColourBase::ChannelType;
 
 const wxColour colour(
 static_cast<CHAN_T>( r * 255 + 0.5 ), static_cast<CHAN_T>( g * 255 + 0.5 ),
 static_cast<CHAN_T>( b * 255 + 0.5 ), static_cast<CHAN_T>( a * 255 + 0.5 ) );
 return colour;
}

References a, b, g, and r.

Referenced by PCB_ONE_LAYER_SELECTOR::buildList(), SELECT_COPPER_LAYERS_PAIR_DIALOG::buildList(), PANEL_SETUP_BOARD_STACKUP::createRowData(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), LAYER_SELECTOR::DrawColorSwatch(), FOOTPRINT_PREVIEW_WIDGET::FOOTPRINT_PREVIEW_WIDGET(), getBorderColour(), PANEL_SETUP_BOARD_STACKUP::GetSelectedColor(), COLOR_SWATCH::MakeBitmap(), WX_PANEL::OnPaint(), CURSOR::Plot(), PCB_EDIT_FRAME::PrepareLayerIndicator(), SCINTILLA_TRICKS::setupStyles(), SYMBOL_PREVIEW_WIDGET::SYMBOL_PREVIEW_WIDGET(), ToCSSString(), and NUMBER_BADGE::UpdateNumber().

ToCSSString()

wxString COLOR4D::ToCSSString

(

)

const

Definition at line 146 of file color4d.cpp.

{
 wxColour c = ToColour();
 wxString str;
 
 const int red = c.Red();
 const int green = c.Green();
 const int blue = c.Blue();
 const int alpha = c.Alpha();
 
 if ( alpha == wxALPHA_OPAQUE )
 {
 str.Printf( wxT( "rgb(%d, %d, %d)" ), red, green, blue );
 }
 else // use rgba() form
 {
 wxString alpha_str = wxString::FromCDouble( alpha / 255.0, 3 );
 
 // The wxC2S_CSS_SYNTAX is particularly sensitive to ','s (as it uses them for value
 // delimiters), and wxWidgets is known to be buggy in this respect when dealing with
 // Serbian and Russian locales (at least), so we enforce an extra level of safety.
 alpha_str.Replace( wxT( "," ), wxT( "." ) );
 
 str.Printf( wxT( "rgba(%d, %d, %d, %s)" ), red, green, blue, alpha_str );
 }
 
 return str;
}

References red, and ToColour().

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), GRID_CELL_COLOR_SELECTOR::GetValue(), KIGFX::operator<<(), SCH_LEGACY_PLUGIN::saveLine(), SIMULATOR_FRAME::SaveWorkbook(), and KIGFX::to_json().

ToHexString()

wxString COLOR4D::ToHexString

(

)

const

Definition at line 209 of file color4d.cpp.

{
 return wxString::Format( wxT("#%02X%02X%02X%02X" ),
 KiROUND( r * 255.0 ),
 KiROUND( g * 255.0 ),
 KiROUND( b * 255.0 ),
 KiROUND( a * 255.0 ) );
}

References a, b, Format(), g, KiROUND(), and r.

Referenced by DIALOG_COLOR_PICKER::SetEditVals().

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 295 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 std::abs(), b, g, and r.

Referenced by Desaturate(), and 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 367 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, delta, 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 309 of file color4d.h.

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

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

Referenced by PNS_PCBNEW_DEBUG_DECORATOR::AddItem(), PNS_PCBNEW_DEBUG_DECORATOR::AddShape(), PNS_LOG_VIEWER_OVERLAY::Arc(), deemphasise(), LAYER_SELECTOR::DrawColorSwatch(), BOARD_PRINTOUT::DrawPage(), FAB_LAYER_COLOR::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), COLOR_SWATCH::MakeBitmap(), PCB_GRID_HELPER::PCB_GRID_HELPER(), PCB_EDIT_FRAME::PrepareLayerIndicator(), SCINTILLA_TRICKS::setupStyles(), and EDIT_POINTS::ViewDraw().

Member Data Documentation

a

double KIGFX::COLOR4D::a

Alpha component.

Definition at line 375 of file color4d.h.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::blitCursor(), KIGFX::CAIRO_GAL_BASE::blitCursor(), Brightened(), DIALOG_COLOR_PICKER::buttColorClick(), KIGFX::CAIRO_GAL_BASE::ChangeGroupColor(), KIGFX::VERTEX_MANAGER::ChangeItemColor(), KIGFX::VERTEX_MANAGER::Color(), COLOR4D(), CUSTOM_COLOR_ITEM::CUSTOM_COLOR_ITEM(), Darkened(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), KIGFX::PCB_PAINTER::draw(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::CAIRO_GAL_BASE::drawAxes(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridCross(), KIGFX::CAIRO_GAL_BASE::drawGridLine(), KIGFX::CAIRO_GAL_BASE::drawGridPoint(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::DrawLine(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::drawPolyline(), KIGFX::OPENGL_GAL::DrawRectangle(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawSegmentChain(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), KIGFX::CAIRO_GAL_BASE::flushPath(), DS_DATA_MODEL_IO::format(), formatFill(), FromCSSRGBA(), BOARD_ADAPTER::GetColor(), BOARD_ADAPTER::InitSettings(), Inverted(), KI_TEST::IsColorNear(), KI_TEST::IsColorNearHex(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), LegacyMix(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), PANEL_PREVIEW_3D_MODEL::loadSettings(), Mix(), DIALOG_COLOR_PICKER::OnChangeAlpha(), DIALOG_COLOR_PICKER::OnResetButton(), KIGFX::operator<(), KIGFX::operator==(), DRAWING_SHEET_PARSER::parseText(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveSheet(), DIALOG_COLOR_PICKER::SetEditVals(), KIGFX::CAIRO_GAL_BASE::SetFillColor(), SetFromHexString(), SetFromWxString(), SCH_LINE::SetLineColor(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), SCINTILLA_TRICKS::setupStyles(), KIGFX::CAIRO_GAL_BASE::storePath(), ToColour(), ToHexString(), and ROUTER_PREVIEW_ITEM::Update().

b

double KIGFX::COLOR4D::b

Blue component.

Definition at line 374 of file color4d.h.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::blitCursor(), KIGFX::CAIRO_GAL_BASE::blitCursor(), Brighten(), Brightened(), DIALOG_COLOR_PICKER::buttColorClick(), KIGFX::CAIRO_GAL_BASE::ChangeGroupColor(), KIGFX::VERTEX_MANAGER::ChangeItemColor(), KIGFX::OPENGL_COMPOSITOR::ClearBuffer(), KIGFX::CAIRO_GAL_BASE::ClearScreen(), KIGFX::VERTEX_MANAGER::Color(), COLOR4D(), EXPORTER_STEP::composePCB(), CUSTOM_COLOR_ITEM::CUSTOM_COLOR_ITEM(), Darken(), Darkened(), Desaturate(), Distance(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::CAIRO_GAL_BASE::drawAxes(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridCross(), KIGFX::CAIRO_GAL_BASE::drawGridLine(), KIGFX::CAIRO_GAL_BASE::drawGridPoint(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::DrawLine(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::drawPolyline(), KIGFX::OPENGL_GAL::DrawRectangle(), DIALOG_COLOR_PICKER::drawRGBPalette(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawSegmentChain(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), KIGFX::CAIRO_GAL_BASE::flushPath(), DS_DATA_MODEL_IO::format(), formatFill(), FromCSSRGBA(), FromHSL(), FromHSV(), GetBrightness(), BOARD_ADAPTER::GetColor(), FAB_LAYER_COLOR::GetColorAsString(), getDXFColorName(), TRANSLINE::Init(), Invert(), Inverted(), KI_TEST::IsColorNear(), KI_TEST::IsColorNearHex(), LegacyMix(), PANEL_PREVIEW_3D_MODEL::loadSettings(), Mix(), DIALOG_COLOR_PICKER::OnChangeEditBlue(), DIALOG_COLOR_PICKER::OnResetButton(), DIALOG_COLOR_PICKER::onRGBMouseDrag(), KIGFX::operator<(), KIGFX::operator==(), DRAWING_SHEET_PARSER::parseText(), Saturate(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveSheet(), DIALOG_COLOR_PICKER::SetEditVals(), KIGFX::CAIRO_GAL_BASE::SetFillColor(), SetFromHexString(), SetFromWxString(), PANEL_TRANSLINE::SetPrmBgColor(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), KIGFX::CAIRO_GAL_BASE::storePath(), ToColour(), ToHexString(), ToHSL(), ToHSV(), KIGFX::RENDER_SETTINGS::update(), RATSNEST_VIEW_ITEM::ViewDraw(), and WithAlpha().

BLACK

const COLOR4D COLOR4D::BLACK

static

Definition at line 382 of file color4d.h.

Referenced by KIGFX::ANTIALIASING_SUPERSAMPLING::Begin(), KIGFX::ANTIALIASING_SMAA::Begin(), KIGFX::CAIRO_GAL::ClearTarget(), KIGFX::OPENGL_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 383 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 373 of file color4d.h.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::blitCursor(), KIGFX::CAIRO_GAL_BASE::blitCursor(), Brighten(), Brightened(), DIALOG_COLOR_PICKER::buttColorClick(), KIGFX::CAIRO_GAL_BASE::ChangeGroupColor(), KIGFX::VERTEX_MANAGER::ChangeItemColor(), KIGFX::OPENGL_COMPOSITOR::ClearBuffer(), KIGFX::CAIRO_GAL_BASE::ClearScreen(), KIGFX::VERTEX_MANAGER::Color(), COLOR4D(), EXPORTER_STEP::composePCB(), CUSTOM_COLOR_ITEM::CUSTOM_COLOR_ITEM(), Darken(), Darkened(), Desaturate(), Distance(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::CAIRO_GAL_BASE::drawAxes(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridCross(), KIGFX::CAIRO_GAL_BASE::drawGridLine(), KIGFX::CAIRO_GAL_BASE::drawGridPoint(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::DrawLine(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::drawPolyline(), KIGFX::OPENGL_GAL::DrawRectangle(), DIALOG_COLOR_PICKER::drawRGBPalette(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawSegmentChain(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), KIGFX::CAIRO_GAL_BASE::flushPath(), DS_DATA_MODEL_IO::format(), formatFill(), FromCSSRGBA(), FromHSL(), FromHSV(), GetBrightness(), BOARD_ADAPTER::GetColor(), FAB_LAYER_COLOR::GetColorAsString(), getDXFColorName(), TRANSLINE::Init(), Invert(), Inverted(), KI_TEST::IsColorNear(), KI_TEST::IsColorNearHex(), LegacyMix(), PANEL_PREVIEW_3D_MODEL::loadSettings(), Mix(), DIALOG_COLOR_PICKER::OnChangeEditGreen(), DIALOG_COLOR_PICKER::OnResetButton(), DIALOG_COLOR_PICKER::onRGBMouseDrag(), KIGFX::operator<(), KIGFX::operator==(), DRAWING_SHEET_PARSER::parseText(), Saturate(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveSheet(), DIALOG_COLOR_PICKER::SetEditVals(), KIGFX::CAIRO_GAL_BASE::SetFillColor(), SetFromHexString(), SetFromWxString(), PANEL_TRANSLINE::SetPrmBgColor(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), KIGFX::CAIRO_GAL_BASE::storePath(), ToColour(), ToHexString(), ToHSL(), ToHSV(), and WithAlpha().

r

double KIGFX::COLOR4D::r

Red component.

Definition at line 372 of file color4d.h.

Referenced by KIGFX::OPENGL_GAL::BitmapText(), KIGFX::OPENGL_GAL::blitCursor(), KIGFX::CAIRO_GAL_BASE::blitCursor(), Brighten(), Brightened(), DIALOG_COLOR_PICKER::buttColorClick(), KIGFX::CAIRO_GAL_BASE::ChangeGroupColor(), KIGFX::VERTEX_MANAGER::ChangeItemColor(), KIGFX::OPENGL_COMPOSITOR::ClearBuffer(), KIGFX::CAIRO_GAL_BASE::ClearScreen(), KIGFX::VERTEX_MANAGER::Color(), COLOR4D(), EXPORTER_STEP::composePCB(), CUSTOM_COLOR_ITEM::CUSTOM_COLOR_ITEM(), Darken(), Darkened(), Desaturate(), Distance(), KIGFX::OPENGL_GAL::DrawArc(), KIGFX::CAIRO_GAL_BASE::DrawArcSegment(), KIGFX::OPENGL_GAL::DrawArcSegment(), KIGFX::CAIRO_GAL_BASE::drawAxes(), KIGFX::OPENGL_GAL::drawBitmapOverbar(), KIGFX::OPENGL_GAL::drawCircle(), KIGFX::OPENGL_GAL::DrawGrid(), KIGFX::CAIRO_GAL_BASE::drawGridCross(), KIGFX::CAIRO_GAL_BASE::drawGridLine(), KIGFX::CAIRO_GAL_BASE::drawGridPoint(), KIGFX::CAIRO_GAL_BASE::DrawGroup(), KIGFX::OPENGL_GAL::DrawLine(), KIGFX::OPENGL_GAL::drawPolygon(), KIGFX::OPENGL_GAL::drawPolyline(), KIGFX::OPENGL_GAL::DrawRectangle(), DIALOG_COLOR_PICKER::drawRGBPalette(), KIGFX::CAIRO_GAL_BASE::DrawSegment(), KIGFX::OPENGL_GAL::drawSegment(), KIGFX::OPENGL_GAL::drawSegmentChain(), KIGFX::OPENGL_GAL::drawSemiCircle(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), EXPORTER_PCB_VRML::EXPORTER_PCB_VRML(), KIGFX::CAIRO_GAL_BASE::flushPath(), DS_DATA_MODEL_IO::format(), formatFill(), FromCSSRGBA(), FromHSL(), FromHSV(), GetBrightness(), BOARD_ADAPTER::GetColor(), FAB_LAYER_COLOR::GetColorAsString(), getDXFColorName(), TRANSLINE::Init(), Invert(), Inverted(), KI_TEST::IsColorNear(), KI_TEST::IsColorNearHex(), LegacyMix(), PANEL_PREVIEW_3D_MODEL::loadSettings(), Mix(), DIALOG_COLOR_PICKER::OnChangeEditRed(), DIALOG_COLOR_PICKER::OnResetButton(), DIALOG_COLOR_PICKER::onRGBMouseDrag(), KIGFX::operator<(), KIGFX::operator==(), DRAWING_SHEET_PARSER::parseText(), Saturate(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveSheet(), DIALOG_COLOR_PICKER::SetEditVals(), KIGFX::CAIRO_GAL_BASE::SetFillColor(), SetFromHexString(), SetFromWxString(), PANEL_TRANSLINE::SetPrmBgColor(), KIGFX::CAIRO_GAL_BASE::SetStrokeColor(), KIGFX::CAIRO_GAL_BASE::storePath(), ToColour(), ToHexString(), ToHSL(), ToHSV(), and WithAlpha().

UNSPECIFIED

const COLOR4D COLOR4D::UNSPECIFIED

static

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

Definition at line 378 of file color4d.h.

Referenced by COLOR4D(), STROKE_PARAMS::Format(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and KIGFX::SCH_PAINTER::getRenderColor().

WHITE

const COLOR4D COLOR4D::WHITE

static

Definition at line 381 of file color4d.h.

Referenced by PNS_DEBUG_SHAPE::PNS_DEBUG_SHAPE().

---

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

• color4d.h
• color4d.cpp