libs/canvas/canvas.cc

   1 /*
   2     Copyright (C) 2011 Paul Davis
   3     Author: Carl Hetherington <cth@carlh.net>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file  canvas/canvas.cc
  22  *  @brief Implementation of the main canvas classes.
  23  */
  24
  25 #include <cassert>
  26 #include <gtkmm/adjustment.h>
  27 #include <gtkmm/label.h>
  28
  29 #include "pbd/compose.h"
  30 #include "pbd/stacktrace.h"
  31
  32 #include "canvas/canvas.h"
  33 #include "canvas/debug.h"
  34
  35 using namespace std;
  36 using namespace ArdourCanvas;
  37
  38 /** Construct a new Canvas */
  39 Canvas::Canvas ()
  40         : _root (this)
  41         , _log_renders (true)
  42         , _scroll_offset_x (0)
  43         , _scroll_offset_y (0)
  44 {
  45         set_epoch ();
  46 }
  47
  48 void
  49 Canvas::scroll_to (Coord x, Coord y)
  50 {
  51         _scroll_offset_x = x;
  52         _scroll_offset_y = y;
  53 }
  54
  55 /** Render an area of the canvas.
  56  *  @param area Area in canvas coordinates.
  57  *  @param context Cairo context to render to.
  58  */
  59 void
  60 Canvas::render (Rect const & area, Cairo::RefPtr<Cairo::Context> const & context) const
  61 {
  62 #ifdef CANVAS_DEBUG
  63         if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
  64                 cerr << "CANVAS @ " << this << endl;
  65                 dump (cerr);
  66                 cerr << "-------------------------\n";
  67         }
  68 #endif
  69
  70         // checkpoint ("render", "-> render");
  71         render_count = 0;
  72
  73         context->save ();
  74
  75 #ifdef CANVAS_DEBUG
  76         if (getenv ("ARDOUR_REDRAW_CANVAS")) {
  77                 /* light up the canvas to show redraws */
  78                 context->set_source_rgba (random()%255 / 255.0,
  79                                           random()%255 / 255.0,
  80                                           random()%255 / 255.0,
  81                                           255);
  82                 context->rectangle (area.x0, area.y0, area.width(), area.height());
  83                 context->stroke ();
  84         }
  85 #endif
  86
  87         /* clip to the requested area */
  88         context->rectangle (area.x0, area.y0, area.width(), area.height());
  89         context->clip ();
  90
  91         boost::optional<Rect> root_bbox = _root.bounding_box();
  92         if (!root_bbox) {
  93                 /* the root has no bounding box, so there's nothing to render */
  94                 // checkpoint ("render", "no root bbox");
  95                 context->restore ();
  96                 return;
  97         }
  98
  99         boost::optional<Rect> draw = root_bbox.get().intersection (area);
 100         if (draw) {
 101                 /* there's a common area between the root and the requested
 102                    area, so render it.
 103                 */
 104                 // checkpoint ("render", "... root");
 105                 context->stroke ();
 106
 107                 _root.render (*draw, context);
 108         }
 109
 110         if (_log_renders) {
 111                 _renders.push_back (area);
 112         }
 113
 114         context->restore ();
 115
 116 #ifdef CANVAS_DEBUG
 117         if (getenv ("ARDOUR_HARLEQUIN_CANVAS")) {
 118                 /* light up the canvas to show redraws */
 119                 context->set_source_rgba (random()%255 / 255.0,
 120                                           random()%255 / 255.0,
 121                                           random()%255 / 255.0,
 122                                           255);
 123                 context->rectangle (area.x0, area.y0, area.width(), area.height());
 124                 context->fill ();
 125         }
 126 #endif
 127         // checkpoint ("render", "<- render");
 128 }
 129
 130 ostream&
 131 operator<< (ostream& o, Canvas& c)
 132 {
 133         c.dump (o);
 134         return o;
 135 }
 136
 137 std::string
 138 Canvas::indent() const
 139 {
 140         string s;
 141
 142         for (int n = 0; n < ArdourCanvas::dump_depth; ++n) {
 143                 s += '\t';
 144         }
 145
 146         return s;
 147 }
 148
 149 std::string
 150 Canvas::render_indent() const
 151 {
 152         string s;
 153
 154         for (int n = 0; n < ArdourCanvas::render_depth; ++n) {
 155                 s += ' ';
 156         }
 157
 158         return s;
 159 }
 160
 161 void
 162 Canvas::dump (ostream& o) const
 163 {
 164         dump_depth = 0;
 165         _root.dump (o);
 166 }
 167
 168 /** Called when an item has been shown or hidden.
 169  *  @param item Item that has been shown or hidden.
 170  */
 171 void
 172 Canvas::item_shown_or_hidden (Item* item)
 173 {
 174         boost::optional<Rect> bbox = item->bounding_box ();
 175         if (bbox) {
 176                 queue_draw_item_area (item, bbox.get ());
 177         }
 178 }
 179
 180 /** Called when an item has a change to its visual properties
 181  *  that do NOT affect its bounding box.
 182  *  @param item Item that has been modified.
 183  */
 184 void
 185 Canvas::item_visual_property_changed (Item* item)
 186 {
 187         boost::optional<Rect> bbox = item->bounding_box ();
 188         if (bbox) {
 189                 queue_draw_item_area (item, bbox.get ());
 190         }
 191 }
 192
 193 /** Called when an item has changed, but not moved.
 194  *  @param item Item that has changed.
 195  *  @param pre_change_bounding_box The bounding box of item before the change,
 196  *  in the item's coordinates.
 197  */
 198 void
 199 Canvas::item_changed (Item* item, boost::optional<Rect> pre_change_bounding_box)
 200 {
 201         if (pre_change_bounding_box) {
 202                 /* request a redraw of the item's old bounding box */
 203                 queue_draw_item_area (item, pre_change_bounding_box.get ());
 204         }
 205
 206         boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
 207         if (post_change_bounding_box) {
 208                 /* request a redraw of the item's new bounding box */
 209                 queue_draw_item_area (item, post_change_bounding_box.get ());
 210         }
 211 }
 212
 213 Duple
 214 Canvas::window_to_canvas (Duple const & d) const
 215 {
 216         return d.translate (Duple (_scroll_offset_x, _scroll_offset_y));
 217 }
 218
 219 Duple
 220 Canvas::canvas_to_window (Duple const & d) const
 221 {
 222         return d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
 223 }
 224
 225 Rect
 226 Canvas::window_to_canvas (Rect const & r) const
 227 {
 228         return r.translate (Duple (_scroll_offset_x, _scroll_offset_y));
 229 }
 230
 231 Rect
 232 Canvas::canvas_to_window (Rect const & r) const
 233 {
 234         return r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
 235 }
 236
 237 /** Called when an item has moved.
 238  *  @param item Item that has moved.
 239  *  @param pre_change_parent_bounding_box The bounding box of the item before
 240  *  the move, in its parent's coordinates.
 241  */
 242 void
 243 Canvas::item_moved (Item* item, boost::optional<Rect> pre_change_parent_bounding_box)
 244 {
 245         if (pre_change_parent_bounding_box) {
 246                 /* request a redraw of where the item used to be. The box has
 247                  * to be in parent coordinate space since the bounding box of
 248                  * an item does not change when moved. If we use
 249                  * item->item_to_canvas() on the old bounding box, we will be
 250                  * using the item's new position, and so will compute the wrong
 251                  * invalidation area. If we use the parent (which has not
 252                  * moved, then this will work.
 253                  */
 254
 255                 queue_draw_item_area (item->parent(), pre_change_parent_bounding_box.get ());
 256         }
 257
 258         boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
 259         if (post_change_bounding_box) {
 260                 /* request a redraw of where the item now is */
 261                 queue_draw_item_area (item, post_change_bounding_box.get ());
 262         }
 263 }
 264
 265 /** Request a redraw of a particular area in an item's coordinates.
 266  *  @param item Item.
 267  *  @param area Area to redraw in the item's coordinates.
 268  */
 269 void
 270 Canvas::queue_draw_item_area (Item* item, Rect area)
 271 {
 272         ArdourCanvas::Rect canvas_area = item->item_to_canvas (area);
 273         // cerr << "CANVAS Invalidate " << area << " TRANSLATE AS " << canvas_area << endl;
 274         request_redraw (canvas_area);
 275 }
 276
 277 /** Construct a GtkCanvas */
 278 GtkCanvas::GtkCanvas ()
 279         : _current_item (0)
 280         , _grabbed_item (0)
 281 {
 282         /* these are the events we want to know about */
 283         add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK);
 284 }
 285
 286 /** Handler for button presses on the canvas.
 287  *  @param ev GDK event.
 288  */
 289 bool
 290 GtkCanvas::button_handler (GdkEventButton* ev)
 291 {
 292         DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button %3 %1 %1\n", ev->x, ev->y, (ev->type == GDK_BUTTON_PRESS ? "press" : "release")));
 293         /* The Duple that we are passing in here is in canvas coordinates */
 294         return deliver_event (Duple (ev->x, ev->y), reinterpret_cast<GdkEvent*> (ev));
 295 }
 296
 297 /** Handler for pointer motion events on the canvas.
 298  *  @param ev GDK event.
 299  *  @return true if the motion event was handled, otherwise false.
 300  */
 301 bool
 302 GtkCanvas::motion_notify_handler (GdkEventMotion* ev)
 303 {
 304         if (_grabbed_item) {
 305                 /* if we have a grabbed item, it gets just the motion event,
 306                    since no enter/leave events can have happened.
 307                 */
 308                 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send MOTION event there\n",
 309                                                                        _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
 310                 return _grabbed_item->Event (reinterpret_cast<GdkEvent*> (ev));
 311         }
 312
 313         /* This is in canvas coordinates */
 314         Duple point (ev->x, ev->y);
 315
 316         /* find the items at the new mouse position */
 317         vector<Item const *> items;
 318         _root.add_items_at_point (point, items);
 319
 320         Item const * new_item = items.empty() ? 0 : items.back ();
 321
 322         if (_current_item && _current_item != new_item) {
 323                 /* leave event */
 324                 GdkEventCrossing leave_event;
 325                 leave_event.type = GDK_LEAVE_NOTIFY;
 326                 leave_event.x = ev->x;
 327                 leave_event.y = ev->y;
 328                 _current_item->Event (reinterpret_cast<GdkEvent*> (&leave_event));
 329         }
 330
 331         if (new_item && _current_item != new_item) {
 332                 /* enter event */
 333                 GdkEventCrossing enter_event;
 334                 enter_event.type = GDK_ENTER_NOTIFY;
 335                 enter_event.x = ev->x;
 336                 enter_event.y = ev->y;
 337                 new_item->Event (reinterpret_cast<GdkEvent*> (&enter_event));
 338         }
 339
 340         _current_item = new_item;
 341
 342         /* Now deliver the motion event.  It may seem a little inefficient
 343            to recompute the items under the event, but the enter notify/leave
 344            events may have deleted canvas items so it is important to
 345            recompute the list in deliver_event.
 346         */
 347         return deliver_event (point, reinterpret_cast<GdkEvent*> (ev));
 348 }
 349
 350 /** Deliver an event to the appropriate item; either the grabbed item, or
 351  *  one of the items underneath the event.
 352  *  @param point Position that the event has occurred at, in canvas coordinates.
 353  *  @param event The event.
 354  */
 355 bool
 356 GtkCanvas::deliver_event (Duple point, GdkEvent* event)
 357 {
 358         if (_grabbed_item) {
 359                 /* we have a grabbed item, so everything gets sent there */
 360                 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send event there\n",
 361                                                                        _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
 362                 return _grabbed_item->Event (event);
 363         }
 364
 365         /* find the items that exist at the event's position */
 366         vector<Item const *> items;
 367         _root.add_items_at_point (point, items);
 368
 369         DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 possible items to deliver event to\n", items.size()));
 370
 371         /* run through the items under the event, from top to bottom, until one claims the event */
 372         vector<Item const *>::const_reverse_iterator i = items.rbegin ();
 373         while (i != items.rend()) {
 374
 375                 if ((*i)->ignore_events ()) {
 376                         DEBUG_TRACE (
 377                                 PBD::DEBUG::CanvasEvents,
 378                                 string_compose ("canvas event ignored by %1 %2\n", (*i)->whatami(), (*i)->name.empty() ? "[unknown]" : (*i)->name)
 379                                 );
 380                         ++i;
 381                         continue;
 382                 }
 383
 384                 if ((*i)->Event (event)) {
 385                         /* this item has just handled the event */
 386                         DEBUG_TRACE (
 387                                 PBD::DEBUG::CanvasEvents,
 388                                 string_compose ("canvas event handled by %1 %2\n", (*i)->whatami(), (*i)->name.empty() ? "[unknown]" : (*i)->name)
 389                                 );
 390
 391                         return true;
 392                 }
 393
 394                 DEBUG_TRACE (
 395                         PBD::DEBUG::CanvasEvents,
 396                         string_compose ("canvas event left unhandled by %1 %2\n", (*i)->whatami(), (*i)->name.empty() ? "[unknown]" : (*i)->name)
 397                         );
 398
 399                 ++i;
 400         }
 401
 402         /* debugging */
 403         if (PBD::debug_bits & PBD::DEBUG::CanvasEvents) {
 404                 while (i != items.rend()) {
 405                         DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event not seen by %1\n", (*i)->name.empty() ? "[unknown]" : (*i)->name));
 406                         ++i;
 407                 }
 408         }
 409
 410         return false;
 411 }
 412
 413 /** Called when an item is being destroyed.
 414  *  @param item Item being destroyed.
 415  *  @param bounding_box Last known bounding box of the item.
 416  */
 417 void
 418 GtkCanvas::item_going_away (Item* item, boost::optional<Rect> bounding_box)
 419 {
 420         if (bounding_box) {
 421                 queue_draw_item_area (item, bounding_box.get ());
 422         }
 423
 424         if (_current_item == item) {
 425                 _current_item = 0;
 426         }
 427
 428         if (_grabbed_item == item) {
 429                 _grabbed_item = 0;
 430         }
 431 }
 432
 433 /** Handler for GDK expose events.
 434  *  @param ev Event.
 435  *  @return true if the event was handled.
 436  */
 437 bool
 438 GtkCanvas::on_expose_event (GdkEventExpose* ev)
 439 {
 440
 441         Cairo::RefPtr<Cairo::Context> c = get_window()->create_cairo_context ();
 442
 443         /* WINDOW  CANVAS
 444          * 0,0     _scroll_offset_x, _scroll_offset_y
 445          */
 446
 447         /* render using canvas coordinates */
 448
 449         Rect canvas_area (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height);
 450         canvas_area  = canvas_area.translate (Duple (_scroll_offset_x, _scroll_offset_y));
 451
 452         /* things are going to render to the cairo surface with canvas
 453          * coordinates:
 454          *
 455          *  an item at window/cairo 0,0 will have canvas_coords _scroll_offset_x,_scroll_offset_y
 456          *
 457          * let them render at their natural coordinates by using cairo_translate()
 458          */
 459
 460         c->translate (-_scroll_offset_x, -_scroll_offset_y);
 461
 462         render (canvas_area, c);
 463
 464         return true;
 465 }
 466
 467 /** @return Our Cairo context, or 0 if we don't have one */
 468 Cairo::RefPtr<Cairo::Context>
 469 GtkCanvas::context ()
 470 {
 471         Glib::RefPtr<Gdk::Window> w = get_window ();
 472         if (!w) {
 473                 return Cairo::RefPtr<Cairo::Context> ();
 474         }
 475
 476         return w->create_cairo_context ();
 477 }
 478
 479 /** Handler for GDK button press events.
 480  *  @param ev Event.
 481  *  @return true if the event was handled.
 482  */
 483 bool
 484 GtkCanvas::on_button_press_event (GdkEventButton* ev)
 485 {
 486         /* translate event coordinates from window to canvas */
 487
 488         GdkEvent copy = *((GdkEvent*)ev);
 489         Duple where = window_to_canvas (Duple (ev->x, ev->y));
 490
 491         copy.button.x = where.x;
 492         copy.button.y = where.y;
 493
 494         /* Coordinates in the event will be canvas coordinates, correctly adjusted
 495            for scroll if this GtkCanvas is in a GtkCanvasViewport.
 496         */
 497         return button_handler ((GdkEventButton*) &copy);
 498 }
 499
 500 /** Handler for GDK button release events.
 501  *  @param ev Event.
 502  *  @return true if the event was handled.
 503  */
 504 bool
 505 GtkCanvas::on_button_release_event (GdkEventButton* ev)
 506 {
 507         /* translate event coordinates from window to canvas */
 508
 509         GdkEvent copy = *((GdkEvent*)ev);
 510         Duple where = window_to_canvas (Duple (ev->x, ev->y));
 511
 512         copy.button.x = where.x;
 513         copy.button.y = where.y;
 514
 515         /* Coordinates in the event will be canvas coordinates, correctly adjusted
 516            for scroll if this GtkCanvas is in a GtkCanvasViewport.
 517         */
 518         return button_handler ((GdkEventButton*) &copy);
 519 }
 520
 521 /** Handler for GDK motion events.
 522  *  @param ev Event.
 523  *  @return true if the event was handled.
 524  */
 525 bool
 526 GtkCanvas::on_motion_notify_event (GdkEventMotion* ev)
 527 {
 528         /* translate event coordinates from window to canvas */
 529
 530         GdkEvent copy = *((GdkEvent*)ev);
 531         Duple where = window_to_canvas (Duple (ev->x, ev->y));
 532
 533         copy.motion.x = where.x;
 534         copy.motion.y = where.y;
 535
 536         /* Coordinates in the event will be canvas coordinates, correctly adjusted
 537            for scroll if this GtkCanvas is in a GtkCanvasViewport.
 538         */
 539         return motion_notify_handler ((GdkEventMotion*) &copy);
 540 }
 541
 542 /** Called to request a redraw of our canvas.
 543  *  @param area Area to redraw, in canvas coordinates.
 544  */
 545 void
 546 GtkCanvas::request_redraw (Rect const & request)
 547 {
 548         Rect area = canvas_to_window (request);
 549         // cerr << "Invalidate " << request << " TRANSLATE AS " << area << endl;
 550         queue_draw_area (floor (area.x0), floor (area.y0), ceil (area.x1) - floor (area.x0), ceil (area.y1) - floor (area.y0));
 551 }
 552
 553 /** Called to request that we try to get a particular size for ourselves.
 554  *  @param size Size to request, in pixels.
 555  */
 556 void
 557 GtkCanvas::request_size (Duple size)
 558 {
 559         Duple req = size;
 560
 561         if (req.x > INT_MAX) {
 562                 req.x = INT_MAX;
 563         }
 564
 565         if (req.y > INT_MAX) {
 566                 req.y = INT_MAX;
 567         }
 568
 569         set_size_request (req.x, req.y);
 570 }
 571
 572 /** `Grab' an item, so that all events are sent to that item until it is `ungrabbed'.
 573  *  This is typically used for dragging items around, so that they are grabbed during
 574  *  the drag.
 575  *  @param item Item to grab.
 576  */
 577 void
 578 GtkCanvas::grab (Item* item)
 579 {
 580         /* XXX: should this be doing gdk_pointer_grab? */
 581         _grabbed_item = item;
 582 }
 583
 584 /** `Ungrab' any item that was previously grabbed */
 585 void
 586 GtkCanvas::ungrab ()
 587 {
 588         /* XXX: should this be doing gdk_pointer_ungrab? */
 589         _grabbed_item = 0;
 590 }
 591
 592 /** @return The visible area of the canvas, in canvas coordinates */
 593 Rect
 594 GtkCanvas::visible_area () const
 595 {
 596         Distance const xo = _scroll_offset_x;
 597         Distance const yo = _scroll_offset_y;
 598         return Rect (xo, yo, xo + get_allocation().get_width (), yo + get_allocation().get_height ());
 599 }
 600
 601 /** Create a GtkCanvaSViewport.
 602  *  @param hadj Adjustment to use for horizontal scrolling.
 603  *  @param vadj Adjustment to use for vertica scrolling.
 604  */
 605 GtkCanvasViewport::GtkCanvasViewport (Gtk::Adjustment& hadj, Gtk::Adjustment& vadj)
 606         : Alignment (0, 0, 1.0, 1.0)
 607         , hadjustment (hadj)
 608         , vadjustment (vadj)
 609 {
 610         add (_canvas);
 611
 612         hadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
 613         vadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
 614 }
 615
 616 void
 617 GtkCanvasViewport::scrolled ()
 618 {
 619         _canvas.scroll_to (hadjustment.get_value(), vadjustment.get_value());
 620         queue_draw ();
 621 }
 622
 623 /** Handler for when GTK asks us what minimum size we want.
 624  *  @param req Requsition to fill in.
 625  */
 626 void
 627 GtkCanvasViewport::on_size_request (Gtk::Requisition* req)
 628 {
 629         /* force the canvas to size itself */
 630         // _canvas.root()->bounding_box();
 631
 632         req->width = 16;
 633         req->height = 16;
 634 }
 635