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;
103 }
105 static void sp_flood_context_class_init(SPFloodContextClass *klass)
106 {
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;
117 }
119 static void sp_flood_context_init(SPFloodContext *flood_context)
120 {
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();
138 }
140 static void sp_flood_context_dispose(GObject *object)
141 {
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);
164 }
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)
179 {
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 }
198 }
200 static void sp_flood_context_setup(SPEventContext *ec)
201 {
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());
224 }
226 inline unsigned char * get_pixel(guchar *px, int x, int y, int width) {
227 return px + (x + y * width) * 4;
228 }
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);
236 }
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;
250 }
252 static void do_trace(GdkPixbuf *px, SPDesktop *desktop, NR::Matrix transform) {
253 SPDocument *document = sp_desktop_document(desktop);
255 Inkscape::Trace::Potrace::PotraceTracingEngine pte;
257 pte.setTraceType(Inkscape::Trace::Potrace::TRACE_BRIGHTNESS);
258 pte.setInvert(false);
260 Glib::RefPtr<Gdk::Pixbuf> pixbuf = Glib::wrap(px, true);
262 std::vector<Inkscape::Trace::TracingEngineResult> results = pte.trace(pixbuf);
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 for (unsigned int i=0 ; i<results.size() ; i++) {
270 Inkscape::Trace::TracingEngineResult result = results[i];
271 totalNodeCount += result.getNodeCount();
273 Inkscape::XML::Node *pathRepr = xml_doc->createElement("svg:path");
274 /* Set style */
275 sp_desktop_apply_style_tool (desktop, pathRepr, "tools.paintbucket", false);
277 NArtBpath *bpath = sp_svg_read_path(result.getPathData().c_str());
278 Path *path = bpath_to_Path(bpath);
279 g_free(bpath);
281 Shape *path_shape = new Shape();
283 path->ConvertWithBackData(0.03);
284 path->Fill(path_shape, 0);
285 delete path;
287 Shape *expanded_path_shape = new Shape();
289 expanded_path_shape->ConvertToShape(path_shape, fill_nonZero);
290 path_shape->MakeOffset(expanded_path_shape, 1.5, join_round, 4);
291 expanded_path_shape->ConvertToShape(path_shape, fill_positive);
293 Path *expanded_path = new Path();
295 expanded_path->Reset();
296 expanded_path_shape->ConvertToForme(expanded_path);
297 expanded_path->ConvertEvenLines(1.0);
298 expanded_path->Simplify(1.0);
300 delete path_shape;
301 delete expanded_path_shape;
303 gchar *str = expanded_path->svg_dump_path();
304 delete expanded_path;
305 pathRepr->setAttribute("d", str);
306 g_free(str);
308 layer_repr->addChild(pathRepr, NULL);
310 SPObject *reprobj = document->getObjectByRepr(pathRepr);
311 if (reprobj) {
312 sp_item_write_transform(SP_ITEM(reprobj), pathRepr, transform, NULL);
314 // premultiply the item transform by the accumulated parent transform in the paste layer
315 NR::Matrix local = sp_item_i2doc_affine(SP_GROUP(desktop->currentLayer()));
316 if (!local.test_identity()) {
317 gchar const *t_str = pathRepr->attribute("transform");
318 NR::Matrix item_t (NR::identity());
319 if (t_str)
320 sp_svg_transform_read(t_str, &item_t);
321 item_t *= local.inverse();
322 // (we're dealing with unattached repr, so we write to its attr instead of using sp_item_set_transform)
323 gchar *affinestr=sp_svg_transform_write(item_t);
324 pathRepr->setAttribute("transform", affinestr);
325 g_free(affinestr);
326 }
328 Inkscape::Selection *selection = sp_desktop_selection(desktop);
329 selection->set(reprobj);
330 pathRepr->setPosition(-1);
331 }
333 Inkscape::GC::release(pathRepr);
334 }
335 }
337 static void sp_flood_do_flood_fill(SPEventContext *event_context, GdkEvent *event) {
338 SPDesktop *desktop = event_context->desktop;
339 SPDocument *document = sp_desktop_document(desktop);
341 /* Create new arena */
342 NRArena *arena = NRArena::create();
343 unsigned dkey = sp_item_display_key_new(1);
345 sp_document_ensure_up_to_date (document);
347 SPItem *document_root = SP_ITEM(SP_DOCUMENT_ROOT(document));
348 NR::Rect bbox = document_root->invokeBbox(NR::identity());
350 if (bbox.isEmpty()) {
351 desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Area is not bounded</b>, cannot fill."));
352 return;
353 }
355 double zoom_scale = desktop->current_zoom();
356 double padding = 1.6;
358 NR::Rect screen = desktop->get_display_area();
360 int width = (int)ceil(screen.extent(NR::X) * zoom_scale * padding);
361 int height = (int)ceil(screen.extent(NR::Y) * zoom_scale * padding);
363 NR::Point origin(screen.min()[NR::X],
364 sp_document_height(document) - screen.extent(NR::Y) - screen.min()[NR::Y]);
366 origin[NR::X] = origin[NR::X] + (screen.extent(NR::X) * ((1 - padding) / 2));
367 origin[NR::Y] = origin[NR::Y] + (screen.extent(NR::Y) * ((1 - padding) / 2));
369 NR::scale scale(zoom_scale, zoom_scale);
370 NR::Matrix affine = scale * NR::translate(-origin * scale);
372 /* Create ArenaItems and set transform */
373 NRArenaItem *root = sp_item_invoke_show(SP_ITEM(sp_document_root(document)), arena, dkey, SP_ITEM_SHOW_DISPLAY);
374 nr_arena_item_set_transform(NR_ARENA_ITEM(root), affine);
376 NRGC gc(NULL);
377 nr_matrix_set_identity(&gc.transform);
379 NRRectL final_bbox;
380 final_bbox.x0 = 0;
381 final_bbox.y0 = 0;//row;
382 final_bbox.x1 = width;
383 final_bbox.y1 = height;//row + num_rows;
385 nr_arena_item_invoke_update(root, &final_bbox, &gc, NR_ARENA_ITEM_STATE_ALL, NR_ARENA_ITEM_STATE_NONE);
387 guchar *px = g_new(guchar, 4 * width * height);
388 memset(px, 0x00, 4 * width * height);
390 NRPixBlock B;
391 nr_pixblock_setup_extern( &B, NR_PIXBLOCK_MODE_R8G8B8A8N,
392 final_bbox.x0, final_bbox.y0, final_bbox.x1, final_bbox.y1,
393 px, 4 * width, FALSE, FALSE );
395 nr_arena_item_invoke_render(NULL, root, &final_bbox, &B, NR_ARENA_ITEM_RENDER_NO_CACHE );
396 nr_pixblock_release(&B);
398 // Hide items
399 sp_item_invoke_hide(SP_ITEM(sp_document_root(document)), dkey);
401 nr_arena_item_unref(root);
402 nr_object_unref((NRObject *) arena);
404 NR::Point pw = NR::Point(event->button.x / zoom_scale, sp_document_height(document) + (event->button.y / zoom_scale)) * affine;
406 pw[NR::X] = (int)MIN(width - 1, MAX(0, pw[NR::X]));
407 pw[NR::Y] = (int)MIN(height - 1, MAX(0, pw[NR::Y]));
409 guchar *trace_px = g_new(guchar, 4 * width * height);
410 memset(trace_px, 0x00, 4 * width * height);
412 std::queue<NR::Point> fill_queue;
413 fill_queue.push(pw);
415 bool aborted = false;
416 int y_limit = height - 1;
418 unsigned char orig_color[4];
419 unsigned char *orig_px = get_pixel(px, (int)pw[NR::X], (int)pw[NR::Y], width);
420 for (int i = 0; i < 4; i++) { orig_color[i] = orig_px[i]; }
422 int tolerance = (255 * prefs_get_int_attribute_limited("tools.paintbucket", "tolerance", 1, 0, 100)) / 100;
424 bool reached_screen_boundary = false;
426 while (!fill_queue.empty() && !aborted) {
427 NR::Point cp = fill_queue.front();
428 fill_queue.pop();
429 unsigned char *s = get_pixel(px, (int)cp[NR::X], (int)cp[NR::Y], width);
431 // same color at this point
432 if (compare_pixels(s, orig_color, tolerance)) {
433 int left = (int)cp[NR::X];
434 int right = (int)cp[NR::X] + 1;
435 int x = (int)cp[NR::X];
436 int y = (int)cp[NR::Y];
438 bool top_fill = true;
439 bool bottom_fill = true;
441 if (y > 0) {
442 top_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, x, y - 1, width, tolerance, top_fill);
443 } else {
444 if (bbox.min()[NR::Y] > screen.min()[NR::Y]) {
445 aborted = true; break;
446 } else {
447 reached_screen_boundary = true;
448 }
449 }
450 if (y < y_limit) {
451 bottom_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, x, y + 1, width, tolerance, bottom_fill);
452 } else {
453 if (bbox.max()[NR::Y] < screen.max()[NR::Y]) {
454 aborted = true; break;
455 } else {
456 reached_screen_boundary = true;
457 }
458 }
460 bool default_top_fill = top_fill;
461 bool default_bottom_fill = bottom_fill;
463 unsigned char *t, *trace_t;
464 bool ok = false;
466 do {
467 ok = false;
468 // go left
469 if (left >= 0) {
470 t = get_pixel(px, left, y, width);
471 if (compare_pixels(t, orig_color, tolerance)) {
472 for (int i = 0; i < 4; i++) { t[i] = 255 - t[i]; }
473 trace_t = get_pixel(trace_px, left, y, width);
474 trace_t[3] = 255;
475 if (y > 0) { top_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, left, y - 1, width, tolerance, top_fill); }
476 if (y < y_limit) { bottom_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, left, y + 1, width, tolerance, bottom_fill); }
477 left--; ok = true;
478 }
479 } else {
480 if (bbox.min()[NR::X] > screen.min()[NR::X]) {
481 aborted = true; break;
482 } else {
483 reached_screen_boundary = true;
484 }
485 }
486 } while (ok);
488 top_fill = default_top_fill;
489 bottom_fill = default_bottom_fill;
491 do {
492 ok = false;
493 // go right
494 if (right < width) {
495 t = get_pixel(px, right, y, width);
496 if (compare_pixels(t, orig_color, tolerance)) {
497 for (int i = 0; i < 4; i++) { t[i] = 255 - t[i]; }
498 trace_t = get_pixel(trace_px, right, y, width);
499 trace_t[3] = 255;
500 if (y > 0) { top_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, right, y - 1, width, tolerance, top_fill); }
501 if (y < y_limit) { bottom_fill = try_add_to_queue(&fill_queue, px, trace_px, orig_color, right, y + 1, width, tolerance, bottom_fill); }
502 right++; ok = true;
503 }
504 } else {
505 if (bbox.max()[NR::X] < screen.max()[NR::X]) {
506 aborted = true; break;
507 } else {
508 reached_screen_boundary = true;
509 }
510 }
511 } while (ok);
512 }
513 }
515 g_free(px);
517 if (aborted) {
518 g_free(trace_px);
519 desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Area is not bounded</b>, cannot fill."));
520 return;
521 }
523 if (reached_screen_boundary) {
524 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."));
525 }
527 GdkPixbuf* pixbuf = gdk_pixbuf_new_from_data(trace_px,
528 GDK_COLORSPACE_RGB,
529 TRUE,
530 8, width, height, width * 4,
531 (GdkPixbufDestroyNotify)g_free,
532 NULL);
534 NR::Matrix inverted_affine = NR::Matrix(affine).inverse();
536 do_trace(pixbuf, desktop, inverted_affine);
538 g_free(trace_px);
540 sp_document_done(document, SP_VERB_CONTEXT_PAINTBUCKET, _("Fill bounded area"));
541 }
543 static gint sp_flood_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
544 {
545 gint ret = FALSE;
547 switch (event->type) {
548 case GDK_BUTTON_PRESS:
549 break;
550 // motion and release are always on root (why?)
551 default:
552 break;
553 }
555 if (((SPEventContextClass *) parent_class)->item_handler) {
556 ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
557 }
559 return ret;
560 }
562 static gint sp_flood_context_root_handler(SPEventContext *event_context, GdkEvent *event)
563 {
564 SPDesktop *desktop = event_context->desktop;
566 gint ret = FALSE;
567 switch (event->type) {
568 case GDK_BUTTON_PRESS:
569 if ( event->button.button == 1 ) {
570 sp_flood_do_flood_fill(event_context, event);
572 ret = TRUE;
573 }
574 break;
575 case GDK_KEY_PRESS:
576 switch (get_group0_keyval (&event->key)) {
577 case GDK_Up:
578 case GDK_Down:
579 case GDK_KP_Up:
580 case GDK_KP_Down:
581 // prevent the zoom field from activation
582 if (!MOD__CTRL_ONLY)
583 ret = TRUE;
584 break;
585 case GDK_Escape:
586 sp_desktop_selection(desktop)->clear();
587 default:
588 break;
589 }
590 break;
591 default:
592 break;
593 }
595 if (!ret) {
596 if (((SPEventContextClass *) parent_class)->root_handler) {
597 ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
598 }
599 }
601 return ret;
602 }
605 static void sp_flood_finish(SPFloodContext *rc)
606 {
607 rc->_message_context->clear();
609 if ( rc->item != NULL ) {
610 SPDesktop * desktop;
612 desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
614 SP_OBJECT(rc->item)->updateRepr();
616 sp_canvas_end_forced_full_redraws(desktop->canvas);
618 sp_desktop_selection(desktop)->set(rc->item);
619 sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_PAINTBUCKET,
620 _("Fill bounded area"));
622 rc->item = NULL;
623 }
624 }
626 /*
627 Local Variables:
628 mode:c++
629 c-file-style:"stroustrup"
630 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
631 indent-tabs-mode:nil
632 fill-column:99
633 End:
634 */
635 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :