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 
124  COLOR4D AsLegacyColor() const
125  {
126  return COLOR4D( COLOR4D::GetNearestLegacyColor( *this ) );
127  }
128 
133  unsigned int ToU32() const;
134 
138  void FromU32( unsigned int aPackedColor );
139 
143  static EDA_COLOR_T GetNearestLegacyColor( const COLOR4D &aColor );
144 #endif /* WX_COMPATIBLITY */
145 
152  COLOR4D& Brighten( double aFactor )
153  {
154  assert( aFactor >= 0.0 && aFactor <= 1.0 );
155 
156  r = r * ( 1.0 - aFactor ) + aFactor;
157  g = g * ( 1.0 - aFactor ) + aFactor;
158  b = b * ( 1.0 - aFactor ) + aFactor;
159 
160  return *this;
161  }
162 
169  COLOR4D& Darken( double aFactor )
170  {
171  assert( aFactor >= 0.0 && aFactor <= 1.0 );
172 
173  r = r * ( 1.0 - aFactor );
174  g = g * ( 1.0 - aFactor );
175  b = b * ( 1.0 - aFactor );
176 
177  return *this;
178  }
179 
186  {
187  r = ( 1.0 - r );
188  g = ( 1.0 - g );
189  b = ( 1.0 - b );
190 
191  return *this;
192  }
193 
197  COLOR4D& Saturate( double aFactor );
198 
205  COLOR4D Brightened( double aFactor ) const
206  {
207  assert( aFactor >= 0.0 && aFactor <= 1.0 );
208 
209  return COLOR4D( r * ( 1.0 - aFactor ) + aFactor,
210  g * ( 1.0 - aFactor ) + aFactor,
211  b * ( 1.0 - aFactor ) + aFactor,
212  a );
213  }
214 
221  COLOR4D Darkened( double aFactor ) const
222  {
223  assert( aFactor >= 0.0 && aFactor <= 1.0 );
224 
225  return COLOR4D( r * ( 1.0 - aFactor ),
226  g * ( 1.0 - aFactor ),
227  b * ( 1.0 - aFactor ),
228  a );
229  }
230 
237  COLOR4D WithAlpha( double aAlpha ) const
238  {
239  assert( aAlpha >= 0.0 && aAlpha <= 1.0 );
240 
241  return COLOR4D( r, g, b, aAlpha );
242  }
243 
250  {
251  return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
252  }
253 
259  double GetBrightness() const
260  {
261  // Weighted W3C formula
262  return r * 0.299 + g * 0.587 + b * 0.117;
263  }
264 
278  void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue, bool aAlwaysDefineHue = false ) const;
279 
288  void FromHSV( double aInH, double aInS, double aInV );
289 
290  // Color components: red, green, blue, alpha
291  double r;
292  double g;
293  double b;
294  double a;
295 
297  static const COLOR4D UNSPECIFIED;
298 
299  // Declare a few color shortcuts that are used for comparisons frequently
300  static const COLOR4D WHITE;
301  static const COLOR4D BLACK;
302 };
303 
305 const bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );
306 
308 const bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
309 
311 std::ostream &operator<<( std::ostream &aStream, COLOR4D const &aColor );
312 
313 } // namespace KIGFX
314 
315 #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:185
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:58
COLOR4D & Brighten(double aFactor)
Function Brighten Makes the color brighter by a given factor.
Definition: color4d.h:152
COLOR4D & Saturate(double aFactor)
Saturates the color to a given factor (in HSV model)
Definition: color4d.cpp:399
static const COLOR4D BLACK
Definition: color4d.h:301
double g
Green component.
Definition: color4d.h:292
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn&#39;t been set yet.
Definition: color4d.h:297
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:272
double b
Blue component.
Definition: color4d.h:293
COLOR4D Brightened(double aFactor) const
Function Brightened Returns a color that is brighter by a given factor, without modifying object...
Definition: color4d.h:205
double a
Alpha component.
Definition: color4d.h:294
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1...
Definition: color4d.h:259
COLOR4D WithAlpha(double aAlpha) const
Function WithAlpha Returns a colour with the same colour, but the given alpha.
Definition: color4d.h:237
static const COLOR4D WHITE
Definition: color4d.h:300
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:264
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:325
YYCODETYPE lhs
COLOR4D Inverted() const
Function Inverted Returns an inverted color, alpha remains the same.
Definition: color4d.h:249
const bool operator==(const COLOR4D &lhs, const COLOR4D &rhs)
Equality operator, are two colors equal.
Definition: color4d.cpp:253
COLOR4D & Darken(double aFactor)
Function Darken Makes the color darker by a given factor.
Definition: color4d.h:169
COLOR4D Darkened(double aFactor) const
Function Darkened Returns a color that is darker by a given factor, without modifying object...
Definition: color4d.h:221
double r
Red component.
Definition: color4d.h:291
const bool operator!=(const COLOR4D &lhs, const COLOR4D &rhs)
Not equality operator, are two colors not equal.
Definition: color4d.cpp:259
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39