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 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 <colors.h>
31 #include <cassert>
32 
33 namespace KIGFX
34 {
39 class COLOR4D
40 {
41 public:
42  // Constructor (creates the Color 0,0,0,0)
43  COLOR4D() :
44  r( 0 ), g( 0 ), b( 0 ), a( 1.0 )
45  {
46  }
47 
56  COLOR4D( double aRed, double aGreen, double aBlue, double aAlpha ) :
57  r( aRed ), g( aGreen ), b( aBlue ), a( aAlpha )
58  {
59  assert( r >= 0.0 && r <= 1.0 );
60  assert( g >= 0.0 && g <= 1.0 );
61  assert( b >= 0.0 && b <= 1.0 );
62  assert( a >= 0.0 && a <= 1.0 );
63  }
64 
71  COLOR4D( EDA_COLOR_T aColor );
72 
73 #ifdef WX_COMPATIBILITY
74 
79  COLOR4D( const wxColour& aColor );
80 
88  bool SetFromWxString( const wxString& aColorString );
89 
90  wxString ToWxString( long flags ) const;
91 
92  wxColour ToColour() const
93  {
94  wxColour colour( r * 255, g * 255, b * 255, a * 255 );
95  return colour;
96  }
97 
108  COLOR4D LegacyMix( COLOR4D aColor ) const;
109 
115  COLOR4D& SetToLegacyHighlightColor();
116 
122  COLOR4D& SetToNearestLegacyColor();
123 
128  unsigned int ToU32() const;
129 
133  void FromU32( unsigned int aPackedColor );
134 
138  static EDA_COLOR_T GetNearestLegacyColor( COLOR4D &aColor );
139 #endif /* WX_COMPATIBLITY */
140 
147  COLOR4D& Brighten( double aFactor )
148  {
149  assert( aFactor >= 0.0 && aFactor <= 1.0 );
150 
151  r = r * ( 1.0 - aFactor ) + aFactor;
152  g = g * ( 1.0 - aFactor ) + aFactor;
153  b = b * ( 1.0 - aFactor ) + aFactor;
154 
155  return *this;
156  }
157 
164  COLOR4D& Darken( double aFactor )
165  {
166  assert( aFactor >= 0.0 && aFactor <= 1.0 );
167 
168  r = r * ( 1.0 - aFactor );
169  g = g * ( 1.0 - aFactor );
170  b = b * ( 1.0 - aFactor );
171 
172  return *this;
173  }
174 
181  {
182  r = ( 1.0 - r );
183  g = ( 1.0 - g );
184  b = ( 1.0 - b );
185 
186  return *this;
187  }
188 
192  COLOR4D& Saturate( double aFactor );
193 
200  COLOR4D Brightened( double aFactor ) const
201  {
202  assert( aFactor >= 0.0 && aFactor <= 1.0 );
203 
204  return COLOR4D( r * ( 1.0 - aFactor ) + aFactor,
205  g * ( 1.0 - aFactor ) + aFactor,
206  b * ( 1.0 - aFactor ) + aFactor,
207  a );
208  }
209 
216  COLOR4D Darkened( double aFactor ) const
217  {
218  assert( aFactor >= 0.0 && aFactor <= 1.0 );
219 
220  return COLOR4D( r * ( 1.0 - aFactor ),
221  g * ( 1.0 - aFactor ),
222  b * ( 1.0 - aFactor ),
223  a );
224  }
225 
232  COLOR4D WithAlpha( double aAlpha ) const
233  {
234  assert( aAlpha >= 0.0 && aAlpha <= 1.0 );
235 
236  return COLOR4D( r, g, b, aAlpha );
237  }
238 
245  {
246  return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
247  }
248 
254  double GetBrightness() const
255  {
256  // Weighted W3C formula
257  return r * 0.299 + g * 0.587 + b * 0.117;
258  }
259 
273  void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue, bool aAlwaysDefineHue = false ) const;
274 
283  void FromHSV( double aInH, double aInS, double aInV );
284 
285  // Color components: red, green, blue, alpha
286  double r;
287  double g;
288  double b;
289  double a;
290 
292  static const COLOR4D UNSPECIFIED;
293 
294  // Declare a few color shortcuts that are used for comparisons frequently
295  static const COLOR4D WHITE;
296  static const COLOR4D BLACK;
297 };
298 
300 const bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );
301 
303 const bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
304 
306 std::ostream &operator<<( std::ostream &aStream, COLOR4D const &aColor );
307 
308 } // namespace KIGFX
309 
310 #endif /* COLOR4D_H_ */
COLOR4D(double aRed, double aGreen, double aBlue, double aAlpha)
Constructor.
Definition: color4d.h:56
COLOR4D & Invert()
Function Invert Makes the color inverted, alpha remains the same.
Definition: color4d.h:180
EDA_COLOR_T
NOTE: EDA_COLOR_T is deprecated and is kept around for compatibility with legacy canvas.
Definition: colors.h:42
Class CAIRO_GAL is the cairo implementation of the graphics abstraction layer.
Definition: class_module.h:57
COLOR4D & Brighten(double aFactor)
Function Brighten Makes the color brighter by a given factor.
Definition: color4d.h:147
COLOR4D & Saturate(double aFactor)
Saturates the color to a given factor (in HSV model)
Definition: color4d.cpp:400
static const COLOR4D BLACK
Definition: color4d.h:296
double g
Green component.
Definition: color4d.h:287
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition: color4d.h:292
void ToHSV(double &aOutHue, double &aOutSaturation, double &aOutValue, bool aAlwaysDefineHue=false) const
Function ToHSV() Converts current color (stored in RGB) to HSV format.
Definition: color4d.cpp:273
double b
Blue component.
Definition: color4d.h:288
COLOR4D Brightened(double aFactor) const
Function Brightened Returns a color that is brighter by a given factor, without modifying object...
Definition: color4d.h:200
double a
Alpha component.
Definition: color4d.h:289
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1...
Definition: color4d.h:254
COLOR4D WithAlpha(double aAlpha) const
Function WithAlpha Returns a colour with the same colour, but the given alpha.
Definition: color4d.h:232
static const COLOR4D WHITE
Definition: color4d.h:295
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:265
void FromHSV(double aInH, double aInS, double aInV)
Function FromHSV() Changes currently used color to the one given by hue, saturation and value paramet...
Definition: color4d.cpp:326
COLOR4D Inverted() const
Function Inverted Returns an inverted color, alpha remains the same.
Definition: color4d.h:244
const bool operator==(const COLOR4D &lhs, const COLOR4D &rhs)
Equality operator, are two colors equal.
Definition: color4d.cpp:254
COLOR4D & Darken(double aFactor)
Function Darken Makes the color darker by a given factor.
Definition: color4d.h:164
COLOR4D Darkened(double aFactor) const
Function Darkened Returns a color that is darker by a given factor, without modifying object...
Definition: color4d.h:216
double r
Red component.
Definition: color4d.h:286
const bool operator!=(const COLOR4D &lhs, const COLOR4D &rhs)
Not equality operator, are two colors not equal.
Definition: color4d.cpp:260
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39