Fix warning.
[ardour.git] / gtk2_ardour / editor_drag.h
index 170c9a80802c84043e8641f790a1780fb2401c3a..fb5ef3da9e80c201da46b8b59543fae6d7375cff 100644 (file)
@@ -37,36 +37,40 @@ namespace ARDOUR {
 class Editor;
 class EditorCursor;
 class TimeAxisView;
+class Drag;
 
-/** Abstract base class for dragging of things within the editor */
-class Drag
+/** Class to manage current drags */
+class DragManager
 {
-
 public:
-       Drag (Editor *, ArdourCanvas::Item *);
-       virtual ~Drag () {}
 
-       /** @return the canvas item being dragged */
-       ArdourCanvas::Item* item () const {
-               return _item;
-       }
+       DragManager (Editor* e);
+       ~DragManager ();
 
-       void swap_grab (ArdourCanvas::Item *, Gdk::Cursor *, uint32_t);
-       void break_drag ();
+       bool motion_handler (GdkEvent *, bool);
 
-       bool motion_handler (GdkEvent*, bool);
+       void abort ();
+       void add (Drag *);
+       void set (Drag *, GdkEvent *, Gdk::Cursor* c = 0);
+       void start_grab (GdkEvent *);
+       bool end_grab (GdkEvent *);
+       bool have_item (ArdourCanvas::Item *) const;
 
-       /** @return true if an end drag is in progress */
+       /** @return true if an end drag or abort is in progress */
        bool ending () const {
                return _ending;
        }
 
-       /** @return current pointer x position in item coordinates */
+       bool active () const {
+               return !_drags.empty ();
+       }
+
+       /** @return current pointer x position in trackview coordinates */
        double current_pointer_x () const {
                return _current_pointer_x;
        }
 
-       /** @return current pointer y position in item coordinates */
+       /** @return current pointer y position in trackview coordinates */
        double current_pointer_y () const {
                return _current_pointer_y;
        }
@@ -76,6 +80,38 @@ public:
                return _current_pointer_frame;
        }
 
+private:
+       Editor* _editor;
+       std::list<Drag*> _drags;
+       bool _ending; ///< true if end_grab or abort is in progress, otherwise false
+       double _current_pointer_x; ///< trackview x of the current pointer
+       double _current_pointer_y; ///< trackview y of the current pointer
+       nframes64_t _current_pointer_frame; ///< frame that the pointer is now at
+};
+
+/** Abstract base class for dragging of things within the editor */
+class Drag
+{
+public:
+       Drag (Editor *, ArdourCanvas::Item *);
+       virtual ~Drag () {}
+
+       void set_manager (DragManager* m) {
+               _drags = m;
+       }
+
+       /** @return the canvas item being dragged */
+       ArdourCanvas::Item* item () const {
+               return _item;
+       }
+
+       void swap_grab (ArdourCanvas::Item *, Gdk::Cursor *, uint32_t);
+       bool motion_handler (GdkEvent*, bool);
+       void abort ();
+
+       nframes64_t adjusted_frame (nframes64_t, GdkEvent const *, bool snap = true) const;
+       nframes64_t adjusted_current_frame (GdkEvent const *, bool snap = true) const;
+       
        /** Called to start a grab of an item.
         *  @param e Event that caused the grab to start.
         *  @param c Cursor to use, or 0.
@@ -96,6 +132,11 @@ public:
         */
        virtual void finished (GdkEvent* e, bool m) = 0;
 
+       /** Called to abort a drag and return things to how
+        *  they were before it started.
+        */
+       virtual void aborted () = 0;
+
        /** @param m Mouse mode.
         *  @return true if this drag should happen in this mouse mode.
         */
@@ -103,48 +144,78 @@ public:
                return (m != Editing::MouseGain);
        }
 
-       /** @return true if a small threshold should be applied before a mouse movement
-        *  is considered a drag, otherwise false.
-        */
-       virtual bool apply_move_threshold () const {
-               return false;
+       /** @return minimum number of frames (in x) and pixels (in y) that should be considered a movement */
+       virtual std::pair<nframes64_t, int> move_threshold () const {
+               return std::make_pair (1, 1);
        }
 
        virtual bool allow_vertical_autoscroll () const {
                return true;
        }
 
+       /** @return true if x movement matters to this drag */
+       virtual bool x_movement_matters () const {
+               return true;
+       }
+
+       /** @return true if y movement matters to this drag */
+       virtual bool y_movement_matters () const {
+               return true;
+       }
+
 protected:
-       nframes64_t adjusted_current_frame (GdkEvent *) const;
+
+       double grab_x () const {
+               return _grab_x;
+       }
+
+       double grab_y () const {
+               return _grab_y;
+       }
+
+       double grab_frame () const {
+               return _grab_frame;
+       }
+
+       double last_pointer_x () const {
+               return _last_pointer_x;
+       }
+
+       double last_pointer_y () const {
+               return _last_pointer_y;
+       }
+
+       double last_pointer_frame () const {
+               return _last_pointer_frame;
+       }
 
        Editor* _editor; ///< our editor
+       DragManager* _drags;
        ArdourCanvas::Item* _item; ///< our item
-       nframes64_t _pointer_frame_offset; ///< offset from the mouse's position for the drag
-                                          ///< to the start of the thing that is being dragged
-       nframes64_t _last_frame_position; ///< last position of the thing being dragged
-       nframes64_t _grab_frame; ///< frame that the mouse was at when start_grab was called, or 0
-       nframes64_t _last_pointer_frame; ///< frame that the pointer was at last time a motion occurred
-       nframes64_t _current_pointer_frame; ///< frame that the pointer is now at
-       double _original_x; ///< original world x of the thing being dragged
-       double _original_y; ///< original world y of the thing being dragged
-       double _grab_x; ///< item x of the grab start position
-       double _grab_y; ///< item y of the grab start position
-       double _current_pointer_x; ///< item x of the current pointer
-       double _current_pointer_y; ///< item y of the current pointer
-       double _last_pointer_x; ///< item x of the pointer last time a motion occurred
-       double _last_pointer_y; ///< item y of the pointer last time a motion occurred
+       /** Offset from the mouse's position for the drag to the start of the thing that is being dragged */
+       nframes64_t _pointer_frame_offset;
        bool _x_constrained; ///< true if x motion is constrained, otherwise false
        bool _y_constrained; ///< true if y motion is constrained, otherwise false
        bool _was_rolling; ///< true if the session was rolling before the drag started, otherwise false
-       bool _have_transaction; ///< true if a transaction has been started, false otherwise. Must be set true by derived class.
 
 private:
 
-       bool _ending; ///< true if end_grab is in progress, otherwise false
-       bool _had_movement; ///< true if movement has occurred, otherwise false
        bool _move_threshold_passed; ///< true if the move threshold has been passed, otherwise false
+       double _grab_x; ///< trackview x of the grab start position
+       double _grab_y; ///< trackview y of the grab start position
+       double _last_pointer_x; ///< trackview x of the pointer last time a motion occurred
+       double _last_pointer_y; ///< trackview y of the pointer last time a motion occurred
+       nframes64_t _grab_frame; ///< adjusted_frame that the mouse was at when start_grab was called, or 0
+       nframes64_t _last_pointer_frame; ///< adjusted_frame the last time a motion occurred
 };
 
+struct DraggingView
+{
+       DraggingView (RegionView* v);
+
+       RegionView* view; ///< the view
+       double initial_y; ///< the initial y position of the view before any reparenting
+};
 
 /** Abstract base class for drags that involve region(s) */
 class RegionDrag : public Drag, public sigc::trackable
@@ -156,11 +227,11 @@ public:
 protected:
 
        RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
-       std::list<RegionView*> _views; ///< all views that are being dragged
+       std::list<DraggingView> _views; ///< information about all views that are being dragged
 
 private:
        void region_going_away (RegionView *);
-       boost::signals2::scoped_connection death_connection;
+       PBD::ScopedConnection death_connection;
 };
 
 
@@ -175,6 +246,7 @@ public:
        virtual void start_grab (GdkEvent *, Gdk::Cursor *);
        virtual void motion (GdkEvent *, bool);
        virtual void finished (GdkEvent *, bool) = 0;
+       virtual void aborted ();
 
 protected:
        struct TimeAxisViewSummary {
@@ -202,6 +274,8 @@ protected:
        ARDOUR::layer_t _dest_layer;
        bool check_possible (RouteTimeAxisView **, ARDOUR::layer_t *);
        bool _brushing;
+       nframes64_t _last_frame_position; ///< last position of the thing being dragged
+       double _total_x_delta;
 };
 
 
@@ -217,9 +291,10 @@ public:
        virtual void start_grab (GdkEvent *, Gdk::Cursor *);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
-       bool apply_move_threshold () const {
-               return true;
+       std::pair<nframes64_t, int> move_threshold () const {
+               return std::make_pair (4, 4);
        }
 
 private:
@@ -233,6 +308,7 @@ public:
        RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, nframes64_t);
 
        void finished (GdkEvent *, bool);
+       void aborted ();
 };
 
 /** Region drag in splice mode */
@@ -243,6 +319,7 @@ public:
 
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 };
 
 /** Drags to create regions */
@@ -254,6 +331,7 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
 private:
        TimeAxisView* _view;
@@ -269,6 +347,7 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
 private:
        MidiRegionView*     region;
@@ -284,6 +363,7 @@ class NoteDrag : public Drag
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
   private:
        MidiRegionView* region;
@@ -305,6 +385,8 @@ public:
        bool active (Editing::MouseMode m) {
                return (m == Editing::MouseGain);
        }
+
+       void aborted ();
 };
 
 /** Drag to trim region(s) */
@@ -322,10 +404,16 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool y_movement_matters () const {
+               return false;
+       }
 
 private:
 
        Operation _operation;
+       bool _have_transaction; ///< true if a transaction has been started, false otherwise. Must be set true by derived class.
 };
 
 /** Meter marker drag */
@@ -337,7 +425,16 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
+       bool allow_vertical_autoscroll () const {
+               return false;
+       }
+
+       bool y_movement_matters () const {
+               return false;
+       }
+       
 private:
        MeterMarker* _marker;
        bool _copy;
@@ -352,6 +449,15 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool allow_vertical_autoscroll () const {
+               return false;
+       }
+
+       bool y_movement_matters () const {
+               return false;
+       }
 
 private:
        TempoMarker* _marker;
@@ -368,6 +474,7 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
        bool active (Editing::MouseMode) {
                return true;
@@ -377,6 +484,10 @@ public:
                return false;
        }
 
+       bool y_movement_matters () const {
+               return false;
+       }
+
 private:
        EditorCursor* _cursor; ///< cursor being dragged
        bool _stop; ///< true to stop the transport on starting the drag, otherwise false
@@ -392,6 +503,11 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool y_movement_matters () const {
+               return false;
+       }
 };
 
 /** Region fade-out drag */
@@ -403,6 +519,11 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool y_movement_matters () const {
+               return false;
+       }
 };
 
 /** Marker drag */
@@ -415,7 +536,16 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool allow_vertical_autoscroll () const {
+               return false;
+       }
 
+       bool y_movement_matters () const {
+               return false;
+       }
+       
 private:
        void update_item (ARDOUR::Location *);
 
@@ -434,12 +564,15 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
        bool active (Editing::MouseMode m);
 
 private:
 
        ControlPoint* _point;
+       double _time_axis_view_grab_x;
+       double _time_axis_view_grab_y;
        double _cumulative_x_drag;
        double _cumulative_y_drag;
        static double const _zero_gain_fraction;
@@ -454,6 +587,7 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
        bool active (Editing::MouseMode) {
                return true;
@@ -462,6 +596,8 @@ public:
 private:
 
        AutomationLine* _line;
+       double _time_axis_view_grab_x;
+       double _time_axis_view_grab_y;
        uint32_t _before;
        uint32_t _after;
        double _cumulative_y_drag;
@@ -476,6 +612,11 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       std::pair<nframes64_t, int> move_threshold () const {
+               return std::make_pair (8, 1);
+       }
 };
 
 /** Region drag in time-FX mode */
@@ -487,6 +628,7 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 };
 
 /** Scrub drag in audition mode */
@@ -498,9 +640,10 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 };
 
-/** Drag in range select(gc_owner.get()) moAutomatable */
+/** Drag in range select mode */
 class SelectionDrag : public Drag
 {
 public:
@@ -516,10 +659,14 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
 
 private:
        Operation _operation;
        bool _copy;
+       int _original_pointer_time_axis;
+       int _last_pointer_time_axis;
+       std::list<TimeAxisView*> _added_time_axes;
 };
 
 /** Range marker drag */
@@ -537,6 +684,15 @@ public:
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool allow_vertical_autoscroll () const {
+               return false;
+       }
+
+       bool y_movement_matters () const {
+               return false;
+       }
 
 private:
        void update_item (ARDOUR::Location *);
@@ -546,15 +702,38 @@ private:
        bool _copy;
 };
 
-/* Drag of rectangle to set zoom */
+/** Drag of rectangle to set zoom */
 class MouseZoomDrag : public Drag
 {
 public:
-       MouseZoomDrag (Editor *e, ArdourCanvas::Item *i) : Drag (e, i) {}
+       MouseZoomDrag (Editor* e, ArdourCanvas::Item *i) : Drag (e, i) {}
+
+       void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
+       void motion (GdkEvent *, bool);
+       void finished (GdkEvent *, bool);
+       void aborted ();
+};
+
+/** Drag of a range of automation data, changing value but not position */
+class AutomationRangeDrag : public Drag
+{
+public:
+       AutomationRangeDrag (Editor *, ArdourCanvas::Item *, std::list<ARDOUR::AudioRange> const &);
 
        void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
        void motion (GdkEvent *, bool);
        void finished (GdkEvent *, bool);
+       void aborted ();
+
+       bool x_movement_matters () const {
+               return false;
+       }
+
+private:
+       std::list<ARDOUR::AudioRange> _ranges;
+       AutomationTimeAxisView* _atav;
+       boost::shared_ptr<AutomationLine> _line;
+       bool _nothing_to_drag;
 };
 
 #endif /* __gtk2_ardour_editor_drag_h_ */