1 /*
2 * Eraser drawing mode
3 *
4 * Authors:
5 * Mitsuru Oka <oka326@parkcity.ne.jp>
6 * Lauris Kaplinski <lauris@kaplinski.com>
7 * bulia byak <buliabyak@users.sf.net>
8 * MenTaLguY <mental@rydia.net>
9 * Jon A. Cruz <jon@joncruz.org>
10 *
11 * The original dynadraw code:
12 * Paul Haeberli <paul@sgi.com>
13 *
14 * Copyright (C) 1998 The Free Software Foundation
15 * Copyright (C) 1999-2005 authors
16 * Copyright (C) 2001-2002 Ximian, Inc.
17 * Copyright (C) 2005-2007 bulia byak
18 * Copyright (C) 2006 MenTaLguY
19 * Copyright (C) 2008 Jon A. Cruz
20 *
21 * Released under GNU GPL, read the file 'COPYING' for more information
22 */
24 #define noERASER_VERBOSE
26 #include "config.h"
28 #include <gtk/gtk.h>
29 #include <gdk/gdkkeysyms.h>
30 #include <glibmm/i18n.h>
31 #include <string>
32 #include <cstring>
33 #include <numeric>
35 #include "svg/svg.h"
36 #include "display/canvas-bpath.h"
37 #include "display/bezier-utils.h"
39 #include <glib/gmem.h>
40 #include "macros.h"
41 #include "document.h"
42 #include "selection.h"
43 #include "desktop.h"
44 #include "desktop-events.h"
45 #include "desktop-handles.h"
46 #include "desktop-affine.h"
47 #include "desktop-style.h"
48 #include "message-context.h"
49 #include "prefs-utils.h"
50 #include "pixmaps/cursor-eraser.xpm"
51 #include "xml/repr.h"
52 #include "context-fns.h"
53 #include "sp-item.h"
54 #include "color.h"
55 #include "rubberband.h"
56 #include "splivarot.h"
57 #include "sp-item-group.h"
58 #include "sp-shape.h"
59 #include "sp-path.h"
60 #include "sp-text.h"
61 #include "display/canvas-bpath.h"
62 #include "display/canvas-arena.h"
63 #include "livarot/Shape.h"
64 #include <2geom/isnan.h>
65 #include <2geom/pathvector.h>
67 #include "eraser-context.h"
69 #define ERC_RED_RGBA 0xff0000ff
71 #define TOLERANCE_ERASER 0.1
73 #define ERASER_EPSILON 0.5e-6
74 #define ERASER_EPSILON_START 0.5e-2
75 #define ERASER_VEL_START 1e-5
77 #define DRAG_MIN 0.0
78 #define DRAG_DEFAULT 1.0
79 #define DRAG_MAX 1.0
82 static void sp_eraser_context_class_init(SPEraserContextClass *klass);
83 static void sp_eraser_context_init(SPEraserContext *erc);
84 static void sp_eraser_context_dispose(GObject *object);
86 static void sp_eraser_context_setup(SPEventContext *ec);
87 static void sp_eraser_context_set(SPEventContext *ec, gchar const *key, gchar const *val);
88 static gint sp_eraser_context_root_handler(SPEventContext *ec, GdkEvent *event);
90 static void clear_current(SPEraserContext *dc);
91 static void set_to_accumulated(SPEraserContext *dc);
92 static void add_cap(SPCurve *curve, NR::Point const &pre, NR::Point const &from, NR::Point const &to, NR::Point const &post, double rounding);
93 static void accumulate_eraser(SPEraserContext *dc);
95 static void fit_and_split(SPEraserContext *erc, gboolean release);
97 static void sp_eraser_reset(SPEraserContext *erc, NR::Point p);
98 static NR::Point sp_eraser_get_npoint(SPEraserContext const *erc, NR::Point v);
99 static NR::Point sp_eraser_get_vpoint(SPEraserContext const *erc, NR::Point n);
100 static void draw_temporary_box(SPEraserContext *dc);
103 static SPEventContextClass *eraser_parent_class = 0;
105 GType sp_eraser_context_get_type(void)
106 {
107 static GType type = 0;
108 if (!type) {
109 GTypeInfo info = {
110 sizeof(SPEraserContextClass),
111 0, // base_init
112 0, // base_finalize
113 (GClassInitFunc)sp_eraser_context_class_init,
114 0, // class_finalize
115 0, // class_data
116 sizeof(SPEraserContext),
117 0, // n_preallocs
118 (GInstanceInitFunc)sp_eraser_context_init,
119 0 // value_table
120 };
121 type = g_type_register_static(SP_TYPE_COMMON_CONTEXT, "SPEraserContext", &info, static_cast<GTypeFlags>(0));
122 }
123 return type;
124 }
126 static void
127 sp_eraser_context_class_init(SPEraserContextClass *klass)
128 {
129 GObjectClass *object_class = (GObjectClass *) klass;
130 SPEventContextClass *event_context_class = (SPEventContextClass *) klass;
132 eraser_parent_class = (SPEventContextClass*)g_type_class_peek_parent(klass);
134 object_class->dispose = sp_eraser_context_dispose;
136 event_context_class->setup = sp_eraser_context_setup;
137 event_context_class->set = sp_eraser_context_set;
138 event_context_class->root_handler = sp_eraser_context_root_handler;
139 }
141 static void
142 sp_eraser_context_init(SPEraserContext *erc)
143 {
144 erc->cursor_shape = cursor_eraser_xpm;
145 erc->hot_x = 4;
146 erc->hot_y = 4;
147 }
149 static void
150 sp_eraser_context_dispose(GObject *object)
151 {
152 //SPEraserContext *erc = SP_ERASER_CONTEXT(object);
154 G_OBJECT_CLASS(eraser_parent_class)->dispose(object);
155 }
157 static void
158 sp_eraser_context_setup(SPEventContext *ec)
159 {
160 SPEraserContext *erc = SP_ERASER_CONTEXT(ec);
161 SPDesktop *desktop = ec->desktop;
163 if (((SPEventContextClass *) eraser_parent_class)->setup)
164 ((SPEventContextClass *) eraser_parent_class)->setup(ec);
166 erc->accumulated = new SPCurve();
167 erc->currentcurve = new SPCurve();
169 erc->cal1 = new SPCurve();
170 erc->cal2 = new SPCurve();
172 erc->currentshape = sp_canvas_item_new(sp_desktop_sketch(desktop), SP_TYPE_CANVAS_BPATH, NULL);
173 sp_canvas_bpath_set_fill(SP_CANVAS_BPATH(erc->currentshape), ERC_RED_RGBA, SP_WIND_RULE_EVENODD);
174 sp_canvas_bpath_set_stroke(SP_CANVAS_BPATH(erc->currentshape), 0x00000000, 1.0, SP_STROKE_LINEJOIN_MITER, SP_STROKE_LINECAP_BUTT);
175 /* fixme: Cannot we cascade it to root more clearly? */
176 g_signal_connect(G_OBJECT(erc->currentshape), "event", G_CALLBACK(sp_desktop_root_handler), desktop);
178 /*
179 static ProfileFloatElement f_profile[PROFILE_FLOAT_SIZE] = {
180 {"mass",0.02, 0.0, 1.0},
181 {"wiggle",0.0, 0.0, 1.0},
182 {"angle",30.0, -90.0, 90.0},
183 {"thinning",0.1, -1.0, 1.0},
184 {"tremor",0.0, 0.0, 1.0},
185 {"flatness",0.9, 0.0, 1.0},
186 {"cap_rounding",0.0, 0.0, 5.0}
187 };
188 */
190 sp_event_context_read(ec, "mass");
191 sp_event_context_read(ec, "wiggle");
192 sp_event_context_read(ec, "angle");
193 sp_event_context_read(ec, "width");
194 sp_event_context_read(ec, "thinning");
195 sp_event_context_read(ec, "tremor");
196 sp_event_context_read(ec, "flatness");
197 sp_event_context_read(ec, "tracebackground");
198 sp_event_context_read(ec, "usepressure");
199 sp_event_context_read(ec, "usetilt");
200 sp_event_context_read(ec, "abs_width");
201 sp_event_context_read(ec, "cap_rounding");
203 erc->is_drawing = false;
205 erc->_message_context = new Inkscape::MessageContext(desktop->messageStack());
207 if (prefs_get_int_attribute("tools.eraser", "selcue", 0) != 0) {
208 ec->enableSelectionCue();
209 }
210 // TODO temp force:
211 ec->enableSelectionCue();
213 }
215 static void
216 sp_eraser_context_set(SPEventContext *ec, gchar const *key, gchar const *val)
217 {
218 //pass on up to parent class to handle common attributes.
219 if ( eraser_parent_class->set ) {
220 eraser_parent_class->set(ec, key, val);
221 }
222 }
224 static double
225 flerp(double f0, double f1, double p)
226 {
227 return f0 + ( f1 - f0 ) * p;
228 }
230 /* Get normalized point */
231 static NR::Point
232 sp_eraser_get_npoint(SPEraserContext const *dc, NR::Point v)
233 {
234 NR::Rect drect = SP_EVENT_CONTEXT(dc)->desktop->get_display_area();
235 double const max = MAX ( drect.dimensions()[NR::X], drect.dimensions()[NR::Y] );
236 return NR::Point(( v[NR::X] - drect.min()[NR::X] ) / max, ( v[NR::Y] - drect.min()[NR::Y] ) / max);
237 }
239 /* Get view point */
240 static NR::Point
241 sp_eraser_get_vpoint(SPEraserContext const *dc, NR::Point n)
242 {
243 NR::Rect drect = SP_EVENT_CONTEXT(dc)->desktop->get_display_area();
244 double const max = MAX ( drect.dimensions()[NR::X], drect.dimensions()[NR::Y] );
245 return NR::Point(n[NR::X] * max + drect.min()[NR::X], n[NR::Y] * max + drect.min()[NR::Y]);
246 }
248 static void
249 sp_eraser_reset(SPEraserContext *dc, NR::Point p)
250 {
251 dc->last = dc->cur = sp_eraser_get_npoint(dc, p);
252 dc->vel = NR::Point(0,0);
253 dc->vel_max = 0;
254 dc->acc = NR::Point(0,0);
255 dc->ang = NR::Point(0,0);
256 dc->del = NR::Point(0,0);
257 }
259 static void
260 sp_eraser_extinput(SPEraserContext *dc, GdkEvent *event)
261 {
262 if (gdk_event_get_axis (event, GDK_AXIS_PRESSURE, &dc->pressure))
263 dc->pressure = CLAMP (dc->pressure, ERC_MIN_PRESSURE, ERC_MAX_PRESSURE);
264 else
265 dc->pressure = ERC_DEFAULT_PRESSURE;
267 if (gdk_event_get_axis (event, GDK_AXIS_XTILT, &dc->xtilt))
268 dc->xtilt = CLAMP (dc->xtilt, ERC_MIN_TILT, ERC_MAX_TILT);
269 else
270 dc->xtilt = ERC_DEFAULT_TILT;
272 if (gdk_event_get_axis (event, GDK_AXIS_YTILT, &dc->ytilt))
273 dc->ytilt = CLAMP (dc->ytilt, ERC_MIN_TILT, ERC_MAX_TILT);
274 else
275 dc->ytilt = ERC_DEFAULT_TILT;
276 }
279 static gboolean
280 sp_eraser_apply(SPEraserContext *dc, NR::Point p)
281 {
282 NR::Point n = sp_eraser_get_npoint(dc, p);
284 /* Calculate mass and drag */
285 double const mass = flerp(1.0, 160.0, dc->mass);
286 double const drag = flerp(0.0, 0.5, dc->drag * dc->drag);
288 /* Calculate force and acceleration */
289 NR::Point force = n - dc->cur;
291 // If force is below the absolute threshold ERASER_EPSILON,
292 // or we haven't yet reached ERASER_VEL_START (i.e. at the beginning of stroke)
293 // _and_ the force is below the (higher) ERASER_EPSILON_START threshold,
294 // discard this move.
295 // This prevents flips, blobs, and jerks caused by microscopic tremor of the tablet pen,
296 // especially bothersome at the start of the stroke where we don't yet have the inertia to
297 // smooth them out.
298 if ( NR::L2(force) < ERASER_EPSILON || (dc->vel_max < ERASER_VEL_START && NR::L2(force) < ERASER_EPSILON_START)) {
299 return FALSE;
300 }
302 dc->acc = force / mass;
304 /* Calculate new velocity */
305 dc->vel += dc->acc;
307 if (NR::L2(dc->vel) > dc->vel_max)
308 dc->vel_max = NR::L2(dc->vel);
310 /* Calculate angle of drawing tool */
312 double a1;
313 if (dc->usetilt) {
314 // 1a. calculate nib angle from input device tilt:
315 gdouble length = std::sqrt(dc->xtilt*dc->xtilt + dc->ytilt*dc->ytilt);;
317 if (length > 0) {
318 NR::Point ang1 = NR::Point(dc->ytilt/length, dc->xtilt/length);
319 a1 = atan2(ang1);
320 }
321 else
322 a1 = 0.0;
323 }
324 else {
325 // 1b. fixed dc->angle (absolutely flat nib):
326 double const radians = ( (dc->angle - 90) / 180.0 ) * M_PI;
327 NR::Point ang1 = NR::Point(-sin(radians), cos(radians));
328 a1 = atan2(ang1);
329 }
331 // 2. perpendicular to dc->vel (absolutely non-flat nib):
332 gdouble const mag_vel = NR::L2(dc->vel);
333 if ( mag_vel < ERASER_EPSILON ) {
334 return FALSE;
335 }
336 NR::Point ang2 = NR::rot90(dc->vel) / mag_vel;
338 // 3. Average them using flatness parameter:
339 // calculate angles
340 double a2 = atan2(ang2);
341 // flip a2 to force it to be in the same half-circle as a1
342 bool flipped = false;
343 if (fabs (a2-a1) > 0.5*M_PI) {
344 a2 += M_PI;
345 flipped = true;
346 }
347 // normalize a2
348 if (a2 > M_PI)
349 a2 -= 2*M_PI;
350 if (a2 < -M_PI)
351 a2 += 2*M_PI;
352 // find the flatness-weighted bisector angle, unflip if a2 was flipped
353 // FIXME: when dc->vel is oscillating around the fixed angle, the new_ang flips back and forth. How to avoid this?
354 double new_ang = a1 + (1 - dc->flatness) * (a2 - a1) - (flipped? M_PI : 0);
356 // Try to detect a sudden flip when the new angle differs too much from the previous for the
357 // current velocity; in that case discard this move
358 double angle_delta = NR::L2(NR::Point (cos (new_ang), sin (new_ang)) - dc->ang);
359 if ( angle_delta / NR::L2(dc->vel) > 4000 ) {
360 return FALSE;
361 }
363 // convert to point
364 dc->ang = NR::Point (cos (new_ang), sin (new_ang));
366 // g_print ("force %g acc %g vel_max %g vel %g a1 %g a2 %g new_ang %g\n", NR::L2(force), NR::L2(dc->acc), dc->vel_max, NR::L2(dc->vel), a1, a2, new_ang);
368 /* Apply drag */
369 dc->vel *= 1.0 - drag;
371 /* Update position */
372 dc->last = dc->cur;
373 dc->cur += dc->vel;
375 return TRUE;
376 }
378 static void
379 sp_eraser_brush(SPEraserContext *dc)
380 {
381 g_assert( dc->npoints >= 0 && dc->npoints < SAMPLING_SIZE );
383 // How much velocity thins strokestyle
384 double vel_thin = flerp (0, 160, dc->vel_thin);
386 // Influence of pressure on thickness
387 double pressure_thick = (dc->usepressure ? dc->pressure : 1.0);
389 // get the real brush point, not the same as pointer (affected by hatch tracking and/or mass
390 // drag)
391 NR::Point brush = sp_eraser_get_vpoint(dc, dc->cur);
392 NR::Point brush_w = SP_EVENT_CONTEXT(dc)->desktop->d2w(brush);
394 double trace_thick = 1;
396 double width = (pressure_thick * trace_thick - vel_thin * NR::L2(dc->vel)) * dc->width;
398 double tremble_left = 0, tremble_right = 0;
399 if (dc->tremor > 0) {
400 // obtain two normally distributed random variables, using polar Box-Muller transform
401 double x1, x2, w, y1, y2;
402 do {
403 x1 = 2.0 * g_random_double_range(0,1) - 1.0;
404 x2 = 2.0 * g_random_double_range(0,1) - 1.0;
405 w = x1 * x1 + x2 * x2;
406 } while ( w >= 1.0 );
407 w = sqrt( (-2.0 * log( w ) ) / w );
408 y1 = x1 * w;
409 y2 = x2 * w;
411 // deflect both left and right edges randomly and independently, so that:
412 // (1) dc->tremor=1 corresponds to sigma=1, decreasing dc->tremor narrows the bell curve;
413 // (2) deflection depends on width, but is upped for small widths for better visual uniformity across widths;
414 // (3) deflection somewhat depends on speed, to prevent fast strokes looking
415 // comparatively smooth and slow ones excessively jittery
416 tremble_left = (y1)*dc->tremor * (0.15 + 0.8*width) * (0.35 + 14*NR::L2(dc->vel));
417 tremble_right = (y2)*dc->tremor * (0.15 + 0.8*width) * (0.35 + 14*NR::L2(dc->vel));
418 }
420 if ( width < 0.02 * dc->width ) {
421 width = 0.02 * dc->width;
422 }
424 double dezoomify_factor = 0.05 * 1000;
425 if (!dc->abs_width) {
426 dezoomify_factor /= SP_EVENT_CONTEXT(dc)->desktop->current_zoom();
427 }
429 NR::Point del_left = dezoomify_factor * (width + tremble_left) * dc->ang;
430 NR::Point del_right = dezoomify_factor * (width + tremble_right) * dc->ang;
432 dc->point1[dc->npoints] = brush + del_left;
433 dc->point2[dc->npoints] = brush - del_right;
435 dc->del = 0.5*(del_left + del_right);
437 dc->npoints++;
438 }
440 void
441 sp_erc_update_toolbox (SPDesktop *desktop, const gchar *id, double value)
442 {
443 desktop->setToolboxAdjustmentValue (id, value);
444 }
446 static void
447 eraser_cancel(SPEraserContext *dc)
448 {
449 SPDesktop *desktop = SP_EVENT_CONTEXT(dc)->desktop;
450 dc->dragging = FALSE;
451 dc->is_drawing = false;
452 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate), 0);
453 /* Remove all temporary line segments */
454 while (dc->segments) {
455 gtk_object_destroy(GTK_OBJECT(dc->segments->data));
456 dc->segments = g_slist_remove(dc->segments, dc->segments->data);
457 }
458 /* reset accumulated curve */
459 dc->accumulated->reset();
460 clear_current(dc);
461 if (dc->repr) {
462 dc->repr = NULL;
463 }
464 }
467 gint
468 sp_eraser_context_root_handler(SPEventContext *event_context,
469 GdkEvent *event)
470 {
471 SPEraserContext *dc = SP_ERASER_CONTEXT(event_context);
472 SPDesktop *desktop = event_context->desktop;
474 gint ret = FALSE;
476 switch (event->type) {
477 case GDK_BUTTON_PRESS:
478 if (event->button.button == 1 && !event_context->space_panning) {
480 if (Inkscape::have_viable_layer(desktop, dc->_message_context) == false) {
481 return TRUE;
482 }
484 NR::Point const button_w(event->button.x,
485 event->button.y);
486 NR::Point const button_dt(desktop->w2d(button_w));
487 sp_eraser_reset(dc, button_dt);
488 sp_eraser_extinput(dc, event);
489 sp_eraser_apply(dc, button_dt);
490 dc->accumulated->reset();
491 if (dc->repr) {
492 dc->repr = NULL;
493 }
495 Inkscape::Rubberband::get(desktop)->start(desktop, button_dt);
496 Inkscape::Rubberband::get(desktop)->setMode(RUBBERBAND_MODE_TOUCHPATH);
498 /* initialize first point */
499 dc->npoints = 0;
501 sp_canvas_item_grab(SP_CANVAS_ITEM(desktop->acetate),
502 ( GDK_KEY_PRESS_MASK |
503 GDK_BUTTON_RELEASE_MASK |
504 GDK_POINTER_MOTION_MASK |
505 GDK_BUTTON_PRESS_MASK ),
506 NULL,
507 event->button.time);
509 ret = TRUE;
511 sp_canvas_force_full_redraw_after_interruptions(desktop->canvas, 3);
512 dc->is_drawing = true;
513 }
514 break;
515 case GDK_MOTION_NOTIFY:
516 {
517 NR::Point const motion_w(event->motion.x,
518 event->motion.y);
519 NR::Point motion_dt(desktop->w2d(motion_w));
520 sp_eraser_extinput(dc, event);
522 dc->_message_context->clear();
524 if ( dc->is_drawing && (event->motion.state & GDK_BUTTON1_MASK) && !event_context->space_panning) {
525 dc->dragging = TRUE;
527 dc->_message_context->set(Inkscape::NORMAL_MESSAGE, _("<b>Drawing</b> an eraser stroke"));
529 if (!sp_eraser_apply(dc, motion_dt)) {
530 ret = TRUE;
531 break;
532 }
534 if ( dc->cur != dc->last ) {
535 sp_eraser_brush(dc);
536 g_assert( dc->npoints > 0 );
537 fit_and_split(dc, FALSE);
538 }
539 ret = TRUE;
540 }
541 Inkscape::Rubberband::get(desktop)->move(motion_dt);
542 }
543 break;
546 case GDK_BUTTON_RELEASE:
547 {
548 NR::Point const motion_w(event->button.x, event->button.y);
549 NR::Point const motion_dt(desktop->w2d(motion_w));
551 sp_canvas_item_ungrab(SP_CANVAS_ITEM(desktop->acetate), event->button.time);
552 sp_canvas_end_forced_full_redraws(desktop->canvas);
553 dc->is_drawing = false;
555 if (dc->dragging && event->button.button == 1 && !event_context->space_panning) {
556 dc->dragging = FALSE;
558 boost::optional<NR::Rect> const b = Inkscape::Rubberband::get(desktop)->getRectangle();
560 sp_eraser_apply(dc, motion_dt);
562 /* Remove all temporary line segments */
563 while (dc->segments) {
564 gtk_object_destroy(GTK_OBJECT(dc->segments->data));
565 dc->segments = g_slist_remove(dc->segments, dc->segments->data);
566 }
568 /* Create object */
569 fit_and_split(dc, TRUE);
570 accumulate_eraser(dc);
571 set_to_accumulated(dc); // performs document_done
573 /* reset accumulated curve */
574 dc->accumulated->reset();
576 clear_current(dc);
577 if (dc->repr) {
578 dc->repr = NULL;
579 }
581 Inkscape::Rubberband::get(desktop)->stop();
582 dc->_message_context->clear();
583 ret = TRUE;
584 }
585 break;
586 }
588 case GDK_KEY_PRESS:
589 switch (get_group0_keyval (&event->key)) {
590 case GDK_Up:
591 case GDK_KP_Up:
592 if (!MOD__CTRL_ONLY) {
593 dc->angle += 5.0;
594 if (dc->angle > 90.0)
595 dc->angle = 90.0;
596 sp_erc_update_toolbox (desktop, "eraser-angle", dc->angle);
597 ret = TRUE;
598 }
599 break;
600 case GDK_Down:
601 case GDK_KP_Down:
602 if (!MOD__CTRL_ONLY) {
603 dc->angle -= 5.0;
604 if (dc->angle < -90.0)
605 dc->angle = -90.0;
606 sp_erc_update_toolbox (desktop, "eraser-angle", dc->angle);
607 ret = TRUE;
608 }
609 break;
610 case GDK_Right:
611 case GDK_KP_Right:
612 if (!MOD__CTRL_ONLY) {
613 dc->width += 0.01;
614 if (dc->width > 1.0)
615 dc->width = 1.0;
616 sp_erc_update_toolbox (desktop, "altx-eraser", dc->width * 100); // the same spinbutton is for alt+x
617 ret = TRUE;
618 }
619 break;
620 case GDK_Left:
621 case GDK_KP_Left:
622 if (!MOD__CTRL_ONLY) {
623 dc->width -= 0.01;
624 if (dc->width < 0.01)
625 dc->width = 0.01;
626 sp_erc_update_toolbox (desktop, "altx-eraser", dc->width * 100);
627 ret = TRUE;
628 }
629 break;
630 case GDK_Home:
631 case GDK_KP_Home:
632 dc->width = 0.01;
633 sp_erc_update_toolbox (desktop, "altx-eraser", dc->width * 100);
634 ret = TRUE;
635 break;
636 case GDK_End:
637 case GDK_KP_End:
638 dc->width = 1.0;
639 sp_erc_update_toolbox (desktop, "altx-eraser", dc->width * 100);
640 ret = TRUE;
641 break;
642 case GDK_x:
643 case GDK_X:
644 if (MOD__ALT_ONLY) {
645 desktop->setToolboxFocusTo ("altx-eraser");
646 ret = TRUE;
647 }
648 break;
649 case GDK_Escape:
650 Inkscape::Rubberband::get(desktop)->stop();
651 if (dc->is_drawing) {
652 // if drawing, cancel, otherwise pass it up for deselecting
653 eraser_cancel (dc);
654 ret = TRUE;
655 }
656 break;
657 case GDK_z:
658 case GDK_Z:
659 if (MOD__CTRL_ONLY && dc->is_drawing) {
660 // if drawing, cancel, otherwise pass it up for undo
661 eraser_cancel (dc);
662 ret = TRUE;
663 }
664 break;
665 default:
666 break;
667 }
668 break;
670 case GDK_KEY_RELEASE:
671 switch (get_group0_keyval(&event->key)) {
672 case GDK_Control_L:
673 case GDK_Control_R:
674 dc->_message_context->clear();
675 break;
676 default:
677 break;
678 }
680 default:
681 break;
682 }
684 if (!ret) {
685 if (((SPEventContextClass *) eraser_parent_class)->root_handler) {
686 ret = ((SPEventContextClass *) eraser_parent_class)->root_handler(event_context, event);
687 }
688 }
690 return ret;
691 }
694 static void
695 clear_current(SPEraserContext *dc)
696 {
697 // reset bpath
698 sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(dc->currentshape), NULL);
700 // reset curve
701 dc->currentcurve->reset();
702 dc->cal1->reset();
703 dc->cal2->reset();
705 // reset points
706 dc->npoints = 0;
707 }
709 static void
710 set_to_accumulated(SPEraserContext *dc)
711 {
712 SPDesktop *desktop = SP_EVENT_CONTEXT(dc)->desktop;
713 bool workDone = false;
715 if (!dc->accumulated->is_empty()) {
716 if (!dc->repr) {
717 /* Create object */
718 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(desktop->doc());
719 Inkscape::XML::Node *repr = xml_doc->createElement("svg:path");
721 /* Set style */
722 sp_desktop_apply_style_tool (desktop, repr, "tools.eraser", false);
724 dc->repr = repr;
726 SPItem *item=SP_ITEM(desktop->currentLayer()->appendChildRepr(dc->repr));
727 Inkscape::GC::release(dc->repr);
728 item->transform = SP_ITEM(desktop->currentRoot())->getRelativeTransform(desktop->currentLayer());
729 item->updateRepr();
730 }
731 Geom::PathVector pathv = dc->accumulated->get_pathvector() * sp_desktop_dt2root_affine(desktop);
732 gchar *str = sp_svg_write_path(pathv);
733 g_assert( str != NULL );
734 dc->repr->setAttribute("d", str);
735 g_free(str);
737 if ( dc->repr ) {
738 bool wasSelection = false;
739 Inkscape::Selection *selection = sp_desktop_selection(desktop);
740 gint eraserMode = (prefs_get_int_attribute("tools.eraser", "mode", 0) != 0) ? 1 : 0;
741 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(desktop->doc());
743 SPItem* acid = SP_ITEM(desktop->doc()->getObjectByRepr(dc->repr));
744 boost::optional<NR::Rect> eraserBbox = acid->getBounds(NR::identity());
745 NR::Rect bounds = (*eraserBbox) * desktop->doc2dt();
746 std::vector<SPItem*> remainingItems;
747 GSList* toWorkOn = 0;
748 if (selection->isEmpty()) {
749 if ( eraserMode ) {
750 toWorkOn = sp_document_partial_items_in_box(sp_desktop_document(desktop), desktop->dkey, bounds);
751 } else {
752 Inkscape::Rubberband::Rubberband *r = Inkscape::Rubberband::get(desktop);
753 toWorkOn = sp_document_items_at_points(sp_desktop_document(desktop), desktop->dkey, r->getPoints());
754 }
755 toWorkOn = g_slist_remove( toWorkOn, acid );
756 } else {
757 toWorkOn = g_slist_copy(const_cast<GSList*>(selection->itemList()));
758 wasSelection = true;
759 }
761 if ( g_slist_length(toWorkOn) > 0 ) {
762 if ( eraserMode ) {
763 for (GSList *i = toWorkOn ; i ; i = i->next ) {
764 SPItem *item = SP_ITEM(i->data);
765 if ( eraserMode ) {
766 boost::optional<NR::Rect> bbox = item->getBounds(NR::identity());
767 if (bbox && bbox->intersects(*eraserBbox)) {
768 Inkscape::XML::Node* dup = dc->repr->duplicate(xml_doc);
769 dc->repr->parent()->appendChild(dup);
770 Inkscape::GC::release(dup); // parent takes over
772 selection->set(item);
773 selection->add(dup);
774 sp_selected_path_diff_skip_undo(desktop);
775 workDone = true; // TODO set this only if something was cut.
776 if ( !selection->isEmpty() ) {
777 // If the item was not completely erased, track the new remainder.
778 GSList *nowSel = g_slist_copy(const_cast<GSList *>(selection->itemList()));
779 for (GSList const *i2 = nowSel ; i2 ; i2 = i2->next ) {
780 remainingItems.push_back(SP_ITEM(i2->data));
781 }
782 g_slist_free(nowSel);
783 }
784 } else {
785 remainingItems.push_back(item);
786 }
787 }
788 }
789 } else {
790 for (GSList *i = toWorkOn ; i ; i = i->next ) {
791 sp_object_ref( SP_ITEM(i->data), 0 );
792 }
793 for (GSList *i = toWorkOn ; i ; i = i->next ) {
794 SPItem *item = SP_ITEM(i->data);
795 item->deleteObject(true);
796 sp_object_unref(item);
797 workDone = true;
798 }
799 }
801 g_slist_free(toWorkOn);
803 if ( !eraserMode ) {
804 //sp_selection_delete(desktop);
805 remainingItems.clear();
806 }
808 selection->clear();
809 if ( wasSelection ) {
810 if ( !remainingItems.empty() ) {
811 selection->add(remainingItems.begin(), remainingItems.end());
812 }
813 }
814 }
816 // Remove the eraser stroke itself:
817 sp_repr_unparent( dc->repr );
818 dc->repr = 0;
819 }
820 } else {
821 if (dc->repr) {
822 sp_repr_unparent(dc->repr);
823 dc->repr = 0;
824 }
825 }
828 if ( workDone ) {
829 sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_ERASER,
830 _("Draw eraser stroke"));
831 } else {
832 sp_document_cancel(sp_desktop_document(desktop));
833 }
834 }
836 static void
837 add_cap(SPCurve *curve,
838 NR::Point const &pre, NR::Point const &from,
839 NR::Point const &to, NR::Point const &post,
840 double rounding)
841 {
842 NR::Point vel = rounding * NR::rot90( to - from ) / sqrt(2.0);
843 double mag = NR::L2(vel);
845 NR::Point v_in = from - pre;
846 double mag_in = NR::L2(v_in);
847 if ( mag_in > ERASER_EPSILON ) {
848 v_in = mag * v_in / mag_in;
849 } else {
850 v_in = NR::Point(0, 0);
851 }
853 NR::Point v_out = to - post;
854 double mag_out = NR::L2(v_out);
855 if ( mag_out > ERASER_EPSILON ) {
856 v_out = mag * v_out / mag_out;
857 } else {
858 v_out = NR::Point(0, 0);
859 }
861 if ( NR::L2(v_in) > ERASER_EPSILON || NR::L2(v_out) > ERASER_EPSILON ) {
862 curve->curveto(from + v_in, to + v_out, to);
863 }
864 }
866 static void
867 accumulate_eraser(SPEraserContext *dc)
868 {
869 if ( !dc->cal1->is_empty() && !dc->cal2->is_empty() ) {
870 dc->accumulated->reset(); /* Is this required ?? */
871 SPCurve *rev_cal2 = dc->cal2->create_reverse();
873 g_assert(dc->cal1->get_segment_count() > 0);
874 g_assert(rev_cal2->get_segment_count() > 0);
875 g_assert( ! dc->cal1->first_path()->closed() );
876 g_assert( ! rev_cal2->first_path()->closed() );
878 Geom::CubicBezier const * dc_cal1_firstseg = dynamic_cast<Geom::CubicBezier const *>( dc->cal1->first_segment() );
879 Geom::CubicBezier const * rev_cal2_firstseg = dynamic_cast<Geom::CubicBezier const *>( rev_cal2->first_segment() );
880 Geom::CubicBezier const * dc_cal1_lastseg = dynamic_cast<Geom::CubicBezier const *>( dc->cal1->last_segment() );
881 Geom::CubicBezier const * rev_cal2_lastseg = dynamic_cast<Geom::CubicBezier const *>( rev_cal2->last_segment() );
882 g_assert( dc_cal1_firstseg );
883 g_assert( rev_cal2_firstseg );
884 g_assert( dc_cal1_lastseg );
885 g_assert( rev_cal2_lastseg );
887 dc->accumulated->append(dc->cal1, FALSE);
889 add_cap(dc->accumulated, (*dc_cal1_lastseg)[2], (*dc_cal1_lastseg)[3], (*rev_cal2_firstseg)[0], (*rev_cal2_firstseg)[1], dc->cap_rounding);
891 dc->accumulated->append(rev_cal2, TRUE);
893 add_cap(dc->accumulated, (*rev_cal2_lastseg)[2], (*rev_cal2_lastseg)[3], (*dc_cal1_firstseg)[0], (*dc_cal1_firstseg)[1], dc->cap_rounding);
895 dc->accumulated->closepath();
897 rev_cal2->unref();
899 dc->cal1->reset();
900 dc->cal2->reset();
901 }
902 }
904 static double square(double const x)
905 {
906 return x * x;
907 }
909 static void
910 fit_and_split(SPEraserContext *dc, gboolean release)
911 {
912 SPDesktop *desktop = SP_EVENT_CONTEXT(dc)->desktop;
914 double const tolerance_sq = square( NR::expansion(desktop->w2d()) * TOLERANCE_ERASER );
916 #ifdef ERASER_VERBOSE
917 g_print("[F&S:R=%c]", release?'T':'F');
918 #endif
920 if (!( dc->npoints > 0 && dc->npoints < SAMPLING_SIZE ))
921 return; // just clicked
923 if ( dc->npoints == SAMPLING_SIZE - 1 || release ) {
924 #define BEZIER_SIZE 4
925 #define BEZIER_MAX_BEZIERS 8
926 #define BEZIER_MAX_LENGTH ( BEZIER_SIZE * BEZIER_MAX_BEZIERS )
928 #ifdef ERASER_VERBOSE
929 g_print("[F&S:#] dc->npoints:%d, release:%s\n",
930 dc->npoints, release ? "TRUE" : "FALSE");
931 #endif
933 /* Current eraser */
934 if ( dc->cal1->is_empty() || dc->cal2->is_empty() ) {
935 /* dc->npoints > 0 */
936 /* g_print("erasers(1|2) reset\n"); */
937 dc->cal1->reset();
938 dc->cal2->reset();
940 dc->cal1->moveto(dc->point1[0]);
941 dc->cal2->moveto(dc->point2[0]);
942 }
944 NR::Point b1[BEZIER_MAX_LENGTH];
945 gint const nb1 = sp_bezier_fit_cubic_r(b1, dc->point1, dc->npoints,
946 tolerance_sq, BEZIER_MAX_BEZIERS);
947 g_assert( nb1 * BEZIER_SIZE <= gint(G_N_ELEMENTS(b1)) );
949 NR::Point b2[BEZIER_MAX_LENGTH];
950 gint const nb2 = sp_bezier_fit_cubic_r(b2, dc->point2, dc->npoints,
951 tolerance_sq, BEZIER_MAX_BEZIERS);
952 g_assert( nb2 * BEZIER_SIZE <= gint(G_N_ELEMENTS(b2)) );
954 if ( nb1 != -1 && nb2 != -1 ) {
955 /* Fit and draw and reset state */
956 #ifdef ERASER_VERBOSE
957 g_print("nb1:%d nb2:%d\n", nb1, nb2);
958 #endif
959 /* CanvasShape */
960 if (! release) {
961 dc->currentcurve->reset();
962 dc->currentcurve->moveto(b1[0]);
963 for (NR::Point *bp1 = b1; bp1 < b1 + BEZIER_SIZE * nb1; bp1 += BEZIER_SIZE) {
964 dc->currentcurve->curveto(bp1[1],
965 bp1[2], bp1[3]);
966 }
967 dc->currentcurve->lineto(b2[BEZIER_SIZE*(nb2-1) + 3]);
968 for (NR::Point *bp2 = b2 + BEZIER_SIZE * ( nb2 - 1 ); bp2 >= b2; bp2 -= BEZIER_SIZE) {
969 dc->currentcurve->curveto(bp2[2], bp2[1], bp2[0]);
970 }
971 // FIXME: dc->segments is always NULL at this point??
972 if (!dc->segments) { // first segment
973 add_cap(dc->currentcurve, b2[1], b2[0], b1[0], b1[1], dc->cap_rounding);
974 }
975 dc->currentcurve->closepath();
976 sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(dc->currentshape), dc->currentcurve);
977 }
979 /* Current eraser */
980 for (NR::Point *bp1 = b1; bp1 < b1 + BEZIER_SIZE * nb1; bp1 += BEZIER_SIZE) {
981 dc->cal1->curveto(bp1[1], bp1[2], bp1[3]);
982 }
983 for (NR::Point *bp2 = b2; bp2 < b2 + BEZIER_SIZE * nb2; bp2 += BEZIER_SIZE) {
984 dc->cal2->curveto(bp2[1], bp2[2], bp2[3]);
985 }
986 } else {
987 /* fixme: ??? */
988 #ifdef ERASER_VERBOSE
989 g_print("[fit_and_split] failed to fit-cubic.\n");
990 #endif
991 draw_temporary_box(dc);
993 for (gint i = 1; i < dc->npoints; i++) {
994 dc->cal1->lineto(dc->point1[i]);
995 }
996 for (gint i = 1; i < dc->npoints; i++) {
997 dc->cal2->lineto(dc->point2[i]);
998 }
999 }
1001 /* Fit and draw and copy last point */
1002 #ifdef ERASER_VERBOSE
1003 g_print("[%d]Yup\n", dc->npoints);
1004 #endif
1005 if (!release) {
1006 gint eraserMode = (prefs_get_int_attribute("tools.eraser", "mode", 0) != 0) ? 1 : 0;
1007 g_assert(!dc->currentcurve->is_empty());
1009 SPCanvasItem *cbp = sp_canvas_item_new(sp_desktop_sketch(desktop),
1010 SP_TYPE_CANVAS_BPATH,
1011 NULL);
1012 SPCurve *curve = dc->currentcurve->copy();
1013 sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH (cbp), curve);
1014 curve->unref();
1016 guint32 fillColor = sp_desktop_get_color_tool (desktop, "tools.eraser", true);
1017 //guint32 strokeColor = sp_desktop_get_color_tool (desktop, "tools.eraser", false);
1018 double opacity = sp_desktop_get_master_opacity_tool (desktop, "tools.eraser");
1019 double fillOpacity = sp_desktop_get_opacity_tool (desktop, "tools.eraser", true);
1020 //double strokeOpacity = sp_desktop_get_opacity_tool (desktop, "tools.eraser", false);
1021 sp_canvas_bpath_set_fill(SP_CANVAS_BPATH(cbp), ((fillColor & 0xffffff00) | SP_COLOR_F_TO_U(opacity*fillOpacity)), SP_WIND_RULE_EVENODD);
1022 //on second thougtht don't do stroke yet because we don't have stoke-width yet and because stoke appears between segments while drawing
1023 //sp_canvas_bpath_set_stroke(SP_CANVAS_BPATH(cbp), ((strokeColor & 0xffffff00) | SP_COLOR_F_TO_U(opacity*strokeOpacity)), 1.0, SP_STROKE_LINEJOIN_MITER, SP_STROKE_LINECAP_BUTT);
1024 sp_canvas_bpath_set_stroke(SP_CANVAS_BPATH(cbp), 0x00000000, 1.0, SP_STROKE_LINEJOIN_MITER, SP_STROKE_LINECAP_BUTT);
1025 /* fixme: Cannot we cascade it to root more clearly? */
1026 g_signal_connect(G_OBJECT(cbp), "event", G_CALLBACK(sp_desktop_root_handler), desktop);
1028 dc->segments = g_slist_prepend(dc->segments, cbp);
1030 if ( !eraserMode ) {
1031 sp_canvas_item_hide(cbp);
1032 sp_canvas_item_hide(dc->currentshape);
1033 }
1034 }
1036 dc->point1[0] = dc->point1[dc->npoints - 1];
1037 dc->point2[0] = dc->point2[dc->npoints - 1];
1038 dc->npoints = 1;
1039 } else {
1040 draw_temporary_box(dc);
1041 }
1042 }
1044 static void
1045 draw_temporary_box(SPEraserContext *dc)
1046 {
1047 dc->currentcurve->reset();
1049 dc->currentcurve->moveto(dc->point1[dc->npoints-1]);
1050 for (gint i = dc->npoints-2; i >= 0; i--) {
1051 dc->currentcurve->lineto(dc->point1[i]);
1052 }
1053 for (gint i = 0; i < dc->npoints; i++) {
1054 dc->currentcurve->lineto(dc->point2[i]);
1055 }
1056 if (dc->npoints >= 2) {
1057 add_cap(dc->currentcurve, dc->point2[dc->npoints-2], dc->point2[dc->npoints-1], dc->point1[dc->npoints-1], dc->point1[dc->npoints-2], dc->cap_rounding);
1058 }
1060 dc->currentcurve->closepath();
1061 sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(dc->currentshape), dc->currentcurve);
1062 }
1064 /*
1065 Local Variables:
1066 mode:c++
1067 c-file-style:"stroustrup"
1068 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1069 indent-tabs-mode:nil
1070 fill-column:99
1071 End:
1072 */
1073 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :