gtk2_ardour/editor_drag.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __gtk2_ardour_editor_drag_h_
  21 #define __gtk2_ardour_editor_drag_h_
  22
  23 #include <list>
  24
  25 #include <gdk/gdk.h>
  26 #include <stdint.h>
  27
  28 #include "ardour/types.h"
  29
  30 #include "canvas.h"
  31 #include "editor_items.h"
  32
  33 namespace ARDOUR {
  34         class Location;
  35 }
  36
  37 class Editor;
  38 class EditorCursor;
  39 class TimeAxisView;
  40
  41 /** Abstract base class for dragging of things within the editor */
  42 class Drag
  43 {
  44
  45 public:
  46         Drag (Editor *, ArdourCanvas::Item *);
  47         virtual ~Drag () {}
  48
  49         /** @return the canvas item being dragged */
  50         ArdourCanvas::Item* item () const {
  51                 return _item;
  52         }
  53
  54         void swap_grab (ArdourCanvas::Item *, Gdk::Cursor *, uint32_t);
  55         void break_drag ();
  56
  57         bool motion_handler (GdkEvent*, bool);
  58
  59         /** @return true if an end drag is in progress */
  60         bool ending () const {
  61                 return _ending;
  62         }
  63
  64         /** @return current pointer x position in item coordinates */
  65         double current_pointer_x () const {
  66                 return _current_pointer_x;
  67         }
  68
  69         /** @return current pointer y position in item coordinates */
  70         double current_pointer_y () const {
  71                 return _current_pointer_y;
  72         }
  73
  74         /** @return current pointer frame */
  75         nframes64_t current_pointer_frame () const {
  76                 return _current_pointer_frame;
  77         }
  78
  79         /** Called to start a grab of an item.
  80          *  @param e Event that caused the grab to start.
  81          *  @param c Cursor to use, or 0.
  82          */
  83         virtual void start_grab (GdkEvent* e, Gdk::Cursor* c = 0);
  84
  85         virtual bool end_grab (GdkEvent *);
  86
  87         /** Called when a drag motion has occurred.
  88          *  @param e Event describing the motion.
  89          *  @param f true if this is the first movement, otherwise false.
  90          */
  91         virtual void motion (GdkEvent* e, bool f) = 0;
  92
  93         /** Called when a drag has finished.
  94          *  @param e Event describing the finish.
  95          *  @param m true if some movement occurred, otherwise false.
  96          */
  97         virtual void finished (GdkEvent* e, bool m) = 0;
  98
  99         /** @param m Mouse mode.
 100          *  @return true if this drag should happen in this mouse mode.
 101          */
 102         virtual bool active (Editing::MouseMode m) {
 103                 return (m != Editing::MouseGain);
 104         }
 105
 106         /** @return true if a small threshold should be applied before a mouse movement
 107          *  is considered a drag, otherwise false.
 108          */
 109         virtual bool apply_move_threshold () const {
 110                 return false;
 111         }
 112
 113         virtual bool allow_vertical_autoscroll () const {
 114                 return true;
 115         }
 116
 117 protected:
 118         nframes64_t adjusted_current_frame (GdkEvent *) const;
 119
 120         Editor* _editor; ///< our editor
 121         ArdourCanvas::Item* _item; ///< our item
 122         nframes64_t _pointer_frame_offset; ///< offset from the mouse's position for the drag
 123                                            ///< to the start of the thing that is being dragged
 124         nframes64_t _last_frame_position; ///< last position of the thing being dragged
 125         nframes64_t _grab_frame; ///< frame that the mouse was at when start_grab was called, or 0
 126         nframes64_t _last_pointer_frame; ///< frame that the pointer was at last time a motion occurred
 127         nframes64_t _current_pointer_frame; ///< frame that the pointer is now at
 128         double _original_x; ///< original world x of the thing being dragged
 129         double _original_y; ///< original world y of the thing being dragged
 130         double _grab_x; ///< item x of the grab start position
 131         double _grab_y; ///< item y of the grab start position
 132         double _current_pointer_x; ///< item x of the current pointer
 133         double _current_pointer_y; ///< item y of the current pointer
 134         double _last_pointer_x; ///< item x of the pointer last time a motion occurred
 135         double _last_pointer_y; ///< item y of the pointer last time a motion occurred
 136         bool _x_constrained; ///< true if x motion is constrained, otherwise false
 137         bool _y_constrained; ///< true if y motion is constrained, otherwise false
 138         bool _was_rolling; ///< true if the session was rolling before the drag started, otherwise false
 139
 140 private:
 141
 142         bool _ending; ///< true if end_grab is in progress, otherwise false
 143         bool _had_movement; ///< true if movement has occurred, otherwise false
 144         bool _move_threshold_passed; ///< true if the move threshold has been passed, otherwise false
 145 };
 146
 147
 148 /** Abstract base class for drags that involve region(s) */
 149 class RegionDrag : public Drag, public sigc::trackable
 150 {
 151 public:
 152         RegionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 153         virtual ~RegionDrag () {}
 154
 155 protected:
 156
 157         RegionView* _primary; ///< the view that was clicked on (or whatever) to start the drag
 158         std::list<RegionView*> _views; ///< all views that are being dragged
 159
 160 private:
 161         void region_going_away (RegionView *);
 162 };
 163
 164
 165 /** Drags involving region motion from somewhere */
 166 class RegionMotionDrag : public RegionDrag
 167 {
 168 public:
 169
 170         RegionMotionDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool);
 171         virtual ~RegionMotionDrag () {}
 172
 173         virtual void start_grab (GdkEvent *, Gdk::Cursor *);
 174         virtual void motion (GdkEvent *, bool);
 175         virtual void finished (GdkEvent *, bool) = 0;
 176
 177 protected:
 178         struct TimeAxisViewSummary {
 179                 TimeAxisViewSummary () : height_list(512) {}
 180
 181                 std::bitset<512> tracks;
 182                 std::vector<int32_t> height_list;
 183                 int visible_y_low;
 184                 int visible_y_high;
 185         };
 186
 187         void copy_regions (GdkEvent *);
 188         bool y_movement_disallowed (int, int, int, TimeAxisViewSummary const &) const;
 189         std::map<RegionView*, RouteTimeAxisView*> find_time_axis_views ();
 190         double compute_x_delta (GdkEvent const *, nframes64_t *);
 191         bool compute_y_delta (
 192                 TimeAxisView const *, TimeAxisView*, int32_t, int32_t, TimeAxisViewSummary const &,
 193                 int32_t *, int32_t *, int32_t *
 194                 );
 195
 196         TimeAxisViewSummary get_time_axis_view_summary ();
 197         virtual bool x_move_allowed () const = 0;
 198
 199         TimeAxisView* _dest_trackview;
 200         ARDOUR::layer_t _dest_layer;
 201         bool check_possible (RouteTimeAxisView **, ARDOUR::layer_t *);
 202         bool _brushing;
 203 };
 204
 205
 206 /** Drags to move (or copy) regions that are already shown in the GUI to
 207  *  somewhere different.
 208  */
 209 class RegionMoveDrag : public RegionMotionDrag
 210 {
 211 public:
 212         RegionMoveDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &, bool, bool);
 213         virtual ~RegionMoveDrag () {}
 214
 215         virtual void start_grab (GdkEvent *, Gdk::Cursor *);
 216         void motion (GdkEvent *, bool);
 217         void finished (GdkEvent *, bool);
 218
 219         bool apply_move_threshold () const {
 220                 return true;
 221         }
 222
 223 private:
 224         bool x_move_allowed () const;
 225
 226         bool _copy;
 227 };
 228
 229 /** Drag to insert a region from somewhere */
 230 class RegionInsertDrag : public RegionMotionDrag
 231 {
 232 public:
 233         RegionInsertDrag (Editor *, boost::shared_ptr<ARDOUR::Region>, RouteTimeAxisView*, nframes64_t);
 234
 235         void finished (GdkEvent *, bool);
 236
 237 private:
 238         bool x_move_allowed () const;
 239 };
 240
 241 /** Region drag in splice mode */
 242 class RegionSpliceDrag : public RegionMoveDrag
 243 {
 244 public:
 245         RegionSpliceDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 246
 247         void motion (GdkEvent *, bool);
 248         void finished (GdkEvent *, bool);
 249 };
 250
 251 /** Drags to create regions */
 252 class RegionCreateDrag : public Drag
 253 {
 254 public:
 255         RegionCreateDrag (Editor *, ArdourCanvas::Item *, TimeAxisView *);
 256
 257         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 258         void motion (GdkEvent *, bool);
 259         void finished (GdkEvent *, bool);
 260
 261 private:
 262         TimeAxisView* _view;
 263         TimeAxisView* _dest_trackview;
 264 };
 265
 266 /** Drag of region gain */
 267 class RegionGainDrag : public Drag
 268 {
 269 public:
 270         RegionGainDrag (Editor *e, ArdourCanvas::Item *i) : Drag (e, i) {}
 271
 272         void motion (GdkEvent *, bool);
 273         void finished (GdkEvent *, bool);
 274         bool active (Editing::MouseMode m) {
 275                 return (m == Editing::MouseGain);
 276         }
 277 };
 278
 279 /** Drag to trim region(s) */
 280 class TrimDrag : public RegionDrag
 281 {
 282 public:
 283         enum Operation {
 284                 StartTrim,
 285                 EndTrim,
 286                 ContentsTrim,
 287         };
 288
 289         TrimDrag (Editor *, ArdourCanvas::Item *, RegionView*, std::list<RegionView*> const &);
 290
 291         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 292         void motion (GdkEvent *, bool);
 293         void finished (GdkEvent *, bool);
 294
 295 private:
 296
 297         Operation _operation;
 298 };
 299
 300 /** Meter marker drag */
 301 class MeterMarkerDrag : public Drag
 302 {
 303 public:
 304         MeterMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
 305
 306         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 307         void motion (GdkEvent *, bool);
 308         void finished (GdkEvent *, bool);
 309
 310 private:
 311         MeterMarker* _marker;
 312         bool _copy;
 313 };
 314
 315 /** Tempo marker drag */
 316 class TempoMarkerDrag : public Drag
 317 {
 318 public:
 319         TempoMarkerDrag (Editor *, ArdourCanvas::Item *, bool);
 320
 321         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 322         void motion (GdkEvent *, bool);
 323         void finished (GdkEvent *, bool);
 324
 325 private:
 326         TempoMarker* _marker;
 327         bool _copy;
 328 };
 329
 330
 331 /** Drag of a cursor */
 332 class CursorDrag : public Drag
 333 {
 334 public:
 335         CursorDrag (Editor *, ArdourCanvas::Item *, bool);
 336
 337         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 338         void motion (GdkEvent *, bool);
 339         void finished (GdkEvent *, bool);
 340
 341         bool active (Editing::MouseMode) {
 342                 return true;
 343         }
 344
 345         bool allow_vertical_autoscroll () const {
 346                 return false;
 347         }
 348
 349 private:
 350         EditorCursor* _cursor; ///< cursor being dragged
 351         bool _stop; ///< true to stop the transport on starting the drag, otherwise false
 352
 353 };
 354
 355 /** Region fade-in drag */
 356 class FadeInDrag : public RegionDrag
 357 {
 358 public:
 359         FadeInDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 360
 361         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 362         void motion (GdkEvent *, bool);
 363         void finished (GdkEvent *, bool);
 364 };
 365
 366 /** Region fade-out drag */
 367 class FadeOutDrag : public RegionDrag
 368 {
 369 public:
 370         FadeOutDrag (Editor *, ArdourCanvas::Item *, RegionView *, std::list<RegionView*> const &);
 371
 372         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 373         void motion (GdkEvent *, bool);
 374         void finished (GdkEvent *, bool);
 375 };
 376
 377 /** Marker drag */
 378 class MarkerDrag : public Drag
 379 {
 380 public:
 381         MarkerDrag (Editor *, ArdourCanvas::Item *);
 382         ~MarkerDrag ();
 383
 384         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 385         void motion (GdkEvent *, bool);
 386         void finished (GdkEvent *, bool);
 387
 388 private:
 389         void update_item (ARDOUR::Location *);
 390
 391         Marker* _marker; ///< marker being dragged
 392         std::list<ARDOUR::Location*> _copied_locations;
 393         ArdourCanvas::Line* _line;
 394         ArdourCanvas::Points _points;
 395 };
 396
 397 /** Control point drag */
 398 class ControlPointDrag : public Drag
 399 {
 400 public:
 401         ControlPointDrag (Editor *, ArdourCanvas::Item *);
 402
 403         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 404         void motion (GdkEvent *, bool);
 405         void finished (GdkEvent *, bool);
 406
 407         bool active (Editing::MouseMode m) {
 408                 return (m == Editing::MouseGain);
 409         }
 410
 411 private:
 412
 413         ControlPoint* _point;
 414         double _cumulative_x_drag;
 415         double _cumulative_y_drag;
 416         static double const _zero_gain_fraction;
 417 };
 418
 419 /** Gain or automation line drag */
 420 class LineDrag : public Drag
 421 {
 422 public:
 423         LineDrag (Editor *e, ArdourCanvas::Item *i);
 424
 425         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 426         void motion (GdkEvent *, bool);
 427         void finished (GdkEvent *, bool);
 428
 429         bool active (Editing::MouseMode) {
 430                 return true;
 431         }
 432
 433 private:
 434
 435         AutomationLine* _line;
 436         uint32_t _before;
 437         uint32_t _after;
 438         double _cumulative_y_drag;
 439 };
 440
 441 /** Dragging of a rubberband rectangle for selecting things */
 442 class RubberbandSelectDrag : public Drag
 443 {
 444 public:
 445         RubberbandSelectDrag (Editor *e, ArdourCanvas::Item *i) : Drag (e, i) {}
 446
 447         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 448         void motion (GdkEvent *, bool);
 449         void finished (GdkEvent *, bool);
 450 };
 451
 452 /** Region drag in time-FX mode */
 453 class TimeFXDrag : public RegionDrag
 454 {
 455 public:
 456         TimeFXDrag (Editor *e, ArdourCanvas::Item *i, RegionView* p, std::list<RegionView*> const & v) : RegionDrag (e, i, p, v) {}
 457
 458         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 459         void motion (GdkEvent *, bool);
 460         void finished (GdkEvent *, bool);
 461 };
 462
 463 /** Scrub drag in audition mode */
 464 class ScrubDrag : public Drag
 465 {
 466 public:
 467         ScrubDrag (Editor *e, ArdourCanvas::Item *i) : Drag (e, i) {}
 468
 469         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 470         void motion (GdkEvent *, bool);
 471         void finished (GdkEvent *, bool);
 472 };
 473
 474 /** Drag in range select(gc_owner.get()) moAutomatable */
 475 class SelectionDrag : public Drag
 476 {
 477 public:
 478         enum Operation {
 479                 CreateSelection,
 480                 SelectionStartTrim,
 481                 SelectionEndTrim,
 482                 SelectionMove
 483         };
 484
 485         SelectionDrag (Editor *, ArdourCanvas::Item *, Operation);
 486
 487         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 488         void motion (GdkEvent *, bool);
 489         void finished (GdkEvent *, bool);
 490
 491 private:
 492         Operation _operation;
 493         bool _copy;
 494 };
 495
 496 /** Range marker drag */
 497 class RangeMarkerBarDrag : public Drag
 498 {
 499 public:
 500         enum Operation {
 501                 CreateRangeMarker,
 502                 CreateTransportMarker,
 503                 CreateCDMarker
 504         };
 505
 506         RangeMarkerBarDrag (Editor *, ArdourCanvas::Item *, Operation);
 507
 508         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 509         void motion (GdkEvent *, bool);
 510         void finished (GdkEvent *, bool);
 511
 512 private:
 513         void update_item (ARDOUR::Location *);
 514
 515         Operation _operation;
 516         ArdourCanvas::SimpleRect* _drag_rect;
 517         bool _copy;
 518 };
 519
 520 /* Drag of rectangle to set zoom */
 521 class MouseZoomDrag : public Drag
 522 {
 523 public:
 524         MouseZoomDrag (Editor *e, ArdourCanvas::Item *i) : Drag (e, i) {}
 525
 526         void start_grab (GdkEvent *, Gdk::Cursor* c = 0);
 527         void motion (GdkEvent *, bool);
 528         void finished (GdkEvent *, bool);
 529 };
 530
 531 #endif /* __gtk2_ardour_editor_drag_h_ */
 532