src/pencil-context.cpp

   1 /** \file
   2  * Pencil event context implementation.
   3  */
   4
   5 /*
   6  * Authors:
   7  *   Lauris Kaplinski <lauris@kaplinski.com>
   8  *   bulia byak <buliabyak@users.sf.net>
   9  *
  10  * Copyright (C) 2000 Lauris Kaplinski
  11  * Copyright (C) 2000-2001 Ximian, Inc.
  12  * Copyright (C) 2002 Lauris Kaplinski
  13  * Copyright (C) 2004 Monash University
  14  *
  15  * Released under GNU GPL, read the file 'COPYING' for more information
  16  */
  17
  18 #include <gdk/gdkkeysyms.h>
  19
  20 #include "pencil-context.h"
  21 #include "desktop.h"
  22 #include "desktop-handles.h"
  23 #include "selection.h"
  24 #include "selection-chemistry.h"
  25 #include "draw-anchor.h"
  26 #include "message-stack.h"
  27 #include "message-context.h"
  28 #include "modifier-fns.h"
  29 #include "sp-path.h"
  30 #include "preferences.h"
  31 #include "snap.h"
  32 #include "pixmaps/cursor-pencil.xpm"
  33 #include <2geom/sbasis-to-bezier.h>
  34 #include <2geom/bezier-utils.h>
  35 #include "display/canvas-bpath.h"
  36 #include <glibmm/i18n.h>
  37 #include "libnr/in-svg-plane.h"
  38 #include "context-fns.h"
  39 #include "sp-namedview.h"
  40 #include "xml/repr.h"
  41 #include "document.h"
  42 #include "desktop-style.h"
  43 #include "macros.h"
  44 #include "display/curve.h"
  45 #include "livarot/Path.h"
  46
  47 static void sp_pencil_context_class_init(SPPencilContextClass *klass);
  48 static void sp_pencil_context_init(SPPencilContext *pc);
  49 static void sp_pencil_context_setup(SPEventContext *ec);
  50 static void sp_pencil_context_dispose(GObject *object);
  51
  52 static gint sp_pencil_context_root_handler(SPEventContext *event_context, GdkEvent *event);
  53 static gint pencil_handle_button_press(SPPencilContext *const pc, GdkEventButton const &bevent);
  54 static gint pencil_handle_motion_notify(SPPencilContext *const pc, GdkEventMotion const &mevent);
  55 static gint pencil_handle_button_release(SPPencilContext *const pc, GdkEventButton const &revent);
  56 static gint pencil_handle_key_press(SPPencilContext *const pc, guint const keyval, guint const state);
  57 static gint pencil_handle_key_release(SPPencilContext *const pc, guint const keyval, guint const state);
  58
  59 static void spdc_set_startpoint(SPPencilContext *pc, Geom::Point const p);
  60 static void spdc_set_endpoint(SPPencilContext *pc, Geom::Point const p);
  61 static void spdc_finish_endpoint(SPPencilContext *pc);
  62 static void spdc_add_freehand_point(SPPencilContext *pc, Geom::Point p, guint state);
  63 static void fit_and_split(SPPencilContext *pc);
  64 static void interpolate(SPPencilContext *pc);
  65 static void sketch_interpolate(SPPencilContext *pc);
  66
  67 static SPDrawContextClass *pencil_parent_class;
  68 static Geom::Point pencil_drag_origin_w(0, 0);
  69 static bool pencil_within_tolerance = false;
  70
  71 /**
  72  * Register SPPencilContext class with Gdk and return its type number.
  73  */
  74 GType
  75 sp_pencil_context_get_type()
  76 {
  77     static GType type = 0;
  78     if (!type) {
  79         GTypeInfo info = {
  80             sizeof(SPPencilContextClass),
  81             NULL, NULL,
  82             (GClassInitFunc) sp_pencil_context_class_init,
  83             NULL, NULL,
  84             sizeof(SPPencilContext),
  85             4,
  86             (GInstanceInitFunc) sp_pencil_context_init,
  87             NULL,   /* value_table */
  88         };
  89         type = g_type_register_static(SP_TYPE_DRAW_CONTEXT, "SPPencilContext", &info, (GTypeFlags)0);
  90     }
  91     return type;
  92 }
  93
  94 /**
  95  * Initialize SPPencilContext vtable.
  96  */
  97 static void
  98 sp_pencil_context_class_init(SPPencilContextClass *klass)
  99 {
 100     GObjectClass *object_class;
 101     SPEventContextClass *event_context_class;
 102
 103     object_class = (GObjectClass *) klass;
 104     event_context_class = (SPEventContextClass *) klass;
 105
 106     pencil_parent_class = (SPDrawContextClass*)g_type_class_peek_parent(klass);
 107
 108     object_class->dispose = sp_pencil_context_dispose;
 109
 110     event_context_class->setup = sp_pencil_context_setup;
 111     event_context_class->root_handler = sp_pencil_context_root_handler;
 112 }
 113
 114 /**
 115  * Callback to initialize SPPencilContext object.
 116  */
 117 static void
 118 sp_pencil_context_init(SPPencilContext *pc)
 119 {
 120     SPEventContext *event_context = SP_EVENT_CONTEXT(pc);
 121
 122     event_context->cursor_shape = cursor_pencil_xpm;
 123     event_context->hot_x = 4;
 124     event_context->hot_y = 4;
 125
 126     pc->npoints = 0;
 127     pc->state = SP_PENCIL_CONTEXT_IDLE;
 128     pc->req_tangent = Geom::Point(0, 0);
 129
 130     // since SPPencilContext is not properly constructed...
 131     pc->sketch_interpolation = Geom::Piecewise<Geom::D2<Geom::SBasis> >();
 132     pc->sketch_n = 0;
 133 }
 134
 135 /**
 136  * Callback to setup SPPencilContext object.
 137  */
 138 static void
 139 sp_pencil_context_setup(SPEventContext *ec)
 140 {
 141     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 142     if (prefs->getBool("/tools/freehand/pencil/selcue")) {
 143         ec->enableSelectionCue();
 144     }
 145
 146     if (((SPEventContextClass *) pencil_parent_class)->setup) {
 147         ((SPEventContextClass *) pencil_parent_class)->setup(ec);
 148     }
 149
 150     SPPencilContext *const pc = SP_PENCIL_CONTEXT(ec);
 151     pc->is_drawing = false;
 152
 153     pc->anchor_statusbar = false;
 154 }
 155
 156 static void
 157 sp_pencil_context_dispose(GObject *object)
 158 {
 159     G_OBJECT_CLASS(pencil_parent_class)->dispose(object);
 160 }
 161
 162 /** Snaps new node relative to the previous node. */
 163 static void
 164 spdc_endpoint_snap(SPPencilContext const *pc, Geom::Point &p, guint const state)
 165 {
 166     if ((state & GDK_CONTROL_MASK)) { //CTRL enables constrained snapping
 167         spdc_endpoint_snap_rotation(pc, p, pc->p[0], state);
 168     } else {
 169         if (!(state & GDK_SHIFT_MASK)) { //SHIFT disables all snapping, except the angular snapping above
 170                                          //After all, the user explicitely asked for angular snapping by
 171                                          //pressing CTRL
 172             spdc_endpoint_snap_free(pc, p, state);
 173         }
 174     }
 175 }
 176
 177 /**
 178  * Callback for handling all pencil context events.
 179  */
 180 gint
 181 sp_pencil_context_root_handler(SPEventContext *const ec, GdkEvent *event)
 182 {
 183     SPPencilContext *const pc = SP_PENCIL_CONTEXT(ec);
 184
 185     gint ret = FALSE;
 186
 187     switch (event->type) {
 188         case GDK_BUTTON_PRESS:
 189             ret = pencil_handle_button_press(pc, event->button);
 190             break;
 191
 192         case GDK_MOTION_NOTIFY:
 193             ret = pencil_handle_motion_notify(pc, event->motion);
 194             break;
 195
 196         case GDK_BUTTON_RELEASE:
 197             ret = pencil_handle_button_release(pc, event->button);
 198             break;
 199
 200         case GDK_KEY_PRESS:
 201             ret = pencil_handle_key_press(pc, get_group0_keyval (&event->key), event->key.state);
 202             break;
 203
 204         case GDK_KEY_RELEASE:
 205             ret = pencil_handle_key_release(pc, get_group0_keyval (&event->key), event->key.state);
 206             break;
 207
 208         default:
 209             break;
 210     }
 211
 212     if (!ret) {
 213         gint (*const parent_root_handler)(SPEventContext *, GdkEvent *)
 214             = ((SPEventContextClass *) pencil_parent_class)->root_handler;
 215         if (parent_root_handler) {
 216             ret = parent_root_handler(ec, event);
 217         }
 218     }
 219
 220     return ret;
 221 }
 222
 223 static gint
 224 pencil_handle_button_press(SPPencilContext *const pc, GdkEventButton const &bevent)
 225 {
 226     gint ret = FALSE;
 227     SPEventContext *event_context = SP_EVENT_CONTEXT(pc);
 228     if ( bevent.button == 1  && !event_context->space_panning) {
 229
 230         SPDrawContext *dc = SP_DRAW_CONTEXT (pc);
 231         SPDesktop *desktop = SP_EVENT_CONTEXT_DESKTOP(dc);
 232         Inkscape::Selection *selection = sp_desktop_selection(desktop);
 233
 234         if (Inkscape::have_viable_layer(desktop, dc->_message_context) == false) {
 235             return TRUE;
 236         }
 237
 238         if (!pc->grab) {
 239             /* Grab mouse, so release will not pass unnoticed */
 240             pc->grab = SP_CANVAS_ITEM(desktop->acetate);
 241             sp_canvas_item_grab(pc->grab, ( GDK_KEY_PRESS_MASK | GDK_BUTTON_PRESS_MASK   |
 242                                             GDK_BUTTON_RELEASE_MASK |
 243                                             GDK_POINTER_MOTION_MASK  ),
 244                                 NULL, bevent.time);
 245         }
 246
 247         Geom::Point const button_w(bevent.x, bevent.y);
 248
 249         /* Find desktop coordinates */
 250         Geom::Point p = pc->desktop->w2d(button_w);
 251
 252         /* Test whether we hit any anchor. */
 253         SPDrawAnchor *anchor = spdc_test_inside(pc, button_w);
 254
 255         pencil_drag_origin_w = Geom::Point(bevent.x,bevent.y);
 256         pencil_within_tolerance = true;
 257
 258         switch (pc->state) {
 259             case SP_PENCIL_CONTEXT_ADDLINE:
 260                 /* Current segment will be finished with release */
 261                 ret = TRUE;
 262                 break;
 263             default:
 264                 /* Set first point of sequence */
 265                 SnapManager &m = desktop->namedview->snap_manager;
 266                 m.setup(desktop);
 267
 268                 if (bevent.state & GDK_CONTROL_MASK) {
 269                     if (!(bevent.state & GDK_SHIFT_MASK)) {
 270                         m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_NODE_HANDLE);
 271                       }
 272                     spdc_create_single_dot(event_context, p, "/tools/freehand/pencil", bevent.state);
 273                     ret = true;
 274                     break;
 275                 }
 276                 if (anchor) {
 277                     p = anchor->dp;
 278                     desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Continuing selected path"));
 279                 } else {
 280
 281                     if (!(bevent.state & GDK_SHIFT_MASK)) {
 282                         // This is the first click of a new curve; deselect item so that
 283                         // this curve is not combined with it (unless it is drawn from its
 284                         // anchor, which is handled by the sibling branch above)
 285                         selection->clear();
 286                         desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Creating new path"));
 287                         m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_NODE_HANDLE);
 288                     } else if (selection->singleItem() && SP_IS_PATH(selection->singleItem())) {
 289                         desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Appending to selected path"));
 290                         m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_NODE_HANDLE);
 291                     }
 292                 }
 293                 pc->sa = anchor;
 294                 spdc_set_startpoint(pc, p);
 295                 ret = TRUE;
 296                 break;
 297         }
 298
 299         pc->is_drawing = true;
 300     }
 301     return ret;
 302 }
 303
 304 static gint
 305 pencil_handle_motion_notify(SPPencilContext *const pc, GdkEventMotion const &mevent)
 306 {
 307     SPDesktop *const dt = pc->desktop;
 308
 309     if ((mevent.state & GDK_CONTROL_MASK) && (mevent.state & GDK_BUTTON1_MASK)) {
 310         // mouse was accidentally moved during Ctrl+click;
 311         // ignore the motion and create a single point
 312         pc->is_drawing = false;
 313         return TRUE;
 314     }
 315     gint ret = FALSE;
 316
 317     SPEventContext *event_context = SP_EVENT_CONTEXT(pc);
 318     if (event_context->space_panning || mevent.state & GDK_BUTTON2_MASK || mevent.state & GDK_BUTTON3_MASK) {
 319         // allow scrolling
 320         return FALSE;
 321     }
 322
 323     if ( ( mevent.state & GDK_BUTTON1_MASK ) && !pc->grab && pc->is_drawing) {
 324         /* Grab mouse, so release will not pass unnoticed */
 325         pc->grab = SP_CANVAS_ITEM(dt->acetate);
 326         sp_canvas_item_grab(pc->grab, ( GDK_KEY_PRESS_MASK | GDK_BUTTON_PRESS_MASK   |
 327                                         GDK_BUTTON_RELEASE_MASK |
 328                                         GDK_POINTER_MOTION_MASK  ),
 329                             NULL, mevent.time);
 330     }
 331
 332     /* Find desktop coordinates */
 333     Geom::Point p = dt->w2d(Geom::Point(mevent.x, mevent.y));
 334
 335     /* Test whether we hit any anchor. */
 336     SPDrawAnchor *anchor = spdc_test_inside(pc, Geom::Point(mevent.x, mevent.y));
 337
 338     if (pencil_within_tolerance) {
 339         Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 340         gint const tolerance = prefs->getIntLimited("/options/dragtolerance/value", 0, 0, 100);
 341         if ( Geom::LInfty( Geom::Point(mevent.x,mevent.y) - pencil_drag_origin_w ) < tolerance ) {
 342             return FALSE;   // Do not drag if we're within tolerance from origin.
 343         }
 344     }
 345
 346     // Once the user has moved farther than tolerance from the original location
 347     // (indicating they intend to move the object, not click), then always process the
 348     // motion notify coordinates as given (no snapping back to origin)
 349     pencil_within_tolerance = false;
 350
 351     switch (pc->state) {
 352         case SP_PENCIL_CONTEXT_ADDLINE:
 353             /* Set red endpoint */
 354             if (anchor) {
 355                 p = anchor->dp;
 356             } else {
 357                 Geom::Point ptnr(p);
 358                 spdc_endpoint_snap(pc, ptnr, mevent.state);
 359                 p = ptnr;
 360             }
 361             spdc_set_endpoint(pc, p);
 362             ret = TRUE;
 363             break;
 364         default:
 365             /* We may be idle or already freehand */
 366             if ( mevent.state & GDK_BUTTON1_MASK && pc->is_drawing ) {
 367                 if (pc->state == SP_PENCIL_CONTEXT_IDLE) {
 368                     sp_event_context_discard_delayed_snap_event(event_context);
 369                 }
 370                 pc->state = SP_PENCIL_CONTEXT_FREEHAND;
 371
 372                 if ( !pc->sa && !pc->green_anchor ) {
 373                     /* Create green anchor */
 374                     pc->green_anchor = sp_draw_anchor_new(pc, pc->green_curve, TRUE, pc->p[0]);
 375                 }
 376                 if (anchor) {
 377                     p = anchor->dp;
 378                 }
 379
 380                 if ( pc->npoints != 0) { // buttonpress may have happened before we entered draw context!
 381                     spdc_add_freehand_point(pc, p, mevent.state);
 382                     ret = TRUE;
 383                 }
 384
 385                 if (anchor && !pc->anchor_statusbar) {
 386                     pc->_message_context->set(Inkscape::NORMAL_MESSAGE, _("<b>Release</b> here to close and finish the path."));
 387                     pc->anchor_statusbar = true;
 388                 } else if (!anchor && pc->anchor_statusbar) {
 389                     pc->_message_context->clear();
 390                     pc->anchor_statusbar = false;
 391                 } else if (!anchor) {
 392                     pc->_message_context->set(Inkscape::NORMAL_MESSAGE, _("Drawing a freehand path"));
 393                 }
 394
 395             } else {
 396                 if (anchor && !pc->anchor_statusbar) {
 397                     pc->_message_context->set(Inkscape::NORMAL_MESSAGE, _("<b>Drag</b> to continue the path from this point."));
 398                     pc->anchor_statusbar = true;
 399                 } else if (!anchor && pc->anchor_statusbar) {
 400                     pc->_message_context->clear();
 401                     pc->anchor_statusbar = false;
 402                 }
 403             }
 404
 405             // Show the pre-snap indicator to communicate to the user where we would snap to if he/she were to
 406             // a) press the mousebutton to start a freehand drawing, or
 407             // b) release the mousebutton to finish a freehand drawing
 408             if (!sp_event_context_knot_mouseover(pc)) {
 409                 SnapManager &m = dt->namedview->snap_manager;
 410                 m.setup(dt);
 411                 m.preSnap(Inkscape::SnapCandidatePoint(p, Inkscape::SNAPSOURCE_NODE_HANDLE));
 412             }
 413             break;
 414     }
 415     return ret;
 416 }
 417
 418 static gint
 419 pencil_handle_button_release(SPPencilContext *const pc, GdkEventButton const &revent)
 420 {
 421     gint ret = FALSE;
 422
 423     SPEventContext *event_context = SP_EVENT_CONTEXT(pc);
 424     if ( revent.button == 1 && pc->is_drawing && !event_context->space_panning) {
 425         SPDesktop *const dt = pc->desktop;
 426
 427         pc->is_drawing = false;
 428
 429         /* Find desktop coordinates */
 430         Geom::Point p = dt->w2d(Geom::Point(revent.x, revent.y));
 431
 432         /* Test whether we hit any anchor. */
 433         SPDrawAnchor *anchor = spdc_test_inside(pc, Geom::Point(revent.x,
 434                                                               revent.y));
 435
 436         switch (pc->state) {
 437             case SP_PENCIL_CONTEXT_IDLE:
 438                 /* Releasing button in idle mode means single click */
 439                 /* We have already set up start point/anchor in button_press */
 440                 if (!(revent.state & GDK_CONTROL_MASK)) {
 441                     // Ctrl+click creates a single point so only set context in ADDLINE mode when Ctrl isn't pressed
 442                     pc->state = SP_PENCIL_CONTEXT_ADDLINE;
 443                 }
 444                 ret = TRUE;
 445                 break;
 446             case SP_PENCIL_CONTEXT_ADDLINE:
 447                 /* Finish segment now */
 448                 if (anchor) {
 449                     p = anchor->dp;
 450                 } else {
 451                     spdc_endpoint_snap(pc, p, revent.state);
 452                 }
 453                 pc->ea = anchor;
 454                 spdc_set_endpoint(pc, p);
 455                 spdc_finish_endpoint(pc);
 456                 pc->state = SP_PENCIL_CONTEXT_IDLE;
 457                 sp_event_context_discard_delayed_snap_event(event_context);
 458                 ret = TRUE;
 459                 break;
 460             case SP_PENCIL_CONTEXT_FREEHAND:
 461                 if (revent.state & GDK_MOD1_MASK) {
 462                     /* sketch mode: interpolate the sketched path and improve the current output path with the new interpolation. don't finish sketch */
 463
 464                     sketch_interpolate(pc);
 465
 466                     if (pc->green_anchor) {
 467                         pc->green_anchor = sp_draw_anchor_destroy(pc->green_anchor);
 468                     }
 469
 470                     pc->state = SP_PENCIL_CONTEXT_SKETCH;
 471                 } else {
 472                     /* Finish segment now */
 473                     /// \todo fixme: Clean up what follows (Lauris)
 474                     if (anchor) {
 475                         p = anchor->dp;
 476                     } else {
 477                         Geom::Point p_end = p;
 478                         spdc_endpoint_snap(pc, p_end, revent.state);
 479                         if (p_end != p) {
 480                             // then we must have snapped!
 481                             spdc_add_freehand_point(pc, p_end, revent.state);
 482                         }
 483                     }
 484
 485                     pc->ea = anchor;
 486                     /* Write curves to object */
 487
 488                     dt->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Finishing freehand"));
 489
 490                     interpolate(pc);
 491                     spdc_concat_colors_and_flush(pc, FALSE);
 492                     pc->sa = NULL;
 493                     pc->ea = NULL;
 494                     if (pc->green_anchor) {
 495                         pc->green_anchor = sp_draw_anchor_destroy(pc->green_anchor);
 496                     }
 497                     pc->state = SP_PENCIL_CONTEXT_IDLE;
 498                     // reset sketch mode too
 499                     pc->sketch_n = 0;
 500                 }
 501                 ret = TRUE;
 502                 break;
 503             case SP_PENCIL_CONTEXT_SKETCH:
 504             default:
 505                 break;
 506         }
 507
 508         if (pc->grab) {
 509             /* Release grab now */
 510             sp_canvas_item_ungrab(pc->grab, revent.time);
 511             pc->grab = NULL;
 512         }
 513
 514         ret = TRUE;
 515     }
 516     return ret;
 517 }
 518
 519 static void
 520 pencil_cancel (SPPencilContext *const pc)
 521 {
 522     if (pc->grab) {
 523         /* Release grab now */
 524         sp_canvas_item_ungrab(pc->grab, 0);
 525         pc->grab = NULL;
 526     }
 527
 528     pc->is_drawing = false;
 529     pc->state = SP_PENCIL_CONTEXT_IDLE;
 530     sp_event_context_discard_delayed_snap_event(SP_EVENT_CONTEXT(pc));
 531
 532     pc->red_curve->reset();
 533     sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(pc->red_bpath), NULL);
 534     while (pc->green_bpaths) {
 535         gtk_object_destroy(GTK_OBJECT(pc->green_bpaths->data));
 536         pc->green_bpaths = g_slist_remove(pc->green_bpaths, pc->green_bpaths->data);
 537     }
 538     pc->green_curve->reset();
 539     if (pc->green_anchor) {
 540         pc->green_anchor = sp_draw_anchor_destroy(pc->green_anchor);
 541     }
 542
 543     pc->_message_context->clear();
 544     pc->_message_context->flash(Inkscape::NORMAL_MESSAGE, _("Drawing cancelled"));
 545
 546     sp_canvas_end_forced_full_redraws(pc->desktop->canvas);
 547 }
 548
 549 static gint
 550 pencil_handle_key_press(SPPencilContext *const pc, guint const keyval, guint const state)
 551 {
 552     gint ret = FALSE;
 553     switch (keyval) {
 554         case GDK_Up:
 555         case GDK_Down:
 556         case GDK_KP_Up:
 557         case GDK_KP_Down:
 558             // Prevent the zoom field from activation.
 559             if (!mod_ctrl_only(state)) {
 560                 ret = TRUE;
 561             }
 562             break;
 563         case GDK_Escape:
 564             if (pc->npoints != 0) {
 565                 // if drawing, cancel, otherwise pass it up for deselecting
 566                 if (pc->state != SP_PENCIL_CONTEXT_IDLE) {
 567                     pencil_cancel (pc);
 568                     ret = TRUE;
 569                 }
 570             }
 571             break;
 572         case GDK_z:
 573         case GDK_Z:
 574             if (mod_ctrl_only(state) && pc->npoints != 0) {
 575                 // if drawing, cancel, otherwise pass it up for undo
 576                 if (pc->state != SP_PENCIL_CONTEXT_IDLE) {
 577                     pencil_cancel (pc);
 578                     ret = TRUE;
 579                 }
 580             }
 581             break;
 582         case GDK_g:
 583         case GDK_G:
 584             if (mod_shift_only(state)) {
 585                 sp_selection_to_guides(SP_EVENT_CONTEXT(pc)->desktop);
 586                 ret = true;
 587             }
 588             break;
 589         case GDK_Alt_L:
 590         case GDK_Alt_R:
 591         case GDK_Meta_L:
 592         case GDK_Meta_R:
 593             if (pc->state == SP_PENCIL_CONTEXT_IDLE) {
 594                 pc->desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("<b>Sketch mode</b>: holding <b>Alt</b> interpolates between sketched paths. Release <b>Alt</b> to finalize."));
 595             }
 596             break;
 597         default:
 598             break;
 599     }
 600     return ret;
 601 }
 602
 603 static gint
 604 pencil_handle_key_release(SPPencilContext *const pc, guint const keyval, guint const /*state*/)
 605 {
 606     gint ret = FALSE;
 607     switch (keyval) {
 608         case GDK_Alt_L:
 609         case GDK_Alt_R:
 610         case GDK_Meta_L:
 611         case GDK_Meta_R:
 612             if (pc->state == SP_PENCIL_CONTEXT_SKETCH) {
 613                 spdc_concat_colors_and_flush(pc, FALSE);
 614                 pc->sketch_n = 0;
 615                 pc->sa = NULL;
 616                 pc->ea = NULL;
 617                 if (pc->green_anchor) {
 618                     pc->green_anchor = sp_draw_anchor_destroy(pc->green_anchor);
 619                 }
 620                 pc->state = SP_PENCIL_CONTEXT_IDLE;
 621                 sp_event_context_discard_delayed_snap_event(SP_EVENT_CONTEXT(pc));
 622                 pc->desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Finishing freehand sketch"));
 623                 ret = TRUE;
 624             }
 625             break;
 626         default:
 627             break;
 628     }
 629     return ret;
 630 }
 631
 632 /**
 633  * Reset points and set new starting point.
 634  */
 635 static void
 636 spdc_set_startpoint(SPPencilContext *const pc, Geom::Point const p)
 637 {
 638     pc->npoints = 0;
 639     pc->red_curve_is_valid = false;
 640     if (in_svg_plane(p)) {
 641         pc->p[pc->npoints++] = p;
 642         pc->ps.push_back(p);
 643     }
 644 }
 645
 646 /**
 647  * Change moving endpoint position.
 648  * <ul>
 649  * <li>Ctrl constrains to moving to H/V direction, snapping in given direction.
 650  * <li>Otherwise we snap freely to whatever attractors are available.
 651  * </ul>
 652  *
 653  * Number of points is (re)set to 2 always, 2nd point is modified.
 654  * We change RED curve.
 655  */
 656 static void
 657 spdc_set_endpoint(SPPencilContext *const pc, Geom::Point const p)
 658 {
 659     if (pc->npoints == 0) {
 660         return;
 661         /* May occur if first point wasn't in SVG plane (e.g. weird w2d transform, perhaps from bad
 662          * zoom setting).
 663          */
 664     }
 665     g_return_if_fail( pc->npoints > 0 );
 666
 667     pc->red_curve->reset();
 668     if ( ( p == pc->p[0] )
 669          || !in_svg_plane(p) )
 670     {
 671         pc->npoints = 1;
 672     } else {
 673         pc->p[1] = p;
 674         pc->npoints = 2;
 675
 676         pc->red_curve->moveto(pc->p[0]);
 677         pc->red_curve->lineto(pc->p[1]);
 678         pc->red_curve_is_valid = true;
 679
 680         sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(pc->red_bpath), pc->red_curve);
 681     }
 682 }
 683
 684 /**
 685  * Finalize addline.
 686  *
 687  * \todo
 688  * fixme: I'd like remove red reset from concat colors (lauris).
 689  * Still not sure, how it will make most sense.
 690  */
 691 static void
 692 spdc_finish_endpoint(SPPencilContext *const pc)
 693 {
 694     if ( ( pc->red_curve->is_empty() )
 695          || ( *(pc->red_curve->first_point()) == *(pc->red_curve->second_point())   ) )
 696     {
 697         pc->red_curve->reset();
 698         sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(pc->red_bpath), NULL);
 699     } else {
 700         /* Write curves to object. */
 701         spdc_concat_colors_and_flush(pc, FALSE);
 702         pc->sa = NULL;
 703         pc->ea = NULL;
 704     }
 705 }
 706
 707
 708 static void
 709 spdc_add_freehand_point(SPPencilContext *pc, Geom::Point p, guint /*state*/)
 710 {
 711     g_assert( pc->npoints > 0 );
 712     g_return_if_fail(unsigned(pc->npoints) < G_N_ELEMENTS(pc->p));
 713
 714     if ( ( p != pc->p[ pc->npoints - 1 ] )
 715          && in_svg_plane(p) )
 716     {
 717         pc->ps.push_back(p);
 718         pc->p[pc->npoints++] = p;
 719         fit_and_split(pc);
 720     }
 721 }
 722
 723 static inline double
 724 square(double const x)
 725 {
 726     return x * x;
 727 }
 728
 729 static void
 730 interpolate(SPPencilContext *pc)
 731 {
 732     if ( pc->ps.size() <= 1 ) {
 733         return;
 734     }
 735
 736     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 737     double const tol = prefs->getDoubleLimited("/tools/freehand/pencil/tolerance", 10.0, 1.0, 100.0) * 0.4;
 738     double const tolerance_sq = 0.02 * square( pc->desktop->w2d().descrim() *
 739                                                tol) * exp(0.2*tol - 2);
 740
 741     g_assert(is_zero(pc->req_tangent)
 742              || is_unit_vector(pc->req_tangent));
 743     Geom::Point const tHatEnd(0, 0);
 744
 745     guint n_points  = pc->ps.size();
 746     pc->green_curve->reset();
 747     pc->red_curve->reset();
 748     pc->red_curve_is_valid = false;
 749
 750     Geom::Point * b = g_new(Geom::Point, 4*n_points);
 751     Geom::Point * points = g_new(Geom::Point, 4*n_points);
 752     for (unsigned int i = 0; i < pc->ps.size(); i++) {
 753         points[i] = pc->ps[i];
 754     }
 755
 756     // worst case gives us a segment per point
 757     int max_segs = 4*n_points;
 758
 759     int const n_segs = Geom::bezier_fit_cubic_r(b, points, n_points,
 760                                              tolerance_sq, max_segs);
 761
 762     if ( n_segs > 0)
 763     {
 764         /* Fit and draw and reset state */
 765         pc->green_curve->moveto(b[0]);
 766         for (int c = 0; c < n_segs; c++) {
 767             pc->green_curve->curveto(b[4*c+1], b[4*c+2], b[4*c+3]);
 768         }
 769         sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(pc->red_bpath), pc->green_curve);
 770
 771         /* Fit and draw and copy last point */
 772         g_assert(!pc->green_curve->is_empty());
 773
 774         /* Set up direction of next curve. */
 775         {
 776             Geom::CubicBezier const * last_seg = dynamic_cast<Geom::CubicBezier const *>(pc->green_curve->last_segment());
 777             g_assert( last_seg );      // Relevance: validity of (*last_seg)[2]
 778             pc->p[0] = last_seg->finalPoint();
 779             pc->npoints = 1;
 780             Geom::Point const req_vec( pc->p[0] - (*last_seg)[2] );
 781             pc->req_tangent = ( ( Geom::is_zero(req_vec) || !in_svg_plane(req_vec) )
 782                                 ? Geom::Point(0, 0)
 783                                 : Geom::unit_vector(req_vec) );
 784         }
 785     }
 786     g_free(b);
 787     g_free(points);
 788     pc->ps.clear();
 789 }
 790
 791
 792 /* interpolates the sketched curve and tweaks the current sketch interpolation*/
 793 static void
 794 sketch_interpolate(SPPencilContext *pc)
 795 {
 796     if ( pc->ps.size() <= 1 ) {
 797         return;
 798     }
 799
 800     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 801     double const tol = prefs->getDoubleLimited("/tools/freehand/pencil/tolerance", 10.0, 1.0, 100.0) * 0.4;
 802     double const tolerance_sq = 0.02 * square( pc->desktop->w2d().descrim() *
 803                                                tol) * exp(0.2*tol - 2);
 804
 805     bool average_all_sketches = prefs->getBool("/tools/freehand/pencil/average_all_sketches", true);
 806
 807     g_assert(is_zero(pc->req_tangent)
 808              || is_unit_vector(pc->req_tangent));
 809     Geom::Point const tHatEnd(0, 0);
 810
 811     guint n_points  = pc->ps.size();
 812     pc->red_curve->reset();
 813     pc->red_curve_is_valid = false;
 814
 815     Geom::Point * b = g_new(Geom::Point, 4*n_points);
 816     Geom::Point * points = g_new(Geom::Point, 4*n_points);
 817     for (unsigned i = 0; i < pc->ps.size(); i++) {
 818         points[i] = pc->ps[i];
 819     }
 820
 821     // worst case gives us a segment per point
 822     int max_segs = 4*n_points;
 823
 824     int const n_segs = Geom::bezier_fit_cubic_r(b, points, n_points,
 825                                              tolerance_sq, max_segs);
 826
 827     if ( n_segs > 0)
 828     {
 829         Geom::Path fit(b[0]);
 830         for (int c = 0; c < n_segs; c++) {
 831             fit.appendNew<Geom::CubicBezier>(b[4*c+1], b[4*c+2], b[4*c+3]);
 832         }
 833         Geom::Piecewise<Geom::D2<Geom::SBasis> > fit_pwd2 = fit.toPwSb();
 834
 835         double t =0.;
 836         if ( pc->sketch_n > 0 ) {
 837             if (average_all_sketches) {
 838                 // Average = (sum of all) / n
 839                 //         = (sum of all + new one) / n+1
 840                 //         = ((old average)*n + new one) / n+1
 841                 t = pc->sketch_n / (pc->sketch_n + 1.);
 842             } else {
 843                 t = 0.5;
 844             }
 845             pc->sketch_interpolation = Geom::lerp(t, fit_pwd2, pc->sketch_interpolation);
 846             // simplify path, to eliminate small segments
 847             Path *path = new Path;
 848             path->LoadPathVector(Geom::path_from_piecewise(pc->sketch_interpolation, 0.01));
 849             path->Simplify(0.5);
 850             Geom::PathVector *pathv = path->MakePathVector();
 851             pc->sketch_interpolation = (*pathv)[0].toPwSb();
 852             delete path;
 853             delete pathv;
 854         } else {
 855             pc->sketch_interpolation = fit_pwd2;
 856         }
 857         pc->sketch_n++;
 858
 859         pc->green_curve->reset();
 860         pc->green_curve->set_pathvector(Geom::path_from_piecewise(pc->sketch_interpolation, 0.01));
 861         sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(pc->red_bpath), pc->green_curve);
 862
 863         /* Fit and draw and copy last point */
 864         g_assert(!pc->green_curve->is_empty());
 865
 866         /* Set up direction of next curve. */
 867         {
 868             Geom::CubicBezier const * last_seg = dynamic_cast<Geom::CubicBezier const *>(pc->green_curve->last_segment());
 869             g_assert( last_seg );      // Relevance: validity of (*last_seg)[2]
 870             pc->p[0] = last_seg->finalPoint();
 871             pc->npoints = 1;
 872             Geom::Point const req_vec( pc->p[0] - (*last_seg)[2] );
 873             pc->req_tangent = ( ( Geom::is_zero(req_vec) || !in_svg_plane(req_vec) )
 874                                 ? Geom::Point(0, 0)
 875                                 : Geom::unit_vector(req_vec) );
 876         }
 877     }
 878     g_free(b);
 879     g_free(points);
 880     pc->ps.clear();
 881 }
 882
 883 static void
 884 fit_and_split(SPPencilContext *pc)
 885 {
 886     g_assert( pc->npoints > 1 );
 887
 888     double const tolerance_sq = 0;
 889
 890     Geom::Point b[4];
 891     g_assert(is_zero(pc->req_tangent)
 892              || is_unit_vector(pc->req_tangent));
 893     Geom::Point const tHatEnd(0, 0);
 894     int const n_segs = Geom::bezier_fit_cubic_full(b, NULL, pc->p, pc->npoints,
 895                                                 pc->req_tangent, tHatEnd,
 896                                                 tolerance_sq, 1);
 897     if ( n_segs > 0
 898          && unsigned(pc->npoints) < G_N_ELEMENTS(pc->p) )
 899     {
 900         /* Fit and draw and reset state */
 901         pc->red_curve->reset();
 902         pc->red_curve->moveto(b[0]);
 903         pc->red_curve->curveto(b[1], b[2], b[3]);
 904         sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(pc->red_bpath), pc->red_curve);
 905         pc->red_curve_is_valid = true;
 906     } else {
 907         /* Fit and draw and copy last point */
 908
 909         g_assert(!pc->red_curve->is_empty());
 910
 911         /* Set up direction of next curve. */
 912         {
 913             Geom::CubicBezier const * last_seg = dynamic_cast<Geom::CubicBezier const *>(pc->red_curve->last_segment());
 914             g_assert( last_seg );      // Relevance: validity of (*last_seg)[2]
 915             pc->p[0] = last_seg->finalPoint();
 916             pc->npoints = 1;
 917             Geom::Point const req_vec( pc->p[0] - (*last_seg)[2] );
 918             pc->req_tangent = ( ( Geom::is_zero(req_vec) || !in_svg_plane(req_vec) )
 919                                 ? Geom::Point(0, 0)
 920                                 : Geom::unit_vector(req_vec) );
 921         }
 922
 923         pc->green_curve->append_continuous(pc->red_curve, 0.0625);
 924         SPCurve *curve = pc->red_curve->copy();
 925
 926         /// \todo fixme:
 927         SPCanvasItem *cshape = sp_canvas_bpath_new(sp_desktop_sketch(pc->desktop), curve);
 928         curve->unref();
 929         sp_canvas_bpath_set_stroke(SP_CANVAS_BPATH(cshape), pc->green_color, 1.0, SP_STROKE_LINEJOIN_MITER, SP_STROKE_LINECAP_BUTT);
 930
 931         pc->green_bpaths = g_slist_prepend(pc->green_bpaths, cshape);
 932
 933         pc->red_curve_is_valid = false;
 934     }
 935 }
 936
 937
 938 /*
 939   Local Variables:
 940   mode:c++
 941   c-file-style:"stroustrup"
 942   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 943   indent-tabs-mode:nil
 944   fill-column:99
 945   End:
 946 */
 947 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :