libs/gtkmm2ext/gtkmm2ext/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 _GTKMM2EXT_COLORS_H_
  21 #define _GTKMM2EXT_COLORS_H_
  22
  23 #include<stdint.h>
  24
  25 #include <cairomm/context.h>
  26
  27 #include "gtkmm2ext/visibility.h"
  28
  29 namespace Gtkmm2ext
  30 {
  31
  32 typedef uint32_t Color;
  33
  34 /* conventient way to use Gtkmm2ext::Color with libcairo */
  35 extern LIBGTKMM2EXT_API void set_source_rgba (Cairo::RefPtr<Cairo::Context>, Gtkmm2ext::Color);
  36 extern LIBGTKMM2EXT_API void set_source_rgb_a (Cairo::RefPtr<Cairo::Context>, Gtkmm2ext::Color, float alpha);  //override the color's alpha
  37
  38 extern LIBGTKMM2EXT_API void set_source_rgba (cairo_t*, Gtkmm2ext::Color);
  39 extern LIBGTKMM2EXT_API void set_source_rgb_a (cairo_t*, Gtkmm2ext::Color, float alpha);  //override the color's alpha
  40
  41
  42 struct LIBGTKMM2EXT_API HSV;
  43 struct LIBGTKMM2EXT_API HSVA;
  44
  45 extern LIBGTKMM2EXT_API Color change_alpha (Color, double alpha);
  46
  47 extern LIBGTKMM2EXT_API Color hsva_to_color (double h, double s, double v, double a = 1.0);
  48 extern LIBGTKMM2EXT_API void  color_to_hsva (Color color, double& h, double& s, double& v, double& a);
  49 extern LIBGTKMM2EXT_API Color color_at_alpha (Color, double a);
  50 extern LIBGTKMM2EXT_API void  color_to_hsv (Color color, double& h, double& s, double& v);
  51 extern LIBGTKMM2EXT_API void  color_to_rgba (Color, double& r, double& g, double& b, double& a);
  52 extern LIBGTKMM2EXT_API Color rgba_to_color (double r, double g, double b, double a);
  53
  54 uint32_t LIBGTKMM2EXT_API contrasting_text_color (uint32_t c);
  55
  56 struct LIBGTKMM2EXT_API HSV;
  57
  58 class LIBGTKMM2EXT_API SVAModifier
  59 {
  60 public:
  61         enum Type {
  62                 Add,
  63                 Multiply,
  64                 Assign
  65         };
  66
  67         SVAModifier (std::string const &);
  68         SVAModifier (Type t, double ss, double vv, double aa) : type (t), _s (ss) , _v (vv) , _a (aa) {}
  69         SVAModifier () : type (Add), _s (0), _v (0), _a (0) {} /* no-op modifier */
  70
  71         double s() const { return _s; }
  72         double v() const { return _v; }
  73         double a() const { return _a; }
  74
  75         HSV operator () (HSV& hsv) const;
  76         std::string to_string () const;
  77         void from_string (std::string const &);
  78
  79 private:
  80         Type type;
  81         double _s;
  82         double _v;
  83         double _a;
  84 };
  85
  86 struct LIBGTKMM2EXT_API HSV
  87 {
  88         HSV ();
  89         HSV (double h, double s, double v, double a = 1.0);
  90         HSV (Color);
  91
  92         double h;
  93         double s;
  94         double v;
  95         double a;
  96
  97         std::string to_string() const;
  98         bool is_gray() const;
  99
 100         Color color() const { return hsva_to_color (h,s, v, a); }
 101         operator Color() const { return color(); }
 102
 103         HSV mod (SVAModifier const & svam);
 104
 105         HSV operator+ (const HSV&) const;
 106         HSV operator- (const HSV&) const;
 107
 108         HSV& operator=(Color);
 109         HSV& operator=(const std::string&);
 110
 111         bool operator== (const HSV& other);
 112
 113         double distance (const HSV& other) const;
 114         HSV delta (const HSV& other) const;
 115
 116         HSV darker (double factor = 1.3) const { return shade (factor); }
 117         HSV lighter (double factor = 0.7) const { return shade (factor); }
 118
 119         HSV shade (double factor) const;
 120         HSV mix (const HSV& other, double amt) const;
 121
 122         HSV opposite() const;
 123         HSV complement() const { return opposite(); }
 124
 125         HSV bw_text () const;
 126         HSV text() const;
 127         HSV selected () const;
 128         HSV outline() const;
 129
 130         void print (std::ostream&) const;
 131
 132 protected:
 133         void clamp ();
 134 };
 135
 136 } /* namespace */
 137
 138 std::ostream& operator<<(std::ostream& o, const Gtkmm2ext::HSV& hsv);
 139
 140 #endif