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 #include <boost/shared_ptr.hpp>
  26
  27 class PortMatrix;
  28 class PortMatrixBody;
  29 class PortMatrixNode;
  30 class PortGroup;
  31 class PortGroupList;
  32
  33 namespace ARDOUR {
  34         class BundleChannel;
  35 }
  36
  37 /** One component of the PortMatrix.  This is a cairo-rendered
  38  *  Pixmap.
  39  */
  40 class PortMatrixComponent
  41 {
  42 public:
  43         PortMatrixComponent (PortMatrix *, PortMatrixBody *);
  44         virtual ~PortMatrixComponent ();
  45
  46         virtual double component_to_parent_x (double x) const = 0;
  47         virtual double parent_to_component_x (double x) const = 0;
  48         virtual double component_to_parent_y (double y) const = 0;
  49         virtual double parent_to_component_y (double y) const = 0;
  50         virtual void mouseover_changed (PortMatrixNode const &) = 0;
  51         virtual void draw_extra (cairo_t *) = 0;
  52
  53         void set_show_ports (bool);
  54         void setup ();
  55         GdkPixmap* get_pixmap (GdkDrawable *);
  56         std::pair<uint32_t, uint32_t> dimensions ();
  57
  58         void require_render () {
  59                 _render_required = true;
  60         }
  61
  62         void require_rebuild () {
  63                 _dimension_computation_required = true;
  64                 _render_required = true;
  65         }
  66
  67         void set_parent_rectangle (Gdk::Rectangle const & r) {
  68                 _parent_rectangle = r;
  69         }
  70
  71         Gdk::Rectangle parent_rectangle () const {
  72                 return _parent_rectangle;
  73         }
  74
  75         /** @return grid spacing */
  76         static uint32_t grid_spacing () {
  77                 return 32;
  78         }
  79
  80 protected:
  81
  82         /** @return width of borders drawn around labels */
  83         static uint32_t label_border_width () {
  84                 return 1;
  85         }
  86
  87         /** @return padding between a name and the nearest line */
  88         static uint32_t name_pad () {
  89                 return 8;
  90         }
  91
  92         /** @return width of thin lines in the grid */
  93         static double thin_grid_line_width () {
  94                 return 0.5;
  95         }
  96
  97         /** @return width of thick lines in the grid */
  98         static double thick_grid_line_width () {
  99                 return 1;
 100         }
 101
 102         /** @return space around the connection indicator */
 103         static uint32_t connection_indicator_pad () {
 104                 return 8;
 105         }
 106
 107         static uint32_t mouseover_line_width () {
 108                 return 4;
 109         }
 110
 111         /** @return angle of column labels, in radians */
 112         static double angle () {
 113                 return M_PI / 4;
 114         }
 115
 116         /** @return background colour */
 117         Gdk::Color background_colour ();
 118
 119         /* XXX I guess these colours should come from a theme, or something */
 120
 121         /** @return text colour */
 122         static Gdk::Color text_colour () {
 123                 return Gdk::Color ("#ffffff");
 124         }
 125
 126         /** @return grid line colour */
 127         static Gdk::Color grid_colour () {
 128                 return Gdk::Color ("#000000");
 129         }
 130
 131         /** @return colour of association blobs */
 132         static Gdk::Color association_colour () {
 133                 return Gdk::Color ("#00ff00");
 134         }
 135
 136         /** @return colour to paint grid squares when they can't be associated */
 137         static Gdk::Color unknown_colour () {
 138                 return Gdk::Color ("#cccccc");
 139         }
 140
 141         /** @return colour to paint mouseover lines */
 142         static Gdk::Color mouseover_line_colour () {
 143                 return Gdk::Color ("#ff0000");
 144         }
 145
 146         /** @return colour to paint channel highlights */
 147         static Gdk::Color highlighted_channel_colour () {
 148                 return Gdk::Color ("#777777");
 149         }
 150
 151         /* XXX */
 152         static Gdk::Color get_a_bundle_colour (int x) {
 153                 if ((x % 2) == 0) {
 154                         return Gdk::Color ("#547027");
 155                 } else {
 156                         return Gdk::Color ("#3552a6");
 157                 }
 158         }
 159
 160         /* XXX */
 161         static Gdk::Color get_a_group_colour (int x) {
 162                 if ((x % 2) == 0) {
 163                         return Gdk::Color ("#222222");
 164                 } else {
 165                         return Gdk::Color ("#444444");
 166                 }
 167         }
 168
 169         void set_source_rgb (cairo_t *, Gdk::Color const &);
 170         void set_source_rgba (cairo_t *, Gdk::Color const &, double);
 171         uint32_t group_size (boost::shared_ptr<const PortGroup>) const;
 172         uint32_t channel_to_position (ARDOUR::BundleChannel, PortGroupList const *) const;
 173         std::pair<boost::shared_ptr<PortGroup>, ARDOUR::BundleChannel> position_to_group_and_channel (uint32_t, PortGroupList const *) const;
 174
 175         /** Render the complete component to a cairo context. */
 176         virtual void render (cairo_t *) = 0;
 177         /** Compute any required dimensions.  This must set up
 178          *  _width and _height.
 179          */
 180         virtual void compute_dimensions () = 0;
 181
 182         PortMatrix* _matrix;
 183         PortMatrixBody* _body; ///< the PortMatrixBody that we're in
 184         uint32_t _width; ///< full width of the contents
 185         uint32_t _height; ///< full height of the contents
 186         Gdk::Rectangle _parent_rectangle;
 187
 188 private:
 189         GdkPixmap* _pixmap; ///< pixmap
 190         bool _render_required; ///< true if the rendered pixmap is out of date
 191         bool _dimension_computation_required; ///< true if the dimensions are out of date
 192 };
 193
 194 #endif