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 Editor* _editor; ///< our editor
217 ArdourCanvas::Item* _item; ///< our item
218 /** Offset from the mouse's position for the drag to the start of the thing that is being dragged */
219 ARDOUR::framecnt_t _pointer_frame_offset;
220 bool _x_constrained; ///< true if x motion is constrained, otherwise false
221 bool _y_constrained; ///< true if y motion is constrained, otherwise false
222 bool _was_rolling; ///< true if the session was rolling before the drag started, otherwise false
226 bool _move_threshold_passed; ///< true if the move threshold has been passed, otherwise false
227 double _grab_x; ///< trackview x of the grab start position
228 double _grab_y; ///< trackview y of the grab start position
229 double _last_pointer_x; ///< trackview x of the pointer last time a motion occurred
230 double _last_pointer_y; ///< trackview y of the pointer last time a motion occurred
231 ARDOUR::framepos_t _raw_grab_frame; ///< unsnapped frame that the mouse was at when start_grab was called, or 0
232 ARDOUR::framepos_t _grab_frame; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
233 ARDOUR::framepos_t _last_pointer_frame; ///< adjusted_frame the last time a motion occurred
238 /** Container for details about a region being dragged */
241 DraggingView (RegionView *, RegionDrag *);
243 RegionView* view; ///< the view
244 /** index into RegionDrag::_time_axis_views of the view that this region is currently beind displayed on */
246 /** layer that this region is currently being displayed on */
247 ARDOUR::layer_t layer;
248 double initial_y; ///< the initial y position of the view before any reparenting
249 framepos_t initial_position; ///< initial position of the region
250 framepos_t initial_end; ///< initial end position of the region
251 boost::shared_ptr<ARDOUR::Playlist> initial_playlist;
254 /** Abstract base class for drags that involve region(s) */
255 class RegionDrag : public Drag, public sigc::trackable
258 RegionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
259 virtual ~RegionDrag () {}
263 RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
264 std::list<DraggingView> _views; ///< information about all views that are being dragged
266 /** a list of the non-hidden TimeAxisViews sorted by editor order key */
267 std::vector<TimeAxisView*> _time_axis_views;
268 int find_time_axis_view (TimeAxisView *) const;
273 friend class DraggingView;
277 void region_going_away (RegionView *);
278 PBD::ScopedConnection death_connection;
282 /** Drags involving region motion from somewhere */
283 class RegionMotionDrag : public RegionDrag
287 RegionMotionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool);
288 virtual ~RegionMotionDrag () {}
290 virtual void start_grab (GdkEvent *, Gdk::Cursor *);
291 virtual void motion (GdkEvent *, bool);
292 virtual void finished (GdkEvent *, bool) = 0;
293 virtual void aborted (bool);
295 /** @return true if the regions being `moved' came from somewhere on the canvas;
296 * false if they came from outside (e.g. from the region list).
298 virtual bool regions_came_from_canvas () const = 0;
302 double compute_x_delta (GdkEvent const *, ARDOUR::framecnt_t *);
303 bool y_movement_allowed (int, ARDOUR::layer_t) const;
306 ARDOUR::framepos_t _last_frame_position; ///< last position of the thing being dragged
307 double _total_x_delta;
308 int _last_pointer_time_axis_view;
309 ARDOUR::layer_t _last_pointer_layer;
313 /** Drags to move (or copy) regions that are already shown in the GUI to
314 * somewhere different.
316 class RegionMoveDrag : public RegionMotionDrag
319 RegionMoveDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, bool);
320 virtual ~RegionMoveDrag () {}
322 void motion (GdkEvent *, bool);
323 void finished (GdkEvent *, bool);
326 bool regions_came_from_canvas () const {
330 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
331 return std::make_pair (4, 4);
334 void setup_pointer_frame_offset ();
337 typedef std::set<boost::shared_ptr<ARDOUR::Playlist> > PlaylistSet;
339 void finished_no_copy (
342 ARDOUR::framecnt_t const
348 ARDOUR::framecnt_t const
351 RegionView* insert_region_into_playlist (
352 boost::shared_ptr<ARDOUR::Region>,
359 void remove_region_from_playlist (
360 boost::shared_ptr<ARDOUR::Region>,
361 boost::shared_ptr<ARDOUR::Playlist>,
362 PlaylistSet& modified_playlists
365 void add_stateful_diff_commands_for_playlists (PlaylistSet const &);
367 void collect_new_region_view (RegionView *);
370 RegionView* _new_region_view;
373 /** Drag to insert a region from somewhere */
374 class RegionInsertDrag : public RegionMotionDrag
377 RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, ARDOUR::framepos_t);
379 void finished (GdkEvent *, bool);
382 bool regions_came_from_canvas () const {
387 /** Region drag in splice mode */
388 class RegionSpliceDrag : public RegionMoveDrag
391 RegionSpliceDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
393 void motion (GdkEvent *, bool);
394 void finished (GdkEvent *, bool);
398 /** Drags to create regions */
399 class RegionCreateDrag : public Drag
402 RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
404 void motion (GdkEvent *, bool);
405 void finished (GdkEvent *, bool);
409 MidiTimeAxisView* _view;
410 boost::shared_ptr<ARDOUR::Region> _region;
414 /** Drags to resize MIDI notes */
415 class NoteResizeDrag : public Drag
418 NoteResizeDrag (Editor *, ArdourCanvas::Item *);
420 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
421 void motion (GdkEvent *, bool);
422 void finished (GdkEvent *, bool);
426 MidiRegionView* region;
431 /** Drags to move MIDI notes */
432 class NoteDrag : public Drag
435 NoteDrag (Editor*, ArdourCanvas::Item*);
437 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
438 void motion (GdkEvent *, bool);
439 void finished (GdkEvent *, bool);
444 ARDOUR::frameoffset_t total_dx () const;
445 int8_t total_dy () const;
447 MidiRegionView* _region;
448 Gnome::Canvas::CanvasNoteEvent* _primary;
449 double _cumulative_dx;
450 double _cumulative_dy;
455 /** Drag to move MIDI patch changes */
456 class PatchChangeDrag : public Drag
459 PatchChangeDrag (Editor *, ArdourCanvas::CanvasPatchChange *, MidiRegionView *);
461 void motion (GdkEvent *, bool);
462 void finished (GdkEvent *, bool);
465 bool y_movement_matters () const {
469 void setup_pointer_frame_offset ();
472 MidiRegionView* _region_view;
473 ArdourCanvas::CanvasPatchChange* _patch_change;
474 double _cumulative_dx;
477 /** Drag of region gain */
478 class RegionGainDrag : public Drag
481 RegionGainDrag (Editor *, ArdourCanvas::Item *);
483 void motion (GdkEvent *, bool);
484 void finished (GdkEvent *, bool);
485 bool active (Editing::MouseMode m) {
486 return (m == Editing::MouseGain);
492 /** Drag to trim region(s) */
493 class TrimDrag : public RegionDrag
502 TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &);
504 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
505 void motion (GdkEvent *, bool);
506 void finished (GdkEvent *, bool);
509 bool y_movement_matters () const {
513 void setup_pointer_frame_offset ();
517 Operation _operation;
520 /** Meter marker drag */
521 class MeterMarkerDrag : public Drag
524 MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
526 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
527 void motion (GdkEvent *, bool);
528 void finished (GdkEvent *, bool);
531 bool allow_vertical_autoscroll () const {
535 bool y_movement_matters () const {
539 void setup_pointer_frame_offset ();
542 MeterMarker* _marker;
546 /** Tempo marker drag */
547 class TempoMarkerDrag : public Drag
550 TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
552 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
553 void motion (GdkEvent *, bool);
554 void finished (GdkEvent *, bool);
557 bool allow_vertical_autoscroll () const {
561 bool y_movement_matters () const {
565 void setup_pointer_frame_offset ();
568 TempoMarker* _marker;
573 /** Drag of the playhead cursor */
574 class CursorDrag : public Drag
577 CursorDrag (Editor *, ArdourCanvas::Item *, bool);
579 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
580 void motion (GdkEvent *, bool);
581 void finished (GdkEvent *, bool);
584 bool active (Editing::MouseMode) {
588 bool allow_vertical_autoscroll () const {
592 bool y_movement_matters () const {
597 void fake_locate (framepos_t);
599 bool _stop; ///< true to stop the transport on starting the drag, otherwise false
602 /** Region fade-in drag */
603 class FadeInDrag : public RegionDrag
606 FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
608 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
609 void motion (GdkEvent *, bool);
610 void finished (GdkEvent *, bool);
613 bool y_movement_matters () const {
617 void setup_pointer_frame_offset ();
620 /** Region fade-out drag */
621 class FadeOutDrag : public RegionDrag
624 FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
626 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
627 void motion (GdkEvent *, bool);
628 void finished (GdkEvent *, bool);
631 bool y_movement_matters () const {
635 void setup_pointer_frame_offset ();
639 class MarkerDrag : public Drag
642 MarkerDrag (Editor *, ArdourCanvas::Item *);
645 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
646 void motion (GdkEvent *, bool);
647 void finished (GdkEvent *, bool);
650 bool allow_vertical_autoscroll () const {
654 bool y_movement_matters () const {
658 void setup_pointer_frame_offset ();
661 void update_item (ARDOUR::Location *);
663 Marker* _marker; ///< marker being dragged
664 std::list<ARDOUR::Location*> _copied_locations;
665 ArdourCanvas::Points _points;
668 /** Control point drag */
669 class ControlPointDrag : public Drag
672 ControlPointDrag (Editor *, ArdourCanvas::Item *);
674 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
675 void motion (GdkEvent *, bool);
676 void finished (GdkEvent *, bool);
679 bool active (Editing::MouseMode m);
683 ControlPoint* _point;
684 double _fixed_grab_x;
685 double _fixed_grab_y;
686 double _cumulative_x_drag;
687 double _cumulative_y_drag;
688 static double const _zero_gain_fraction;
691 /** Gain or automation line drag */
692 class LineDrag : public Drag
695 LineDrag (Editor *e, ArdourCanvas::Item *i);
697 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
698 void motion (GdkEvent *, bool);
699 void finished (GdkEvent *, bool);
702 bool active (Editing::MouseMode) {
708 AutomationLine* _line;
709 double _fixed_grab_x;
710 double _fixed_grab_y;
713 double _cumulative_y_drag;
716 /** Transient feature line drags*/
717 class FeatureLineDrag : public Drag
720 FeatureLineDrag (Editor *e, ArdourCanvas::Item *i);
722 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
723 void motion (GdkEvent *, bool);
724 void finished (GdkEvent *, bool);
727 bool active (Editing::MouseMode) {
733 ArdourCanvas::Line* _line;
734 AudioRegionView* _arv;
736 double _region_view_grab_x;
737 double _cumulative_x_drag;
743 /** Dragging of a rubberband rectangle for selecting things */
744 class RubberbandSelectDrag : public Drag
747 RubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
749 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
750 void motion (GdkEvent *, bool);
751 void finished (GdkEvent *, bool);
754 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
755 return std::make_pair (8, 1);
759 /** Region drag in time-FX mode */
760 class TimeFXDrag : public RegionDrag
763 TimeFXDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
765 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
766 void motion (GdkEvent *, bool);
767 void finished (GdkEvent *, bool);
771 /** Scrub drag in audition mode */
772 class ScrubDrag : public Drag
775 ScrubDrag (Editor *, ArdourCanvas::Item *);
777 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
778 void motion (GdkEvent *, bool);
779 void finished (GdkEvent *, bool);
783 /** Drag in range select mode */
784 class SelectionDrag : public Drag
794 SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
796 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
797 void motion (GdkEvent *, bool);
798 void finished (GdkEvent *, bool);
801 void setup_pointer_frame_offset ();
804 Operation _operation;
806 int _original_pointer_time_axis;
807 int _last_pointer_time_axis;
808 std::list<TimeAxisView*> _added_time_axes;
811 /** Range marker drag */
812 class RangeMarkerBarDrag : public Drag
817 CreateTransportMarker,
821 RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
823 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
824 void motion (GdkEvent *, bool);
825 void finished (GdkEvent *, bool);
828 bool allow_vertical_autoscroll () const {
832 bool y_movement_matters () const {
837 void update_item (ARDOUR::Location *);
839 Operation _operation;
840 ArdourCanvas::SimpleRect* _drag_rect;
844 /** Drag of rectangle to set zoom */
845 class MouseZoomDrag : public Drag
848 MouseZoomDrag (Editor *, ArdourCanvas::Item *);
850 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
851 void motion (GdkEvent *, bool);
852 void finished (GdkEvent *, bool);
855 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
856 return std::make_pair (4, 4);
863 /** Drag of a range of automation data, changing value but not position */
864 class AutomationRangeDrag : public Drag
867 AutomationRangeDrag (Editor *, ArdourCanvas::Item *, std::list<ARDOUR::AudioRange> const &);
869 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
870 void motion (GdkEvent *, bool);
871 void finished (GdkEvent *, bool);
874 bool x_movement_matters () const {
879 std::list<ARDOUR::AudioRange> _ranges;
880 AutomationTimeAxisView* _atav;
882 /** A line that is part of the drag */
884 boost::shared_ptr<AutomationLine> line; ///< the line
885 std::list<ControlPoint*> points; ///< points to drag on the line
886 std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> range; ///< the range of all points on the line, in session frames
887 XMLNode* state; ///< the XML state node before the drag
890 std::list<Line> _lines;
892 bool _nothing_to_drag;
895 #endif /* __gtk2_ardour_editor_drag_h_ */