if CANVAS_DEBUG is defined, then the env variable CANVAS_HARLEQUIN_DEBUGGING will...
[ardour.git] / libs / canvas / canvas.cc
index ceaa366c3554c823757dc999236362ae9ef746b6..242f8ecbfd20acadf161e7df36b3b121fd6b7ec4 100644 (file)
@@ -33,6 +33,7 @@
 #include "canvas/canvas.h"
 #include "canvas/debug.h"
 #include "canvas/line.h"
+#include "canvas/scroll_group.h"
 
 using namespace std;
 using namespace ArdourCanvas;
@@ -40,8 +41,6 @@ using namespace ArdourCanvas;
 /** Construct a new Canvas */
 Canvas::Canvas ()
        : _root (this)
-       , _scroll_offset_x (0)
-       , _scroll_offset_y (0)
 {
        set_epoch ();
 }
@@ -49,12 +48,29 @@ Canvas::Canvas ()
 void
 Canvas::scroll_to (Coord x, Coord y)
 {
-       _scroll_offset_x = x;
-       _scroll_offset_y = y;
+       /* We do things this way because we do not want to recurse through
+          the canvas for every scroll. In the presence of large MIDI
+          tracks this means traversing item lists that include
+          thousands of items (notes).
+
+          This design limits us to moving only those items (groups, typically)
+          that should move in certain ways as we scroll. In other terms, it
+          becomes O(1) rather than O(N).
+       */
+
+       for (list<ScrollGroup*>::iterator i = scrollers.begin(); i != scrollers.end(); ++i) {
+               (*i)->scroll_to (Duple (x, y));
+       }
 
        pick_current_item (0); // no current mouse position 
 }
 
+void
+Canvas::add_scroller (ScrollGroup& i)
+{
+       scrollers.push_back (&i);
+}
+
 void
 Canvas::zoomed ()
 {
@@ -62,7 +78,7 @@ Canvas::zoomed ()
 }
 
 /** Render an area of the canvas.
- *  @param area Area in canvas coordinates.
+ *  @param area Area in window coordinates.
  *  @param context Cairo context to render to.
  */
 void
@@ -94,11 +110,17 @@ Canvas::render (Rect const & area, Cairo::RefPtr<Cairo::Context> const & context
 
                _root.render (*draw, context);
 
-               // This outlines the rect being rendered, after it has been drawn.
-               // context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0);
-               // context->set_source_rgba (1.0, 0, 0, 1.0);
-               // context->stroke ();
-
+#ifdef CANVAS_DEBUG
+               if (getenv ("CANVAS_HARLEQUIN_DEBUGGING")) {
+                       // This transparently colors the rect being rendered, after it has been drawn.
+                       double r = (random() % 65536) /65536.0;
+                       double g = (random() % 65536) /65536.0;
+                       double b = (random() % 65536) /65536.0;
+                       context->rectangle (draw->x0, draw->y0, draw->x1 - draw->x0, draw->y1 - draw->y0);
+                       context->set_source_rgba (r, g, b, 0.25);
+                       context->fill ();
+               }
+#endif
        }
 
 }
@@ -149,7 +171,9 @@ Canvas::item_shown_or_hidden (Item* item)
 {
        boost::optional<Rect> bbox = item->bounding_box ();
        if (bbox) {
-               queue_draw_item_area (item, bbox.get ());
+               if (item->item_to_window (*bbox).intersection (visible_area ())) {
+                       queue_draw_item_area (item, bbox.get ());
+               }
        }
 }
 
@@ -162,7 +186,9 @@ Canvas::item_visual_property_changed (Item* item)
 {
        boost::optional<Rect> bbox = item->bounding_box ();
        if (bbox) {
-               queue_draw_item_area (item, bbox.get ());
+               if (item->item_to_window (*bbox).intersection (visible_area ())) {
+                       queue_draw_item_area (item, bbox.get ());
+               }
        }
 }
 
@@ -174,60 +200,98 @@ Canvas::item_visual_property_changed (Item* item)
 void
 Canvas::item_changed (Item* item, boost::optional<Rect> pre_change_bounding_box)
 {
+       
+       Rect window_bbox = visible_area ();
+
        if (pre_change_bounding_box) {
-               /* request a redraw of the item's old bounding box */
-               queue_draw_item_area (item, pre_change_bounding_box.get ());
+
+               if (item->item_to_window (*pre_change_bounding_box).intersection (window_bbox)) {
+                       /* request a redraw of the item's old bounding box */
+                       queue_draw_item_area (item, pre_change_bounding_box.get ());
+               }
        }
 
        boost::optional<Rect> post_change_bounding_box = item->bounding_box ();
        if (post_change_bounding_box) {
-               /* request a redraw of the item's new bounding box */
-               queue_draw_item_area (item, post_change_bounding_box.get ());
+               
+               if (item->item_to_window (*post_change_bounding_box).intersection (window_bbox)) {
+                       /* request a redraw of the item's new bounding box */
+                       queue_draw_item_area (item, post_change_bounding_box.get ());
+               }
        }
 }
 
 Duple
 Canvas::window_to_canvas (Duple const & d) const
 {
-       return d.translate (Duple (_scroll_offset_x, _scroll_offset_y));
-}
+       /* Find the scroll group that covers d (a window coordinate). Scroll groups are only allowed
+        * as children of the root group, so we just scan its first level
+        * children and see what we can find.
+        */
 
-Duple
-Canvas::canvas_to_window (Duple const & d, bool rounded) const
-{
-       Duple wd = d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
+       std::list<Item*> const& root_children (_root.items());
+       ScrollGroup* sg = 0;
 
-       /* Note that this intentionally almost always returns integer coordinates */
-       if (rounded) {
-               wd.x = round (wd.x);
-               wd.y = round (wd.y);
+       /* if the coordinates are negative, clamp to zero and find the item
+        * that covers that "edge" position.
+        */
+
+       Duple in_window (d);
+
+       if (in_window.x < 0) {
+               in_window.x = 0;
+       }
+       if (in_window.y < 0) {
+               in_window.y = 0;
        }
 
-       return wd;
-}      
+       for (std::list<Item*>::const_iterator i = root_children.begin(); i != root_children.end(); ++i) {
+               if (((sg = dynamic_cast<ScrollGroup*>(*i)) != 0) && sg->covers_window (in_window)) {
+                       break;
+               }
+       }
 
-Rect
-Canvas::window_to_canvas (Rect const & r) const
-{
-       return r.translate (Duple (_scroll_offset_x, _scroll_offset_y));
+       if (sg) {
+               return d.translate (sg->scroll_offset());
+       }
+
+       return d;
 }
 
-Rect
-Canvas::canvas_to_window (Rect const & r, bool rounded) const
+Duple
+Canvas::canvas_to_window (Duple const & d, bool rounded) const
 {
-       Rect wr = r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
+       /* Find the scroll group that covers d (a canvas coordinate). Scroll groups are only allowed
+        * as children of the root group, so we just scan its first level
+        * children and see what we can find.
+        */
+
+       std::list<Item*> const& root_children (_root.items());
+       ScrollGroup* sg = 0;
+       Duple wd;
+
+       for (std::list<Item*>::const_iterator i = root_children.begin(); i != root_children.end(); ++i) {
+               if (((sg = dynamic_cast<ScrollGroup*>(*i)) != 0) && sg->covers_canvas (d)) {
+                       break;
+               }
+       }
+       
+
+       if (sg) {
+               wd = d.translate (-sg->scroll_offset());
+       } else {
+               wd = d;
+       }
 
        /* Note that this intentionally almost always returns integer coordinates */
 
        if (rounded) {
-               wr.x0 = round (wr.x0);
-               wr.x1 = round (wr.x1);
-               wr.y0 = round (wr.y0);
-               wr.y1 = round (wr.y1);
+               wd.x = round (wd.x);
+               wd.y = round (wd.y);
        }
 
-       return wr;
-}      
+       return wd;
+}
 
 /** Called when an item has moved.
  *  @param item Item that has moved.
@@ -264,9 +328,7 @@ Canvas::item_moved (Item* item, boost::optional<Rect> pre_change_parent_bounding
 void
 Canvas::queue_draw_item_area (Item* item, Rect area)
 {
-       ArdourCanvas::Rect canvas_area = item->item_to_canvas (area);
-       // cerr << "CANVAS " << this << " for " << item << ' ' << item->whatami() << ' ' << item->name << " invalidate " << area << " TRANSLATE AS " << canvas_area << " window = " << canvas_to_window (canvas_area) << std::endl;
-       request_redraw (canvas_area);
+       request_redraw (item->item_to_window (area));
 }
 
 /** Construct a GtkCanvas */
@@ -278,7 +340,7 @@ GtkCanvas::GtkCanvas ()
 {
        /* these are the events we want to know about */
        add_events (Gdk::BUTTON_PRESS_MASK | Gdk::BUTTON_RELEASE_MASK | Gdk::POINTER_MOTION_MASK |
-                   Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK);
+                   Gdk::SCROLL_MASK | Gdk::ENTER_NOTIFY_MASK | Gdk::LEAVE_NOTIFY_MASK);
 }
 
 void
@@ -298,9 +360,13 @@ GtkCanvas::pick_current_item (int state)
                return;
        }
 
-       pick_current_item (window_to_canvas (Duple (x, y)), state);
+       pick_current_item (Duple (x, y), state);
 }
-               
+
+/** Given @param point (a position in window coordinates)
+ *  and mouse state @param state, check to see if _current_item
+ *  (which will be used to deliver events) should change.
+ */
 void
 GtkCanvas::pick_current_item (Duple const & point, int state)
 {
@@ -310,7 +376,7 @@ GtkCanvas::pick_current_item (Duple const & point, int state)
                return;
        }
 
-       /* find the items at the given position */
+       /* find the items at the given window position */
 
        vector<Item const *> items;
        _root.add_items_at_point (point, items);
@@ -340,15 +406,14 @@ GtkCanvas::pick_current_item (Duple const & point, int state)
 
        for (i = items.begin(); i != items.end(); ++i) {
 
-               Item const * new_item = *i;
+               Item const * possible_item = *i;
 
-               /* We ignore invisible items, groups and items that ignore events */
+               /* We ignore invisible items, containers and items that ignore events */
 
-               if (!new_item->visible() || new_item->ignore_events() || dynamic_cast<Group const *>(new_item) != 0) {
+               if (!possible_item->visible() || possible_item->ignore_events() || dynamic_cast<ArdourCanvas::Container const *>(possible_item) != 0) {
                        continue;
                }
-               
-               within_items.push_front (new_item);
+               within_items.push_front (possible_item);
        }
 
        if (within_items.empty()) {
@@ -371,6 +436,9 @@ GtkCanvas::pick_current_item (Duple const & point, int state)
        }
 }
 
+/** Deliver a series of enter & leave events based on the pointer position being at window
+ * coordinate @param point, and pointer @param state (modifier keys, etc)
+ */
 void
 GtkCanvas::deliver_enter_leave (Duple const & point, int state)
 {
@@ -384,8 +452,14 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state)
        enter_event.mode = GDK_CROSSING_NORMAL;
        enter_event.focus = FALSE;
        enter_event.state = state;
-       enter_event.x = point.x;
-       enter_event.y = point.y;
+
+       /* Events delivered to canvas items are expected to be in canvas
+        * coordinates but @param point is in window coordinates.
+        */
+       
+       Duple c = window_to_canvas (point);
+       enter_event.x = c.x;
+       enter_event.y = c.y;
 
        GdkEventCrossing leave_event = enter_event;
        leave_event.type = GDK_LEAVE_NOTIFY;
@@ -432,7 +506,6 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state)
                 * heirarchy between current and new_current.
                 */
                
-
                for (i = _current_item->parent(); i && i != _new_current_item; i = i->parent()) {
                        items_to_leave_virtual.push_back (i);
                }
@@ -440,7 +513,6 @@ GtkCanvas::deliver_enter_leave (Duple const & point, int state)
                enter_detail = GDK_NOTIFY_INFERIOR;
                leave_detail = GDK_NOTIFY_ANCESTOR;
 
-
        } else if (_new_current_item->is_descendant_of (*_current_item)) {
                /* move from ancestor to descendant (X: "_new_current_item is
                 * an inferior ("child") of _current_item")
@@ -593,6 +665,11 @@ GtkCanvas::item_going_away (Item* item, boost::optional<Rect> bounding_box)
                _focused_item = 0;
        }
 
+       ScrollGroup* sg = dynamic_cast<ScrollGroup*>(item);
+       if (sg) {
+               scrollers.remove (sg);
+       }
+
        if (_current_item == item) {
                /* no need to send a leave event to this item, since it is going away 
                 */
@@ -626,6 +703,32 @@ GtkCanvas::context ()
        return w->create_cairo_context ();
 }
 
+/** Handler for GDK scroll events.
+ *  @param ev Event.
+ *  @return true if the event was handled.
+ */
+bool
+GtkCanvas::on_scroll_event (GdkEventScroll* ev)
+{
+       /* translate event coordinates from window to canvas */
+
+       GdkEvent copy = *((GdkEvent*)ev);
+       Duple winpos = Duple (ev->x, ev->y);
+       Duple where = window_to_canvas (winpos);
+       
+       pick_current_item (winpos, ev->state);
+
+       copy.button.x = where.x;
+       copy.button.y = where.y;
+       
+       /* Coordinates in the event will be canvas coordinates, correctly adjusted
+          for scroll if this GtkCanvas is in a GtkCanvasViewport.
+       */
+
+       DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas scroll @ %1, %2 => %3\n", ev->x, ev->y, where));
+       return deliver_event (reinterpret_cast<GdkEvent*>(&copy));
+}
+
 /** Handler for GDK button press events.
  *  @param ev Event.
  *  @return true if the event was handled.
@@ -636,7 +739,10 @@ GtkCanvas::on_button_press_event (GdkEventButton* ev)
        /* translate event coordinates from window to canvas */
 
        GdkEvent copy = *((GdkEvent*)ev);
-       Duple where = window_to_canvas (Duple (ev->x, ev->y));
+       Duple winpos = Duple (ev->x, ev->y);
+       Duple where = window_to_canvas (winpos);
+       
+       pick_current_item (winpos, ev->state);
 
        copy.button.x = where.x;
        copy.button.y = where.y;
@@ -645,7 +751,6 @@ GtkCanvas::on_button_press_event (GdkEventButton* ev)
           for scroll if this GtkCanvas is in a GtkCanvasViewport.
        */
 
-       pick_current_item (where, ev->state);
        DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button press @ %1, %2 => %3\n", ev->x, ev->y, where));
        return deliver_event (reinterpret_cast<GdkEvent*>(&copy));
 }
@@ -660,9 +765,10 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev)
        /* translate event coordinates from window to canvas */
 
        GdkEvent copy = *((GdkEvent*)ev);
-       Duple where = window_to_canvas (Duple (ev->x, ev->y));
+       Duple winpos = Duple (ev->x, ev->y);
+       Duple where = window_to_canvas (winpos);
        
-       pick_current_item (where, ev->state);
+       pick_current_item (winpos, ev->state);
 
        copy.button.x = where.x;
        copy.button.y = where.y;
@@ -671,11 +777,32 @@ GtkCanvas::on_button_release_event (GdkEventButton* ev)
           for scroll if this GtkCanvas is in a GtkCanvasViewport.
        */
 
-       pick_current_item (where, ev->state);
        DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas button release @ %1, %2 => %3\n", ev->x, ev->y, where));
        return deliver_event (reinterpret_cast<GdkEvent*>(&copy));
 }
 
+bool
+GtkCanvas::get_mouse_position (Duple& winpos) const
+{
+       int x;
+       int y;
+       Gdk::ModifierType mask;
+       Glib::RefPtr<Gdk::Window> self = Glib::RefPtr<Gdk::Window>::cast_const (get_window ());
+
+       if (!self) {
+               std::cerr << " no self window\n";
+               winpos = Duple (0, 0);
+               return false;
+       }
+
+       Glib::RefPtr<Gdk::Window> win = self->get_pointer (x, y, mask);
+
+       winpos.x = x;
+       winpos.y = y;
+
+       return true;
+}
+
 /** Handler for GDK motion events.
  *  @param ev Event.
  *  @return true if the event was handled.
@@ -695,9 +822,11 @@ GtkCanvas::on_motion_notify_event (GdkEventMotion* ev)
        /* Coordinates in "copy" will be canvas coordinates, 
        */
 
-       // DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2\n", ev->x, ev->y));
+       DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas motion @ %1, %2 canvas @ %3, %4\n", ev->x, ev->y, copy.motion.x, copy.motion.y));
+
+       MouseMotion (point); /* EMIT SIGNAL */
 
-       pick_current_item (where, ev->state);
+       pick_current_item (point, ev->state);
 
        /* Now deliver the motion event.  It may seem a little inefficient
           to recompute the items under the event, but the enter notify/leave
@@ -711,8 +840,7 @@ GtkCanvas::on_motion_notify_event (GdkEventMotion* ev)
 bool
 GtkCanvas::on_enter_notify_event (GdkEventCrossing* ev)
 {
-       Duple where = window_to_canvas (Duple (ev->x, ev->y));
-       pick_current_item (where, ev->state);
+       pick_current_item (Duple (ev->x, ev->y), ev->state);
        return true;
 }
 
@@ -720,24 +848,29 @@ bool
 GtkCanvas::on_leave_notify_event (GdkEventCrossing* ev)
 {
        _new_current_item = 0;
-       Duple where = window_to_canvas (Duple (ev->x, ev->y));
-       deliver_enter_leave (where, ev->state);
+       deliver_enter_leave (Duple (ev->x, ev->y), ev->state);
        return true;
 }
 
 /** Called to request a redraw of our canvas.
- *  @param area Area to redraw, in canvas coordinates.
+ *  @param area Area to redraw, in window coordinates.
  */
 void
 GtkCanvas::request_redraw (Rect const & request)
 {
-       boost::optional<Rect> req = request.intersection (visible_area());
+       Rect real_area;
 
-       if (req) {
-               Rect r = req.get();
-               Rect area = canvas_to_window (r);
-               queue_draw_area (area.x0, area.y0, area.width(), area.height());
-       }
+       Coord const w = width ();
+       Coord const h = height ();
+
+       /* clamp area requested to actual visible window */
+
+       real_area.x0 = max (0.0, min (w, request.x0));
+       real_area.x1 = max (0.0, min (w, request.x1));
+       real_area.y0 = max (0.0, min (h, request.y0));
+       real_area.y1 = max (0.0, min (h, request.y1));
+
+       queue_draw_area (real_area.x0, real_area.y0, real_area.width(), real_area.height());
 }
 
 /** Called to request that we try to get a particular size for ourselves.
@@ -798,13 +931,23 @@ GtkCanvas::unfocus (Item* item)
        }
 }
 
-/** @return The visible area of the canvas, in canvas coordinates */
+/** @return The visible area of the canvas, in window coordinates */
 Rect
 GtkCanvas::visible_area () const
 {
-       Distance const xo = _scroll_offset_x;
-       Distance const yo = _scroll_offset_y;
-       return Rect (xo, yo, xo + get_allocation().get_width (), yo + get_allocation().get_height ());
+       return Rect (0, 0, get_allocation().get_width (), get_allocation().get_height ());
+}
+
+Coord
+GtkCanvas::width() const
+{
+       return get_allocation().get_width();
+}
+
+Coord
+GtkCanvas::height() const
+{
+       return get_allocation().get_height();
 }
 
 /** Create a GtkCanvaSViewport.