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 
104  COLOR4D LegacyMix( COLOR4D aColor ) const;
105 
111  COLOR4D& SetToLegacyHighlightColor();
112 
118  COLOR4D& SetToNearestLegacyColor();
119 
120  COLOR4D AsLegacyColor() const
121  {
122  return COLOR4D( COLOR4D::GetNearestLegacyColor( *this ) );
123  }
124 
129  unsigned int ToU32() const;
130 
134  void FromU32( unsigned int aPackedColor );
135 
139  static EDA_COLOR_T GetNearestLegacyColor( const COLOR4D &aColor );
140 #endif /* WX_COMPATIBLITY */
141 
148  COLOR4D& Brighten( double aFactor )
149  {
150  assert( aFactor >= 0.0 && aFactor <= 1.0 );
151 
152  r = r * ( 1.0 - aFactor ) + aFactor;
153  g = g * ( 1.0 - aFactor ) + aFactor;
154  b = b * ( 1.0 - aFactor ) + aFactor;
155 
156  return *this;
157  }
158 
165  COLOR4D& Darken( double aFactor )
166  {
167  assert( aFactor >= 0.0 && aFactor <= 1.0 );
168 
169  r = r * ( 1.0 - aFactor );
170  g = g * ( 1.0 - aFactor );
171  b = b * ( 1.0 - aFactor );
172 
173  return *this;
174  }
175 
182  {
183  r = ( 1.0 - r );
184  g = ( 1.0 - g );
185  b = ( 1.0 - b );
186 
187  return *this;
188  }
189 
193  COLOR4D& Saturate( double aFactor );
194 
201  COLOR4D Brightened( double aFactor ) const
202  {
203  assert( aFactor >= 0.0 && aFactor <= 1.0 );
204 
205  return COLOR4D( r * ( 1.0 - aFactor ) + aFactor,
206  g * ( 1.0 - aFactor ) + aFactor,
207  b * ( 1.0 - aFactor ) + aFactor,
208  a );
209  }
210 
217  COLOR4D Darkened( double aFactor ) const
218  {
219  assert( aFactor >= 0.0 && aFactor <= 1.0 );
220 
221  return COLOR4D( r * ( 1.0 - aFactor ),
222  g * ( 1.0 - aFactor ),
223  b * ( 1.0 - aFactor ),
224  a );
225  }
226 
233  COLOR4D WithAlpha( double aAlpha ) const
234  {
235  assert( aAlpha >= 0.0 && aAlpha <= 1.0 );
236 
237  return COLOR4D( r, g, b, aAlpha );
238  }
239 
246  {
247  return COLOR4D( 1.0 - r, 1.0 - g, 1.0 - b, a );
248  }
249 
255  double GetBrightness() const
256  {
257  // Weighted W3C formula
258  return r * 0.299 + g * 0.587 + b * 0.117;
259  }
260 
274  void ToHSV( double& aOutHue, double& aOutSaturation, double& aOutValue, bool aAlwaysDefineHue = false ) const;
275 
284  void FromHSV( double aInH, double aInS, double aInV );
285 
286  // Color components: red, green, blue, alpha
287  double r;
288  double g;
289  double b;
290  double a;
291 
293  static const COLOR4D UNSPECIFIED;
294 
295  // Declare a few color shortcuts that are used for comparisons frequently
296  static const COLOR4D WHITE;
297  static const COLOR4D BLACK;
298 };
299 
301 const bool operator==( const COLOR4D& lhs, const COLOR4D& rhs );
302 
304 const bool operator!=( const COLOR4D& lhs, const COLOR4D& rhs );
305 
307 std::ostream &operator<<( std::ostream &aStream, COLOR4D const &aColor );
308 
309 } // namespace KIGFX
310 
311 #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:181
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:148
COLOR4D & Saturate(double aFactor)
Saturates the color to a given factor (in HSV model)
Definition: color4d.cpp:413
static const COLOR4D BLACK
Definition: color4d.h:297
double g
Green component.
Definition: color4d.h:288
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn&#39;t been set yet.
Definition: color4d.h:293
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:286
double b
Blue component.
Definition: color4d.h:289
COLOR4D Brightened(double aFactor) const
Function Brightened Returns a color that is brighter by a given factor, without modifying object...
Definition: color4d.h:201
double a
Alpha component.
Definition: color4d.h:290
double GetBrightness() const
Function GetBrightness Returns the brightness value of the color ranged from 0.0 to 1...
Definition: color4d.h:255
COLOR4D WithAlpha(double aAlpha) const
Function WithAlpha Returns a colour with the same colour, but the given alpha.
Definition: color4d.h:233
static const COLOR4D WHITE
Definition: color4d.h:296
std::ostream & operator<<(std::ostream &aStream, COLOR4D const &aColor)
Syntactic sugar for outputting colors to strings.
Definition: color4d.cpp:278
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:339
YYCODETYPE lhs
COLOR4D Inverted() const
Function Inverted Returns an inverted color, alpha remains the same.
Definition: color4d.h:245
const bool operator==(const COLOR4D &lhs, const COLOR4D &rhs)
Equality operator, are two colors equal.
Definition: color4d.cpp:267
COLOR4D & Darken(double aFactor)
Function Darken Makes the color darker by a given factor.
Definition: color4d.h:165
COLOR4D Darkened(double aFactor) const
Function Darkened Returns a color that is darker by a given factor, without modifying object...
Definition: color4d.h:217
double r
Red component.
Definition: color4d.h:287
const bool operator!=(const COLOR4D &lhs, const COLOR4D &rhs)
Not equality operator, are two colors not equal.
Definition: color4d.cpp:273
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39