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