Code

Connector tool: make connectors avoid the convex hull of shapes.
[inkscape.git] / src / desktop-events.cpp
index 46fb00cca773cf27eeaac5f3b4df20ceb32d5e98..cea478f85847c35d149ef913d8e6d63b32b26856 100644 (file)
@@ -1,9 +1,7 @@
-#define __SP_DESKTOP_EVENTS_C__
-
-/*
- * Event handlers for SPDesktop
- *
- * Author:
+/** @file
+ * @brief Event handlers for SPDesktop
+ */
+/* Author:
  *   Lauris Kaplinski <lauris@kaplinski.com>
  *
  * Copyright (C) 1999-2002 Lauris Kaplinski
 #endif
 #include <map>
 #include <string>
+#include <2geom/line.h>
+#include <glibmm/i18n.h>
+
+#include "desktop.h"
+#include "desktop-handles.h"
+#include "dialogs/dialog-events.h"
+#include "display/canvas-axonomgrid.h"
+#include "display/canvas-grid.h"
 #include "display/guideline.h"
 #include "display/snap-indicator.h"
+#include "document.h"
+#include "event-context.h"
+#include "helper/action.h"
 #include "helper/unit-menu.h"
 #include "helper/units.h"
-#include "desktop.h"
-#include "document.h"
+#include "message-context.h"
+#include "preferences.h"
+#include "snap.h"
 #include "sp-guide.h"
+#include "sp-metrics.h"
 #include "sp-namedview.h"
-#include "desktop-handles.h"
-#include "event-context.h"
+#include "tools-switch.h"
+#include "ui/dialog/guides.h"
 #include "widgets/desktop-widget.h"
-#include "sp-metrics.h"
-#include <glibmm/i18n.h>
-#include "dialogs/dialog-events.h"
-#include "message-context.h"
 #include "xml/repr.h"
-#include "dialogs/guidelinedialog.h"
-#include "snap.h"
-#include "display/canvas-grid.h"
-#include "display/canvas-axonomgrid.h"
-#include "preferences.h"
-#include "helper/action.h"
-#include "tools-switch.h"
-#include <2geom/line.h>
 
 static void snoop_extended(GdkEvent* event, SPDesktop *desktop);
 static void init_extended();
@@ -67,7 +66,6 @@ int sp_desktop_root_handler(SPCanvasItem */*item*/, GdkEvent *event, SPDesktop *
     return sp_event_context_root_handler(desktop->event_context, event);
 }
 
-
 static gint sp_dt_ruler_event(GtkWidget *widget, GdkEvent *event, SPDesktopWidget *dtw, bool horiz)
 {
     static bool dragging = false;
@@ -88,7 +86,10 @@ static gint sp_dt_ruler_event(GtkWidget *widget, GdkEvent *event, SPDesktopWidge
     case GDK_BUTTON_PRESS:
             if (event->button.button == 1) {
                 dragging = true;
-                sp_canvas_set_snap_delay_active(desktop->canvas, true);
+
+                // FIXME: The snap delay mechanism won't work here, because it has been implemented for the event context. Dragging
+                // guides off the ruler will send event to the ruler and not to the context, which bypasses sp_event_context_snap_delay_handler
+
                 Geom::Point const event_w(sp_canvas_window_to_world(dtw->canvas, event_win));
                 Geom::Point const event_dt(desktop->w2d(event_w));
 
@@ -146,7 +147,10 @@ static gint sp_dt_ruler_event(GtkWidget *widget, GdkEvent *event, SPDesktopWidge
 
                 SnapManager &m = desktop->namedview->snap_manager;
                 m.setup(desktop);
-                m.guideSnap(event_dt, normal);
+                // We only have a temporary guide which is not stored in our document yet.
+                // Because the guide snapper only looks in the document for guides to snap to,
+                // we don't have to worry about a guide snapping to itself here
+                m.guideFreeSnap(event_dt, normal, SP_DRAG_MOVE_ORIGIN);
 
                 sp_guideline_set_position(SP_GUIDELINE(guide), from_2geom(event_dt));
                 desktop->set_coordinate_status(to_2geom(event_dt));
@@ -161,10 +165,15 @@ static gint sp_dt_ruler_event(GtkWidget *widget, GdkEvent *event, SPDesktopWidge
 
                 SnapManager &m = desktop->namedview->snap_manager;
                 m.setup(desktop);
-                m.guideSnap(event_dt, normal);
+                // We only have a temporary guide which is not stored in our document yet.
+                // Because the guide snapper only looks in the document for guides to snap to,
+                // we don't have to worry about a guide snapping to itself here
+                m.guideFreeSnap(event_dt, normal, SP_DRAG_MOVE_ORIGIN);
 
                 dragging = false;
-                sp_canvas_set_snap_delay_active(desktop->canvas, false);
+
+                sp_event_context_discard_delayed_snap_event(desktop->event_context);
+
                 gtk_object_destroy(GTK_OBJECT(guide));
                 guide = NULL;
                 if ((horiz ? wy : wx) >= 0) {
@@ -178,6 +187,14 @@ static gint sp_dt_ruler_event(GtkWidget *widget, GdkEvent *event, SPDesktopWidge
                                      _("Create guide"));
                 }
                 desktop->set_coordinate_status(from_2geom(event_dt));
+
+                // A dt_ruler_event might be emitted when dragging a guide of the rulers
+                // while drawing a Bezier curve. In such a situation, we're already in that
+                // specific context and the snap delay is already active. We should interfere
+                // with that context and we should therefore leave the snap delay status
+                // as it is. So although it might have been set to active above on
+                // GDK_BUTTON_PRESS, we should not set it back to inactive here. That must be
+                // done by the context.
             }
        default:
             break;
@@ -196,19 +213,13 @@ int sp_dt_vruler_event(GtkWidget *widget, GdkEvent *event, SPDesktopWidget *dtw)
     return sp_dt_ruler_event(widget, event, dtw, false);
 }
 
-/* Guides */
-
 static Geom::Point drag_origin;
-
-enum SPGuideDragType {
-    SP_DRAG_TRANSLATE,
-    SP_DRAG_TRANSLATE_CONSTRAINED,
-    SP_DRAG_ROTATE,
-    SP_DRAG_MOVE_ORIGIN,
-    SP_DRAG_NONE
-};
-
 static SPGuideDragType drag_type = SP_DRAG_NONE;
+//static bool reset_drag_origin = false; // when Ctrl is pressed while dragging, this is used to trigger resetting of the
+//                                       // drag origin to that location so that constrained movement is more intuitive
+
+// Min distance from anchor to initiate rotation, measured in screenpixels
+#define tol 40.0
 
 gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
 {
@@ -222,7 +233,7 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
        case GDK_2BUTTON_PRESS:
             if (event->button.button == 1) {
                 drag_type = SP_DRAG_NONE;
-                sp_canvas_set_snap_delay_active(desktop->canvas, false);
+                sp_event_context_discard_delayed_snap_event(desktop->event_context);
                 sp_canvas_item_ungrab(item, event->button.time);
                 Inkscape::UI::Dialogs::GuidelinePropertiesDialog::showDialog(guide, desktop);
                 ret = TRUE;
@@ -230,24 +241,28 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
             break;
        case GDK_BUTTON_PRESS:
             if (event->button.button == 1) {
-                if (event->button.state & GDK_CONTROL_MASK) {
-                    SPDocument *doc = SP_OBJECT_DOCUMENT(guide);
-                    sp_guide_remove(guide);
-                    sp_document_done(doc, SP_VERB_NONE, _("Delete guide"));
-                    ret = TRUE;
-                    break;
-                }
-
-                sp_canvas_set_snap_delay_active(desktop->canvas, true);
-                double tol = 40.0;
                 Geom::Point const event_w(event->button.x, event->button.y);
                 Geom::Point const event_dt(desktop->w2d(event_w));
-                drag_origin = event_dt;
-                if (Geom::L2(guide->point_on_line - event_dt) < tol) {
-                    // the click was on the guide 'anchor'
-                    drag_type = (event->button.state & GDK_SHIFT_MASK) ? SP_DRAG_MOVE_ORIGIN : SP_DRAG_TRANSLATE;
+
+                // Due to the tolerance allowed when grabbing a guide, event_dt will generally
+                // be close to the guide but not just exactly on it. The drag origin calculated
+                // here must be exactly on the guide line though, otherwise
+                // small errors will occur once we snap, see
+                // https://bugs.launchpad.net/inkscape/+bug/333762
+                drag_origin = Geom::projection(event_dt, Geom::Line(guide->point_on_line, guide->angle()));
+
+                if (event->button.state & GDK_SHIFT_MASK) {
+                    // with shift we rotate the guide
+                    drag_type = SP_DRAG_ROTATE;
                 } else {
-                    drag_type = (event->button.state & GDK_SHIFT_MASK) ? SP_DRAG_ROTATE : SP_DRAG_TRANSLATE;
+                    if (event->button.state & GDK_CONTROL_MASK) {
+                        drag_type = SP_DRAG_MOVE_ORIGIN;
+                    } else {
+                        drag_type = SP_DRAG_TRANSLATE;
+                    }
+                }
+
+                if (drag_type == SP_DRAG_ROTATE || drag_type == SP_DRAG_TRANSLATE) {
                     sp_canvas_item_grab(item,
                                         ( GDK_BUTTON_RELEASE_MASK  |
                                           GDK_BUTTON_PRESS_MASK    |
@@ -264,36 +279,49 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
                                            event->motion.y);
                 Geom::Point motion_dt(desktop->w2d(motion_w));
 
-                // This is for snapping while dragging existing guidelines. New guidelines, 
+                // This is for snapping while dragging existing guidelines. New guidelines,
                 // which are dragged off the ruler, are being snapped in sp_dt_ruler_event
                 SnapManager &m = desktop->namedview->snap_manager;
-                m.setup(desktop);
-                m.guideSnap(motion_dt, to_2geom(guide->normal_to_line));
+                m.setup(desktop, true, NULL, NULL, guide);
+                if (drag_type == SP_DRAG_MOVE_ORIGIN) {
+                    // If we snap in guideConstrainedSnap() below, then motion_dt will
+                    // be forced to be on the guide. If we don't snap however, then
+                    // the origin should still be constrained to the guide. So let's do
+                    // that explicitly first:
+
+                    Geom::Line line(guide->point_on_line, guide->angle());
+                    Geom::Coord t = line.nearestPoint(motion_dt);
+                    motion_dt = line.pointAt(t);
+                    m.guideConstrainedSnap(motion_dt, *guide);
+                } else {
+                    m.guideFreeSnap(motion_dt, guide->normal_to_line, drag_type);
+                }
 
                 switch (drag_type) {
                     case SP_DRAG_TRANSLATE:
                     {
-                        sp_guide_moveto(*guide, guide->point_on_line + motion_dt - drag_origin, false);
-                        break;
-                    }
-                    case SP_DRAG_TRANSLATE_CONSTRAINED:
-                    {
-                        Geom::Point pt_constr = Geom::constrain_angle(guide->point_on_line, motion_dt);
-                        sp_guide_moveto(*guide, pt_constr, false);
+                        sp_guide_moveto(*guide, motion_dt, false);
                         break;
                     }
                     case SP_DRAG_ROTATE:
                     {
-                        double angle = angle_between(drag_origin - guide->point_on_line, motion_dt - guide->point_on_line);
-                        sp_guide_set_normal(*guide, guide->normal_to_line * Geom::Rotate(angle), false);
+                        Geom::Point pt = motion_dt - guide->point_on_line;
+                        double angle = std::atan2(pt[Geom::Y], pt[Geom::X]);
+                        if  (event->motion.state & GDK_CONTROL_MASK) {
+                            Inkscape::Preferences *prefs = Inkscape::Preferences::get();
+                            unsigned const snaps = abs(prefs->getInt("/options/rotationsnapsperpi/value", 12));
+                            if (snaps) {
+                                double sections = floor(angle * snaps / M_PI + .5);
+                                angle = (M_PI / snaps) * sections;
+                            }
+                        }
+                        sp_guide_set_normal(*guide, Geom::Point(1,0) * Geom::Rotate(angle + M_PI_2), false);
                         break;
                     }
                     case SP_DRAG_MOVE_ORIGIN:
                     {
-                        Geom::Line line(guide->point_on_line, guide->angle());
-                        Geom::Coord t = line.nearestPoint(motion_dt);
-                        sp_guide_moveto(*guide, line.pointAt(t), false);
-                        break;
+                        sp_guide_moveto(*guide, motion_dt, false);
+                       break;
                     }
                     case SP_DRAG_NONE:
                         g_assert_not_reached();
@@ -314,34 +342,46 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
                     Geom::Point event_dt(desktop->w2d(event_w));
 
                     SnapManager &m = desktop->namedview->snap_manager;
-                    m.setup(desktop);
-                    m.guideSnap(event_dt, guide->normal_to_line);
+                    m.setup(desktop, true, NULL, NULL, guide);
+                    if (drag_type == SP_DRAG_MOVE_ORIGIN) {
+                       // If we snap in guideConstrainedSnap() below, then motion_dt will
+                        // be forced to be on the guide. If we don't snap however, then
+                        // the origin should still be constrained to the guide. So let's
+                        // do that explicitly first:
+                       Geom::Line line(guide->point_on_line, guide->angle());
+                        Geom::Coord t = line.nearestPoint(event_dt);
+                        event_dt = line.pointAt(t);
+                       m.guideConstrainedSnap(event_dt, *guide);
+                    } else {
+                        m.guideFreeSnap(event_dt, guide->normal_to_line, drag_type);
+                    }
 
                     if (sp_canvas_world_pt_inside_window(item->canvas, event_w)) {
                         switch (drag_type) {
                             case SP_DRAG_TRANSLATE:
                             {
-                                sp_guide_moveto(*guide, guide->point_on_line + event_dt - drag_origin, true);
-                                break;
-                            }
-                            case SP_DRAG_TRANSLATE_CONSTRAINED:
-                            {
-                                Geom::Point pt_constr = Geom::constrain_angle(guide->point_on_line, event_dt);
-                                sp_guide_moveto(*guide, pt_constr, true);
+                                sp_guide_moveto(*guide, event_dt, true);
                                 break;
                             }
                             case SP_DRAG_ROTATE:
                             {
-                                double angle = angle_between(drag_origin - guide->point_on_line, event_dt - guide->point_on_line);
-                                sp_guide_set_normal(*guide, guide->normal_to_line * Geom::Rotate(angle), true);
+                                Geom::Point pt = event_dt - guide->point_on_line;
+                                double angle = std::atan2(pt[Geom::Y], pt[Geom::X]);
+                                if  (event->motion.state & GDK_CONTROL_MASK) {
+                                    Inkscape::Preferences *prefs = Inkscape::Preferences::get();
+                                    unsigned const snaps = abs(prefs->getInt("/options/rotationsnapsperpi/value", 12));
+                                    if (snaps) {
+                                        double sections = floor(angle * snaps / M_PI + .5);
+                                        angle = (M_PI / snaps) * sections;
+                                    }
+                                }
+                                sp_guide_set_normal(*guide, Geom::Point(1,0) * Geom::Rotate(angle + M_PI_2), true);
                                 break;
                             }
                             case SP_DRAG_MOVE_ORIGIN:
                             {
-                                Geom::Line line(guide->point_on_line, guide->angle());
-                                Geom::Coord t = line.nearestPoint(event_dt);
-                                sp_guide_moveto(*guide, line.pointAt(t), true);
-                                break;
+                               sp_guide_moveto(*guide, event_dt, true);
+                               break;
                             }
                             case SP_DRAG_NONE:
                                 g_assert_not_reached();
@@ -362,7 +402,7 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
                     desktop->setPosition (from_2geom(event_dt));
                 }
                 drag_type = SP_DRAG_NONE;
-                sp_canvas_set_snap_delay_active(desktop->canvas, false);
+                sp_event_context_discard_delayed_snap_event(desktop->event_context);
                 sp_canvas_item_ungrab(item, event->button.time);
                 ret=TRUE;
             }
@@ -370,6 +410,17 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
     {
             sp_guideline_set_color(SP_GUIDELINE(item), guide->hicolor);
 
+            // set move or rotate cursor
+            Geom::Point const event_w(event->crossing.x, event->crossing.y);
+            Geom::Point const event_dt(desktop->w2d(event_w));
+
+            if (event->crossing.state & GDK_SHIFT_MASK) {
+                GdkCursor *guide_cursor;
+                guide_cursor = gdk_cursor_new (GDK_EXCHANGE);
+                gdk_window_set_cursor(GTK_WIDGET(sp_desktop_canvas(desktop))->window, guide_cursor);
+                gdk_cursor_unref(guide_cursor);
+            }
+
             char *guide_description = sp_guide_description(guide);
             desktop->guidesMessageContext()->setF(Inkscape::NORMAL_MESSAGE, _("<b>Guideline</b>: %s"), guide_description);
             g_free(guide_description);
@@ -377,10 +428,51 @@ gint sp_dt_guide_event(SPCanvasItem *item, GdkEvent *event, gpointer data)
     }
     case GDK_LEAVE_NOTIFY:
             sp_guideline_set_color(SP_GUIDELINE(item), guide->color);
+
+            // restore event context's cursor
+            gdk_window_set_cursor(GTK_WIDGET(sp_desktop_canvas(desktop))->window, desktop->event_context->cursor);
+
             desktop->guidesMessageContext()->clear();
             break;
-    default:
+        case GDK_KEY_PRESS:
+            switch (get_group0_keyval (&event->key)) {
+                case GDK_Delete:
+                case GDK_KP_Delete:
+                case GDK_BackSpace:
+                {
+                    SPDocument *doc = SP_OBJECT_DOCUMENT(guide);
+                    sp_guide_remove(guide);
+                    sp_document_done(doc, SP_VERB_NONE, _("Delete guide"));
+                    ret = TRUE;
+                    break;
+                }
+                case GDK_Shift_L:
+                case GDK_Shift_R:
+                    GdkCursor *guide_cursor;
+                    guide_cursor = gdk_cursor_new (GDK_EXCHANGE);
+                    gdk_window_set_cursor(GTK_WIDGET(sp_desktop_canvas(desktop))->window, guide_cursor);
+                    gdk_cursor_unref(guide_cursor);
+                    ret = TRUE;
+                default:
+                    // do nothing;
+                    break;
+            }
             break;
+        case GDK_KEY_RELEASE:
+            switch (get_group0_keyval (&event->key)) {
+                case GDK_Shift_L:
+                case GDK_Shift_R:
+                    GdkCursor *guide_cursor;
+                    guide_cursor = gdk_cursor_new (GDK_EXCHANGE);
+                    gdk_window_set_cursor(GTK_WIDGET(sp_desktop_canvas(desktop))->window, guide_cursor);
+                    gdk_cursor_unref(guide_cursor);
+                    break;
+                default:
+                    // do nothing;
+                    break;
+            }
+    default:
+        break;
     }
 
     return ret;