KiCad PCB EDA Suite
color4d.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KICAD, a free EDA CAD application.
3 *
4 * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
5 * Copyright (C) 2017-2020 Kicad Developers, see AUTHORS.txt for contributors.
6 *
7 * Color class
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef COLOR4D_H_
28#define COLOR4D_H_
29
30#include <wx/debug.h>
31#include <nlohmann/json_fwd.hpp>
32
33#ifdef WX_COMPATIBILITY
34#include <wx/colour.h>
35#include <wx/string.h>
36#endif
37
42{
44 BLACK = 0,
80 HIGHLIGHT_FLAG = ( 1<<19 ),
81 MASKCOLOR = 31
82};
83
85{
86 unsigned char m_Blue;
87 unsigned char m_Green;
88 unsigned char m_Red;
90 std::string m_ColorName;
92};
93
95const StructColors* colorRefs();
96
97
98namespace KIGFX
99{
104{
105public:
106 // Constructor (creates the Color 0,0,0,0)
108 r( 0 ),
109 g( 0 ),
110 b( 0 ),
111 a( 1.0 )
112 {
113 }
114
121 COLOR4D( double aRed, double aGreen, double aBlue, double aAlpha ) :
122 r( aRed ),
123 g( aGreen ),
124 b( aBlue ),
125 a( aAlpha )
126 {
127 wxASSERT( r >= 0.0 && r <= 1.0 );
128 wxASSERT( g >= 0.0 && g <= 1.0 );
129 wxASSERT( b >= 0.0 && b <= 1.0 );
130 wxASSERT( a >= 0.0 && a <= 1.0 );
131 }
132
137 COLOR4D( EDA_COLOR_T aColor );
138
146 COLOR4D& FromCSSRGBA( int aRed, int aGreen, int aBlue, double aAlpha = 1.0 );
147
148#ifdef WX_COMPATIBILITY
149
154 COLOR4D( const wxString& aColorStr );
155
159 COLOR4D( const wxColour& aColor );
160
167 bool SetFromWxString( const wxString& aColorString );
168
169 wxString ToCSSString() const;
170
171 bool SetFromHexString( const wxString& aColorString );
172 wxString ToHexString() const;
173
174 wxColour ToColour() const;
175
184 COLOR4D LegacyMix( const COLOR4D& aColor ) const;
185
191 unsigned int ToU32() const;
192
196 void FromU32( unsigned int aPackedColor );
197#endif /* WX_COMPATIBILITY */
198
199
208 void ToHSL( double& aOutHue, double& aOutSaturation, double& aOutValue ) const;
209
217 void FromHSL( double aInHue, double aInSaturation, double aInLightness );
218
225 COLOR4D& Brighten( double aFactor )
226 {
227 wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
228
229 r = r * ( 1.0 - aFactor ) + aFactor;
230 g = g * ( 1.0 - aFactor ) + aFactor;
231 b = b * ( 1.0 - aFactor ) + aFactor;
232
233 return *this;
234 }
235
242 COLOR4D& Darken( double aFactor )
243 {
244 wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
245
246 r = r * ( 1.0 - aFactor );
247 g = g * ( 1.0 - aFactor );
248 b = b * ( 1.0 - aFactor );
249
250 return *this;
251 }
252
259 {
260 r = ( 1.0 - r );
261 g = ( 1.0 - g );
262 b = ( 1.0 - b );
263
264 return *this;
265 }
266
270 COLOR4D& Saturate( double aFactor );
271
278 COLOR4D Brightened( double aFactor ) const
279 {
280 wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
281
282 return COLOR4D( r * ( 1.0 - aFactor ) + aFactor, g * ( 1.0 - aFactor ) + aFactor,
283 b * ( 1.0 - aFactor ) + aFactor, a );
284 }
285
292 COLOR4D Darkened( double aFactor ) const
293 {
294 wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
295
296 return COLOR4D( r * ( 1.0 - aFactor ), g * ( 1.0 - aFactor ), b * ( 1.0 - aFactor ), a );
297 }
298
305 COLOR4D Mix( const COLOR4D& aColor, double aFactor ) const
306 {
307 wxASSERT( aFactor >= 0.0 && aFactor <= 1.0 );
308
309 return COLOR4D( aColor.r * ( 1.0 - aFactor ) + r * aFactor,
310 aColor.g * ( 1.0 - aFactor ) + g * aFactor,
311 aColor.b * ( 1.0 - aFactor ) + b * aFactor,
312 a );
313 }
314
321 COLOR4D WithAlpha( double aAlpha ) const
322 {
323 wxASSERT( aAlpha >= 0.0 && aAlpha <= 1.0 );
324
325 return COLOR4D( r, g, b, aAlpha );
326 }
327
334 {
335 return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
336 }
337
343 double GetBrightness() const
344 {
345 // Weighted W3C formula
346 return r * 0.299 + g * 0.587 + b * 0.117;
347 }
348
361 void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue,
362 bool aAlwaysDefineHue = false ) const;
363
371 void FromHSV( double aInH, double aInS, double aInV );
372
376 double Distance( const COLOR4D& other ) const;
377
381 static EDA_COLOR_T FindNearestLegacyColor( int aR, int aG, int aB );
382
383 // Color components: red, green, blue, alpha
384 double r;
385 double g;
386 double b;
387 double a;
388
390 static const COLOR4D UNSPECIFIED;
391
392 // Declare a few color shortcuts that are used for comparisons frequently
393 static const COLOR4D WHITE;
394 static const COLOR4D BLACK;
395 static const COLOR4D CLEAR;
396};
397
399const bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );
400
402const bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
403
404const bool operator<( const COLOR4D& lhs, const COLOR4D& rhs );
405
407std::ostream &operator<<( std::ostream &aStream, COLOR4D const &aColor );
408
409// to allow json( COLOR4D )
410void to_json( nlohmann::json& aJson, const COLOR4D& aColor );
411
412// To allow json::get<COLOR4D>()
413void from_json( const nlohmann::json& aJson, COLOR4D& aColor );
414
415} // namespace KIGFX
416
417#endif /* COLOR4D_H_ */
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
void ToHSL(double &aOutHue, double &aOutSaturation, double &aOutValue) const
Converts current color (stored in RGB) to HSL format.
Definition: color4d.cpp:315
double r
Red component.
Definition: color4d.h:384
double g
Green component.
Definition: color4d.h:385
COLOR4D WithAlpha(double aAlpha) const
Return a color with the same color, but the given alpha.
Definition: color4d.h:321
static const COLOR4D CLEAR
Definition: color4d.h:395
COLOR4D & Invert()
Makes the color inverted, alpha remains the same.
Definition: color4d.h:258
void ToHSV(double &aOutHue, double &aOutSaturation, double &aOutValue, bool aAlwaysDefineHue=false) const
Convert current color (stored in RGB) to HSV format.
Definition: color4d.cpp:387
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.
Definition: color4d.cpp:544
void FromHSV(double aInH, double aInS, double aInV)
Changes currently used color to the one given by hue, saturation and value parameters.
Definition: color4d.cpp:441
COLOR4D & Darken(double aFactor)
Makes the color darker by a given factor.
Definition: color4d.h:242
COLOR4D Darkened(double aFactor) const
Return a color that is darker by a given factor, without modifying object.
Definition: color4d.h:292
COLOR4D Inverted() const
Returns an inverted color, alpha remains the same.
Definition: color4d.h:333
COLOR4D & Brighten(double aFactor)
Makes the color brighter by a given factor.
Definition: color4d.h:225
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:343
static const COLOR4D WHITE
Definition: color4d.h:393
double a
Alpha component.
Definition: color4d.h:387
COLOR4D Brightened(double aFactor) const
Return a color that is brighter by a given factor, without modifying object.
Definition: color4d.h:278
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition: color4d.h:390
COLOR4D(double aRed, double aGreen, double aBlue, double aAlpha)
Definition: color4d.h:121
double Distance(const COLOR4D &other) const
Returns the distance (in RGB space) between two colors.
Definition: color4d.cpp:536
void FromHSL(double aInHue, double aInSaturation, double aInLightness)
Change currently used color to the one given by hue, saturation and lightness parameters.
Definition: color4d.cpp:346
static const COLOR4D BLACK
Definition: color4d.h:394
COLOR4D Mix(const COLOR4D &aColor, double aFactor) const
Return a color that is mixed with the input by a factor.
Definition: color4d.h:305
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.
Definition: color4d.cpp:581
COLOR4D & Saturate(double aFactor)
Saturates the color to a given factor (in HSV model)
Definition: color4d.cpp:515
double b
Blue component.
Definition: color4d.h:386
const StructColors * colorRefs()
Global list of legacy color names, still used all over the place for constructing COLOR4D's.
Definition: color4d.cpp:39
EDA_COLOR_T
Legacy color enumeration.
Definition: color4d.h:42
@ HIGHLIGHT_FLAG
Definition: color4d.h:80
@ LIGHTGREEN
Definition: color4d.h:63
@ PUREORANGE
Definition: color4d.h:78
@ BROWN
Definition: color4d.h:61
@ PURECYAN
Definition: color4d.h:70
@ LIGHTBLUE
Definition: color4d.h:62
@ WHITE
Definition: color4d.h:48
@ LIGHTERORANGE
Definition: color4d.h:74
@ LIGHTORANGE
Definition: color4d.h:77
@ BLUE
Definition: color4d.h:56
@ LIGHTGRAY
Definition: color4d.h:47
@ DARKGRAY
Definition: color4d.h:46
@ MAGENTA
Definition: color4d.h:60
@ DARKORANGE
Definition: color4d.h:75
@ DARKMAGENTA
Definition: color4d.h:54
@ LIGHTYELLOW
Definition: color4d.h:49
@ DARKCYAN
Definition: color4d.h:52
@ NBCOLORS
Number of colors.
Definition: color4d.h:79
@ PURERED
Definition: color4d.h:71
@ UNSPECIFIED_COLOR
Definition: color4d.h:43
@ GREEN
Definition: color4d.h:57
@ CYAN
Definition: color4d.h:58
@ DARKRED
Definition: color4d.h:53
@ DARKBLUE
Definition: color4d.h:50
@ LIGHTCYAN
Definition: color4d.h:64
@ DARKDARKGRAY
Definition: color4d.h:45
@ ORANGE
Definition: color4d.h:76
@ PUREGREEN
Definition: color4d.h:69
@ LIGHTMAGENTA
Definition: color4d.h:66
@ PUREYELLOW
Definition: color4d.h:73
@ YELLOW
Definition: color4d.h:67
@ PUREBLUE
Definition: color4d.h:68
@ LIGHTRED
Definition: color4d.h:65
@ MASKCOLOR
mask for color index into colorRefs()[]
Definition: color4d.h:81
@ BLACK
Definition: color4d.h:44
@ DARKGREEN
Definition: color4d.h:51
@ PUREMAGENTA
Definition: color4d.h:72
@ RED
Definition: color4d.h:59
@ DARKBROWN
Definition: color4d.h:55
nlohmann::json json
Definition: gerbview.cpp:44
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:266
void from_json(const nlohmann::json &aJson, COLOR4D &aColor)
Definition: color4d.cpp:307
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:295
const bool operator<(const COLOR4D &lhs, const COLOR4D &rhs)
Definition: color4d.cpp:280
const bool operator==(const COLOR4D &lhs, const COLOR4D &rhs)
Equality operator, are two colors equal.
Definition: color4d.cpp:268
const bool operator!=(const COLOR4D &lhs, const COLOR4D &rhs)
Not equality operator, are two colors not equal.
Definition: color4d.cpp:274
void to_json(nlohmann::json &aJson, const COLOR4D &aColor)
Definition: color4d.cpp:301
unsigned char m_Blue
Definition: color4d.h:86
EDA_COLOR_T m_LightColor
Definition: color4d.h:91
std::string m_ColorName
Definition: color4d.h:90
EDA_COLOR_T m_Numcolor
Definition: color4d.h:89
unsigned char m_Green
Definition: color4d.h:87
unsigned char m_Red
Definition: color4d.h:88