gtk2_ardour/port_matrix_component.h

   1 /*
   2     Copyright (C) 2002-2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __gtk_ardour_port_matrix_component_h__
  21 #define __gtk_ardour_port_matrix_component_h__
  22
  23 #include <stdint.h>
  24 #include <gtkmm/eventbox.h>
  25
  26 class PortMatrix;
  27 class PortMatrixBody;
  28 class PortMatrixNode;
  29
  30 /** One component of the PortMatrix.  This is a cairo-rendered
  31  *  Pixmap.
  32  */
  33 class PortMatrixComponent
  34 {
  35 public:
  36         PortMatrixComponent (PortMatrix *, PortMatrixBody *);
  37         virtual ~PortMatrixComponent ();
  38
  39         virtual double component_to_parent_x (double x) const = 0;
  40         virtual double parent_to_component_x (double x) const = 0;
  41         virtual double component_to_parent_y (double y) const = 0;
  42         virtual double parent_to_component_y (double y) const = 0;
  43         virtual void mouseover_changed (PortMatrixNode const &) = 0;
  44         virtual void draw_extra (cairo_t *) = 0;
  45
  46         void set_show_ports (bool);
  47         void setup ();
  48         GdkPixmap* get_pixmap (GdkDrawable *);
  49         std::pair<uint32_t, uint32_t> dimensions ();
  50
  51         void require_render () {
  52                 _render_required = true;
  53         }
  54
  55         void require_rebuild () {
  56                 _dimension_computation_required = true;
  57                 _render_required = true;
  58         }
  59
  60         void set_parent_rectangle (Gdk::Rectangle const & r) {
  61                 _parent_rectangle = r;
  62         }
  63
  64         Gdk::Rectangle parent_rectangle () const {
  65                 return _parent_rectangle;
  66         }
  67
  68         /** @return width of columns in the grid */
  69         static uint32_t column_width () {
  70                 return 32;
  71         }
  72
  73         /** @return height of rows in the grid */
  74         static uint32_t row_height () {
  75                 return 32;
  76         }
  77
  78 protected:
  79
  80         /** @return width of borders drawn around labels */
  81         static uint32_t label_border_width () {
  82                 return 1;
  83         }
  84
  85         /** @return padding between a name and the nearest line */
  86         static uint32_t name_pad () {
  87                 return 8;
  88         }
  89
  90         /** @return width of thin lines in the grid */
  91         static double thin_grid_line_width () {
  92                 return 0.5;
  93         }
  94
  95         /** @return width of thick lines in the grid */
  96         static double thick_grid_line_width () {
  97                 return 1;
  98         }
  99
 100         /** @return space around the connection indicator */
 101         static uint32_t connection_indicator_pad () {
 102                 return 8;
 103         }
 104
 105         static uint32_t mouseover_line_width () {
 106                 return 4;
 107         }
 108
 109         /** @return angle of column labels, in radians */
 110         static double angle () {
 111                 return M_PI / 4;
 112         }
 113
 114         /** @return background colour */
 115         Gdk::Color background_colour ();
 116
 117         /* XXX I guess these colours should come from a theme, or something */
 118
 119         /** @return text colour */
 120         static Gdk::Color text_colour () {
 121                 return Gdk::Color ("#ffffff");
 122         }
 123
 124         /** @return grid line colour */
 125         static Gdk::Color grid_colour () {
 126                 return Gdk::Color ("#000000");
 127         }
 128
 129         /** @return colour of association blobs */
 130         static Gdk::Color association_colour () {
 131                 return Gdk::Color ("#00ff00");
 132         }
 133
 134         /** @return colour to paint grid squares when they can't be associated */
 135         static Gdk::Color unknown_colour () {
 136                 return Gdk::Color ("#cccccc");
 137         }
 138
 139         /** @return colour to paint mouseover lines */
 140         static Gdk::Color mouseover_line_colour () {
 141                 return Gdk::Color ("#ff0000");
 142         }
 143
 144         /** @return colour to paint channel highlights */
 145         static Gdk::Color highlighted_channel_colour () {
 146                 return Gdk::Color ("#777777");
 147         }
 148
 149         /* XXX */
 150         static Gdk::Color get_a_bundle_colour (int x) {
 151                 if ((x % 2) == 0) {
 152                         return Gdk::Color ("#547027");
 153                 } else {
 154                         return Gdk::Color ("#3552a6");
 155                 }
 156         }
 157
 158         /* XXX */
 159         static Gdk::Color get_a_group_colour (int x) {
 160                 if ((x % 2) == 0) {
 161                         return Gdk::Color ("#222222");
 162                 } else {
 163                         return Gdk::Color ("#444444");
 164                 }
 165         }
 166
 167         void set_source_rgb (cairo_t *, Gdk::Color const &);
 168         void set_source_rgba (cairo_t *, Gdk::Color const &, double);
 169
 170         /** Render the complete component to a cairo context. */
 171         virtual void render (cairo_t *) = 0;
 172         /** Compute any required dimensions.  This must set up
 173          *  _width and _height.
 174          */
 175         virtual void compute_dimensions () = 0;
 176
 177         PortMatrix* _matrix;
 178         PortMatrixBody* _body; ///< the PortMatrixBody that we're in
 179         uint32_t _width; ///< full width of the contents
 180         uint32_t _height; ///< full height of the contents
 181         Gdk::Rectangle _parent_rectangle;
 182
 183 private:
 184         GdkPixmap* _pixmap; ///< pixmap
 185         bool _render_required; ///< true if the rendered pixmap is out of date
 186         bool _dimension_computation_required; ///< true if the dimensions are out of date
 187 };
 188
 189 #endif