Code

Add user-selectable paint bucket path offset size
[inkscape.git] / src / flood-context.cpp
1 #define __SP_FLOOD_CONTEXT_C__
3 /*
4  * Flood fill drawing context
5  *
6  * Author:
7  *   Lauris Kaplinski <lauris@kaplinski.com>
8  *   bulia byak <buliabyak@users.sf.net>
9  *   John Bintz <jcoswell@coswellproductions.org>
10  *
11  * Copyright (C) 2006      Johan Engelen <johan@shouraizou.nl>
12  * Copyright (C) 2000-2005 authors
13  * Copyright (C) 2000-2001 Ximian, Inc.
14  *
15  * Released under GNU GPL, read the file 'COPYING' for more information
16  */
18 #include "config.h"
20 #include <gdk/gdkkeysyms.h>
21 #include <queue>
23 #include "macros.h"
24 #include "display/sp-canvas.h"
25 #include "document.h"
26 #include "sp-namedview.h"
27 #include "sp-object.h"
28 #include "sp-rect.h"
29 #include "selection.h"
30 #include "selection-chemistry.h"
31 #include "desktop-handles.h"
32 #include "snap.h"
33 #include "desktop.h"
34 #include "desktop-style.h"
35 #include "message-stack.h"
36 #include "message-context.h"
37 #include "pixmaps/cursor-paintbucket.xpm"
38 #include "flood-context.h"
39 #include "sp-metrics.h"
40 #include <glibmm/i18n.h>
41 #include "object-edit.h"
42 #include "xml/repr.h"
43 #include "xml/node-event-vector.h"
44 #include "prefs-utils.h"
45 #include "context-fns.h"
47 #include "display/nr-arena-item.h"
48 #include "display/nr-arena.h"
49 #include "display/nr-arena-image.h"
50 #include "display/canvas-arena.h"
51 #include "libnr/nr-pixops.h"
52 #include "libnr/nr-matrix-rotate-ops.h"
53 #include "libnr/nr-matrix-translate-ops.h"
54 #include "libnr/nr-rotate-fns.h"
55 #include "libnr/nr-scale-ops.h"
56 #include "libnr/nr-scale-translate-ops.h"
57 #include "libnr/nr-translate-matrix-ops.h"
58 #include "libnr/nr-translate-scale-ops.h"
59 #include "libnr/nr-matrix-ops.h"
60 #include "sp-item.h"
61 #include "sp-root.h"
62 #include "sp-defs.h"
63 #include "splivarot.h"
64 #include "livarot/Path.h"
65 #include "livarot/Shape.h"
66 #include "libnr/n-art-bpath.h"
67 #include "svg/svg.h"
69 #include "trace/trace.h"
70 #include "trace/potrace/inkscape-potrace.h"
72 static void sp_flood_context_class_init(SPFloodContextClass *klass);
73 static void sp_flood_context_init(SPFloodContext *flood_context);
74 static void sp_flood_context_dispose(GObject *object);
76 static void sp_flood_context_setup(SPEventContext *ec);
78 static gint sp_flood_context_root_handler(SPEventContext *event_context, GdkEvent *event);
79 static gint sp_flood_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event);
81 static void sp_flood_finish(SPFloodContext *rc);
83 static SPEventContextClass *parent_class;
86 GtkType sp_flood_context_get_type()
87 {
88     static GType type = 0;
89     if (!type) {
90         GTypeInfo info = {
91             sizeof(SPFloodContextClass),
92             NULL, NULL,
93             (GClassInitFunc) sp_flood_context_class_init,
94             NULL, NULL,
95             sizeof(SPFloodContext),
96             4,
97             (GInstanceInitFunc) sp_flood_context_init,
98             NULL,    /* value_table */
99         };
100         type = g_type_register_static(SP_TYPE_EVENT_CONTEXT, "SPFloodContext", &info, (GTypeFlags) 0);
101     }
102     return type;
105 static void sp_flood_context_class_init(SPFloodContextClass *klass)
107     GObjectClass *object_class = (GObjectClass *) klass;
108     SPEventContextClass *event_context_class = (SPEventContextClass *) klass;
110     parent_class = (SPEventContextClass *) g_type_class_peek_parent(klass);
112     object_class->dispose = sp_flood_context_dispose;
114     event_context_class->setup = sp_flood_context_setup;
115     event_context_class->root_handler  = sp_flood_context_root_handler;
116     event_context_class->item_handler  = sp_flood_context_item_handler;
119 static void sp_flood_context_init(SPFloodContext *flood_context)
121     SPEventContext *event_context = SP_EVENT_CONTEXT(flood_context);
123     event_context->cursor_shape = cursor_paintbucket_xpm;
124     event_context->hot_x = 11;
125     event_context->hot_y = 30;
126     event_context->xp = 0;
127     event_context->yp = 0;
128     event_context->tolerance = 0;
129     event_context->within_tolerance = false;
130     event_context->item_to_select = NULL;
132     event_context->shape_repr = NULL;
133     event_context->shape_knot_holder = NULL;
135     flood_context->item = NULL;
137     new (&flood_context->sel_changed_connection) sigc::connection();
140 static void sp_flood_context_dispose(GObject *object)
142     SPFloodContext *rc = SP_FLOOD_CONTEXT(object);
143     SPEventContext *ec = SP_EVENT_CONTEXT(object);
145     rc->sel_changed_connection.disconnect();
146     rc->sel_changed_connection.~connection();
148     /* fixme: This is necessary because we do not grab */
149     if (rc->item) {
150         sp_flood_finish(rc);
151     }
153     if (ec->shape_repr) { // remove old listener
154         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
155         Inkscape::GC::release(ec->shape_repr);
156         ec->shape_repr = 0;
157     }
159     if (rc->_message_context) {
160         delete rc->_message_context;
161     }
163     G_OBJECT_CLASS(parent_class)->dispose(object);
166 static Inkscape::XML::NodeEventVector ec_shape_repr_events = {
167     NULL, /* child_added */
168     NULL, /* child_removed */
169     ec_shape_event_attr_changed,
170     NULL, /* content_changed */
171     NULL  /* order_changed */
172 };
174 /**
175 \brief  Callback that processes the "changed" signal on the selection;
176 destroys old and creates new knotholder
177 */
178 void sp_flood_context_selection_changed(Inkscape::Selection *selection, gpointer data)
180     SPFloodContext *rc = SP_FLOOD_CONTEXT(data);
181     SPEventContext *ec = SP_EVENT_CONTEXT(rc);
183     if (ec->shape_repr) { // remove old listener
184         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
185         Inkscape::GC::release(ec->shape_repr);
186         ec->shape_repr = 0;
187     }
189     SPItem *item = selection->singleItem();
190     if (item) {
191         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
192         if (shape_repr) {
193             ec->shape_repr = shape_repr;
194             Inkscape::GC::anchor(shape_repr);
195             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
196         }
197     }
200 static void sp_flood_context_setup(SPEventContext *ec)
202     SPFloodContext *rc = SP_FLOOD_CONTEXT(ec);
204     if (((SPEventContextClass *) parent_class)->setup) {
205         ((SPEventContextClass *) parent_class)->setup(ec);
206     }
208     SPItem *item = sp_desktop_selection(ec->desktop)->singleItem();
209     if (item) {
210         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
211         if (shape_repr) {
212             ec->shape_repr = shape_repr;
213             Inkscape::GC::anchor(shape_repr);
214             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
215         }
216     }
218     rc->sel_changed_connection.disconnect();
219     rc->sel_changed_connection = sp_desktop_selection(ec->desktop)->connectChanged(
220         sigc::bind(sigc::ptr_fun(&sp_flood_context_selection_changed), (gpointer)rc)
221     );
223     rc->_message_context = new Inkscape::MessageContext((ec->desktop)->messageStack());
226 inline unsigned char * get_pixel(guchar *px, int x, int y, int width) {
227   return px + (x + y * width) * 4;
230 static bool compare_pixels(unsigned char *a, unsigned char *b, int tolerance) {
231   int diff = 0;
232   for (int i = 0; i < 4; i++) {
233     diff += (int)abs(a[i] - b[i]);
234   }
235   return ((diff / 4) <= tolerance);
238 static bool try_add_to_queue(std::queue<NR::Point> *fill_queue, guchar *px, guchar *trace_px, unsigned char *orig, int x, int y, int width, int tolerance, bool fill_switch) {
239   unsigned char *t = get_pixel(px, x, y, width);
240   if (compare_pixels(t, orig, tolerance)) {
241     unsigned char *trace_t = get_pixel(trace_px, x, y, width);
242     if (trace_t[3] != 255) {
243       if (fill_switch) {
244         fill_queue->push(NR::Point(x, y));
245       }
246     }
247     return false;
248   }
249   return true;
252 static void do_trace(GdkPixbuf *px, SPDesktop *desktop, NR::Matrix transform) {
253     SPDocument *document = sp_desktop_document(desktop);
254     
255     Inkscape::Trace::Potrace::PotraceTracingEngine pte;
256         
257     pte.setTraceType(Inkscape::Trace::Potrace::TRACE_BRIGHTNESS);
258     pte.setInvert(false);
260     Glib::RefPtr<Gdk::Pixbuf> pixbuf = Glib::wrap(px, true);
261     
262     std::vector<Inkscape::Trace::TracingEngineResult> results = pte.trace(pixbuf);
263     
264     Inkscape::XML::Node *layer_repr = SP_GROUP(desktop->currentLayer())->repr;
265     Inkscape::XML::Document *xml_doc = sp_document_repr_doc(desktop->doc());
267     long totalNodeCount = 0L;
269     double offset = prefs_get_double_attribute_limited("tools.paintbucket", "offset", 1.5, 0.0, 2.0);
271     for (unsigned int i=0 ; i<results.size() ; i++) {
272         Inkscape::Trace::TracingEngineResult result = results[i];
273         totalNodeCount += result.getNodeCount();
275         Inkscape::XML::Node *pathRepr = xml_doc->createElement("svg:path");
276         /* Set style */
277         sp_desktop_apply_style_tool (desktop, pathRepr, "tools.paintbucket", false);
279         NArtBpath *bpath = sp_svg_read_path(result.getPathData().c_str());
280         Path *path = bpath_to_Path(bpath);
281         g_free(bpath);
282         
283         Shape *path_shape = new Shape();
284         
285         path->ConvertWithBackData(0.03);
286         path->Fill(path_shape, 0);
287         delete path;
288         
289         Shape *expanded_path_shape = new Shape();
290         
291         expanded_path_shape->ConvertToShape(path_shape, fill_nonZero);
292         path_shape->MakeOffset(expanded_path_shape, offset, join_round, 4);
293         expanded_path_shape->ConvertToShape(path_shape, fill_positive);
295         Path *expanded_path = new Path();
296         
297         expanded_path->Reset();
298         expanded_path_shape->ConvertToForme(expanded_path);
299         expanded_path->ConvertEvenLines(1.0);
300         expanded_path->Simplify(1.0);
301         
302         delete path_shape;
303         delete expanded_path_shape;
304         
305         gchar *str = expanded_path->svg_dump_path();
306         delete expanded_path;
307         pathRepr->setAttribute("d", str);
308         g_free(str);
310         layer_repr->addChild(pathRepr, NULL);
312         SPObject *reprobj = document->getObjectByRepr(pathRepr);
313         if (reprobj) {
314             sp_item_write_transform(SP_ITEM(reprobj), pathRepr, transform, NULL);
315             
316             // premultiply the item transform by the accumulated parent transform in the paste layer
317             NR::Matrix local = sp_item_i2doc_affine(SP_GROUP(desktop->currentLayer()));
318             if (!local.test_identity()) {
319                 gchar const *t_str = pathRepr->attribute("transform");
320                 NR::Matrix item_t (NR::identity());
321                 if (t_str)
322                     sp_svg_transform_read(t_str, &item_t);
323                 item_t *= local.inverse();
324                 // (we're dealing with unattached repr, so we write to its attr instead of using sp_item_set_transform)
325                 gchar *affinestr=sp_svg_transform_write(item_t);
326                 pathRepr->setAttribute("transform", affinestr);
327                 g_free(affinestr);
328             }
330             Inkscape::Selection *selection = sp_desktop_selection(desktop);
331             selection->set(reprobj);
332             pathRepr->setPosition(-1);
333         }
334         
335         Inkscape::GC::release(pathRepr);
336     }
339 static void sp_flood_do_flood_fill(SPEventContext *event_context, GdkEvent *event) {
340     SPDesktop *desktop = event_context->desktop;
341     SPDocument *document = sp_desktop_document(desktop);
343     /* Create new arena */
344     NRArena *arena = NRArena::create();
345     unsigned dkey = sp_item_display_key_new(1);
347     sp_document_ensure_up_to_date (document);
348     
349     SPItem *document_root = SP_ITEM(SP_DOCUMENT_ROOT(document));
350     NR::Rect bbox = document_root->invokeBbox(NR::identity());
352     if (bbox.isEmpty()) { 
353       desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Area is not bounded</b>, cannot fill."));
354       return;
355     }
356     
357     double zoom_scale = desktop->current_zoom();
358     double padding = 1.6;
360     NR::Rect screen = desktop->get_display_area();
362     int width = (int)ceil(screen.extent(NR::X) * zoom_scale * padding);
363     int height = (int)ceil(screen.extent(NR::Y) * zoom_scale * padding);
365     NR::Point origin(screen.min()[NR::X],
366                      sp_document_height(document) - screen.extent(NR::Y) - screen.min()[NR::Y]);
367                      
368     origin[NR::X] = origin[NR::X] + (screen.extent(NR::X) * ((1 - padding) / 2));
369     origin[NR::Y] = origin[NR::Y] + (screen.extent(NR::Y) * ((1 - padding) / 2));
370     
371     NR::scale scale(zoom_scale, zoom_scale);
372     NR::Matrix affine = scale * NR::translate(-origin * scale);
373     
374     /* Create ArenaItems and set transform */
375     NRArenaItem *root = sp_item_invoke_show(SP_ITEM(sp_document_root(document)), arena, dkey, SP_ITEM_SHOW_DISPLAY);
376     nr_arena_item_set_transform(NR_ARENA_ITEM(root), affine);
378     NRGC gc(NULL);
379     nr_matrix_set_identity(&gc.transform);
380     
381     NRRectL final_bbox;
382     final_bbox.x0 = 0;
383     final_bbox.y0 = 0;//row;
384     final_bbox.x1 = width;
385     final_bbox.y1 = height;//row + num_rows;
386     
387     nr_arena_item_invoke_update(root, &final_bbox, &gc, NR_ARENA_ITEM_STATE_ALL, NR_ARENA_ITEM_STATE_NONE);
389     guchar *px = g_new(guchar, 4 * width * height);
390     memset(px, 0x00, 4 * width * height);
392     NRPixBlock B;
393     nr_pixblock_setup_extern( &B, NR_PIXBLOCK_MODE_R8G8B8A8N,
394                               final_bbox.x0, final_bbox.y0, final_bbox.x1, final_bbox.y1,
395                               px, 4 * width, FALSE, FALSE );
396     
397     nr_arena_item_invoke_render(NULL, root, &final_bbox, &B, NR_ARENA_ITEM_RENDER_NO_CACHE );
398     nr_pixblock_release(&B);
399     
400     // Hide items
401     sp_item_invoke_hide(SP_ITEM(sp_document_root(document)), dkey);
402     
403     nr_arena_item_unref(root);
404     nr_object_unref((NRObject *) arena);
405     
406     NR::Point pw = NR::Point(event->button.x / zoom_scale, sp_document_height(document) + (event->button.y / zoom_scale)) * affine;
407     
408     pw[NR::X] = (int)MIN(width - 1, MAX(0, pw[NR::X]));
409     pw[NR::Y] = (int)MIN(height - 1, MAX(0, pw[NR::Y]));
411     guchar *trace_px = g_new(guchar, 4 * width * height);
412     memset(trace_px, 0x00, 4 * width * height);
413     
414     std::queue<NR::Point> fill_queue;
415     fill_queue.push(pw);
416     
417     bool aborted = false;
418     int y_limit = height - 1;
419     
420     unsigned char orig_color[4];
421     unsigned char *orig_px = get_pixel(px, (int)pw[NR::X], (int)pw[NR::Y], width);
422     for (int i = 0; i < 4; i++) { orig_color[i] = orig_px[i]; }
424     int tolerance = (255 * prefs_get_int_attribute_limited("tools.paintbucket", "tolerance", 1, 0, 100)) / 100;
426     bool reached_screen_boundary = false;
428     while (!fill_queue.empty() && !aborted) {
429       NR::Point cp = fill_queue.front();
430       fill_queue.pop();
431       unsigned char *s = get_pixel(px, (int)cp[NR::X], (int)cp[NR::Y], width);
432       
433       // same color at this point
434       if (compare_pixels(s, orig_color, tolerance)) {
435         int left = (int)cp[NR::X];
436         int right = (int)cp[NR::X] + 1;
437         int x = (int)cp[NR::X];
438         int y = (int)cp[NR::Y];
439         
440         bool top_fill = true;
441         bool bottom_fill = true;
442         
443         if (y > 0) { 
444           top_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, x, y - 1, width, tolerance, top_fill);
445         } else {
446           if (bbox.min()[NR::Y] > screen.min()[NR::Y]) {
447             aborted = true; break;
448           } else {
449             reached_screen_boundary = true;
450           }
451         }
452         if (y < y_limit) { 
453           bottom_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, x, y + 1, width, tolerance, bottom_fill);
454         } else {
455           if (bbox.max()[NR::Y] < screen.max()[NR::Y]) {
456             aborted = true; break;
457           } else {
458             reached_screen_boundary = true;
459           }
460         }
461         
462         bool default_top_fill = top_fill;
463         bool default_bottom_fill = bottom_fill;
464         
465         unsigned char *t, *trace_t;
466         bool ok = false;
467         
468         do {
469           ok = false;
470           // go left
471           if (left >= 0) {
472             t = get_pixel(px, left, y, width);
473             if (compare_pixels(t, orig_color, tolerance)) {
474               for (int i = 0; i < 4; i++) { t[i] = 255 - t[i]; }
475               trace_t = get_pixel(trace_px, left, y, width);
476               trace_t[3] = 255; 
477               if (y > 0) { top_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, left, y - 1, width, tolerance, top_fill); }
478               if (y < y_limit) { bottom_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, left, y + 1, width, tolerance, bottom_fill); }
479               left--; ok = true;
480             }
481           } else {
482             if (bbox.min()[NR::X] > screen.min()[NR::X]) {
483               aborted = true; break;
484             } else {
485               reached_screen_boundary = true;
486             }
487           }
488         } while (ok);
489       
490         top_fill = default_top_fill;
491         bottom_fill = default_bottom_fill;
492         
493         do {
494           ok = false;
495           // go right
496           if (right < width) {
497             t = get_pixel(px, right, y, width);
498             if (compare_pixels(t, orig_color, tolerance)) {
499               for (int i = 0; i < 4; i++) { t[i] = 255 - t[i]; }
500               trace_t = get_pixel(trace_px, right, y, width);
501               trace_t[3] = 255;
502               if (y > 0) { top_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, right, y - 1, width, tolerance, top_fill); }
503               if (y < y_limit) { bottom_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, right, y + 1, width, tolerance, bottom_fill); }
504               right++; ok = true;
505             }
506           } else {
507             if (bbox.max()[NR::X] < screen.max()[NR::X]) {
508               aborted = true; break;
509             } else {
510               reached_screen_boundary = true;
511             }
512           }
513         } while (ok);
514       }
515     }
516     
517     g_free(px);
518     
519     if (aborted) {
520       g_free(trace_px);
521       desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Area is not bounded</b>, cannot fill."));
522       return;
523     }
524     
525     if (reached_screen_boundary) {
526       desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Only the visible part of the bounded area was filled.</b> If you want to fill all of the area, undo, zoom out, and fill again.")); 
527     }
528     
529     GdkPixbuf* pixbuf = gdk_pixbuf_new_from_data(trace_px,
530                                       GDK_COLORSPACE_RGB,
531                                       TRUE,
532                                       8, width, height, width * 4,
533                                       (GdkPixbufDestroyNotify)g_free,
534                                       NULL);
536     NR::Matrix inverted_affine = NR::Matrix(affine).inverse();
537     
538     do_trace(pixbuf, desktop, inverted_affine);
540     g_free(trace_px);
541     
542     sp_document_done(document, SP_VERB_CONTEXT_PAINTBUCKET, _("Fill bounded area"));
545 static gint sp_flood_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
547     gint ret = FALSE;
549     switch (event->type) {
550     case GDK_BUTTON_PRESS:
551         break;
552         // motion and release are always on root (why?)
553     default:
554         break;
555     }
557     if (((SPEventContextClass *) parent_class)->item_handler) {
558         ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
559     }
561     return ret;
564 static gint sp_flood_context_root_handler(SPEventContext *event_context, GdkEvent *event)
566     SPDesktop *desktop = event_context->desktop;
568     gint ret = FALSE;
569     switch (event->type) {
570     case GDK_BUTTON_PRESS:
571         if ( event->button.button == 1 ) {
572             sp_flood_do_flood_fill(event_context, event);
574             ret = TRUE;
575         }
576         break;
577     case GDK_KEY_PRESS:
578         switch (get_group0_keyval (&event->key)) {
579         case GDK_Up:
580         case GDK_Down:
581         case GDK_KP_Up:
582         case GDK_KP_Down:
583             // prevent the zoom field from activation
584             if (!MOD__CTRL_ONLY)
585                 ret = TRUE;
586             break;
587         case GDK_Escape:
588             sp_desktop_selection(desktop)->clear();
589         default:
590             break;
591         }
592         break;
593     default:
594         break;
595     }
597     if (!ret) {
598         if (((SPEventContextClass *) parent_class)->root_handler) {
599             ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
600         }
601     }
603     return ret;
607 static void sp_flood_finish(SPFloodContext *rc)
609     rc->_message_context->clear();
611     if ( rc->item != NULL ) {
612         SPDesktop * desktop;
614         desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
616         SP_OBJECT(rc->item)->updateRepr();
618         sp_canvas_end_forced_full_redraws(desktop->canvas);
620         sp_desktop_selection(desktop)->set(rc->item);
621         sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_PAINTBUCKET,
622                          _("Fill bounded area"));
624         rc->item = NULL;
625     }
628 /*
629   Local Variables:
630   mode:c++
631   c-file-style:"stroustrup"
632   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
633   indent-tabs-mode:nil
634   fill-column:99
635   End:
636 */
637 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :