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,
75  HIGHLIGHT_FLAG = ( 1<<19 ),
76  MASKCOLOR = 31
77 };
78 
80 {
81  unsigned char m_Blue;
82  unsigned char m_Green;
83  unsigned char m_Red;
85  std::string m_ColorName;
87 };
88 
90 const StructColors* colorRefs();
91 
92 
93 namespace KIGFX
94 {
98 class COLOR4D
99 {
100 public:
101  // Constructor (creates the Color 0,0,0,0)
103  r( 0 ), g( 0 ), b( 0 ), a( 1.0 )
104  {
105  }
106 
113  constexpr COLOR4D( double aRed, double aGreen, double aBlue, double aAlpha ) :
114  r( aRed ), g( aGreen ), b( aBlue ), a( aAlpha )
115  {
116  assert( r >= 0.0 && r <= 1.0 );
117  assert( g >= 0.0 && g <= 1.0 );
118  assert( b >= 0.0 && b <= 1.0 );
119  assert( a >= 0.0 && a <= 1.0 );
120  }
121 
126  COLOR4D( EDA_COLOR_T aColor );
127 
135  COLOR4D& FromCSSRGBA( int aRed, int aGreen, int aBlue, double aAlpha = 1.0 );
136 
137 #ifdef WX_COMPATIBILITY
138 
141  COLOR4D( const wxColour& aColor );
142 
149  bool SetFromWxString( const wxString& aColorString );
150 
151  wxString ToWxString( long flags ) const;
152 
153  wxColour ToColour() const;
154 
163  COLOR4D LegacyMix( COLOR4D aColor ) const;
164 
170  unsigned int ToU32() const;
171 
175  void FromU32( unsigned int aPackedColor );
176 #endif /* WX_COMPATIBLITY */
177 
178 
187  void ToHSL( double& aOutHue, double& aOutSaturation, double& aOutValue ) const;
188 
196  void FromHSL( double aInHue, double aInSaturation, double aInLightness );
197 
204  COLOR4D& Brighten( double aFactor )
205  {
206  assert( aFactor >= 0.0 && aFactor <= 1.0 );
207 
208  r = r * ( 1.0 - aFactor ) + aFactor;
209  g = g * ( 1.0 - aFactor ) + aFactor;
210  b = b * ( 1.0 - aFactor ) + aFactor;
211 
212  return *this;
213  }
214 
221  COLOR4D& Darken( double aFactor )
222  {
223  assert( aFactor >= 0.0 && aFactor <= 1.0 );
224 
225  r = r * ( 1.0 - aFactor );
226  g = g * ( 1.0 - aFactor );
227  b = b * ( 1.0 - aFactor );
228 
229  return *this;
230  }
231 
238  {
239  r = ( 1.0 - r );
240  g = ( 1.0 - g );
241  b = ( 1.0 - b );
242 
243  return *this;
244  }
245 
249  COLOR4D& Saturate( double aFactor );
250 
257  COLOR4D Brightened( double aFactor ) const
258  {
259  assert( aFactor >= 0.0 && aFactor <= 1.0 );
260 
261  return COLOR4D( r * ( 1.0 - aFactor ) + aFactor, g * ( 1.0 - aFactor ) + aFactor,
262  b * ( 1.0 - aFactor ) + aFactor, a );
263  }
264 
271  COLOR4D Darkened( double aFactor ) const
272  {
273  assert( aFactor >= 0.0 && aFactor <= 1.0 );
274 
275  return COLOR4D( r * ( 1.0 - aFactor ), g * ( 1.0 - aFactor ), b * ( 1.0 - aFactor ), a );
276  }
277 
284  COLOR4D Mix( const COLOR4D& aColor, double aFactor ) const
285  {
286  assert( aFactor >= 0.0 && aFactor <= 1.0 );
287 
288  return COLOR4D( aColor.r * ( 1.0 - aFactor ) + r * aFactor,
289  aColor.g * ( 1.0 - aFactor ) + g * aFactor,
290  aColor.b * ( 1.0 - aFactor ) + b * aFactor,
291  a );
292  }
293 
300  COLOR4D WithAlpha( double aAlpha ) const
301  {
302  assert( aAlpha >= 0.0 && aAlpha <= 1.0 );
303 
304  return COLOR4D( r, g, b, aAlpha );
305  }
306 
313  {
314  return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
315  }
316 
322  double GetBrightness() const
323  {
324  // Weighted W3C formula
325  return r * 0.299 + g * 0.587 + b * 0.117;
326  }
327 
340  void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue,
341  bool aAlwaysDefineHue = false ) const;
342 
350  void FromHSV( double aInH, double aInS, double aInV );
351 
355  static EDA_COLOR_T FindNearestLegacyColor( int aR, int aG, int aB );
356 
357  // Color components: red, green, blue, alpha
358  double r;
359  double g;
360  double b;
361  double a;
362 
364  static const COLOR4D UNSPECIFIED;
365 
366  // Declare a few color shortcuts that are used for comparisons frequently
367  static const COLOR4D WHITE;
368  static const COLOR4D BLACK;
369  static const COLOR4D CLEAR;
370 };
371 
373 const bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );
374 
376 const bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
377 
378 const bool operator<( const COLOR4D& lhs, const COLOR4D& rhs );
379 
381 std::ostream &operator<<( std::ostream &aStream, COLOR4D const &aColor );
382 
383 // to allow json( COLOR4D )
384 void to_json( nlohmann::json& aJson, const COLOR4D& aColor );
385 
386 // To allow json::get<COLOR4D>()
387 void from_json( const nlohmann::json& aJson, COLOR4D& aColor );
388 
389 } // namespace KIGFX
390 
391 #endif /* COLOR4D_H_ */
COLOR4D & Invert()
Makes the color inverted, alpha remains the same.
Definition: color4d.h:237
void ToHSV(double &aOutHue, double &aOutSaturation, double &aOutValue, bool aAlwaysDefineHue=false) const
Convert current color (stored in RGB) to HSV format.
Definition: color4d.cpp:293
double GetBrightness() const
Returns the brightness value of the color ranged from 0.0 to 1.0.
Definition: color4d.h:322
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:476
unsigned char m_Red
Definition: color4d.h:83
COLOR4D Inverted() const
Returns an inverted color, alpha remains the same.
Definition: color4d.h:312
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:175
COLOR4D & Brighten(double aFactor)
Makes the color brighter by a given factor.
Definition: color4d.h:204
COLOR4D & Saturate(double aFactor)
Saturates the color to a given factor (in HSV model)
Definition: color4d.cpp:420
std::string m_ColorName
Definition: color4d.h:85
unsigned char m_Green
Definition: color4d.h:82
mask for color index into colorRefs()[]
Definition: color4d.h:76
Definition: color4d.h:61
static const COLOR4D BLACK
Definition: color4d.h:368
COLOR4D WithAlpha(double aAlpha) const
Return a color with the same color, but the given alpha.
Definition: color4d.h:300
double g
Green component.
Definition: color4d.h:359
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:271
void from_json(const nlohmann::json &aJson, COLOR4D &aColor)
Definition: color4d.cpp:213
nlohmann::json json
Definition: gerbview.cpp:40
const bool operator<(const COLOR4D &lhs, const COLOR4D &rhs)
Definition: color4d.cpp:188
double b
Blue component.
Definition: color4d.h:360
Number of colors.
Definition: color4d.h:74
COLOR4D Brightened(double aFactor) const
Return a color that is brighter by a given factor, without modifying object.
Definition: color4d.h:257
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:361
static const COLOR4D CLEAR
Definition: color4d.h:369
Definition: color4d.h:57
unsigned char m_Blue
Definition: color4d.h:81
Definition: color4d.h:58
constexpr COLOR4D(double aRed, double aGreen, double aBlue, double aAlpha)
Definition: color4d.h:113
static const COLOR4D WHITE
Definition: color4d.h:367
void ToHSL(double &aOutHue, double &aOutSaturation, double &aOutValue) const
Converts current color (stored in RGB) to HSL format.
Definition: color4d.cpp:221
Definition: color4d.h:59
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:202
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:346
EDA_COLOR_T
Legacy color enumeration.
Definition: color4d.h:41
void to_json(nlohmann::json &aJson, const COLOR4D &aColor)
Definition: color4d.cpp:207
Definition: color4d.h:48
Definition: color4d.h:56
EDA_COLOR_T m_LightColor
Definition: color4d.h:86
const bool operator==(const COLOR4D &lhs, const COLOR4D &rhs)
Equality operator, are two colors equal.
Definition: color4d.cpp:177
COLOR4D & Darken(double aFactor)
Makes the color darker by a given factor.
Definition: color4d.h:221
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition: color4d.h:364
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:440
EDA_COLOR_T m_Numcolor
Definition: color4d.h:84
double r
Red component.
Definition: color4d.h:358
const bool operator!=(const COLOR4D &lhs, const COLOR4D &rhs)
Not equality operator, are two colors not equal.
Definition: color4d.cpp:183
COLOR4D Mix(const COLOR4D &aColor, double aFactor) const
Return a color that is mixed with the input by a factor.
Definition: color4d.h:284
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:252
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:98