Don't redraw the summary every time the playhead moves (if it hasn't moved visibly...
[ardour.git] / 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
40         void set_session (ARDOUR::Session *);
41         void set_overlays_dirty ();
42         void routes_added (std::list<RouteTimeAxisView*> const &);
43
44 private:
45
46         enum Position {
47                 LEFT,
48                 LEFT_TOP,
49                 TOP,
50                 RIGHT_TOP,
51                 RIGHT,
52                 RIGHT_BOTTOM,
53                 BOTTOM,
54                 LEFT_BOTTOM,
55                 INSIDE,
56                 BELOW_OR_ABOVE,
57                 TO_LEFT_OR_RIGHT,
58                 OTHERWISE_OUTSIDE
59         };
60
61         bool on_expose_event (GdkEventExpose *);
62         void on_size_request (Gtk::Requisition *);
63         bool on_button_press_event (GdkEventButton *);
64         bool on_button_release_event (GdkEventButton *);
65         bool on_motion_notify_event (GdkEventMotion *);
66         bool on_scroll_event (GdkEventScroll *);
67
68         void centre_on_click (GdkEventButton *);
69         void render (cairo_t *);
70         void render_region (RegionView*, cairo_t*, double) const;
71         void get_editor (std::pair<double, double> *, std::pair<double, double> *) const;
72         void set_editor (double, double);
73         void set_editor (std::pair<double, double>, double);
74         void set_editor (std::pair<double, double>, std::pair<double, double>);
75         void set_editor_x (double);
76         void set_editor_x (std::pair<double, double>);
77         void set_editor_y (double);
78         void set_editor_y (std::pair<double, double>);
79         void playhead_position_changed (framepos_t);
80         double summary_y_to_editor (double) const;
81         double editor_y_to_summary (double) const;
82         Position get_position (double, double) const;
83         void set_cursor (Position);
84         void route_gui_changed (std::string);
85         bool suspending_editor_updates () const;
86         double playhead_frame_to_position (framepos_t) const;
87         void set_overlays_dirty (int, int, int, int);
88
89         framepos_t _start; ///< start frame of the overview
90         framepos_t _end; ///< end frame of the overview
91
92         /** fraction of the session length by which the overview size should extend past the start and end markers */
93         double _overhang_fraction;
94
95         double _x_scale; ///< pixels per frame for the x axis of the pixmap
96         double _track_height;
97         double _last_playhead;
98
99         std::pair<double, double> _start_editor_x;
100         std::pair<double, double> _start_editor_y;
101         double _start_mouse_x;
102         double _start_mouse_y;
103
104         Position _start_position;
105
106         bool _move_dragging;
107         bool _moved;
108         std::pair<double, double> _view_rectangle_x;
109         std::pair<double, double> _view_rectangle_y;
110
111         std::pair<double, double> _pending_editor_x;
112         std::pair<double, double> _pending_editor_y;
113         bool _pending_editor_changed;
114
115         bool _zoom_dragging;
116         Position _zoom_position;
117
118         bool _old_follow_playhead;
119
120         PBD::ScopedConnectionList position_connection;
121         PBD::ScopedConnectionList region_property_connection;
122 };
123
124 #endif