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 <cassert>
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,
59  RED,
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 
95 const StructColors* colorRefs();
96 
97 
98 namespace KIGFX
99 {
103 class COLOR4D
104 {
105 public:
106  // Constructor (creates the Color 0,0,0,0)
108  r( 0 ), g( 0 ), b( 0 ), a( 1.0 )
109  {
110  }
111 
118  constexpr COLOR4D( double aRed, double aGreen, double aBlue, double aAlpha ) :
119  r( aRed ), g( aGreen ), b( aBlue ), a( aAlpha )
120  {
121  assert( r >= 0.0 && r <= 1.0 );
122  assert( g >= 0.0 && g <= 1.0 );
123  assert( b >= 0.0 && b <= 1.0 );
124  assert( a >= 0.0 && a <= 1.0 );
125  }
126 
131  COLOR4D( EDA_COLOR_T aColor );
132 
140  COLOR4D& FromCSSRGBA( int aRed, int aGreen, int aBlue, double aAlpha = 1.0 );
141 
142 #ifdef WX_COMPATIBILITY
143 
146  COLOR4D( const wxColour& aColor );
147 
154  bool SetFromWxString( const wxString& aColorString );
155 
156  wxString ToWxString( long flags ) const;
157 
158  wxColour ToColour() const;
159 
168  COLOR4D LegacyMix( const COLOR4D& aColor ) const;
169 
175  unsigned int ToU32() const;
176 
180  void FromU32( unsigned int aPackedColor );
181 #endif /* WX_COMPATIBILITY */
182 
183 
192  void ToHSL( double& aOutHue, double& aOutSaturation, double& aOutValue ) const;
193 
201  void FromHSL( double aInHue, double aInSaturation, double aInLightness );
202 
209  COLOR4D& Brighten( double aFactor )
210  {
211  assert( aFactor >= 0.0 && aFactor <= 1.0 );
212 
213  r = r * ( 1.0 - aFactor ) + aFactor;
214  g = g * ( 1.0 - aFactor ) + aFactor;
215  b = b * ( 1.0 - aFactor ) + aFactor;
216 
217  return *this;
218  }
219 
226  COLOR4D& Darken( double aFactor )
227  {
228  assert( aFactor >= 0.0 && aFactor <= 1.0 );
229 
230  r = r * ( 1.0 - aFactor );
231  g = g * ( 1.0 - aFactor );
232  b = b * ( 1.0 - aFactor );
233 
234  return *this;
235  }
236 
243  {
244  r = ( 1.0 - r );
245  g = ( 1.0 - g );
246  b = ( 1.0 - b );
247 
248  return *this;
249  }
250 
254  COLOR4D& Saturate( double aFactor );
255 
262  COLOR4D Brightened( double aFactor ) const
263  {
264  assert( aFactor >= 0.0 && aFactor <= 1.0 );
265 
266  return COLOR4D( r * ( 1.0 - aFactor ) + aFactor, g * ( 1.0 - aFactor ) + aFactor,
267  b * ( 1.0 - aFactor ) + aFactor, a );
268  }
269 
276  COLOR4D Darkened( double aFactor ) const
277  {
278  assert( aFactor >= 0.0 && aFactor <= 1.0 );
279 
280  return COLOR4D( r * ( 1.0 - aFactor ), g * ( 1.0 - aFactor ), b * ( 1.0 - aFactor ), a );
281  }
282 
289  COLOR4D Mix( const COLOR4D& aColor, double aFactor ) const
290  {
291  assert( aFactor >= 0.0 && aFactor <= 1.0 );
292 
293  return COLOR4D( aColor.r * ( 1.0 - aFactor ) + r * aFactor,
294  aColor.g * ( 1.0 - aFactor ) + g * aFactor,
295  aColor.b * ( 1.0 - aFactor ) + b * aFactor,
296  a );
297  }
298 
305  COLOR4D WithAlpha( double aAlpha ) const
306  {
307  assert( aAlpha >= 0.0 && aAlpha <= 1.0 );
308 
309  return COLOR4D( r, g, b, aAlpha );
310  }
311 
318  {
319  return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
320  }
321 
327  double GetBrightness() const
328  {
329  // Weighted W3C formula
330  return r * 0.299 + g * 0.587 + b * 0.117;
331  }
332 
345  void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue,
346  bool aAlwaysDefineHue = false ) const;
347 
355  void FromHSV( double aInH, double aInS, double aInV );
356 
360  static EDA_COLOR_T FindNearestLegacyColor( int aR, int aG, int aB );
361 
362  // Color components: red, green, blue, alpha
363  double r;
364  double g;
365  double b;
366  double a;
367 
369  static const COLOR4D UNSPECIFIED;
370 
371  // Declare a few color shortcuts that are used for comparisons frequently
372  static const COLOR4D WHITE;
373  static const COLOR4D BLACK;
374  static const COLOR4D CLEAR;
375 };
376 
378 const bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );
379 
381 const bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
382 
383 const bool operator<( const COLOR4D& lhs, const COLOR4D& rhs );
384 
386 std::ostream &operator<<( std::ostream &aStream, COLOR4D const &aColor );
387 
388 // to allow json( COLOR4D )
389 void to_json( nlohmann::json& aJson, const COLOR4D& aColor );
390 
391 // To allow json::get<COLOR4D>()
392 void from_json( const nlohmann::json& aJson, COLOR4D& aColor );
393 
394 } // namespace KIGFX
395 
396 #endif /* COLOR4D_H_ */
COLOR4D & Invert()
Makes the color inverted, alpha remains the same.
Definition: color4d.h:242
void ToHSV(double &aOutHue, double &aOutSaturation, double &aOutValue, bool aAlwaysDefineHue=false) const
Convert current color (stored in RGB) to HSV format.
Definition: color4d.cpp:312
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:327
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:498
unsigned char m_Red
Definition: color4d.h:88
COLOR4D Inverted() const
Returns an inverted color, alpha remains the same.
Definition: color4d.h:317
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:191
COLOR4D & Brighten(double aFactor)
Makes the color brighter by a given factor.
Definition: color4d.h:209
COLOR4D & Saturate(double aFactor)
Saturates the color to a given factor (in HSV model)
Definition: color4d.cpp:440
std::string m_ColorName
Definition: color4d.h:90
unsigned char m_Green
Definition: color4d.h:87
mask for color index into colorRefs()[]
Definition: color4d.h:81
Definition: color4d.h:61
static const COLOR4D BLACK
Definition: color4d.h:373
COLOR4D WithAlpha(double aAlpha) const
Return a color with the same color, but the given alpha.
Definition: color4d.h:305
double g
Green component.
Definition: color4d.h:364
Definition: color4d.h:44
COLOR4D Darkened(double aFactor) const
Return a color that is darker by a given factor, without modifying object.
Definition: color4d.h:276
void from_json(const nlohmann::json &aJson, COLOR4D &aColor)
Definition: color4d.cpp:232
nlohmann::json json
Definition: gerbview.cpp:41
const bool operator<(const COLOR4D &lhs, const COLOR4D &rhs)
Definition: color4d.cpp:205
double b
Blue component.
Definition: color4d.h:365
Number of colors.
Definition: color4d.h:79
COLOR4D Brightened(double aFactor) const
Return a color that is brighter by a given factor, without modifying object.
Definition: color4d.h:262
Definition: color4d.h:76
Definition: color4d.h:67
const StructColors * colorRefs()
Global list of legacy color names, still used all over the place for constructing COLOR4D's.
Definition: color4d.cpp:37
double a
Alpha component.
Definition: color4d.h:366
static const COLOR4D CLEAR
Definition: color4d.h:374
Definition: color4d.h:57
unsigned char m_Blue
Definition: color4d.h:86
Definition: color4d.h:58
constexpr COLOR4D(double aRed, double aGreen, double aBlue, double aAlpha)
Definition: color4d.h:118
static const COLOR4D WHITE
Definition: color4d.h:372
void ToHSL(double &aOutHue, double &aOutSaturation, double &aOutValue) const
Converts current color (stored in RGB) to HSL format.
Definition: color4d.cpp:240
Definition: color4d.h:59
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:220
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:366
EDA_COLOR_T
Legacy color enumeration.
Definition: color4d.h:41
void to_json(nlohmann::json &aJson, const COLOR4D &aColor)
Definition: color4d.cpp:226
Definition: color4d.h:48
Definition: color4d.h:56
EDA_COLOR_T m_LightColor
Definition: color4d.h:91
const bool operator==(const COLOR4D &lhs, const COLOR4D &rhs)
Equality operator, are two colors equal.
Definition: color4d.cpp:193
COLOR4D & Darken(double aFactor)
Makes the color darker by a given factor.
Definition: color4d.h:226
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition: color4d.h:369
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:461
EDA_COLOR_T m_Numcolor
Definition: color4d.h:89
double r
Red component.
Definition: color4d.h:363
const bool operator!=(const COLOR4D &lhs, const COLOR4D &rhs)
Not equality operator, are two colors not equal.
Definition: color4d.cpp:199
COLOR4D Mix(const COLOR4D &aColor, double aFactor) const
Return a color that is mixed with the input by a factor.
Definition: color4d.h:289
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:271
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103