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 boost::shared_ptr<ARDOUR::Region> add_midi_region (MidiTimeAxisView*);
217 void show_verbose_cursor_time (framepos_t);
218 void show_verbose_cursor_duration (framepos_t, framepos_t, double xoffset = 0);
219 void show_verbose_cursor_text (std::string const &);
221 Editor* _editor; ///< our editor
223 ArdourCanvas::Item* _item; ///< our item
224 /** Offset from the mouse's position for the drag to the start of the thing that is being dragged */
225 ARDOUR::framecnt_t _pointer_frame_offset;
226 bool _x_constrained; ///< true if x motion is constrained, otherwise false
227 bool _y_constrained; ///< true if y motion is constrained, otherwise false
228 bool _was_rolling; ///< true if the session was rolling before the drag started, otherwise false
232 bool _move_threshold_passed; ///< true if the move threshold has been passed, otherwise false
233 double _grab_x; ///< trackview x of the grab start position
234 double _grab_y; ///< trackview y of the grab start position
235 double _last_pointer_x; ///< trackview x of the pointer last time a motion occurred
236 double _last_pointer_y; ///< trackview y of the pointer last time a motion occurred
237 ARDOUR::framepos_t _raw_grab_frame; ///< unsnapped frame that the mouse was at when start_grab was called, or 0
238 ARDOUR::framepos_t _grab_frame; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
239 ARDOUR::framepos_t _last_pointer_frame; ///< adjusted_frame the last time a motion occurred
244 /** Container for details about a region being dragged */
248 DraggingView (RegionView *, RegionDrag *);
250 RegionView* view; ///< the view
251 /** index into RegionDrag::_time_axis_views of the view that this region is currently being displayed on,
252 * or -1 if it is not visible.
255 /** layer that this region is currently being displayed on. This is a double
256 rather than a layer_t as we use fractional layers during drags to allow the user
257 to indicate a new layer to put a region on.
260 double initial_y; ///< the initial y position of the view before any reparenting
261 framepos_t initial_position; ///< initial position of the region
262 framepos_t initial_end; ///< initial end position of the region
263 boost::shared_ptr<ARDOUR::Playlist> initial_playlist;
266 /** Abstract base class for drags that involve region(s) */
267 class RegionDrag : public Drag, public sigc::trackable
270 RegionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
271 virtual ~RegionDrag () {}
275 RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
276 std::list<DraggingView> _views; ///< information about all views that are being dragged
278 /** a list of the non-hidden TimeAxisViews sorted by editor order key */
279 std::vector<TimeAxisView*> _time_axis_views;
280 int find_time_axis_view (TimeAxisView *) const;
285 friend class DraggingView;
289 void region_going_away (RegionView *);
290 PBD::ScopedConnection death_connection;
294 /** Drags involving region motion from somewhere */
295 class RegionMotionDrag : public RegionDrag
299 RegionMotionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool);
300 virtual ~RegionMotionDrag () {}
302 virtual void start_grab (GdkEvent *, Gdk::Cursor *);
303 virtual void motion (GdkEvent *, bool);
304 virtual void finished (GdkEvent *, bool);
305 virtual void aborted (bool);
307 /** @return true if the regions being `moved' came from somewhere on the canvas;
308 * false if they came from outside (e.g. from the region list).
310 virtual bool regions_came_from_canvas () const = 0;
314 double compute_x_delta (GdkEvent const *, ARDOUR::framepos_t *);
315 bool y_movement_allowed (int, double) const;
318 ARDOUR::framepos_t _last_frame_position; ///< last position of the thing being dragged
319 double _total_x_delta;
320 int _last_pointer_time_axis_view;
321 double _last_pointer_layer;
325 /** Drags to move (or copy) regions that are already shown in the GUI to
326 * somewhere different.
328 class RegionMoveDrag : public RegionMotionDrag
331 RegionMoveDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, bool);
332 virtual ~RegionMoveDrag () {}
334 void motion (GdkEvent *, bool);
335 void finished (GdkEvent *, bool);
338 bool regions_came_from_canvas () const {
342 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
343 return std::make_pair (4, 4);
346 void setup_pointer_frame_offset ();
349 typedef std::set<boost::shared_ptr<ARDOUR::Playlist> > PlaylistSet;
351 void finished_no_copy (
354 ARDOUR::framecnt_t const
360 ARDOUR::framecnt_t const
363 RegionView* insert_region_into_playlist (
364 boost::shared_ptr<ARDOUR::Region>,
371 void remove_region_from_playlist (
372 boost::shared_ptr<ARDOUR::Region>,
373 boost::shared_ptr<ARDOUR::Playlist>,
374 PlaylistSet& modified_playlists
377 void add_stateful_diff_commands_for_playlists (PlaylistSet const &);
379 void collect_new_region_view (RegionView *);
382 RegionView* _new_region_view;
385 /** Drag to insert a region from somewhere */
386 class RegionInsertDrag : public RegionMotionDrag
389 RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, ARDOUR::framepos_t);
391 void finished (GdkEvent *, bool);
394 bool regions_came_from_canvas () const {
399 /** Region drag in splice mode */
400 class RegionSpliceDrag : public RegionMoveDrag
403 RegionSpliceDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
405 void motion (GdkEvent *, bool);
406 void finished (GdkEvent *, bool);
410 /** Drags to create regions */
411 class RegionCreateDrag : public Drag
414 RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
416 void motion (GdkEvent *, bool);
417 void finished (GdkEvent *, bool);
421 MidiTimeAxisView* _view;
422 boost::shared_ptr<ARDOUR::Region> _region;
425 /** Drags to resize MIDI notes */
426 class NoteResizeDrag : public Drag
429 NoteResizeDrag (Editor *, ArdourCanvas::Item *);
431 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
432 void motion (GdkEvent *, bool);
433 void finished (GdkEvent *, bool);
437 MidiRegionView* region;
442 /** Drags to move MIDI notes */
443 class NoteDrag : public Drag
446 NoteDrag (Editor*, ArdourCanvas::Item*);
448 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
449 void motion (GdkEvent *, bool);
450 void finished (GdkEvent *, bool);
455 ARDOUR::frameoffset_t total_dx () const;
456 int8_t total_dy () const;
458 MidiRegionView* _region;
459 Gnome::Canvas::CanvasNoteEvent* _primary;
460 double _cumulative_dx;
461 double _cumulative_dy;
466 class NoteCreateDrag : public Drag
469 NoteCreateDrag (Editor *, ArdourCanvas::Item *, MidiRegionView *);
472 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
473 void motion (GdkEvent *, bool);
474 void finished (GdkEvent *, bool);
478 double y_to_region (double) const;
479 framecnt_t grid_frames (framepos_t) const;
481 MidiRegionView* _region_view;
482 ArdourCanvas::SimpleRect* _drag_rect;
486 /** Drag to move MIDI patch changes */
487 class PatchChangeDrag : public Drag
490 PatchChangeDrag (Editor *, ArdourCanvas::CanvasPatchChange *, MidiRegionView *);
492 void motion (GdkEvent *, bool);
493 void finished (GdkEvent *, bool);
496 bool y_movement_matters () const {
500 void setup_pointer_frame_offset ();
503 MidiRegionView* _region_view;
504 ArdourCanvas::CanvasPatchChange* _patch_change;
505 double _cumulative_dx;
508 /** Drag to trim region(s) */
509 class TrimDrag : public RegionDrag
518 TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &);
520 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
521 void motion (GdkEvent *, bool);
522 void finished (GdkEvent *, bool);
525 bool y_movement_matters () const {
529 void setup_pointer_frame_offset ();
533 Operation _operation;
536 /** Meter marker drag */
537 class MeterMarkerDrag : public Drag
540 MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
542 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
543 void motion (GdkEvent *, bool);
544 void finished (GdkEvent *, bool);
547 bool allow_vertical_autoscroll () const {
551 bool y_movement_matters () const {
555 void setup_pointer_frame_offset ();
558 MeterMarker* _marker;
560 XMLNode* before_state;
563 /** Tempo marker drag */
564 class TempoMarkerDrag : public Drag
567 TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
569 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
570 void motion (GdkEvent *, bool);
571 void finished (GdkEvent *, bool);
574 bool allow_vertical_autoscroll () const {
578 bool y_movement_matters () const {
582 void setup_pointer_frame_offset ();
585 TempoMarker* _marker;
587 XMLNode* before_state;
591 /** Drag of the playhead cursor */
592 class CursorDrag : public Drag
595 CursorDrag (Editor *, ArdourCanvas::Item *, bool);
597 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
598 void motion (GdkEvent *, bool);
599 void finished (GdkEvent *, bool);
602 bool active (Editing::MouseMode) {
606 bool allow_vertical_autoscroll () const {
610 bool y_movement_matters () const {
615 void fake_locate (framepos_t);
617 bool _stop; ///< true to stop the transport on starting the drag, otherwise false
618 double _grab_zoom; ///< editor frames per unit when our grab started
621 /** Region fade-in drag */
622 class FadeInDrag : public RegionDrag
625 FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
627 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
628 void motion (GdkEvent *, bool);
629 void finished (GdkEvent *, bool);
632 bool y_movement_matters () const {
636 void setup_pointer_frame_offset ();
639 /** Region fade-out drag */
640 class FadeOutDrag : public RegionDrag
643 FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
645 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
646 void motion (GdkEvent *, bool);
647 void finished (GdkEvent *, bool);
650 bool y_movement_matters () const {
654 void setup_pointer_frame_offset ();
658 class MarkerDrag : public Drag
661 MarkerDrag (Editor *, ArdourCanvas::Item *);
664 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
665 void motion (GdkEvent *, bool);
666 void finished (GdkEvent *, bool);
669 bool allow_vertical_autoscroll () const {
673 bool y_movement_matters () const {
677 void setup_pointer_frame_offset ();
680 void update_item (ARDOUR::Location *);
682 Marker* _marker; ///< marker being dragged
683 std::list<ARDOUR::Location*> _copied_locations;
684 ArdourCanvas::Points _points;
687 /** Control point drag */
688 class ControlPointDrag : public Drag
691 ControlPointDrag (Editor *, ArdourCanvas::Item *);
693 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
694 void motion (GdkEvent *, bool);
695 void finished (GdkEvent *, bool);
698 bool active (Editing::MouseMode m);
702 ControlPoint* _point;
703 double _fixed_grab_x;
704 double _fixed_grab_y;
705 double _cumulative_x_drag;
706 double _cumulative_y_drag;
707 static double _zero_gain_fraction;
710 /** Gain or automation line drag */
711 class LineDrag : public Drag
714 LineDrag (Editor *e, ArdourCanvas::Item *i);
716 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
717 void motion (GdkEvent *, bool);
718 void finished (GdkEvent *, bool);
721 bool active (Editing::MouseMode) {
727 AutomationLine* _line;
728 double _fixed_grab_x;
729 double _fixed_grab_y;
732 double _cumulative_y_drag;
735 /** Transient feature line drags*/
736 class FeatureLineDrag : public Drag
739 FeatureLineDrag (Editor *e, ArdourCanvas::Item *i);
741 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
742 void motion (GdkEvent *, bool);
743 void finished (GdkEvent *, bool);
746 bool active (Editing::MouseMode) {
752 ArdourCanvas::Line* _line;
753 AudioRegionView* _arv;
755 double _region_view_grab_x;
756 double _cumulative_x_drag;
762 /** Dragging of a rubberband rectangle for selecting things */
763 class RubberbandSelectDrag : public Drag
766 RubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
768 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
769 void motion (GdkEvent *, bool);
770 void finished (GdkEvent *, bool);
773 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
774 return std::make_pair (8, 1);
777 void do_select_things (GdkEvent *, bool);
779 /** Select some things within a rectangle.
780 * @param button_state The button state from the GdkEvent.
781 * @param x1 The left-hand side of the rectangle in session frames.
782 * @param x2 The right-hand side of the rectangle in session frames.
783 * @param y1 The top of the rectangle in trackview coordinates.
784 * @param y2 The bottom of the rectangle in trackview coordinates.
785 * @param drag_in_progress true if the drag is currently happening.
787 virtual void select_things (int button_state, framepos_t x1, framepos_t x2, double y1, double y2, bool drag_in_progress) = 0;
789 virtual void deselect_things () = 0;
795 /** A general editor RubberbandSelectDrag (for regions, automation points etc.) */
796 class EditorRubberbandSelectDrag : public RubberbandSelectDrag
799 EditorRubberbandSelectDrag (Editor *, ArdourCanvas::Item *);
801 void select_things (int, framepos_t, framepos_t, double, double, bool);
802 void deselect_things ();
805 /** A RubberbandSelectDrag for selecting MIDI notes */
806 class MidiRubberbandSelectDrag : public RubberbandSelectDrag
809 MidiRubberbandSelectDrag (Editor *, MidiRegionView *);
811 void select_things (int, framepos_t, framepos_t, double, double, bool);
812 void deselect_things ();
815 MidiRegionView* _region_view;
818 /** A RubberbandSelectDrag for selecting MIDI notes but with no horizonal component */
819 class MidiVerticalSelectDrag : public RubberbandSelectDrag
822 MidiVerticalSelectDrag (Editor *, MidiRegionView *);
824 void select_things (int, framepos_t, framepos_t, double, double, bool);
825 void deselect_things ();
828 MidiRegionView* _region_view;
831 /** Region drag in time-FX mode */
832 class TimeFXDrag : public RegionDrag
835 TimeFXDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
837 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
838 void motion (GdkEvent *, bool);
839 void finished (GdkEvent *, bool);
843 /** Scrub drag in audition mode */
844 class ScrubDrag : public Drag
847 ScrubDrag (Editor *, ArdourCanvas::Item *);
849 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
850 void motion (GdkEvent *, bool);
851 void finished (GdkEvent *, bool);
855 /** Drag in range select mode */
856 class SelectionDrag : public Drag
866 SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
868 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
869 void motion (GdkEvent *, bool);
870 void finished (GdkEvent *, bool);
873 void setup_pointer_frame_offset ();
876 Operation _operation;
878 int _original_pointer_time_axis;
879 int _last_pointer_time_axis;
880 std::list<TimeAxisView*> _added_time_axes;
881 bool _time_selection_at_start;
884 /** Range marker drag */
885 class RangeMarkerBarDrag : public Drag
890 CreateTransportMarker,
894 RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
896 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
897 void motion (GdkEvent *, bool);
898 void finished (GdkEvent *, bool);
901 bool allow_vertical_autoscroll () const {
905 bool y_movement_matters () const {
910 void update_item (ARDOUR::Location *);
912 Operation _operation;
913 ArdourCanvas::SimpleRect* _drag_rect;
917 /** Drag of rectangle to set zoom */
918 class MouseZoomDrag : public Drag
921 MouseZoomDrag (Editor *, ArdourCanvas::Item *);
923 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
924 void motion (GdkEvent *, bool);
925 void finished (GdkEvent *, bool);
928 std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
929 return std::make_pair (4, 4);
936 /** Drag of a range of automation data (either on an automation track or region gain),
937 * changing value but not position.
939 class AutomationRangeDrag : public Drag
942 AutomationRangeDrag (Editor *, AutomationTimeAxisView *, std::list<ARDOUR::AudioRange> const &);
943 AutomationRangeDrag (Editor *, AudioRegionView *, std::list<ARDOUR::AudioRange> const &);
945 void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
946 void motion (GdkEvent *, bool);
947 void finished (GdkEvent *, bool);
950 bool x_movement_matters () const {
954 bool active (Editing::MouseMode) {
959 void setup (std::list<boost::shared_ptr<AutomationLine> > const &);
960 double y_fraction (boost::shared_ptr<AutomationLine>, double global_y_position) const;
962 std::list<ARDOUR::AudioRange> _ranges;
964 /** A line that is part of the drag */
966 boost::shared_ptr<AutomationLine> line; ///< the line
967 std::list<ControlPoint*> points; ///< points to drag on the line
968 std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> range; ///< the range of all points on the line, in session frames
969 XMLNode* state; ///< the XML state node before the drag
970 double original_fraction; ///< initial y-fraction before the drag
973 std::list<Line> _lines;
975 bool _nothing_to_drag;
978 /** Drag of one edge of an xfade
980 class CrossfadeEdgeDrag : public Drag
983 CrossfadeEdgeDrag (Editor*, AudioRegionView*, ArdourCanvas::Item*, bool start);
985 void start_grab (GdkEvent*, Gdk::Cursor* c = 0);
986 void motion (GdkEvent*, bool);
987 void finished (GdkEvent*, bool);
990 bool y_movement_matters () const {
994 virtual std::pair<ARDOUR::framecnt_t, int> move_threshold () const {
995 return std::make_pair (4, 4);
999 AudioRegionView* arv;
1003 #endif /* __gtk2_ardour_editor_drag_h_ */