#include "canvas/canvas.h"
#include "canvas/debug.h"
+#include "canvas/line.h"
+#include "canvas/scroll_group.h"
using namespace std;
using namespace ArdourCanvas;
/** Construct a new Canvas */
Canvas::Canvas ()
: _root (this)
- , _scroll_offset_x (0)
- , _scroll_offset_y (0)
{
set_epoch ();
}
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 ()
{
}
/** 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
{
#ifdef CANVAS_DEBUG
if (DEBUG_ENABLED(PBD::DEBUG::CanvasRender)) {
- cerr << "RENDER: " << area << endl;
+ cerr << this << " RENDER: " << area << endl;
//cerr << "CANVAS @ " << this << endl;
//dump (cerr);
//cerr << "-------------------------\n";
_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
}
}
{
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 ());
+ }
}
}
{
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 ());
+ }
}
}
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.
+ */
+
+ std::list<Item*> const& root_children (_root.items());
+ ScrollGroup* sg = 0;
+
+ /* 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;
+ }
+
+ 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;
+ }
+ }
+
+ if (sg) {
+ return d.translate (sg->scroll_offset());
+ }
+
+ return d;
}
Duple
-Canvas::canvas_to_window (Duple const & d) const
+Canvas::canvas_to_window (Duple const & d, bool rounded) const
{
- Duple wd = d.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
- wd.x = round (wd.x);
- wd.y = round (wd.y);
- return wd;
-}
+ /* 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.
+ */
-Rect
-Canvas::window_to_canvas (Rect const & r) const
-{
- return r.translate (Duple (_scroll_offset_x, _scroll_offset_y));
-}
+ std::list<Item*> const& root_children (_root.items());
+ ScrollGroup* sg = 0;
+ Duple wd;
-Rect
-Canvas::canvas_to_window (Rect const & r) const
-{
- Rect wr = r.translate (Duple (-_scroll_offset_x, -_scroll_offset_y));
- wr.x0 = floor (wr.x0);
- wr.x1 = ceil (wr.x1);
- wr.y0 = floor (wr.y0);
- wr.y1 = ceil (wr.y1);
- return wr;
-}
+ 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) {
+ wd.x = round (wd.x);
+ wd.y = round (wd.y);
+ }
+
+ return wd;
+}
/** Called when an item has moved.
* @param item Item that has moved.
void
Canvas::queue_draw_item_area (Item* item, Rect area)
{
- ArdourCanvas::Rect canvas_area = item->item_to_canvas (area);
- // cerr << "CANVAS " << this << " for " << item->whatami() << ' ' << item->name << " invalidate " << area << " TRANSLATE AS " << canvas_area << endl;
- request_redraw (canvas_area);
+ request_redraw (item->item_to_window (area));
}
/** Construct a 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
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)
{
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);
+ DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("%1 covers %2 items\n", point, items.size()));
+
+#ifndef NDEBUG
+ if (DEBUG_ENABLED(PBD::DEBUG::CanvasEnterLeave)) {
+ for (vector<Item const*>::const_iterator it = items.begin(); it != items.end(); ++it) {
+#ifdef CANVAS_DEBUG
+ std::cerr << "\tItem " << (*it)->whatami() << '/' << (*it)->name << std::endl;
+#else
+ std::cerr << "\tItem " << (*it)->whatami() << std::endl;
+#endif
+ }
+ }
+#endif
+
/* put all items at point that are event-sensitive and visible and NOT
groups into within_items. Note that items is sorted from bottom to
top, but we're going to reverse that for within_items so that its
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()) {
/* no items at point, just send leave event below */
+ _new_current_item = 0;
} else {
+
if (within_items.front() == _current_item) {
/* uppermost item at point is already _current_item */
return;
}
-
+
_new_current_item = const_cast<Item*> (within_items.front());
}
- deliver_enter_leave (point, state);
+ if (_new_current_item != _current_item) {
+ deliver_enter_leave (point, 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)
{
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;
} else if (_current_item->is_descendant_of (*_new_current_item)) {
/* move from descendant to ancestor (X: "_current_item is an
- * inferior of _new_current_item")
+ * inferior ("child") of _new_current_item")
*
* Deliver "virtual" leave notifications to all items in the
* 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);
}
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 of _current_item")
+ * an inferior ("child") of _current_item")
*
* Deliver "virtual" enter notifications to all items in the
* heirarchy between current and new_current.
if (_current_item && !_current_item->ignore_events ()) {
leave_event.detail = leave_detail;
_current_item->Event ((GdkEvent*)&leave_event);
- // std::cerr << "LEAVE " << _current_item->whatami() << '/' << _current_item->name << std::endl;
+ DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("LEAVE %1/%2\n", _current_item->whatami(), _current_item->name));
}
leave_event.detail = GDK_NOTIFY_VIRTUAL;
for (vector<Item*>::iterator it = items_to_leave_virtual.begin(); it != items_to_leave_virtual.end(); ++it) {
if (!(*it)->ignore_events()) {
+ DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("leave %1/%2\n", (*it)->whatami(), (*it)->name));
(*it)->Event ((GdkEvent*)&leave_event);
- // std::cerr << "leave " << (*it)->whatami() << '/' << (*it)->name << std::endl;
}
}
for (vector<Item*>::iterator it = items_to_enter_virtual.begin(); it != items_to_enter_virtual.end(); ++it) {
if (!(*it)->ignore_events()) {
+ DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("enter %1/%2\n", (*it)->whatami(), (*it)->name));
(*it)->Event ((GdkEvent*)&enter_event);
// std::cerr << "enter " << (*it)->whatami() << '/' << (*it)->name << std::endl;
}
if (_new_current_item && !_new_current_item->ignore_events()) {
enter_event.detail = enter_detail;
+ DEBUG_TRACE (PBD::DEBUG::CanvasEnterLeave, string_compose ("ENTER %1/%2\n", _new_current_item->whatami(), _new_current_item->name));
_new_current_item->Event ((GdkEvent*)&enter_event);
- // std::cerr << "ENTER " << _new_current_item->whatami() << '/' << _new_current_item->name << std::endl;
}
_current_item = _new_current_item;
{
/* Point in in canvas coordinate space */
+ const Item* event_item;
+
if (_grabbed_item) {
/* we have a grabbed item, so everything gets sent there */
DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send event there\n",
_grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
- return _grabbed_item->Event (event);
+ event_item = _grabbed_item;
+ } else {
+ event_item = _current_item;
}
- if (!_current_item) {
+ if (!event_item) {
return false;
}
/* run through the items from child to parent, until one claims the event */
- Item* item = const_cast<Item*> (_current_item);
+ Item* item = const_cast<Item*> (event_item);
while (item) {
return true;
}
- DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("canvas event left unhandled by %1 %2\n", item->whatami(), item->name.empty() ? "[unknown]" : item->name));
+ 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)));
if ((item = parent) == 0) {
break;
queue_draw_item_area (item, bounding_box.get ());
}
- /* no need to send a leave event to this item, since it is going away
- */
-
if (_new_current_item == item) {
_new_current_item = 0;
}
- if (_current_item == item) {
- _current_item = 0;
- }
-
if (_grabbed_item == item) {
_grabbed_item = 0;
}
_focused_item = 0;
}
- pick_current_item (0); // no mouse state
+ 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
+ */
+ _current_item = 0;
+ pick_current_item (0); // no mouse state
+ }
}
bool
GtkCanvas::on_expose_event (GdkEventExpose* ev)
{
- Cairo::RefPtr<Cairo::Context> c = get_window()->create_cairo_context ();
-
- render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), c);
-
+ Cairo::RefPtr<Cairo::Context> cairo_context = get_window()->create_cairo_context ();
+ render (Rect (ev->area.x, ev->area.y, ev->area.x + ev->area.width, ev->area.y + ev->area.height), cairo_context);
return true;
}
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*>(©));
+}
+
/** Handler for GDK button press events.
* @param ev Event.
* @return true if the event was handled.
/* 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;
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*>(©));
}
/* 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;
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*>(©));
}
+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.
/* 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));
- if (_grabbed_item) {
- /* if we have a grabbed item, it gets just the motion event,
- since no enter/leave events can have happened.
- */
- DEBUG_TRACE (PBD::DEBUG::CanvasEvents, string_compose ("%1 %2 (%3) was grabbed, send MOTION event there\n",
- _grabbed_item, _grabbed_item->whatami(), _grabbed_item->name));
- return _grabbed_item->Event (reinterpret_cast<GdkEvent*> (©));
- }
+ 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
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;
}
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)
{
- Rect area = canvas_to_window (request);
- queue_draw_area (area.x0, area.y0, area.width(), area.height());
+ Rect real_area;
+
+ 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.
}
}
-/** @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.