massive reworking of color selection implementation
[ardour.git] / libs / canvas / canvas / colors.h
1 /*
2     Copyright (C) 2011-2013 Paul Davis
3     Author: Carl Hetherington <cth@carlh.net>
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #ifndef __ardour_canvas_colors_h__
21 #define __ardour_canvas_colors_h__
22
23 #include <cairomm/context.h>
24
25 #include "canvas/visibility.h"
26 #include "canvas/types.h"
27
28 namespace ArdourCanvas 
29 {
30
31 struct LIBCANVAS_API HSV;
32 struct LIBCANVAS_API HSVA;
33
34 extern LIBCANVAS_API Color hsva_to_color (double h, double s, double v, double a = 1.0);
35 extern LIBCANVAS_API void  color_to_hsva (Color color, double& h, double& s, double& v, double& a);
36 extern LIBCANVAS_API void  color_to_hsv (Color color, double& h, double& s, double& v);
37 extern LIBCANVAS_API void  color_to_rgba (Color, double& r, double& g, double& b, double& a);
38 extern LIBCANVAS_API Color rgba_to_color (double r, double g, double b, double a);
39
40 uint32_t LIBCANVAS_API contrasting_text_color (uint32_t c);
41
42 struct LIBCANVAS_API HSV
43 {
44         HSV ();
45         HSV (double h, double s, double v, double a = 1.0);
46         HSV (Color);
47
48         double h;
49         double s;
50         double v;
51         double a;
52
53         bool is_gray() const;
54         
55         Color color() const { return hsva_to_color (h,s, v, a); }
56         operator Color() const { return color(); }
57
58         HSV operator+ (const HSV&) const;
59         HSV operator- (const HSV&) const;
60
61         HSV& operator=(Color);
62         HSV& operator=(const std::string&);
63
64         bool operator== (const HSV& other);
65
66         double distance (const HSV& other) const;
67         HSV delta (const HSV& other) const;
68
69         HSV darker (double factor = 1.3) const { return shade (factor); }
70         HSV lighter (double factor = 0.7) const { return shade (factor); }
71
72         HSV shade (double factor) const;
73         HSV mix (const HSV& other, double amt) const;
74
75         HSV opposite() const;
76         HSV complement() const { return opposite(); }
77
78         HSV bw_text () const;
79         HSV text() const;
80         HSV selected () const;
81         HSV outline() const;
82
83         void print (std::ostream&) const;
84
85   protected:
86         void clamp ();
87 };
88
89 }
90
91 std::ostream& operator<<(std::ostream& o, const ArdourCanvas::HSV& hsv);
92
93 #endif /* __ardour_canvas_colors_h__ */