2 Copyright (C) 2011 Paul Davis
3 Author: Carl Hetherington <cth@carlh.net>
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.
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.
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.
21 /** @file canvas/canvas.cc
22 * @brief Implementation of the main canvas classes.
27 #include <gtkmm/adjustment.h>
28 #include <gtkmm/label.h>
30 #include "pbd/compose.h"
31 #include "pbd/stacktrace.h"
33 #include "canvas/canvas.h"
34 #include "canvas/debug.h"
37 using namespace ArdourCanvas;
39 /** Construct a new Canvas */
42 , _scroll_offset_x (0)
43 , _scroll_offset_y (0)
49 Canvas::scroll_to (Coord x, Coord y)
54 pick_current_item (0); // no current mouse position
60 pick_current_item (0); // no current mouse position
63 /** Render an area of the canvas.
64 * @param area Area in canvas coordinates.
65 * @param context Cairo context to render to.
68 Canvas::render (Rect const & area, Cairo::RefPtr<Cairo::Context> const & context) const
71 if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
72 cerr << "RENDER: " << area << endl;
73 //cerr << "CANVAS @ " << this << endl;
75 //cerr << "-------------------------\n";
81 boost::optional<Rect> root_bbox = _root.bounding_box();
83 /* the root has no bounding box, so there's nothing to render */
87 boost::optional<Rect> draw = root_bbox->intersection (area);
90 /* there's a common area between the root and the requested
94 _root.render (*draw, context);
96 // This outlines the rect being rendered, after it has been drawn.
97 // context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0);
98 // context->set_source_rgba (1.0, 0, 0, 1.0);
99 // context->stroke ();
106 operator<< (ostream& o, Canvas& c)
113 Canvas::indent() const
117 for (int n = 0; n < ArdourCanvas::dump_depth; ++n) {
125 Canvas::render_indent() const
129 for (int n = 0; n < ArdourCanvas::render_depth; ++n) {
137 Canvas::dump (ostream& o) const
143 /** Called when an item has been shown or hidden.
144 * @param item Item that has been shown or hidden.
147 Canvas::item_shown_or_hidden (Item* item)
149 boost::optional<Rect> bbox = item->bounding_box ();
151 queue_draw_item_area (item, bbox.get ());
155 /** Called when an item has a change to its visual properties
156 * that do NOT affect its bounding box.
157 * @param item Item that has been modified.
160 Canvas::item_visual_property_changed (Item* item)
162 boost::optional<Rect> bbox = item->bounding_box ();
164 queue_draw_item_area (item, bbox.get ());
168 /** Called when an item has changed, but not moved.
169 * @param item Item that has changed.
170 * @param pre_change_bounding_box The bounding box of item before the change,
171 * in the item's coordinates.
174 Canvas::item_changed (Item* item, boost::optional<Rect> pre_change_bounding_box)
176 if (pre_change_bounding_box) {
177 /* request a redraw of the item's old bounding box */
178 queue_draw_item_area (item, pre_change_bounding_box.get ());
181 boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
182 if (post_change_bounding_box) {
183 /* request a redraw of the item's new bounding box */
184 queue_draw_item_area (item, post_change_bounding_box.get ());
189 Canvas::window_to_canvas (Duple const & d) const
191 return d.translate (Duple (_scroll_offset_x, _scroll_offset_y));
195 Canvas::canvas_to_window (Duple const & d) const
197 Duple wd = d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
204 Canvas::window_to_canvas (Rect const & r) const
206 return r.translate (Duple (_scroll_offset_x, _scroll_offset_y));
210 Canvas::canvas_to_window (Rect const & r) const
212 Rect wr = r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
213 wr.x0 = floor (wr.x0);
214 wr.x1 = ceil (wr.x1);
215 wr.y0 = floor (wr.y0);
216 wr.y1 = ceil (wr.y1);
220 /** Called when an item has moved.
221 * @param item Item that has moved.
222 * @param pre_change_parent_bounding_box The bounding box of the item before
223 * the move, in its parent's coordinates.
226 Canvas::item_moved (Item* item, boost::optional<Rect> pre_change_parent_bounding_box)
228 if (pre_change_parent_bounding_box) {
229 /* request a redraw of where the item used to be. The box has
230 * to be in parent coordinate space since the bounding box of
231 * an item does not change when moved. If we use
232 * item->item_to_canvas() on the old bounding box, we will be
234 * using the item's new position, and so will compute the wrong
235 * invalidation area. If we use the parent (which has not
236 * moved, then this will work.
238 queue_draw_item_area (item->parent(), pre_change_parent_bounding_box.get ());
241 boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
242 if (post_change_bounding_box) {
243 /* request a redraw of where the item now is */
244 queue_draw_item_area (item, post_change_bounding_box.get ());
248 /** Request a redraw of a particular area in an item's coordinates.
250 * @param area Area to redraw in the item's coordinates.
253 Canvas::queue_draw_item_area (Item* item, Rect area)
255 ArdourCanvas::Rect canvas_area = item->item_to_canvas (area);
256 // cerr << "CANVAS " << this << " for " << item->whatami() << ' ' << item->name << " invalidate " << area << " TRANSLATE AS " << canvas_area << endl;
257 request_redraw (canvas_area);
260 /** Construct a GtkCanvas */
261 GtkCanvas::GtkCanvas ()
263 , _new_current_item (0)
267 /* these are the events we want to know about */
268 add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK |
269 Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK);
273 GtkCanvas::pick_current_item (int state)
278 /* this version of ::pick_current_item() is called after an item is
279 * added or removed, so we have no coordinates to work from as is the
280 * case with a motion event. Find out where the mouse is and use that.
283 Glib::RefPtr<const Gdk::Window> pointer_window = Gdk::Display::get_default()->get_window_at_pointer (x, y);
285 if (pointer_window != get_window()) {
289 pick_current_item (window_to_canvas (Duple (x, y)), state);
293 GtkCanvas::pick_current_item (Duple const & point, int state)
295 /* we do not enter/leave items during a drag/grab */
301 /* find the items at the given position */
303 vector<Item const *> items;
304 _root.add_items_at_point (point, items);
306 /* put all items at point that are event-sensitive and visible and NOT
307 groups into within_items. Note that items is sorted from bottom to
308 top, but we're going to reverse that for within_items so that its
309 first item is the upper-most item that can be chosen as _current_item.
312 vector<Item const *>::const_iterator i;
313 list<Item const *> within_items;
315 for (i = items.begin(); i != items.end(); ++i) {
317 Item const * new_item = *i;
319 /* We ignore invisible items, groups and items that ignore events */
321 if (!new_item->visible() || new_item->ignore_events() || dynamic_cast<Group const *>(new_item) != 0) {
325 within_items.push_front (new_item);
328 if (within_items.empty()) {
330 /* no items at point, just send leave event below */
333 if (within_items.front() == _current_item) {
334 /* uppermost item at point is already _current_item */
338 _new_current_item = const_cast<Item*> (within_items.front());
341 deliver_enter_leave (point, state);
345 GtkCanvas::deliver_enter_leave (Duple const & point, int state)
347 /* setup enter & leave event structures */
349 GdkEventCrossing enter_event;
350 enter_event.type = GDK_ENTER_NOTIFY;
351 enter_event.window = get_window()->gobj();
352 enter_event.send_event = 0;
353 enter_event.subwindow = 0;
354 enter_event.mode = GDK_CROSSING_NORMAL;
355 enter_event.focus = FALSE;
356 enter_event.state = state;
357 enter_event.x = point.x;
358 enter_event.y = point.y;
360 GdkEventCrossing leave_event = enter_event;
361 leave_event.type = GDK_LEAVE_NOTIFY;
364 GdkNotifyType enter_detail;
365 GdkNotifyType leave_detail;
366 vector<Item*> items_to_leave_virtual;
367 vector<Item*> items_to_enter_virtual;
369 if (_new_current_item == 0) {
371 leave_detail = GDK_NOTIFY_UNKNOWN;
375 /* no current item, so also send virtual leave events to the
376 * entire heirarchy for the current item
379 for (i = _current_item->parent(); i ; i = i->parent()) {
380 items_to_leave_virtual.push_back (i);
384 } else if (_current_item == 0) {
386 enter_detail = GDK_NOTIFY_UNKNOWN;
388 /* no current item, so also send virtual enter events to the
389 * entire heirarchy for the new item
392 for (i = _new_current_item->parent(); i ; i = i->parent()) {
393 items_to_enter_virtual.push_back (i);
396 } else if (_current_item->is_descendant_of (*_new_current_item)) {
398 /* move from descendant to ancestor (X: "_current_item is an
399 * inferior of _new_current_item")
401 * Deliver "virtual" leave notifications to all items in the
402 * heirarchy between current and new_current.
406 for (i = _current_item->parent(); i && i != _new_current_item; i = i->parent()) {
407 items_to_leave_virtual.push_back (i);
410 enter_detail = GDK_NOTIFY_INFERIOR;
411 leave_detail = GDK_NOTIFY_ANCESTOR;
414 } else if (_new_current_item->is_descendant_of (*_current_item)) {
415 /* move from ancestor to descendant (X: "_new_current_item is
416 * an inferior of _current_item")
418 * Deliver "virtual" enter notifications to all items in the
419 * heirarchy between current and new_current.
422 for (i = _new_current_item->parent(); i && i != _current_item; i = i->parent()) {
423 items_to_enter_virtual.push_back (i);
426 enter_detail = GDK_NOTIFY_ANCESTOR;
427 leave_detail = GDK_NOTIFY_INFERIOR;
431 Item const * common_ancestor = _current_item->closest_ancestor_with (*_new_current_item);
433 /* deliver virtual leave events to everything between _current
434 * and common_ancestor.
437 for (i = _current_item->parent(); i && i != common_ancestor; i = i->parent()) {
438 items_to_leave_virtual.push_back (i);
441 /* deliver virtual enter events to everything between
442 * _new_current and common_ancestor.
445 for (i = _new_current_item->parent(); i && i != common_ancestor; i = i->parent()) {
446 items_to_enter_virtual.push_back (i);
449 enter_detail = GDK_NOTIFY_NONLINEAR;
450 leave_detail = GDK_NOTIFY_NONLINEAR;
454 if (_current_item && !_current_item->ignore_events ()) {
455 leave_event.detail = leave_detail;
456 _current_item->Event ((GdkEvent*)&leave_event);
457 // std::cerr << "LEAVE " << _current_item->whatami() << '/' << _current_item->name << std::endl;
460 leave_event.detail = GDK_NOTIFY_VIRTUAL;
461 enter_event.detail = GDK_NOTIFY_VIRTUAL;
463 for (vector<Item*>::iterator it = items_to_leave_virtual.begin(); it != items_to_leave_virtual.end(); ++it) {
464 if (!(*it)->ignore_events()) {
465 (*it)->Event ((GdkEvent*)&leave_event);
466 // std::cerr << "leave " << (*it)->whatami() << '/' << (*it)->name << std::endl;
470 for (vector<Item*>::iterator it = items_to_enter_virtual.begin(); it != items_to_enter_virtual.end(); ++it) {
471 if (!(*it)->ignore_events()) {
472 (*it)->Event ((GdkEvent*)&enter_event);
473 // std::cerr << "enter " << (*it)->whatami() << '/' << (*it)->name << std::endl;
477 if (_new_current_item && !_new_current_item->ignore_events()) {
478 enter_event.detail = enter_detail;
479 _new_current_item->Event ((GdkEvent*)&enter_event);
480 // std::cerr << "ENTER " << _new_current_item->whatami() << '/' << _new_current_item->name << std::endl;
483 _current_item = _new_current_item;
487 /** Deliver an event to the appropriate item; either the grabbed item, or
488 * one of the items underneath the event.
489 * @param point Position that the event has occurred at, in canvas coordinates.
490 * @param event The event.
493 GtkCanvas::deliver_event (GdkEvent* event)
495 /* Point in in canvas coordinate space */
498 /* we have a grabbed item, so everything gets sent there */
499 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send event there\n",
500 _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
501 return _grabbed_item->Event (event);
504 if (!_current_item) {
508 /* run through the items from child to parent, until one claims the event */
510 Item* item = const_cast<Item*> (_current_item);
514 Item* parent = item->parent ();
516 if (!item->ignore_events () &&
517 item->Event (event)) {
518 /* this item has just handled the event */
520 PBD::DEBUG::CanvasEvents,
521 string_compose ("canvas event handled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name)
527 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event left unhandled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name));
529 if ((item = parent) == 0) {
538 /** Called when an item is being destroyed.
539 * @param item Item being destroyed.
540 * @param bounding_box Last known bounding box of the item.
543 GtkCanvas::item_going_away (Item* item, boost::optional<Rect> bounding_box)
546 queue_draw_item_area (item, bounding_box.get ());
549 /* no need to send a leave event to this item, since it is going away
552 if (_new_current_item == item) {
553 _new_current_item = 0;
556 if (_current_item == item) {
560 if (_grabbed_item == item) {
564 if (_focused_item == item) {
568 pick_current_item (0); // no mouse state
572 /** Handler for GDK expose events.
574 * @return true if the event was handled.
577 GtkCanvas::on_expose_event (GdkEventExpose* ev)
579 Cairo::RefPtr<Cairo::Context> c = get_window()->create_cairo_context ();
581 render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), c);
586 /** @return Our Cairo context, or 0 if we don't have one */
587 Cairo::RefPtr<Cairo::Context>
588 GtkCanvas::context ()
590 Glib::RefPtr<Gdk::Window> w = get_window ();
592 return Cairo::RefPtr<Cairo::Context> ();
595 return w->create_cairo_context ();
598 /** Handler for GDK button press events.
600 * @return true if the event was handled.
603 GtkCanvas::on_button_press_event (GdkEventButton* ev)
605 /* translate event coordinates from window to canvas */
607 GdkEvent copy = *((GdkEvent*)ev);
608 Duple where = window_to_canvas (Duple (ev->x, ev->y));
610 copy.button.x = where.x;
611 copy.button.y = where.y;
613 /* Coordinates in the event will be canvas coordinates, correctly adjusted
614 for scroll if this GtkCanvas is in a GtkCanvasViewport.
617 pick_current_item (where, ev->state);
618 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button press @ %1, %2 => %3\n", ev->x, ev->y, where));
619 return deliver_event (reinterpret_cast<GdkEvent*>(©));
622 /** Handler for GDK button release events.
624 * @return true if the event was handled.
627 GtkCanvas::on_button_release_event (GdkEventButton* ev)
629 /* translate event coordinates from window to canvas */
631 GdkEvent copy = *((GdkEvent*)ev);
632 Duple where = window_to_canvas (Duple (ev->x, ev->y));
634 pick_current_item (where, ev->state);
636 copy.button.x = where.x;
637 copy.button.y = where.y;
639 /* Coordinates in the event will be canvas coordinates, correctly adjusted
640 for scroll if this GtkCanvas is in a GtkCanvasViewport.
643 pick_current_item (where, ev->state);
644 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button release @ %1, %2 => %3\n", ev->x, ev->y, where));
645 return deliver_event (reinterpret_cast<GdkEvent*>(©));
648 /** Handler for GDK motion events.
650 * @return true if the event was handled.
653 GtkCanvas::on_motion_notify_event (GdkEventMotion* ev)
655 /* translate event coordinates from window to canvas */
657 GdkEvent copy = *((GdkEvent*)ev);
658 Duple point (ev->x, ev->y);
659 Duple where = window_to_canvas (point);
661 copy.motion.x = where.x;
662 copy.motion.y = where.y;
664 /* Coordinates in "copy" will be canvas coordinates,
667 // DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2\n", ev->x, ev->y));
670 /* if we have a grabbed item, it gets just the motion event,
671 since no enter/leave events can have happened.
673 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send MOTION event there\n",
674 _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
675 return _grabbed_item->Event (reinterpret_cast<GdkEvent*> (©));
678 pick_current_item (where, ev->state);
680 /* Now deliver the motion event. It may seem a little inefficient
681 to recompute the items under the event, but the enter notify/leave
682 events may have deleted canvas items so it is important to
683 recompute the list in deliver_event.
686 return deliver_event (reinterpret_cast<GdkEvent*> (©));
690 GtkCanvas::on_enter_notify_event (GdkEventCrossing* ev)
692 Duple where = window_to_canvas (Duple (ev->x, ev->y));
693 pick_current_item (where, ev->state);
698 GtkCanvas::on_leave_notify_event (GdkEventCrossing* ev)
700 _new_current_item = 0;
701 Duple where = window_to_canvas (Duple (ev->x, ev->y));
702 deliver_enter_leave (where, ev->state);
706 /** Called to request a redraw of our canvas.
707 * @param area Area to redraw, in canvas coordinates.
710 GtkCanvas::request_redraw (Rect const & request)
712 Rect area = canvas_to_window (request);
713 queue_draw_area (area.x0, area.y0, area.width(), area.height());
716 /** Called to request that we try to get a particular size for ourselves.
717 * @param size Size to request, in pixels.
720 GtkCanvas::request_size (Duple size)
724 if (req.x > INT_MAX) {
728 if (req.y > INT_MAX) {
732 set_size_request (req.x, req.y);
735 /** `Grab' an item, so that all events are sent to that item until it is `ungrabbed'.
736 * This is typically used for dragging items around, so that they are grabbed during
738 * @param item Item to grab.
741 GtkCanvas::grab (Item* item)
743 /* XXX: should this be doing gdk_pointer_grab? */
744 _grabbed_item = item;
748 /** `Ungrab' any item that was previously grabbed */
752 /* XXX: should this be doing gdk_pointer_ungrab? */
756 /** Set keyboard focus on an item, so that all keyboard events are sent to that item until the focus
758 * @param item Item to grab.
761 GtkCanvas::focus (Item* item)
763 _focused_item = item;
767 GtkCanvas::unfocus (Item* item)
769 if (item == _focused_item) {
774 /** @return The visible area of the canvas, in canvas coordinates */
776 GtkCanvas::visible_area () const
778 Distance const xo = _scroll_offset_x;
779 Distance const yo = _scroll_offset_y;
780 return Rect (xo, yo, xo + get_allocation().get_width (), yo + get_allocation().get_height ());
783 /** Create a GtkCanvaSViewport.
784 * @param hadj Adjustment to use for horizontal scrolling.
785 * @param vadj Adjustment to use for vertica scrolling.
787 GtkCanvasViewport::GtkCanvasViewport (Gtk::Adjustment& hadj, Gtk::Adjustment& vadj)
788 : Alignment (0, 0, 1.0, 1.0)
794 hadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
795 vadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
799 GtkCanvasViewport::scrolled ()
801 _canvas.scroll_to (hadjustment.get_value(), vadjustment.get_value());
805 /** Handler for when GTK asks us what minimum size we want.
806 * @param req Requsition to fill in.
809 GtkCanvasViewport::on_size_request (Gtk::Requisition* req)
811 /* force the canvas to size itself */
812 // _canvas.root()->bounding_box();