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.
26 #include <gtkmm/adjustment.h>
27 #include <gtkmm/label.h>
29 #include "pbd/compose.h"
30 #include "pbd/stacktrace.h"
32 #include "canvas/canvas.h"
33 #include "canvas/debug.h"
36 using namespace ArdourCanvas;
38 /** Construct a new Canvas */
41 , _scroll_offset_x (0)
42 , _scroll_offset_y (0)
48 Canvas::scroll_to (Coord x, Coord y)
54 /** Render an area of the canvas.
55 * @param area Area in canvas coordinates.
56 * @param context Cairo context to render to.
59 Canvas::render (Rect const & area, Cairo::RefPtr<Cairo::Context> const & context) const
62 if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
63 cerr << "RENDER: " << area << endl;
64 //cerr << "CANVAS @ " << this << endl;
66 //cerr << "-------------------------\n";
72 boost::optional<Rect> root_bbox = _root.bounding_box();
74 /* the root has no bounding box, so there's nothing to render */
78 boost::optional<Rect> draw = root_bbox->intersection (area);
80 /* there's a common area between the root and the requested
84 _root.render (*draw, context);
89 operator<< (ostream& o, Canvas& c)
96 Canvas::indent() const
100 for (int n = 0; n < ArdourCanvas::dump_depth; ++n) {
108 Canvas::render_indent() const
112 for (int n = 0; n < ArdourCanvas::render_depth; ++n) {
120 Canvas::dump (ostream& o) const
126 /** Called when an item has been shown or hidden.
127 * @param item Item that has been shown or hidden.
130 Canvas::item_shown_or_hidden (Item* item)
132 boost::optional<Rect> bbox = item->bounding_box ();
134 queue_draw_item_area (item, bbox.get ());
138 /** Called when an item has a change to its visual properties
139 * that do NOT affect its bounding box.
140 * @param item Item that has been modified.
143 Canvas::item_visual_property_changed (Item* item)
145 boost::optional<Rect> bbox = item->bounding_box ();
147 queue_draw_item_area (item, bbox.get ());
151 /** Called when an item has changed, but not moved.
152 * @param item Item that has changed.
153 * @param pre_change_bounding_box The bounding box of item before the change,
154 * in the item's coordinates.
157 Canvas::item_changed (Item* item, boost::optional<Rect> pre_change_bounding_box)
159 if (pre_change_bounding_box) {
160 /* request a redraw of the item's old bounding box */
161 queue_draw_item_area (item, pre_change_bounding_box.get ());
164 boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
165 if (post_change_bounding_box) {
166 /* request a redraw of the item's new bounding box */
167 queue_draw_item_area (item, post_change_bounding_box.get ());
172 Canvas::window_to_canvas (Duple const & d) const
174 return d.translate (Duple (_scroll_offset_x, _scroll_offset_y));
178 Canvas::canvas_to_window (Duple const & d) const
180 return d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
184 Canvas::window_to_canvas (Rect const & r) const
186 return r.translate (Duple (_scroll_offset_x, _scroll_offset_y));
190 Canvas::canvas_to_window (Rect const & r) const
192 return r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
195 /** Called when an item has moved.
196 * @param item Item that has moved.
197 * @param pre_change_parent_bounding_box The bounding box of the item before
198 * the move, in its parent's coordinates.
201 Canvas::item_moved (Item* item, boost::optional<Rect> pre_change_parent_bounding_box)
203 if (pre_change_parent_bounding_box) {
204 /* request a redraw of where the item used to be. The box has
205 * to be in parent coordinate space since the bounding box of
206 * an item does not change when moved. If we use
207 * item->item_to_canvas() on the old bounding box, we will be
208 * using the item's new position, and so will compute the wrong
209 * invalidation area. If we use the parent (which has not
210 * moved, then this will work.
213 queue_draw_item_area (item->parent(), pre_change_parent_bounding_box.get ());
216 boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
217 if (post_change_bounding_box) {
218 /* request a redraw of where the item now is */
219 queue_draw_item_area (item, post_change_bounding_box.get ());
223 /** Request a redraw of a particular area in an item's coordinates.
225 * @param area Area to redraw in the item's coordinates.
228 Canvas::queue_draw_item_area (Item* item, Rect area)
230 ArdourCanvas::Rect canvas_area = item->item_to_canvas (area);
231 // cerr << "CANVAS " << this << " for " << item->whatami() << ' ' << item->name << " invalidate " << area << " TRANSLATE AS " << canvas_area << endl;
232 request_redraw (canvas_area);
235 /** Construct a GtkCanvas */
236 GtkCanvas::GtkCanvas ()
240 /* these are the events we want to know about */
241 add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK);
244 /** Handler for button presses on the canvas.
245 * @param ev GDK event.
248 GtkCanvas::button_handler (GdkEventButton* ev)
250 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button %3 %1 %1\n", ev->x, ev->y, (ev->type == GDK_BUTTON_PRESS ? "press" : "release")));
251 /* The Duple that we are passing in here is in canvas coordinates */
252 return deliver_event (Duple (ev->x, ev->y), reinterpret_cast<GdkEvent*> (ev));
255 /** Handler for pointer motion events on the canvas.
256 * @param ev GDK event.
257 * @return true if the motion event was handled, otherwise false.
260 GtkCanvas::motion_notify_handler (GdkEventMotion* ev)
262 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2\n", ev->x, ev->y));
265 /* if we have a grabbed item, it gets just the motion event,
266 since no enter/leave events can have happened.
268 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send MOTION event there\n",
269 _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
270 return _grabbed_item->Event (reinterpret_cast<GdkEvent*> (ev));
273 Duple point (ev->x, ev->y);
275 enter_leave_items (point, ev->state);
277 /* Now deliver the motion event. It may seem a little inefficient
278 to recompute the items under the event, but the enter notify/leave
279 events may have deleted canvas items so it is important to
280 recompute the list in deliver_event.
282 return deliver_event (point, reinterpret_cast<GdkEvent*> (ev));
286 GtkCanvas::enter_leave_items (int state)
291 /* this version of ::enter_leave_items() is called after an item is
292 * added or removed, so we have no coordinates to work from as is the
293 * case with a motion event. Find out where the mouse is and use that.
296 Glib::RefPtr<const Gdk::Window> pointer_window = Gdk::Display::get_default()->get_window_at_pointer (x, y);
298 if (pointer_window != get_window()) {
302 enter_leave_items (window_to_canvas (Duple (x, y)), state);
306 GtkCanvas::enter_leave_items (Duple const & point, int state)
308 /* find the items at the given position */
310 vector<Item const *> items;
311 _root.add_items_at_point (point, items);
313 GdkEventCrossing enter_event;
314 enter_event.type = GDK_ENTER_NOTIFY;
315 enter_event.window = get_window()->gobj();
316 enter_event.send_event = 0;
317 enter_event.subwindow = 0;
318 enter_event.mode = GDK_CROSSING_NORMAL;
319 enter_event.detail = GDK_NOTIFY_NONLINEAR;
320 enter_event.focus = FALSE;
321 enter_event.state = state;
322 enter_event.x = point.x;
323 enter_event.y = point.y;
325 GdkEventCrossing leave_event = enter_event;
326 leave_event.type = GDK_LEAVE_NOTIFY;
327 leave_event.detail = GDK_NOTIFY_ANCESTOR;
328 leave_event.subwindow = 0;
333 _current_item->Event (reinterpret_cast<GdkEvent*> (&leave_event));
339 /* items is sorted from top to bottom, so reverse through it from bottom
340 * to top to find the lowest, first event-sensitive item and notify that
344 cerr << "E/L: " << items.size() << " to check at " << point << endl;
345 for (vector<Item const*>::const_reverse_iterator i = items.rbegin(); i != items.rend(); ++i) {
346 cerr << '\t' << (*i)->whatami() << ' ' << (*i)->name << " ignore ? " << (*i)->ignore_events() << " current ? " << (_current_item == (*i)) << endl;
348 cerr << "------------\n";
350 for (vector<Item const*>::const_reverse_iterator i = items.rbegin(); i != items.rend(); ++i) {
352 Item const * new_item = *i;
354 cerr << "\tE/L check out " << new_item->whatami() << ' ' << new_item->name << " ignore ? " << new_item->ignore_events() << " current ? " << (_current_item == new_item) << endl;
356 if (new_item->ignore_events()) {
357 cerr << "continue1\n";
361 if (_current_item == new_item) {
362 cerr << "continue2\n";
368 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("Leave %1 %2\n", _current_item->whatami(), _current_item->name));
369 _current_item->Event (reinterpret_cast<GdkEvent*> (&leave_event));
372 if (new_item && _current_item != new_item) {
374 _current_item = new_item;
375 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("Enter %1 %2\n", _current_item->whatami(), _current_item->name));
376 _current_item->Event (reinterpret_cast<GdkEvent*> (&enter_event));
380 cerr << "Loop around again\n";
384 /** Deliver an event to the appropriate item; either the grabbed item, or
385 * one of the items underneath the event.
386 * @param point Position that the event has occurred at, in canvas coordinates.
387 * @param event The event.
390 GtkCanvas::deliver_event (Duple point, GdkEvent* event)
393 /* we have a grabbed item, so everything gets sent there */
394 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send event there\n",
395 _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
396 return _grabbed_item->Event (event);
399 /* find the items that exist at the event's position */
400 vector<Item const *> items;
401 _root.add_items_at_point (point, items);
403 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 possible items to deliver event to\n", items.size()));
405 /* run through the items under the event, from top to bottom, until one claims the event */
406 vector<Item const *>::const_reverse_iterator i = items.rbegin ();
407 while (i != items.rend()) {
409 if ((*i)->ignore_events ()) {
411 PBD::DEBUG::CanvasEvents,
412 string_compose ("canvas event ignored by %1 %2\n", (*i)->whatami(), (*i)->name.empty() ? "[unknown]" : (*i)->name)
418 if ((*i)->Event (event)) {
419 /* this item has just handled the event */
421 PBD::DEBUG::CanvasEvents,
422 string_compose ("canvas event handled by %1 %2\n", (*i)->whatami(), (*i)->name.empty() ? "[unknown]" : (*i)->name)
429 PBD::DEBUG::CanvasEvents,
430 string_compose ("canvas event left unhandled by %1 %2\n", (*i)->whatami(), (*i)->name.empty() ? "[unknown]" : (*i)->name)
437 if (PBD::debug_bits & PBD::DEBUG::CanvasEvents) {
438 while (i != items.rend()) {
439 DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event not seen by %1\n", (*i)->name.empty() ? "[unknown]" : (*i)->name));
447 /** Called when an item is being destroyed.
448 * @param item Item being destroyed.
449 * @param bounding_box Last known bounding box of the item.
452 GtkCanvas::item_going_away (Item* item, boost::optional<Rect> bounding_box)
455 queue_draw_item_area (item, bounding_box.get ());
458 if (_current_item == item) {
462 if (_grabbed_item == item) {
466 enter_leave_items (0); // no mouse state
470 /** Handler for GDK expose events.
472 * @return true if the event was handled.
475 GtkCanvas::on_expose_event (GdkEventExpose* ev)
477 Cairo::RefPtr<Cairo::Context> c = get_window()->create_cairo_context ();
479 render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), c);
484 /** @return Our Cairo context, or 0 if we don't have one */
485 Cairo::RefPtr<Cairo::Context>
486 GtkCanvas::context ()
488 Glib::RefPtr<Gdk::Window> w = get_window ();
490 return Cairo::RefPtr<Cairo::Context> ();
493 return w->create_cairo_context ();
496 /** Handler for GDK button press events.
498 * @return true if the event was handled.
501 GtkCanvas::on_button_press_event (GdkEventButton* ev)
503 /* translate event coordinates from window to canvas */
505 GdkEvent copy = *((GdkEvent*)ev);
506 Duple where = window_to_canvas (Duple (ev->x, ev->y));
508 copy.button.x = where.x;
509 copy.button.y = where.y;
511 /* Coordinates in the event will be canvas coordinates, correctly adjusted
512 for scroll if this GtkCanvas is in a GtkCanvasViewport.
514 return button_handler ((GdkEventButton*) ©);
517 /** Handler for GDK button release events.
519 * @return true if the event was handled.
522 GtkCanvas::on_button_release_event (GdkEventButton* ev)
524 /* translate event coordinates from window to canvas */
526 GdkEvent copy = *((GdkEvent*)ev);
527 Duple where = window_to_canvas (Duple (ev->x, ev->y));
529 copy.button.x = where.x;
530 copy.button.y = where.y;
532 /* Coordinates in the event will be canvas coordinates, correctly adjusted
533 for scroll if this GtkCanvas is in a GtkCanvasViewport.
535 return button_handler ((GdkEventButton*) ©);
538 /** Handler for GDK motion events.
540 * @return true if the event was handled.
543 GtkCanvas::on_motion_notify_event (GdkEventMotion* ev)
545 /* translate event coordinates from window to canvas */
547 GdkEvent copy = *((GdkEvent*)ev);
548 Duple where = window_to_canvas (Duple (ev->x, ev->y));
550 copy.motion.x = where.x;
551 copy.motion.y = where.y;
553 /* Coordinates in the event will be canvas coordinates, correctly adjusted
554 for scroll if this GtkCanvas is in a GtkCanvasViewport.
556 return motion_notify_handler ((GdkEventMotion*) ©);
559 /** Called to request a redraw of our canvas.
560 * @param area Area to redraw, in canvas coordinates.
563 GtkCanvas::request_redraw (Rect const & request)
565 Rect area = canvas_to_window (request);
566 // cerr << this << " Invalidate " << request << " TRANSLATE AS " << area << endl;
567 queue_draw_area (floor (area.x0), floor (area.y0), ceil (area.x1) - floor (area.x0), ceil (area.y1) - floor (area.y0));
570 /** Called to request that we try to get a particular size for ourselves.
571 * @param size Size to request, in pixels.
574 GtkCanvas::request_size (Duple size)
578 if (req.x > INT_MAX) {
582 if (req.y > INT_MAX) {
586 set_size_request (req.x, req.y);
589 /** `Grab' an item, so that all events are sent to that item until it is `ungrabbed'.
590 * This is typically used for dragging items around, so that they are grabbed during
592 * @param item Item to grab.
595 GtkCanvas::grab (Item* item)
597 /* XXX: should this be doing gdk_pointer_grab? */
598 _grabbed_item = item;
601 /** `Ungrab' any item that was previously grabbed */
605 /* XXX: should this be doing gdk_pointer_ungrab? */
609 /** @return The visible area of the canvas, in canvas coordinates */
611 GtkCanvas::visible_area () const
613 Distance const xo = _scroll_offset_x;
614 Distance const yo = _scroll_offset_y;
615 return Rect (xo, yo, xo + get_allocation().get_width (), yo + get_allocation().get_height ());
618 /** Create a GtkCanvaSViewport.
619 * @param hadj Adjustment to use for horizontal scrolling.
620 * @param vadj Adjustment to use for vertica scrolling.
622 GtkCanvasViewport::GtkCanvasViewport (Gtk::Adjustment& hadj, Gtk::Adjustment& vadj)
623 : Alignment (0, 0, 1.0, 1.0)
629 hadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
630 vadj.signal_value_changed().connect (sigc::mem_fun (*this, &GtkCanvasViewport::scrolled));
634 GtkCanvasViewport::scrolled ()
636 _canvas.scroll_to (hadjustment.get_value(), vadjustment.get_value());
640 /** Handler for when GTK asks us what minimum size we want.
641 * @param req Requsition to fill in.
644 GtkCanvasViewport::on_size_request (Gtk::Requisition* req)
646 /* force the canvas to size itself */
647 // _canvas.root()->bounding_box();