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_
29 #include "ardour/types.h"
32 #include "editor_items.h"
39 class StatefulDiffCommand;
44 class CanvasNoteEvent;
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
104 /** Abstract base class for dragging of things within the editor */
108 Drag (Editor *, ArdourCanvas::Item *);
111 void set_manager (DragManager* m) {
115 /** @return the canvas item being dragged */
116 ArdourCanvas::Item* item () const {
120 void swap_grab (ArdourCanvas::Item *, Gdk::Cursor *, uint32_t);
121 bool motion_handler (GdkEvent*, bool);
124 ARDOUR::framepos_t adjusted_frame (ARDOUR::framepos_t, GdkEvent const *, bool snap = true) const;
125 ARDOUR::framepos_t adjusted_current_frame (GdkEvent const *, bool snap = true) const;
127 /** Called to start a grab of an item.
128 * @param e Event that caused the grab to start.
129 * @param c Cursor to use, or 0.
131 virtual void start_grab (GdkEvent* e, Gdk::Cursor* c = 0);
133 virtual bool end_grab (GdkEvent *);
135 /** Called when a drag motion has occurred.
136 * @param e Event describing the motion.
137 * @param f true if this is the first movement, otherwise false.
139 virtual void motion (GdkEvent* e, bool f) = 0;
141 /** Called when a drag has finished.
142 * @param e Event describing the finish.
143 * @param m true if some movement occurred, otherwise false.
145 virtual void finished (GdkEvent* e, bool m) = 0;
147 /** Called to abort a drag and return things to how
148 * they were before it started.
150 virtual void aborted () = 0;
152 /** @param m Mouse mode.
153 * @return true if this drag should happen in this mouse mode.
155 virtual bool active (Editing::MouseMode m) {
156 return (m != Editing::MouseGain);
159 /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
160 virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
161 return std::make_pair (1, 1);
164 virtual bool allow_vertical_autoscroll () const {
168 /** @return true if x movement matters to this drag */
169 virtual bool x_movement_matters () const {
173 /** @return true if y movement matters to this drag */
174 virtual bool y_movement_matters () const {
180 double grab_x () const {
184 double grab_y () const {
188 ARDOUR::framepos_t raw_grab_frame () const {
189 return _raw_grab_frame;
192 ARDOUR::framepos_t grab_frame () const {
196 double last_pointer_x () const {
197 return _last_pointer_x;
200 double last_pointer_y () const {
201 return _last_pointer_y;
204 double last_pointer_frame () const {
205 return _last_pointer_frame;
208 Editor* _editor; ///< our editor
210 ArdourCanvas::Item* _item; ///< our item
211 /** Offset from the mouse's position for the drag to the start of the thing that is being dragged */
212 ARDOUR::framecnt_t _pointer_frame_offset;
213 bool _x_constrained; ///< true if x motion is constrained, otherwise false
214 bool _y_constrained; ///< true if y motion is constrained, otherwise false
215 bool _was_rolling; ///< true if the session was rolling before the drag started, otherwise false
219 bool _move_threshold_passed; ///< true if the move threshold has been passed, otherwise false
220 double _grab_x; ///< trackview x of the grab start position
221 double _grab_y; ///< trackview y of the grab start position
222 double _last_pointer_x; ///< trackview x of the pointer last time a motion occurred
223 double _last_pointer_y; ///< trackview y of the pointer last time a motion occurred
224 ARDOUR::framepos_t _raw_grab_frame; ///< unsnapped frame that the mouse was at when start_grab was called, or 0
225 ARDOUR::framepos_t _grab_frame; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
226 ARDOUR::framepos_t _last_pointer_frame; ///< adjusted_frame the last time a motion occurred
231 /** Container for details about a region being dragged */
234 DraggingView (RegionView *, RegionDrag *);
236 RegionView* view; ///< the view
237 /** index into RegionDrag::_time_axis_views of the view that this region is currently beind displayed on */
239 /** layer that this region is currently being displayed on */
240 ARDOUR::layer_t layer;
241 double initial_y; ///< the initial y position of the view before any reparenting
242 framepos_t initial_position; ///< initial position of the region
243 framepos_t initial_end; ///< initial end position of the region
244 boost::shared_ptr<ARDOUR::Playlist> initial_playlist;
247 /** Abstract base class for drags that involve region(s) */
248 class RegionDrag : public Drag, public sigc::trackable
251 RegionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
252 virtual ~RegionDrag () {}
256 RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
257 std::list<DraggingView> _views; ///< information about all views that are being dragged
259 /** a list of the non-hidden TimeAxisViews sorted by editor order key */
260 std::vector<TimeAxisView*> _time_axis_views;
261 int find_time_axis_view (TimeAxisView *) const;
266 friend class DraggingView;
270 void region_going_away (RegionView *);
271 PBD::ScopedConnection death_connection;
275 /** Drags involving region motion from somewhere */
276 class RegionMotionDrag : public RegionDrag
280 RegionMotionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool);
281 virtual ~RegionMotionDrag () {}
283 virtual void start_grab (GdkEvent *, Gdk::Cursor *);
284 virtual void motion (GdkEvent *, bool);
285 virtual void finished (GdkEvent *, bool) = 0;
286 virtual void aborted ();
288 /** @return true if the regions being `moved' came from somewhere on the canvas;
289 * false if they came from outside (e.g. from the region list).
291 virtual bool regions_came_from_canvas () const = 0;
295 double compute_x_delta (GdkEvent const *, ARDOUR::framecnt_t *);
296 bool y_movement_allowed (int, ARDOUR::layer_t) const;
299 ARDOUR::framepos_t _last_frame_position; ///< last position of the thing being dragged
300 double _total_x_delta;
301 int _last_pointer_time_axis_view;
302 ARDOUR::layer_t _last_pointer_layer;
306 /** Drags to move (or copy) regions that are already shown in the GUI to
307 * somewhere different.
309 class RegionMoveDrag : public RegionMotionDrag
312 RegionMoveDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, bool);
313 virtual ~RegionMoveDrag () {}
315 virtual void start_grab (GdkEvent *, Gdk::Cursor *);
316 void motion (GdkEvent *, bool);
317 void finished (GdkEvent *, bool);
320 bool regions_came_from_canvas () const {
324 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
325 return std::make_pair (4, 4);
329 typedef std::set<boost::shared_ptr<ARDOUR::Playlist> > PlaylistSet;
331 void finished_no_copy (
334 ARDOUR::framecnt_t const
340 ARDOUR::framecnt_t const
343 RegionView* insert_region_into_playlist (
344 boost::shared_ptr<ARDOUR::Region>,
351 void remove_region_from_playlist (
352 boost::shared_ptr<ARDOUR::Region>,
353 boost::shared_ptr<ARDOUR::Playlist>,
354 PlaylistSet& modified_playlists
357 void add_stateful_diff_commands_for_playlists (PlaylistSet const &);
359 void collect_new_region_view (RegionView *);
362 RegionView* _new_region_view;
365 /** Drag to insert a region from somewhere */
366 class RegionInsertDrag : public RegionMotionDrag
369 RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, ARDOUR::framepos_t);
371 void finished (GdkEvent *, bool);
374 bool regions_came_from_canvas () const {
379 /** Region drag in splice mode */
380 class RegionSpliceDrag : public RegionMoveDrag
383 RegionSpliceDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
385 void motion (GdkEvent *, bool);
386 void finished (GdkEvent *, bool);
390 /** Drags to create regions */
391 class RegionCreateDrag : public Drag
394 RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
396 void motion (GdkEvent *, bool);
397 void finished (GdkEvent *, bool);
401 MidiTimeAxisView* _view;
402 boost::shared_ptr<ARDOUR::Region> _region;
406 /** Drags to resize MIDI notes */
407 class NoteResizeDrag : public Drag
410 NoteResizeDrag (Editor *, ArdourCanvas::Item *);
412 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
413 void motion (GdkEvent *, bool);
414 void finished (GdkEvent *, bool);
418 MidiRegionView* region;
423 /** Drags to move MIDI notes */
424 class NoteDrag : public Drag
427 NoteDrag (Editor*, ArdourCanvas::Item*);
429 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
430 void motion (GdkEvent *, bool);
431 void finished (GdkEvent *, bool);
436 ARDOUR::frameoffset_t total_dx () const;
437 int8_t total_dy () const;
439 MidiRegionView* _region;
440 Gnome::Canvas::CanvasNoteEvent* _primary;
441 double _cumulative_dx;
442 double _cumulative_dy;
447 /** Drag of region gain */
448 class RegionGainDrag : public Drag
451 RegionGainDrag (Editor *, ArdourCanvas::Item *);
453 void motion (GdkEvent *, bool);
454 void finished (GdkEvent *, bool);
455 bool active (Editing::MouseMode m) {
456 return (m == Editing::MouseGain);
462 /** Drag to trim region(s) */
463 class TrimDrag : public RegionDrag
472 TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &);
474 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
475 void motion (GdkEvent *, bool);
476 void finished (GdkEvent *, bool);
479 bool y_movement_matters () const {
485 Operation _operation;
486 bool _have_transaction; ///< true if a transaction has been started, false otherwise. Must be set true by derived class.
489 /** Meter marker drag */
490 class MeterMarkerDrag : public Drag
493 MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
495 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
496 void motion (GdkEvent *, bool);
497 void finished (GdkEvent *, bool);
500 bool allow_vertical_autoscroll () const {
504 bool y_movement_matters () const {
509 MeterMarker* _marker;
513 /** Tempo marker drag */
514 class TempoMarkerDrag : public Drag
517 TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
519 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
520 void motion (GdkEvent *, bool);
521 void finished (GdkEvent *, bool);
524 bool allow_vertical_autoscroll () const {
528 bool y_movement_matters () const {
533 TempoMarker* _marker;
538 /** Drag of a cursor */
539 class CursorDrag : public Drag
542 CursorDrag (Editor *, ArdourCanvas::Item *, bool);
544 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
545 void motion (GdkEvent *, bool);
546 void finished (GdkEvent *, bool);
549 bool active (Editing::MouseMode) {
553 bool allow_vertical_autoscroll () const {
557 bool y_movement_matters () const {
562 EditorCursor* _cursor; ///< cursor being dragged
563 bool _stop; ///< true to stop the transport on starting the drag, otherwise false
567 /** Region fade-in drag */
568 class FadeInDrag : public RegionDrag
571 FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
573 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
574 void motion (GdkEvent *, bool);
575 void finished (GdkEvent *, bool);
578 bool y_movement_matters () const {
583 /** Region fade-out drag */
584 class FadeOutDrag : public RegionDrag
587 FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
589 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
590 void motion (GdkEvent *, bool);
591 void finished (GdkEvent *, bool);
594 bool y_movement_matters () const {
600 class MarkerDrag : public Drag
603 MarkerDrag (Editor *, ArdourCanvas::Item *);
606 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
607 void motion (GdkEvent *, bool);
608 void finished (GdkEvent *, bool);
611 bool allow_vertical_autoscroll () const {
615 bool y_movement_matters () const {
620 void update_item (ARDOUR::Location *);
622 Marker* _marker; ///< marker being dragged
623 std::list<ARDOUR::Location*> _copied_locations;
624 ArdourCanvas::Line* _line;
625 ArdourCanvas::Points _points;
628 /** Control point drag */
629 class ControlPointDrag : public Drag
632 ControlPointDrag (Editor *, ArdourCanvas::Item *);
634 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
635 void motion (GdkEvent *, bool);
636 void finished (GdkEvent *, bool);
639 bool active (Editing::MouseMode m);
643 ControlPoint* _point;
644 double _fixed_grab_x;
645 double _fixed_grab_y;
646 double _cumulative_x_drag;
647 double _cumulative_y_drag;
648 static double const _zero_gain_fraction;
651 /** Gain or automation line drag */
652 class LineDrag : public Drag
655 LineDrag (Editor *e, ArdourCanvas::Item *i);
657 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
658 void motion (GdkEvent *, bool);
659 void finished (GdkEvent *, bool);
662 bool active (Editing::MouseMode) {
668 AutomationLine* _line;
669 double _fixed_grab_x;
670 double _fixed_grab_y;
673 double _cumulative_y_drag;
676 /** Transient feature line drags*/
677 class FeatureLineDrag : public Drag
680 FeatureLineDrag (Editor *e, ArdourCanvas::Item *i);
682 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
683 void motion (GdkEvent *, bool);
684 void finished (GdkEvent *, bool);
687 bool active (Editing::MouseMode) {
693 ArdourCanvas::SimpleLine* _line;
694 AudioRegionView* _arv;
696 double _region_view_grab_x;
697 double _cumulative_x_drag;
703 /** Dragging of a rubberband rectangle for selecting things */
704 class RubberbandSelectDrag : public Drag
707 RubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
709 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
710 void motion (GdkEvent *, bool);
711 void finished (GdkEvent *, bool);
714 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
715 return std::make_pair (8, 1);
719 /** Region drag in time-FX mode */
720 class TimeFXDrag : public RegionDrag
723 TimeFXDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
725 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
726 void motion (GdkEvent *, bool);
727 void finished (GdkEvent *, bool);
731 /** Scrub drag in audition mode */
732 class ScrubDrag : public Drag
735 ScrubDrag (Editor *, ArdourCanvas::Item *);
737 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
738 void motion (GdkEvent *, bool);
739 void finished (GdkEvent *, bool);
743 /** Drag in range select mode */
744 class SelectionDrag : public Drag
754 SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
756 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
757 void motion (GdkEvent *, bool);
758 void finished (GdkEvent *, bool);
762 Operation _operation;
764 int _original_pointer_time_axis;
765 int _last_pointer_time_axis;
766 std::list<TimeAxisView*> _added_time_axes;
769 /** Range marker drag */
770 class RangeMarkerBarDrag : public Drag
775 CreateTransportMarker,
779 RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
781 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
782 void motion (GdkEvent *, bool);
783 void finished (GdkEvent *, bool);
786 bool allow_vertical_autoscroll () const {
790 bool y_movement_matters () const {
795 void update_item (ARDOUR::Location *);
797 Operation _operation;
798 ArdourCanvas::SimpleRect* _drag_rect;
802 /** Drag of rectangle to set zoom */
803 class MouseZoomDrag : public Drag
806 MouseZoomDrag (Editor *, ArdourCanvas::Item *);
808 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
809 void motion (GdkEvent *, bool);
810 void finished (GdkEvent *, bool);
813 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
814 return std::make_pair (4, 4);
821 /** Drag of a range of automation data, changing value but not position */
822 class AutomationRangeDrag : public Drag
825 AutomationRangeDrag (Editor *, ArdourCanvas::Item *, std::list<ARDOUR::AudioRange> const &);
827 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
828 void motion (GdkEvent *, bool);
829 void finished (GdkEvent *, bool);
832 bool x_movement_matters () const {
837 std::list<ARDOUR::AudioRange> _ranges;
838 AutomationTimeAxisView* _atav;
840 /** A line that is part of the drag */
842 boost::shared_ptr<AutomationLine> line; ///< the line
843 std::list<ControlPoint*> points; ///< points to drag on the line
844 std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> range; ///< the range of all points on the line, in session frames
845 XMLNode* state; ///< the XML state node before the drag
848 std::list<Line> _lines;
850 bool _nothing_to_drag;
853 #endif /* __gtk2_ardour_editor_drag_h_ */