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"
35 #include "canvas/line.h"
38 using namespace ArdourCanvas;
40 /** Construct a new Canvas */
43 , _scroll_offset_x (0)
44 , _scroll_offset_y (0)
50 Canvas::scroll_to (Coord x, Coord y)
55 pick_current_item (0); // no current mouse position
61 pick_current_item (0); // no current mouse position
64 /** Render an area of the canvas.
65 * @param area Area in canvas coordinates.
66 * @param context Cairo context to render to.
69 Canvas::render (Rect const & area, Cairo::RefPtr<Cairo::Context> const & context) const
72 if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
73 cerr << this << " RENDER: " << area << endl;
74 //cerr << "CANVAS @ " << this << endl;
76 //cerr << "-------------------------\n";
82 boost::optional<Rect> root_bbox = _root.bounding_box();
84 /* the root has no bounding box, so there's nothing to render */
88 boost::optional<Rect> draw = root_bbox->intersection (area);
91 /* there's a common area between the root and the requested
95 _root.render (*draw, context);
97 // This outlines the rect being rendered, after it has been drawn.
98 // context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0);
99 // context->set_source_rgba (1.0, 0, 0, 1.0);
100 // context->stroke ();
107 operator<< (ostream& o, Canvas& c)
114 Canvas::indent() const
118 for (int n = 0; n < ArdourCanvas::dump_depth; ++n) {
126 Canvas::render_indent() const
130 for (int n = 0; n < ArdourCanvas::render_depth; ++n) {
138 Canvas::dump (ostream& o) const
144 /** Called when an item has been shown or hidden.
145 * @param item Item that has been shown or hidden.
148 Canvas::item_shown_or_hidden (Item* item)
150 boost::optional<Rect> bbox = item->bounding_box ();
152 queue_draw_item_area (item, bbox.get ());
156 /** Called when an item has a change to its visual properties
157 * that do NOT affect its bounding box.
158 * @param item Item that has been modified.
161 Canvas::item_visual_property_changed (Item* item)
163 boost::optional<Rect> bbox = item->bounding_box ();
165 queue_draw_item_area (item, bbox.get ());
169 /** Called when an item has changed, but not moved.
170 * @param item Item that has changed.
171 * @param pre_change_bounding_box The bounding box of item before the change,
172 * in the item's coordinates.
175 Canvas::item_changed (Item* item, boost::optional<Rect> pre_change_bounding_box)
177 if (pre_change_bounding_box) {
178 /* request a redraw of the item's old bounding box */
179 queue_draw_item_area (item, pre_change_bounding_box.get ());
182 boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
183 if (post_change_bounding_box) {
184 /* request a redraw of the item's new bounding box */
185 queue_draw_item_area (item, post_change_bounding_box.get ());
190 Canvas::window_to_canvas (Duple const & d) const
192 return d.translate (Duple (_scroll_offset_x, _scroll_offset_y));
196 Canvas::canvas_to_window (Duple const & d) const
198 Duple wd = d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
200 /* Note that this intentionally always returns integer coordinates */
209 Canvas::window_to_canvas (Rect const & r) const
211 return r.translate (Duple (_scroll_offset_x, _scroll_offset_y));
215 Canvas::canvas_to_window (Rect const & r) const
217 Rect wr = r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
219 /* Note that this intentionally always returns integer coordinates */
221 wr.x0 = round (wr.x0);
222 wr.x1 = round (wr.x1);
223 wr.y0 = round (wr.y0);
224 wr.y1 = round (wr.y1);
229 /** Called when an item has moved.
230 * @param item Item that has moved.
231 * @param pre_change_parent_bounding_box The bounding box of the item before
232 * the move, in its parent's coordinates.
235 Canvas::item_moved (Item* item, boost::optional<Rect> pre_change_parent_bounding_box)
237 if (pre_change_parent_bounding_box) {
238 /* request a redraw of where the item used to be. The box has
239 * to be in parent coordinate space since the bounding box of
240 * an item does not change when moved. If we use
241 * item->item_to_canvas() on the old bounding box, we will be
243 * using the item's new position, and so will compute the wrong
244 * invalidation area. If we use the parent (which has not
245 * moved, then this will work.
247 queue_draw_item_area (item->parent(), pre_change_parent_bounding_box.get ());
250 boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
251 if (post_change_bounding_box) {
252 /* request a redraw of where the item now is */
253 queue_draw_item_area (item, post_change_bounding_box.get ());
257 /** Request a redraw of a particular area in an item's coordinates.
259 * @param area Area to redraw in the item's coordinates.
262 Canvas::queue_draw_item_area (Item* item, Rect area)
264 ArdourCanvas::Rect canvas_area = item->item_to_canvas (area);
265 // cerr << "CANVAS " << this << " for " << item->whatami() << ' ' << item->name << " invalidate " << area << " TRANSLATE AS " << canvas_area << " window = " << canvas_to_window (canvas_area) << std::endl;
266 request_redraw (canvas_area);
269 /** Construct a GtkCanvas */
270 GtkCanvas::GtkCanvas ()
272 , _new_current_item (0)
276 /* these are the events we want to know about */
277 add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK |
278 Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK);
282 GtkCanvas::pick_current_item (int state)
287 /* this version of ::pick_current_item() is called after an item is
288 * added or removed, so we have no coordinates to work from as is the
289 * case with a motion event. Find out where the mouse is and use that.
292 Glib::RefPtr<const Gdk::Window> pointer_window = Gdk::Display::get_default()->get_window_at_pointer (x, y);
294 if (pointer_window != get_window()) {
298 pick_current_item (window_to_canvas (Duple (x, y)), state);
302 GtkCanvas::pick_current_item (Duple const & point, int state)
304 /* we do not enter/leave items during a drag/grab */
310 /* find the items at the given position */
312 vector<Item const *> items;
313 _root.add_items_at_point (point, items);
315 DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("%1 covers %2 items\n", point, items.size()));
318 if (DEBUG_ENABLED(PBD::DEBUG::CanvasEnterLeave)) {
319 for (vector<Item const*>::const_iterator it = items.begin(); it != items.end(); ++it) {
321 std::cerr << "\tItem " << (*it)->whatami() << '/' << (*it)->name << std::endl;
323 std::cerr << "\tItem " << (*it)->whatami() << std::endl;
329 /* put all items at point that are event-sensitive and visible and NOT
330 groups into within_items. Note that items is sorted from bottom to
331 top, but we're going to reverse that for within_items so that its
332 first item is the upper-most item that can be chosen as _current_item.
335 vector<Item const *>::const_iterator i;
336 list<Item const *> within_items;
338 for (i = items.begin(); i != items.end(); ++i) {
340 Item const * new_item = *i;
342 /* We ignore invisible items, groups and items that ignore events */
344 if (!new_item->visible() || new_item->ignore_events() || dynamic_cast<Group const *>(new_item) != 0) {
348 within_items.push_front (new_item);
351 if (within_items.empty()) {
353 /* no items at point, just send leave event below */
357 if (within_items.front() == _current_item) {
358 /* uppermost item at point is already _current_item */
362 _new_current_item = const_cast<Item*> (within_items.front());
365 if (_new_current_item != _current_item) {
366 deliver_enter_leave (point, state);
371 GtkCanvas::deliver_enter_leave (Duple const & point, int state)
373 /* setup enter & leave event structures */
375 GdkEventCrossing enter_event;
376 enter_event.type = GDK_ENTER_NOTIFY;
377 enter_event.window = get_window()->gobj();
378 enter_event.send_event = 0;
379 enter_event.subwindow = 0;
380 enter_event.mode = GDK_CROSSING_NORMAL;
381 enter_event.focus = FALSE;
382 enter_event.state = state;
383 enter_event.x = point.x;
384 enter_event.y = point.y;
386 GdkEventCrossing leave_event = enter_event;
387 leave_event.type = GDK_LEAVE_NOTIFY;
390 GdkNotifyType enter_detail;
391 GdkNotifyType leave_detail;
392 vector<Item*> items_to_leave_virtual;
393 vector<Item*> items_to_enter_virtual;
395 if (_new_current_item == 0) {
397 leave_detail = GDK_NOTIFY_UNKNOWN;
401 /* no current item, so also send virtual leave events to the
402 * entire heirarchy for the current item
405 for (i = _current_item->parent(); i ; i = i->parent()) {
406 items_to_leave_virtual.push_back (i);
410 } else if (_current_item == 0) {
412 enter_detail = GDK_NOTIFY_UNKNOWN;
414 /* no current item, so also send virtual enter events to the
415 * entire heirarchy for the new item
418 for (i = _new_current_item->parent(); i ; i = i->parent()) {
419 items_to_enter_virtual.push_back (i);
422 } else if (_current_item->is_descendant_of (*_new_current_item)) {
424 /* move from descendant to ancestor (X: "_current_item is an
425 * inferior ("child") of _new_current_item")
427 * Deliver "virtual" leave notifications to all items in the
428 * heirarchy between current and new_current.
432 for (i = _current_item->parent(); i && i != _new_current_item; i = i->parent()) {
433 items_to_leave_virtual.push_back (i);
436 enter_detail = GDK_NOTIFY_INFERIOR;
437 leave_detail = GDK_NOTIFY_ANCESTOR;
440 } else if (_new_current_item->is_descendant_of (*_current_item)) {
441 /* move from ancestor to descendant (X: "_new_current_item is
442 * an inferior ("child") of _current_item")
444 * Deliver "virtual" enter notifications to all items in the
445 * heirarchy between current and new_current.
448 for (i = _new_current_item->parent(); i && i != _current_item; i = i->parent()) {
449 items_to_enter_virtual.push_back (i);
452 enter_detail = GDK_NOTIFY_ANCESTOR;
453 leave_detail = GDK_NOTIFY_INFERIOR;
457 Item const * common_ancestor = _current_item->closest_ancestor_with (*_new_current_item);
459 /* deliver virtual leave events to everything between _current
460 * and common_ancestor.
463 for (i = _current_item->parent(); i && i != common_ancestor; i = i->parent()) {
464 items_to_leave_virtual.push_back (i);
467 /* deliver virtual enter events to everything between
468 * _new_current and common_ancestor.
471 for (i = _new_current_item->parent(); i && i != common_ancestor; i = i->parent()) {
472 items_to_enter_virtual.push_back (i);
475 enter_detail = GDK_NOTIFY_NONLINEAR;
476 leave_detail = GDK_NOTIFY_NONLINEAR;
480 if (_current_item && !_current_item->ignore_events ()) {
481 leave_event.detail = leave_detail;
482 _current_item->Event ((GdkEvent*)&leave_event);
483 DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("LEAVE %1/%2\n", _current_item->whatami(), _current_item->name));
486 leave_event.detail = GDK_NOTIFY_VIRTUAL;
487 enter_event.detail = GDK_NOTIFY_VIRTUAL;
489 for (vector<Item*>::iterator it = items_to_leave_virtual.begin(); it != items_to_leave_virtual.end(); ++it) {
490 if (!(*it)->ignore_events()) {
491 DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("leave %1/%2\n", (*it)->whatami(), (*it)->name));
492 (*it)->Event ((GdkEvent*)&leave_event);
496 for (vector<Item*>::iterator it = items_to_enter_virtual.begin(); it != items_to_enter_virtual.end(); ++it) {
497 if (!(*it)->ignore_events()) {
498 DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("enter %1/%2\n", (*it)->whatami(), (*it)->name));
499 (*it)->Event ((GdkEvent*)&enter_event);
500 // std::cerr << "enter " << (*it)->whatami() << '/' << (*it)->name << std::endl;
504 if (_new_current_item && !_new_current_item->ignore_events()) {
505 enter_event.detail = enter_detail;
506 DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("ENTER %1/%2\n", _new_current_item->whatami(), _new_current_item->name));
507 _new_current_item->Event ((GdkEvent*)&enter_event);
510 _current_item = _new_current_item;
514 /** Deliver an event to the appropriate item; either the grabbed item, or
515 * one of the items underneath the event.
516 * @param point Position that the event has occurred at, in canvas coordinates.
517 * @param event The event.
520 GtkCanvas::deliver_event (GdkEvent* event)
522 /* Point in in canvas coordinate space */
524 const Item* event_item;
527 /* we have a grabbed item, so everything gets sent there */
528 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send event there\n",
529 _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
530 event_item = _grabbed_item;
532 event_item = _current_item;
539 /* run through the items from child to parent, until one claims the event */
541 Item* item = const_cast<Item*> (event_item);
545 Item* parent = item->parent ();
547 if (!item->ignore_events () &&
548 item->Event (event)) {
549 /* this item has just handled the event */
551 PBD::DEBUG::CanvasEvents,
552 string_compose ("canvas event handled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name)
558 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event %3 left unhandled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name, event_type_string (event->type)));
560 if ((item = parent) == 0) {
569 /** Called when an item is being destroyed.
570 * @param item Item being destroyed.
571 * @param bounding_box Last known bounding box of the item.
574 GtkCanvas::item_going_away (Item* item, boost::optional<Rect> bounding_box)
577 queue_draw_item_area (item, bounding_box.get ());
580 if (_new_current_item == item) {
581 _new_current_item = 0;
584 if (_grabbed_item == item) {
588 if (_focused_item == item) {
592 if (_current_item == item) {
593 /* no need to send a leave event to this item, since it is going away
596 pick_current_item (0); // no mouse state
601 /** Handler for GDK expose events.
603 * @return true if the event was handled.
606 GtkCanvas::on_expose_event (GdkEventExpose* ev)
608 Cairo::RefPtr<Cairo::Context> cairo_context = get_window()->create_cairo_context ();
609 Rect area (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height);
611 render (area, cairo_context);
616 /** @return Our Cairo context, or 0 if we don't have one */
617 Cairo::RefPtr<Cairo::Context>
618 GtkCanvas::context ()
620 Glib::RefPtr<Gdk::Window> w = get_window ();
622 return Cairo::RefPtr<Cairo::Context> ();
625 return w->create_cairo_context ();
628 /** Handler for GDK button press events.
630 * @return true if the event was handled.
633 GtkCanvas::on_button_press_event (GdkEventButton* ev)
635 /* translate event coordinates from window to canvas */
637 GdkEvent copy = *((GdkEvent*)ev);
638 Duple where = window_to_canvas (Duple (ev->x, ev->y));
640 copy.button.x = where.x;
641 copy.button.y = where.y;
643 /* Coordinates in the event will be canvas coordinates, correctly adjusted
644 for scroll if this GtkCanvas is in a GtkCanvasViewport.
647 pick_current_item (where, ev->state);
648 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button press @ %1, %2 => %3\n", ev->x, ev->y, where));
649 return deliver_event (reinterpret_cast<GdkEvent*>(©));
652 /** Handler for GDK button release events.
654 * @return true if the event was handled.
657 GtkCanvas::on_button_release_event (GdkEventButton* ev)
659 /* translate event coordinates from window to canvas */
661 GdkEvent copy = *((GdkEvent*)ev);
662 Duple where = window_to_canvas (Duple (ev->x, ev->y));
664 pick_current_item (where, ev->state);
666 copy.button.x = where.x;
667 copy.button.y = where.y;
669 /* Coordinates in the event will be canvas coordinates, correctly adjusted
670 for scroll if this GtkCanvas is in a GtkCanvasViewport.
673 pick_current_item (where, ev->state);
674 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button release @ %1, %2 => %3\n", ev->x, ev->y, where));
675 return deliver_event (reinterpret_cast<GdkEvent*>(©));
678 /** Handler for GDK motion events.
680 * @return true if the event was handled.
683 GtkCanvas::on_motion_notify_event (GdkEventMotion* ev)
685 /* translate event coordinates from window to canvas */
687 GdkEvent copy = *((GdkEvent*)ev);
688 Duple point (ev->x, ev->y);
689 Duple where = window_to_canvas (point);
691 copy.motion.x = where.x;
692 copy.motion.y = where.y;
694 /* Coordinates in "copy" will be canvas coordinates,
697 // DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2\n", ev->x, ev->y));
699 pick_current_item (where, ev->state);
701 /* Now deliver the motion event. It may seem a little inefficient
702 to recompute the items under the event, but the enter notify/leave
703 events may have deleted canvas items so it is important to
704 recompute the list in deliver_event.
707 return deliver_event (reinterpret_cast<GdkEvent*> (©));
711 GtkCanvas::on_enter_notify_event (GdkEventCrossing* ev)
713 Duple where = window_to_canvas (Duple (ev->x, ev->y));
714 pick_current_item (where, ev->state);
719 GtkCanvas::on_leave_notify_event (GdkEventCrossing* ev)
721 _new_current_item = 0;
722 Duple where = window_to_canvas (Duple (ev->x, ev->y));
723 deliver_enter_leave (where, ev->state);
727 /** Called to request a redraw of our canvas.
728 * @param area Area to redraw, in canvas coordinates.
731 GtkCanvas::request_redraw (Rect const & request)
733 boost::optional<Rect> req = request.intersection (visible_area());
737 Rect area = canvas_to_window (r);
738 queue_draw_area (area.x0, area.y0, area.width(), area.height());
742 /** Called to request that we try to get a particular size for ourselves.
743 * @param size Size to request, in pixels.
746 GtkCanvas::request_size (Duple size)
750 if (req.x > INT_MAX) {
754 if (req.y > INT_MAX) {
758 set_size_request (req.x, req.y);
761 /** `Grab' an item, so that all events are sent to that item until it is `ungrabbed'.
762 * This is typically used for dragging items around, so that they are grabbed during
764 * @param item Item to grab.
767 GtkCanvas::grab (Item* item)
769 /* XXX: should this be doing gdk_pointer_grab? */
770 _grabbed_item = item;
774 /** `Ungrab' any item that was previously grabbed */
778 /* XXX: should this be doing gdk_pointer_ungrab? */
782 /** Set keyboard focus on an item, so that all keyboard events are sent to that item until the focus
784 * @param item Item to grab.
787 GtkCanvas::focus (Item* item)
789 _focused_item = item;
793 GtkCanvas::unfocus (Item* item)
795 if (item == _focused_item) {
800 /** @return The visible area of the canvas, in canvas coordinates */
802 GtkCanvas::visible_area () const
804 Distance const xo = _scroll_offset_x;
805 Distance const yo = _scroll_offset_y;
806 return Rect (xo, yo, xo + get_allocation().get_width (), yo + get_allocation().get_height ());
809 /** Create a GtkCanvaSViewport.
810 * @param hadj Adjustment to use for horizontal scrolling.
811 * @param vadj Adjustment to use for vertica scrolling.
813 GtkCanvasViewport::GtkCanvasViewport (Gtk::Adjustment& hadj, Gtk::Adjustment& vadj)
814 : Alignment (0, 0, 1.0, 1.0)
820 hadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
821 vadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
825 GtkCanvasViewport::scrolled ()
827 _canvas.scroll_to (hadjustment.get_value(), vadjustment.get_value());
831 /** Handler for when GTK asks us what minimum size we want.
832 * @param req Requsition to fill in.
835 GtkCanvasViewport::on_size_request (Gtk::Requisition* req)
837 /* force the canvas to size itself */
838 // _canvas.root()->bounding_box();