gtk2_ardour/editor_summary.h

   1 /*
   2     Copyright (C) 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_editor_summary_h__
  21 #define __gtk_ardour_editor_summary_h__
  22
  23 #include "gtkmm2ext/cairo_widget.h"
  24 #include "editor_component.h"
  25
  26 namespace ARDOUR {
  27         class Session;
  28 }
  29
  30 class Editor;
  31
  32 /** Class to provide a visual summary of the contents of an editor window; represents
  33  *  the whole session as a set of lines, one per region view.
  34  */
  35 class EditorSummary : public CairoWidget, public EditorComponent, public ARDOUR::SessionHandlePtr, public PBD::ScopedConnectionList
  36 {
  37 public:
  38         EditorSummary (Editor *);
  39         ~EditorSummary ();
  40
  41         void set_session (ARDOUR::Session *);
  42         void set_overlays_dirty ();
  43         void set_background_dirty ();
  44         void routes_added (std::list<RouteTimeAxisView*> const &);
  45
  46 private:
  47         void on_size_allocate (Gtk::Allocation& alloc);
  48
  49         enum Position {
  50                 LEFT,
  51                 LEFT_TOP,
  52                 TOP,
  53                 RIGHT_TOP,
  54                 RIGHT,
  55                 RIGHT_BOTTOM,
  56                 BOTTOM,
  57                 LEFT_BOTTOM,
  58                 INSIDE,
  59                 BELOW_OR_ABOVE,
  60                 TO_LEFT_OR_RIGHT,
  61                 OTHERWISE_OUTSIDE
  62         };
  63
  64         void on_size_request (Gtk::Requisition *);
  65         bool on_button_press_event (GdkEventButton *);
  66         bool on_button_release_event (GdkEventButton *);
  67         bool on_motion_notify_event (GdkEventMotion *);
  68         bool on_scroll_event (GdkEventScroll *);
  69         bool on_key_press_event (GdkEventKey*);
  70         bool on_key_release_event (GdkEventKey*);
  71         bool on_enter_notify_event (GdkEventCrossing*);
  72         bool on_leave_notify_event (GdkEventCrossing*);
  73
  74         void centre_on_click (GdkEventButton *);
  75         void render (cairo_t *, cairo_rectangle_t*);
  76         void render_region (RegionView*, cairo_t*, double) const;
  77         void get_editor (std::pair<double, double> *, std::pair<double, double> *) const;
  78         void set_editor (double, double);
  79         void set_editor (std::pair<double, double>, double);
  80         void set_editor (std::pair<double, double>, std::pair<double, double>);
  81         void set_editor_x (double);
  82         void set_editor_x (std::pair<double, double>);
  83         void set_editor_y (double);
  84         void set_editor_y (std::pair<double, double>);
  85         void playhead_position_changed (framepos_t);
  86         double summary_y_to_editor (double) const;
  87         double editor_y_to_summary (double) const;
  88         Position get_position (double, double) const;
  89         void set_cursor (Position);
  90         void route_gui_changed (std::string);
  91         bool suspending_editor_updates () const;
  92         double playhead_frame_to_position (framepos_t) const;
  93         framepos_t position_to_playhead_frame_to_position (double pos) const;
  94         void set_overlays_dirty (int, int, int, int);
  95
  96         framepos_t _start; ///< start frame of the overview
  97         framepos_t _end; ///< end frame of the overview
  98
  99         /** fraction of the session length by which the overview size should extend past the start and end markers */
 100         double _overhang_fraction;
 101
 102         double _x_scale; ///< pixels per frame for the x axis of the pixmap
 103         double _track_height;
 104         double _last_playhead;
 105
 106         std::pair<double, double> _start_editor_x;
 107         std::pair<double, double> _start_editor_y;
 108         double _start_mouse_x;
 109         double _start_mouse_y;
 110
 111         Position _start_position;
 112
 113         bool _move_dragging;
 114         bool _moved;
 115         std::pair<double, double> _view_rectangle_x;
 116         std::pair<double, double> _view_rectangle_y;
 117
 118         std::pair<double, double> _pending_editor_x;
 119         std::pair<double, double> _pending_editor_y;
 120         bool _pending_editor_changed;
 121
 122         bool _zoom_dragging;
 123         Position _zoom_position;
 124
 125         bool _old_follow_playhead;
 126         cairo_surface_t* _image;
 127         void render_background_image ();
 128         bool _background_dirty;
 129
 130         PBD::ScopedConnectionList position_connection;
 131         PBD::ScopedConnection route_ctrl_id_connection;
 132         PBD::ScopedConnectionList region_property_connection;
 133 };
 134
 135 #endif