Fix fader jumps when releasing button 2 on drags; move to mouse position on button...
[ardour.git] / libs / gtkmm2ext / pixfader.cc
1 /*
2     Copyright (C) 2006 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     $Id: fastmeter.h 570 2006-06-07 21:21:21Z sampo $
19 */
20
21
22 #include <iostream>
23 #include "gtkmm2ext/pixfader.h"
24 #include "gtkmm2ext/keyboard.h"
25
26 using namespace Gtkmm2ext;
27 using namespace Gtk;
28 using namespace Gdk;
29 using namespace std;
30
31
32 int PixFader::fine_scale_modifier = Keyboard::PrimaryModifier;
33 int PixFader::extra_fine_scale_modifier = Keyboard::SecondaryModifier;
34
35 PixFader::PixFader (Glib::RefPtr<Pixbuf> belt, Gtk::Adjustment& adj, int orientation, int fader_length)
36
37         : adjustment (adj),
38           pixbuf (belt),
39           _orien(orientation)
40 {
41         dragging = false;
42         default_value = adjustment.get_value();
43         last_drawn = -1;
44
45         view.x = 0;
46         view.y = 0;
47
48         if (orientation == VERT) {
49                 view.width = girth = pixbuf->get_width();
50         } else {
51                 view.height = girth = pixbuf->get_height();
52         }
53
54         set_fader_length (fader_length);
55
56         add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK|Gdk::SCROLL_MASK|Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK);
57
58         adjustment.signal_value_changed().connect (mem_fun (*this, &PixFader::adjustment_changed));
59         adjustment.signal_changed().connect (mem_fun (*this, &PixFader::adjustment_changed));
60 }
61
62 PixFader::~PixFader ()
63 {
64 }
65
66 bool
67 PixFader::on_expose_event (GdkEventExpose* ev)
68 {
69         GdkRectangle intersection;
70         int srcx, srcy;
71
72         int const ds = display_span ();
73
74         int offset_into_pixbuf = (int) floor (span / ((float) span / ds));
75
76         /* account for fader lengths that are shorter than the fader pixbuf */
77         if (_orien == VERT) {
78                 offset_into_pixbuf += pixbuf->get_height() / 2 - view.height;
79         } else {
80                 offset_into_pixbuf += pixbuf->get_width() / 2 - view.width;
81         }
82         
83         Glib::RefPtr<Gdk::GC> fg_gc (get_style()->get_fg_gc(get_state()));
84
85         if (gdk_rectangle_intersect (&view, &ev->area, &intersection)) {
86                 if (_orien == VERT) {
87                         srcx = intersection.x;
88                         srcy = offset_into_pixbuf + intersection.y;
89                 } else {
90                         srcx = offset_into_pixbuf + intersection.x;
91                         srcy = intersection.y;
92                 }
93                 get_window()->draw_pixbuf (fg_gc, pixbuf, 
94                                            srcx, srcy,
95                                            intersection.x, intersection.y,
96                                            intersection.width, intersection.height,
97                                            Gdk::RGB_DITHER_NONE, 0, 0);
98                 
99                 get_window()->draw_line (get_style()->get_bg_gc(STATE_ACTIVE), 0, 0, view.width - 1, 0); /* top */
100                 get_window()->draw_line (get_style()->get_bg_gc(STATE_ACTIVE), 0, 0, 0, view.height - 1); /* left */
101                 get_window()->draw_line (get_style()->get_bg_gc(STATE_NORMAL), view.width - 1, 0, view.width - 1, view.height - 1); /* right */
102                 get_window()->draw_line (get_style()->get_bg_gc(STATE_NORMAL), 0, view.height - 1, view.width - 1, view.height - 1); /* bottom */
103         }
104
105         /* always draw the line */
106         if (_orien == VERT) {
107                 get_window()->draw_line (fg_gc, 1, unity_loc, girth - 2, unity_loc);
108         } else {
109                 get_window()->draw_line (fg_gc, unity_loc, 1, unity_loc, girth - 2);
110         }
111         last_drawn = ds;
112         return true;
113 }
114
115 void
116 PixFader::on_size_request (GtkRequisition* req)
117 {
118         req->width = view.width;
119         req->height = view.height;
120 }
121
122 bool
123 PixFader::on_button_press_event (GdkEventButton* ev)
124 {
125         if (ev->type != GDK_BUTTON_PRESS) {
126                 return false;
127         }
128
129         if (ev->button != 1 && ev->button != 2) {
130                 return false;
131         }
132
133         add_modal_grab ();
134         grab_loc = (_orien == VERT) ? ev->y : ev->x;
135         grab_start = (_orien == VERT) ? ev->y : ev->x;
136         grab_window = ev->window;
137         dragging = true;
138
139         if (ev->button == 2) {
140                 set_adjustment_from_event (ev);
141         }
142         
143         return true;
144 }
145
146 bool
147 PixFader::on_button_release_event (GdkEventButton* ev)
148 {
149         double const ev_pos = (_orien == VERT) ? ev->y : ev->x;
150         
151         switch (ev->button) {
152         case 1:
153                 if (dragging) {
154                         remove_modal_grab();
155                         dragging = false;
156
157                         if (ev_pos == grab_start) {
158
159                                 /* no motion - just a click */
160
161                                 if (ev->state & Keyboard::TertiaryModifier) {
162                                         adjustment.set_value (default_value);
163                                 } else if (ev->state & fine_scale_modifier) {
164                                         adjustment.set_value (adjustment.get_lower());
165                                 } else if ((_orien == VERT && ev_pos < span - display_span()) || (_orien == HORIZ && ev_pos > span - display_span())) {
166                                         /* above the current display height, remember X Window coords */
167                                         adjustment.set_value (adjustment.get_value() + adjustment.get_step_increment());
168                                 } else {
169                                         adjustment.set_value (adjustment.get_value() - adjustment.get_step_increment());
170                                 }
171                         }
172
173                 } 
174                 break;
175                 
176         case 2:
177                 if (dragging) {
178                         remove_modal_grab();
179                         dragging = false;
180                         set_adjustment_from_event (ev);
181                 }
182                 break;
183
184         default:
185                 break;
186         }
187
188         return false;
189 }
190
191 bool
192 PixFader::on_scroll_event (GdkEventScroll* ev)
193 {
194         double scale;
195         bool ret = false;
196
197         if (ev->state & fine_scale_modifier) {
198                 if (ev->state & extra_fine_scale_modifier) {
199                         scale = 0.01;
200                 } else {
201                         scale = 0.05;
202                 }
203         } else {
204                 scale = 0.25;
205         }
206
207         if (_orien == VERT) {
208
209                 /* should left/right scroll affect vertical faders ? */
210
211                 switch (ev->direction) {
212
213                 case GDK_SCROLL_UP:
214                         adjustment.set_value (adjustment.get_value() + (adjustment.get_page_increment() * scale));
215                         ret = true;
216                         break;
217                 case GDK_SCROLL_DOWN:
218                         adjustment.set_value (adjustment.get_value() - (adjustment.get_page_increment() * scale));
219                         ret = true;
220                         break;
221                 default:
222                         break;
223                 }
224         } else {
225
226                 /* up/down scrolls should definitely affect horizontal faders
227                    because they are so much easier to use
228                 */
229
230                 switch (ev->direction) {
231
232                 case GDK_SCROLL_RIGHT:
233                 case GDK_SCROLL_UP:
234                         adjustment.set_value (adjustment.get_value() + (adjustment.get_page_increment() * scale));
235                         ret = true;
236                         break;
237                 case GDK_SCROLL_LEFT:
238                 case GDK_SCROLL_DOWN:
239                         adjustment.set_value (adjustment.get_value() - (adjustment.get_page_increment() * scale));
240                         ret = true;
241                         break;
242                 default:
243                         break;
244                 }
245         }
246         return ret;
247 }
248
249 bool
250 PixFader::on_motion_notify_event (GdkEventMotion* ev)
251 {
252         if (dragging) {
253                 double scale = 1.0;
254                 double const ev_pos = (_orien == VERT) ? ev->y : ev->x;
255                 
256                 if (ev->window != grab_window) {
257                         grab_loc = ev_pos;
258                         grab_window = ev->window;
259                         return true;
260                 }
261                 
262                 if (ev->state & fine_scale_modifier) {
263                         if (ev->state & extra_fine_scale_modifier) {
264                                 scale = 0.05;
265                         } else {
266                                 scale = 0.1;
267                         }
268                 }
269
270                 double const delta = ev_pos - grab_loc;
271                 grab_loc = ev_pos;
272
273                 double fract = (delta / span);
274
275                 fract = min (1.0, fract);
276                 fract = max (-1.0, fract);
277
278                 // X Window is top->bottom for 0..Y
279                 
280                 if (_orien == VERT) {
281                         fract = -fract;
282                 }
283
284                 adjustment.set_value (adjustment.get_value() + scale * fract * (adjustment.get_upper() - adjustment.get_lower()));
285         }
286
287         return true;
288 }
289
290 void
291 PixFader::adjustment_changed ()
292 {
293         if (display_span() != last_drawn) {
294                 queue_draw ();
295         }
296 }
297
298 /** @return pixel offset of the current value from the right or bottom of the fader */
299 int
300 PixFader::display_span ()
301 {
302         float fract = (adjustment.get_upper() - adjustment.get_value ()) / ((adjustment.get_upper() - adjustment.get_lower()));
303         return (_orien == VERT) ? (int)floor (span * (1.0 - fract)) : (int)floor (span * fract);
304 }
305
306 void
307 PixFader::set_fader_length (int l)
308 {
309         if (_orien == VERT) {
310                 view.height = span = l;
311                 unity_loc = (int) rint (view.height - (default_value * view.height)) - 1;
312         } else {
313                 view.width = span = l;
314                 unity_loc = (int) rint (default_value * view.width) - 1;
315         }
316
317         queue_draw ();
318 }
319
320 bool
321 PixFader::on_enter_notify_event (GdkEventCrossing*)
322 {
323         Keyboard::magic_widget_grab_focus ();
324         return false;
325 }
326
327 bool
328 PixFader::on_leave_notify_event (GdkEventCrossing*)
329 {
330         Keyboard::magic_widget_drop_focus();
331         return false;
332 }
333
334 void
335 PixFader::set_adjustment_from_event (GdkEventButton* ev)
336 {
337         double fract = (_orien == VERT) ? (1.0 - (ev->y / span)) : (ev->x / span);
338
339         fract = min (1.0, fract);
340         fract = max (0.0, fract);
341
342         adjustment.set_value (fract * (adjustment.get_upper () - adjustment.get_lower ()));
343 }