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 change_alpha (Color, double alpha);
  35
  36 extern LIBCANVAS_API Color hsva_to_color (double h, double s, double v, double a = 1.0);
  37 extern LIBCANVAS_API void  color_to_hsva (Color color, double& h, double& s, double& v, double& a);
  38 extern LIBCANVAS_API void  color_to_hsv (Color color, double& h, double& s, double& v);
  39 extern LIBCANVAS_API void  color_to_rgba (Color, double& r, double& g, double& b, double& a);
  40 extern LIBCANVAS_API Color rgba_to_color (double r, double g, double b, double a);
  41
  42 uint32_t LIBCANVAS_API contrasting_text_color (uint32_t c);
  43
  44 struct LIBCANVAS_API HSV;
  45
  46 class LIBCANVAS_API SVAModifier
  47 {
  48   public:
  49         enum Type {
  50                 Add,
  51                 Multiply,
  52                 Assign
  53         };
  54
  55         SVAModifier (std::string const &);
  56         SVAModifier (Type t, double ss, double vv, double aa) : type (t), _s (ss) , _v (vv) , _a (aa) {}
  57         SVAModifier () : type (Add), _s (0), _v (0), _a (0) {} /* no-op modifier */
  58
  59         double s() const { return _s; }
  60         double v() const { return _v; }
  61         double a() const { return _a; }
  62
  63         HSV operator () (HSV& hsv) const;
  64         std::string to_string () const;
  65         void from_string (std::string const &);
  66
  67   private:
  68         Type type;
  69         double _s;
  70         double _v;
  71         double _a;
  72 };
  73
  74 struct LIBCANVAS_API HSV
  75 {
  76         HSV ();
  77         HSV (double h, double s, double v, double a = 1.0);
  78         HSV (Color);
  79         HSV (const std::string&);
  80
  81         double h;
  82         double s;
  83         double v;
  84         double a;
  85
  86         std::string to_string() const;
  87         bool is_gray() const;
  88
  89         Color color() const { return hsva_to_color (h,s, v, a); }
  90         operator Color() const { return color(); }
  91
  92         HSV mod (SVAModifier const & svam);
  93
  94         HSV operator+ (const HSV&) const;
  95         HSV operator- (const HSV&) const;
  96
  97         HSV& operator=(Color);
  98         HSV& operator=(const std::string&);
  99
 100         bool operator== (const HSV& other);
 101
 102         double distance (const HSV& other) const;
 103         HSV delta (const HSV& other) const;
 104
 105         HSV darker (double factor = 1.3) const { return shade (factor); }
 106         HSV lighter (double factor = 0.7) const { return shade (factor); }
 107
 108         HSV shade (double factor) const;
 109         HSV mix (const HSV& other, double amt) const;
 110
 111         HSV opposite() const;
 112         HSV complement() const { return opposite(); }
 113
 114         HSV bw_text () const;
 115         HSV text() const;
 116         HSV selected () const;
 117         HSV outline() const;
 118
 119         void print (std::ostream&) const;
 120
 121   protected:
 122         void clamp ();
 123 };
 124
 125
 126 }
 127
 128 std::ostream& operator<<(std::ostream& o, const ArdourCanvas::HSV& hsv);
 129
 130 #endif /* __ardour_canvas_colors_h__ */