2 Copyright (C) 2009 Paul Davis
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.
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.
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.
20 #ifndef __gtk2_ardour_editor_drag_h_
21 #define __gtk2_ardour_editor_drag_h_
28 #include "ardour/types.h"
31 #include "editor_items.h"
38 class StatefulDiffCommand
;
43 class CanvasNoteEvent
;
44 class CanvasPatchChange
;
51 class MidiTimeAxisView
;
54 /** Class to manage current drags */
59 DragManager (Editor
* e
);
62 bool motion_handler (GdkEvent
*, bool);
66 void set (Drag
*, GdkEvent
*, Gdk::Cursor
* c
= 0);
67 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
68 bool end_grab (GdkEvent
*);
69 bool have_item (ArdourCanvas::Item
*) const;
71 /** @return true if an end drag or abort is in progress */
72 bool ending () const {
76 bool active () const {
77 return !_drags
.empty ();
80 /** @return current pointer x position in trackview coordinates */
81 double current_pointer_x () const {
82 return _current_pointer_x
;
85 /** @return current pointer y position in trackview coordinates */
86 double current_pointer_y () const {
87 return _current_pointer_y
;
90 /** @return current pointer frame */
91 ARDOUR::framepos_t
current_pointer_frame () const {
92 return _current_pointer_frame
;
97 std::list
<Drag
*> _drags
;
98 bool _ending
; ///< true if end_grab or abort is in progress, otherwise false
99 double _current_pointer_x
; ///< trackview x of the current pointer
100 double _current_pointer_y
; ///< trackview y of the current pointer
101 ARDOUR::framepos_t _current_pointer_frame
; ///< frame that the pointer is now at
102 bool _old_follow_playhead
; ///< state of Editor::follow_playhead() before the drags started
105 /** Abstract base class for dragging of things within the editor */
109 Drag (Editor
*, ArdourCanvas::Item
*);
112 void set_manager (DragManager
* m
) {
116 /** @return the canvas item being dragged */
117 ArdourCanvas::Item
* item () const {
121 void swap_grab (ArdourCanvas::Item
*, Gdk::Cursor
*, uint32_t);
122 bool motion_handler (GdkEvent
*, bool);
125 ARDOUR::framepos_t
adjusted_frame (ARDOUR::framepos_t
, GdkEvent
const *, bool snap
= true) const;
126 ARDOUR::framepos_t
adjusted_current_frame (GdkEvent
const *, bool snap
= true) const;
128 /** Called to start a grab of an item.
129 * @param e Event that caused the grab to start.
130 * @param c Cursor to use, or 0.
132 virtual void start_grab (GdkEvent
* e
, Gdk::Cursor
* c
= 0);
134 virtual bool end_grab (GdkEvent
*);
136 /** Called when a drag motion has occurred.
137 * @param e Event describing the motion.
138 * @param f true if this is the first movement, otherwise false.
140 virtual void motion (GdkEvent
* e
, bool f
) = 0;
142 /** Called when a drag has finished.
143 * @param e Event describing the finish.
144 * @param m true if some movement occurred, otherwise false.
146 virtual void finished (GdkEvent
* e
, bool m
) = 0;
148 /** Called to abort a drag and return things to how
149 * they were before it started.
150 * @param m true if some movement occurred, otherwise false.
152 virtual void aborted (bool m
) = 0;
154 /** @param m Mouse mode.
155 * @return true if this drag should happen in this mouse mode.
157 virtual bool active (Editing::MouseMode m
) {
158 return (m
!= Editing::MouseGain
);
161 /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
162 virtual std::pair
<ARDOUR::framecnt_t
, int> move_threshold () const {
163 return std::make_pair (1, 1);
166 virtual bool allow_vertical_autoscroll () const {
170 /** @return true if x movement matters to this drag */
171 virtual bool x_movement_matters () const {
175 /** @return true if y movement matters to this drag */
176 virtual bool y_movement_matters () const {
180 /** Set up the _pointer_frame_offset */
181 virtual void setup_pointer_frame_offset () {
182 _pointer_frame_offset
= 0;
187 double grab_x () const {
191 double grab_y () const {
195 ARDOUR::framepos_t
raw_grab_frame () const {
196 return _raw_grab_frame
;
199 ARDOUR::framepos_t
grab_frame () const {
203 double last_pointer_x () const {
204 return _last_pointer_x
;
207 double last_pointer_y () const {
208 return _last_pointer_y
;
211 double last_pointer_frame () const {
212 return _last_pointer_frame
;
215 void show_verbose_cursor_time (framepos_t
);
216 void show_verbose_cursor_duration (framepos_t
, framepos_t
, double xoffset
= 0);
217 void show_verbose_cursor_text (std::string
const &);
219 Editor
* _editor
; ///< our editor
221 ArdourCanvas::Item
* _item
; ///< our item
222 /** Offset from the mouse's position for the drag to the start of the thing that is being dragged */
223 ARDOUR::framecnt_t _pointer_frame_offset
;
224 bool _x_constrained
; ///< true if x motion is constrained, otherwise false
225 bool _y_constrained
; ///< true if y motion is constrained, otherwise false
226 bool _was_rolling
; ///< true if the session was rolling before the drag started, otherwise false
230 bool _move_threshold_passed
; ///< true if the move threshold has been passed, otherwise false
231 double _grab_x
; ///< trackview x of the grab start position
232 double _grab_y
; ///< trackview y of the grab start position
233 double _last_pointer_x
; ///< trackview x of the pointer last time a motion occurred
234 double _last_pointer_y
; ///< trackview y of the pointer last time a motion occurred
235 ARDOUR::framepos_t _raw_grab_frame
; ///< unsnapped frame that the mouse was at when start_grab was called, or 0
236 ARDOUR::framepos_t _grab_frame
; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
237 ARDOUR::framepos_t _last_pointer_frame
; ///< adjusted_frame the last time a motion occurred
242 /** Container for details about a region being dragged */
245 DraggingView (RegionView
*, RegionDrag
*);
247 RegionView
* view
; ///< the view
248 /** index into RegionDrag::_time_axis_views of the view that this region is currently beind displayed on */
250 /** layer that this region is currently being displayed on */
251 ARDOUR::layer_t layer
;
252 double initial_y
; ///< the initial y position of the view before any reparenting
253 framepos_t initial_position
; ///< initial position of the region
254 framepos_t initial_end
; ///< initial end position of the region
255 boost::shared_ptr
<ARDOUR::Playlist
> initial_playlist
;
258 /** Abstract base class for drags that involve region(s) */
259 class RegionDrag
: public Drag
, public sigc::trackable
262 RegionDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &);
263 virtual ~RegionDrag () {}
267 RegionView
* _primary
; ///< the view that was clicked on (or whatever) to start the drag
268 std::list
<DraggingView
> _views
; ///< information about all views that are being dragged
270 /** a list of the non-hidden TimeAxisViews sorted by editor order key */
271 std::vector
<TimeAxisView
*> _time_axis_views
;
272 int find_time_axis_view (TimeAxisView
*) const;
277 friend class DraggingView
;
281 void region_going_away (RegionView
*);
282 PBD::ScopedConnection death_connection
;
286 /** Drags involving region motion from somewhere */
287 class RegionMotionDrag
: public RegionDrag
291 RegionMotionDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &, bool);
292 virtual ~RegionMotionDrag () {}
294 virtual void start_grab (GdkEvent
*, Gdk::Cursor
*);
295 virtual void motion (GdkEvent
*, bool);
296 virtual void finished (GdkEvent
*, bool) = 0;
297 virtual void aborted (bool);
299 /** @return true if the regions being `moved' came from somewhere on the canvas;
300 * false if they came from outside (e.g. from the region list).
302 virtual bool regions_came_from_canvas () const = 0;
306 double compute_x_delta (GdkEvent
const *, ARDOUR::framecnt_t
*);
307 bool y_movement_allowed (int, ARDOUR::layer_t
) const;
310 ARDOUR::framepos_t _last_frame_position
; ///< last position of the thing being dragged
311 double _total_x_delta
;
312 int _last_pointer_time_axis_view
;
313 ARDOUR::layer_t _last_pointer_layer
;
317 /** Drags to move (or copy) regions that are already shown in the GUI to
318 * somewhere different.
320 class RegionMoveDrag
: public RegionMotionDrag
323 RegionMoveDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &, bool, bool);
324 virtual ~RegionMoveDrag () {}
326 void motion (GdkEvent
*, bool);
327 void finished (GdkEvent
*, bool);
330 bool regions_came_from_canvas () const {
334 std::pair
<ARDOUR::framecnt_t
, int> move_threshold () const {
335 return std::make_pair (4, 4);
338 void setup_pointer_frame_offset ();
341 typedef std::set
<boost::shared_ptr
<ARDOUR::Playlist
> > PlaylistSet
;
343 void finished_no_copy (
346 ARDOUR::framecnt_t
const
352 ARDOUR::framecnt_t
const
355 RegionView
* insert_region_into_playlist (
356 boost::shared_ptr
<ARDOUR::Region
>,
363 void remove_region_from_playlist (
364 boost::shared_ptr
<ARDOUR::Region
>,
365 boost::shared_ptr
<ARDOUR::Playlist
>,
366 PlaylistSet
& modified_playlists
369 void add_stateful_diff_commands_for_playlists (PlaylistSet
const &);
371 void collect_new_region_view (RegionView
*);
374 RegionView
* _new_region_view
;
377 /** Drag to insert a region from somewhere */
378 class RegionInsertDrag
: public RegionMotionDrag
381 RegionInsertDrag (Editor
*, boost::shared_ptr
<ARDOUR::Region
>, RouteTimeAxisView
*, ARDOUR::framepos_t
);
383 void finished (GdkEvent
*, bool);
386 bool regions_came_from_canvas () const {
391 /** Region drag in splice mode */
392 class RegionSpliceDrag
: public RegionMoveDrag
395 RegionSpliceDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &);
397 void motion (GdkEvent
*, bool);
398 void finished (GdkEvent
*, bool);
402 /** Drags to create regions */
403 class RegionCreateDrag
: public Drag
406 RegionCreateDrag (Editor
*, ArdourCanvas::Item
*, TimeAxisView
*);
408 void motion (GdkEvent
*, bool);
409 void finished (GdkEvent
*, bool);
413 MidiTimeAxisView
* _view
;
414 boost::shared_ptr
<ARDOUR::Region
> _region
;
418 /** Drags to resize MIDI notes */
419 class NoteResizeDrag
: public Drag
422 NoteResizeDrag (Editor
*, ArdourCanvas::Item
*);
424 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
425 void motion (GdkEvent
*, bool);
426 void finished (GdkEvent
*, bool);
430 MidiRegionView
* region
;
435 /** Drags to move MIDI notes */
436 class NoteDrag
: public Drag
439 NoteDrag (Editor
*, ArdourCanvas::Item
*);
441 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
442 void motion (GdkEvent
*, bool);
443 void finished (GdkEvent
*, bool);
448 ARDOUR::frameoffset_t
total_dx () const;
449 int8_t total_dy () const;
451 MidiRegionView
* _region
;
452 Gnome::Canvas::CanvasNoteEvent
* _primary
;
453 double _cumulative_dx
;
454 double _cumulative_dy
;
459 /** Drag to move MIDI patch changes */
460 class PatchChangeDrag
: public Drag
463 PatchChangeDrag (Editor
*, ArdourCanvas::CanvasPatchChange
*, MidiRegionView
*);
465 void motion (GdkEvent
*, bool);
466 void finished (GdkEvent
*, bool);
469 bool y_movement_matters () const {
473 void setup_pointer_frame_offset ();
476 MidiRegionView
* _region_view
;
477 ArdourCanvas::CanvasPatchChange
* _patch_change
;
478 double _cumulative_dx
;
481 /** Drag of region gain */
482 class RegionGainDrag
: public Drag
485 RegionGainDrag (Editor
*, ArdourCanvas::Item
*);
487 void motion (GdkEvent
*, bool);
488 void finished (GdkEvent
*, bool);
489 bool active (Editing::MouseMode m
) {
490 return (m
== Editing::MouseGain
);
496 /** Drag to trim region(s) */
497 class TrimDrag
: public RegionDrag
506 TrimDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &);
508 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
509 void motion (GdkEvent
*, bool);
510 void finished (GdkEvent
*, bool);
513 bool y_movement_matters () const {
517 void setup_pointer_frame_offset ();
521 Operation _operation
;
524 /** Meter marker drag */
525 class MeterMarkerDrag
: public Drag
528 MeterMarkerDrag (Editor
*, ArdourCanvas::Item
*, bool);
530 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
531 void motion (GdkEvent
*, bool);
532 void finished (GdkEvent
*, bool);
535 bool allow_vertical_autoscroll () const {
539 bool y_movement_matters () const {
543 void setup_pointer_frame_offset ();
546 MeterMarker
* _marker
;
550 /** Tempo marker drag */
551 class TempoMarkerDrag
: public Drag
554 TempoMarkerDrag (Editor
*, ArdourCanvas::Item
*, bool);
556 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
557 void motion (GdkEvent
*, bool);
558 void finished (GdkEvent
*, bool);
561 bool allow_vertical_autoscroll () const {
565 bool y_movement_matters () const {
569 void setup_pointer_frame_offset ();
572 TempoMarker
* _marker
;
577 /** Drag of the playhead cursor */
578 class CursorDrag
: public Drag
581 CursorDrag (Editor
*, ArdourCanvas::Item
*, bool);
583 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
584 void motion (GdkEvent
*, bool);
585 void finished (GdkEvent
*, bool);
588 bool active (Editing::MouseMode
) {
592 bool allow_vertical_autoscroll () const {
596 bool y_movement_matters () const {
601 void fake_locate (framepos_t
);
603 bool _stop
; ///< true to stop the transport on starting the drag, otherwise false
604 double _grab_zoom
; ///< editor frames per unit when our grab started
607 /** Region fade-in drag */
608 class FadeInDrag
: public RegionDrag
611 FadeInDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &);
613 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
614 void motion (GdkEvent
*, bool);
615 void finished (GdkEvent
*, bool);
618 bool y_movement_matters () const {
622 void setup_pointer_frame_offset ();
625 /** Region fade-out drag */
626 class FadeOutDrag
: public RegionDrag
629 FadeOutDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &);
631 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
632 void motion (GdkEvent
*, bool);
633 void finished (GdkEvent
*, bool);
636 bool y_movement_matters () const {
640 void setup_pointer_frame_offset ();
644 class MarkerDrag
: public Drag
647 MarkerDrag (Editor
*, ArdourCanvas::Item
*);
650 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
651 void motion (GdkEvent
*, bool);
652 void finished (GdkEvent
*, bool);
655 bool allow_vertical_autoscroll () const {
659 bool y_movement_matters () const {
663 void setup_pointer_frame_offset ();
666 void update_item (ARDOUR::Location
*);
668 Marker
* _marker
; ///< marker being dragged
669 std::list
<ARDOUR::Location
*> _copied_locations
;
670 ArdourCanvas::Points _points
;
673 /** Control point drag */
674 class ControlPointDrag
: public Drag
677 ControlPointDrag (Editor
*, ArdourCanvas::Item
*);
679 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
680 void motion (GdkEvent
*, bool);
681 void finished (GdkEvent
*, bool);
684 bool active (Editing::MouseMode m
);
688 ControlPoint
* _point
;
689 double _fixed_grab_x
;
690 double _fixed_grab_y
;
691 double _cumulative_x_drag
;
692 double _cumulative_y_drag
;
693 static double const _zero_gain_fraction
;
696 /** Gain or automation line drag */
697 class LineDrag
: public Drag
700 LineDrag (Editor
*e
, ArdourCanvas::Item
*i
);
702 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
703 void motion (GdkEvent
*, bool);
704 void finished (GdkEvent
*, bool);
707 bool active (Editing::MouseMode
) {
713 AutomationLine
* _line
;
714 double _fixed_grab_x
;
715 double _fixed_grab_y
;
718 double _cumulative_y_drag
;
721 /** Transient feature line drags*/
722 class FeatureLineDrag
: public Drag
725 FeatureLineDrag (Editor
*e
, ArdourCanvas::Item
*i
);
727 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
728 void motion (GdkEvent
*, bool);
729 void finished (GdkEvent
*, bool);
732 bool active (Editing::MouseMode
) {
738 ArdourCanvas::Line
* _line
;
739 AudioRegionView
* _arv
;
741 double _region_view_grab_x
;
742 double _cumulative_x_drag
;
748 /** Dragging of a rubberband rectangle for selecting things */
749 class RubberbandSelectDrag
: public Drag
752 RubberbandSelectDrag (Editor
*, ArdourCanvas::Item
*);
754 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
755 void motion (GdkEvent
*, bool);
756 void finished (GdkEvent
*, bool);
759 std::pair
<ARDOUR::framecnt_t
, int> move_threshold () const {
760 return std::make_pair (8, 1);
764 /** Region drag in time-FX mode */
765 class TimeFXDrag
: public RegionDrag
768 TimeFXDrag (Editor
*, ArdourCanvas::Item
*, RegionView
*, std::list
<RegionView
*> const &);
770 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
771 void motion (GdkEvent
*, bool);
772 void finished (GdkEvent
*, bool);
776 /** Scrub drag in audition mode */
777 class ScrubDrag
: public Drag
780 ScrubDrag (Editor
*, ArdourCanvas::Item
*);
782 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
783 void motion (GdkEvent
*, bool);
784 void finished (GdkEvent
*, bool);
788 /** Drag in range select mode */
789 class SelectionDrag
: public Drag
799 SelectionDrag (Editor
*, ArdourCanvas::Item
*, Operation
);
801 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
802 void motion (GdkEvent
*, bool);
803 void finished (GdkEvent
*, bool);
806 void setup_pointer_frame_offset ();
809 Operation _operation
;
811 int _original_pointer_time_axis
;
812 int _last_pointer_time_axis
;
813 std::list
<TimeAxisView
*> _added_time_axes
;
816 /** Range marker drag */
817 class RangeMarkerBarDrag
: public Drag
822 CreateTransportMarker
,
826 RangeMarkerBarDrag (Editor
*, ArdourCanvas::Item
*, Operation
);
828 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
829 void motion (GdkEvent
*, bool);
830 void finished (GdkEvent
*, bool);
833 bool allow_vertical_autoscroll () const {
837 bool y_movement_matters () const {
842 void update_item (ARDOUR::Location
*);
844 Operation _operation
;
845 ArdourCanvas::SimpleRect
* _drag_rect
;
849 /** Drag of rectangle to set zoom */
850 class MouseZoomDrag
: public Drag
853 MouseZoomDrag (Editor
*, ArdourCanvas::Item
*);
855 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
856 void motion (GdkEvent
*, bool);
857 void finished (GdkEvent
*, bool);
860 std::pair
<ARDOUR::framecnt_t
, int> move_threshold () const {
861 return std::make_pair (4, 4);
868 /** Drag of a range of automation data, changing value but not position */
869 class AutomationRangeDrag
: public Drag
872 AutomationRangeDrag (Editor
*, ArdourCanvas::Item
*, std::list
<ARDOUR::AudioRange
> const &);
874 void start_grab (GdkEvent
*, Gdk::Cursor
* c
= 0);
875 void motion (GdkEvent
*, bool);
876 void finished (GdkEvent
*, bool);
879 bool x_movement_matters () const {
884 std::list
<ARDOUR::AudioRange
> _ranges
;
885 AutomationTimeAxisView
* _atav
;
887 /** A line that is part of the drag */
889 boost::shared_ptr
<AutomationLine
> line
; ///< the line
890 std::list
<ControlPoint
*> points
; ///< points to drag on the line
891 std::pair
<ARDOUR::framepos_t
, ARDOUR::framepos_t
> range
; ///< the range of all points on the line, in session frames
892 XMLNode
* state
; ///< the XML state node before the drag
895 std::list
<Line
> _lines
;
897 bool _nothing_to_drag
;
900 #endif /* __gtk2_ardour_editor_drag_h_ */