Code

warn if unable to fill an unbounded area
[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-rect.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 "helper/png-write.h"
52 #include "libnr/nr-pixops.h"
53 #include "libnr/nr-matrix-rotate-ops.h"
54 #include "libnr/nr-matrix-translate-ops.h"
55 #include "libnr/nr-rotate-fns.h"
56 #include "libnr/nr-scale-ops.h"
57 #include "libnr/nr-scale-translate-ops.h"
58 #include "libnr/nr-translate-matrix-ops.h"
59 #include "libnr/nr-translate-scale-ops.h"
60 #include "libnr/nr-matrix-ops.h"
61 #include "sp-item.h"
62 #include "sp-root.h"
63 #include "sp-defs.h"
64 #include "splivarot.h"
65 #include "livarot/Path.h"
66 #include "livarot/Shape.h"
67 #include "libnr/n-art-bpath.h"
68 #include "svg/svg.h"
70 #include "trace/trace.h"
71 #include "trace/potrace/inkscape-potrace.h"
73 static void sp_flood_context_class_init(SPFloodContextClass *klass);
74 static void sp_flood_context_init(SPFloodContext *flood_context);
75 static void sp_flood_context_dispose(GObject *object);
77 static void sp_flood_context_setup(SPEventContext *ec);
79 static gint sp_flood_context_root_handler(SPEventContext *event_context, GdkEvent *event);
80 static gint sp_flood_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event);
82 static void sp_flood_finish(SPFloodContext *rc);
84 static SPEventContextClass *parent_class;
87 struct SPEBP {
88     int width, height, sheight;
89     guchar r, g, b, a;
90     NRArenaItem *root; // the root arena item to show; it is assumed that all unneeded items are hidden
91     guchar *px;
92     unsigned (*status)(float, void *);
93     void *data;
94 };
96 GtkType sp_flood_context_get_type()
97 {
98     static GType type = 0;
99     if (!type) {
100         GTypeInfo info = {
101             sizeof(SPFloodContextClass),
102             NULL, NULL,
103             (GClassInitFunc) sp_flood_context_class_init,
104             NULL, NULL,
105             sizeof(SPFloodContext),
106             4,
107             (GInstanceInitFunc) sp_flood_context_init,
108             NULL,    /* value_table */
109         };
110         type = g_type_register_static(SP_TYPE_EVENT_CONTEXT, "SPFloodContext", &info, (GTypeFlags) 0);
111     }
112     return type;
115 static void sp_flood_context_class_init(SPFloodContextClass *klass)
117     GObjectClass *object_class = (GObjectClass *) klass;
118     SPEventContextClass *event_context_class = (SPEventContextClass *) klass;
120     parent_class = (SPEventContextClass *) g_type_class_peek_parent(klass);
122     object_class->dispose = sp_flood_context_dispose;
124     event_context_class->setup = sp_flood_context_setup;
125     event_context_class->root_handler  = sp_flood_context_root_handler;
126     event_context_class->item_handler  = sp_flood_context_item_handler;
129 static void sp_flood_context_init(SPFloodContext *flood_context)
131     SPEventContext *event_context = SP_EVENT_CONTEXT(flood_context);
133     event_context->cursor_shape = cursor_rect_xpm;
134     event_context->hot_x = 4;
135     event_context->hot_y = 4;
136     event_context->xp = 0;
137     event_context->yp = 0;
138     event_context->tolerance = 0;
139     event_context->within_tolerance = false;
140     event_context->item_to_select = NULL;
142     event_context->shape_repr = NULL;
143     event_context->shape_knot_holder = NULL;
145     flood_context->item = NULL;
147     new (&flood_context->sel_changed_connection) sigc::connection();
150 static void sp_flood_context_dispose(GObject *object)
152     SPFloodContext *rc = SP_FLOOD_CONTEXT(object);
153     SPEventContext *ec = SP_EVENT_CONTEXT(object);
155     rc->sel_changed_connection.disconnect();
156     rc->sel_changed_connection.~connection();
158     /* fixme: This is necessary because we do not grab */
159     if (rc->item) {
160         sp_flood_finish(rc);
161     }
163     if (ec->shape_repr) { // remove old listener
164         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
165         Inkscape::GC::release(ec->shape_repr);
166         ec->shape_repr = 0;
167     }
169     if (rc->_message_context) {
170         delete rc->_message_context;
171     }
173     G_OBJECT_CLASS(parent_class)->dispose(object);
176 static Inkscape::XML::NodeEventVector ec_shape_repr_events = {
177     NULL, /* child_added */
178     NULL, /* child_removed */
179     ec_shape_event_attr_changed,
180     NULL, /* content_changed */
181     NULL  /* order_changed */
182 };
184 /**
185 \brief  Callback that processes the "changed" signal on the selection;
186 destroys old and creates new knotholder
187 */
188 void sp_flood_context_selection_changed(Inkscape::Selection *selection, gpointer data)
190     SPFloodContext *rc = SP_FLOOD_CONTEXT(data);
191     SPEventContext *ec = SP_EVENT_CONTEXT(rc);
193     if (ec->shape_repr) { // remove old listener
194         sp_repr_remove_listener_by_data(ec->shape_repr, ec);
195         Inkscape::GC::release(ec->shape_repr);
196         ec->shape_repr = 0;
197     }
199     SPItem *item = selection->singleItem();
200     if (item) {
201         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
202         if (shape_repr) {
203             ec->shape_repr = shape_repr;
204             Inkscape::GC::anchor(shape_repr);
205             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
206         }
207     }
210 static void sp_flood_context_setup(SPEventContext *ec)
212     SPFloodContext *rc = SP_FLOOD_CONTEXT(ec);
214     if (((SPEventContextClass *) parent_class)->setup) {
215         ((SPEventContextClass *) parent_class)->setup(ec);
216     }
218     SPItem *item = sp_desktop_selection(ec->desktop)->singleItem();
219     if (item) {
220         Inkscape::XML::Node *shape_repr = SP_OBJECT_REPR(item);
221         if (shape_repr) {
222             ec->shape_repr = shape_repr;
223             Inkscape::GC::anchor(shape_repr);
224             sp_repr_add_listener(shape_repr, &ec_shape_repr_events, ec);
225         }
226     }
228     rc->sel_changed_connection.disconnect();
229     rc->sel_changed_connection = sp_desktop_selection(ec->desktop)->connectChanged(
230         sigc::bind(sigc::ptr_fun(&sp_flood_context_selection_changed), (gpointer)rc)
231     );
233     rc->_message_context = new Inkscape::MessageContext((ec->desktop)->messageStack());
236 /**
237 Hide all items which are not listed in list, recursively, skipping groups and defs
238 */
239 static void
240 hide_other_items_recursively(SPObject *o, GSList *list, unsigned dkey)
242     if (SP_IS_ITEM(o)
243         && !SP_IS_DEFS(o)
244         && !SP_IS_ROOT(o)
245         && !SP_IS_GROUP(o)
246         && !g_slist_find(list, o))
247     {
248         sp_item_invoke_hide(SP_ITEM(o), dkey);
249     }
251      // recurse
252     if (!g_slist_find(list, o)) {
253         for (SPObject *child = sp_object_first_child(o) ; child != NULL; child = SP_OBJECT_NEXT(child) ) {
254             hide_other_items_recursively(child, list, dkey);
255         }
256     }
259 inline unsigned char * get_pixel(guchar *px, int x, int y, int width) {
260   return px + (x + y * width) * 4;
263 static bool compare_pixels(unsigned char *a, unsigned char *b, int fuzziness) {
264   for (int i = 0; i < 4; i++) {
265     if (a[i] != b[i]) { 
266       return false;
267     }
268   }
269   return true;
272 static void try_add_to_queue(std::queue<NR::Point> *fill_queue, guchar *px, unsigned char *orig, int x, int y, int width) {
273   unsigned char *t = get_pixel(px, x, y, width);
274   if (compare_pixels(t, orig, 0)) {
275     fill_queue->push(NR::Point(x, y));
276   }
279 static void do_trace(GdkPixbuf *px, SPDesktop *desktop, NR::Matrix transform) {
280     SPDocument *document = sp_desktop_document(desktop);
281     
282     Inkscape::Trace::Potrace::PotraceTracingEngine pte;
283         
284     pte.setTraceType(Inkscape::Trace::Potrace::TRACE_BRIGHTNESS);
285     pte.setInvert(false);
287     Glib::RefPtr<Gdk::Pixbuf> pixbuf = Glib::wrap(px, true);
288     
289     std::vector<Inkscape::Trace::TracingEngineResult> results = pte.trace(pixbuf);
290     
291     Inkscape::XML::Node *layer_repr = SP_GROUP(desktop->currentLayer())->repr;
292     Inkscape::XML::Document *xml_doc = sp_document_repr_doc(desktop->doc());
294     long totalNodeCount = 0L;
296     for (unsigned int i=0 ; i<results.size() ; i++) {
297         Inkscape::Trace::TracingEngineResult result = results[i];
298         totalNodeCount += result.getNodeCount();
300         Inkscape::XML::Node *pathRepr = xml_doc->createElement("svg:path");
301         /* Set style */
302         sp_desktop_apply_style_tool (desktop, pathRepr, "tools.paintbucket", false);
304         NArtBpath *bpath = sp_svg_read_path(result.getPathData().c_str());
305         Path *path = bpath_to_Path(bpath);
306         g_free(bpath);
307         
308         Shape *path_shape = new Shape();
309         
310         path->ConvertWithBackData(0.03);
311         path->Fill(path_shape, 0);
312         delete path;
313         
314         Shape *expanded_path_shape = new Shape();
315         
316         expanded_path_shape->ConvertToShape(path_shape, fill_nonZero);
317         path_shape->MakeOffset(expanded_path_shape, 1.5, join_round, 4);
318         expanded_path_shape->ConvertToShape(path_shape, fill_positive);
320         Path *expanded_path = new Path();
321         
322         expanded_path->Reset();
323         expanded_path_shape->ConvertToForme(expanded_path);
324         expanded_path->ConvertEvenLines(1.0);
325         expanded_path->Simplify(1.0);
326         
327         delete path_shape;
328         delete expanded_path_shape;
329         
330         gchar *str = expanded_path->svg_dump_path();
331         delete expanded_path;
332         pathRepr->setAttribute("d", str);
333         g_free(str);
334         
335         layer_repr->addChild(pathRepr, NULL);
337         SPObject *reprobj = document->getObjectByRepr(pathRepr);
338         if (reprobj) {
339             sp_item_write_transform(SP_ITEM(reprobj), pathRepr, transform, NULL);
340             Inkscape::Selection *selection = sp_desktop_selection(desktop);
341             selection->set(reprobj);
342             pathRepr->setPosition(-1);
343         }
344         
345         Inkscape::GC::release(pathRepr);
346     }
349 static void sp_flood_do_flood_fill(SPEventContext *event_context, GdkEvent *event) {
350     SPDesktop *desktop = event_context->desktop;
351     SPDocument *document = sp_desktop_document(desktop);
353     /* Create new arena */
354     NRArena *arena = NRArena::create();
355     unsigned dkey = sp_item_display_key_new(1);
357     sp_document_ensure_up_to_date (document);
358     
359     SPItem *document_root = SP_ITEM(SP_DOCUMENT_ROOT(document));
360     NR::Rect bbox = document_root->invokeBbox(NR::identity());
362     if (bbox.isEmpty()) { 
363       desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Area is not bounded</b>, cannot fill."));
364       return;
365     }
367     int width = (int)ceil(bbox.extent(NR::X));
368     int height = (int)ceil(bbox.extent(NR::Y));
370     NR::Point origin(bbox.min()[NR::X], bbox.min()[NR::Y]);
371     
372     NR::scale scale(width / (bbox.extent(NR::X)), height / (bbox.extent(NR::Y)));
373     NR::Matrix affine = scale * NR::translate(-origin * scale);
374     
375     /* Create ArenaItems and set transform */
376     NRArenaItem *root = sp_item_invoke_show(SP_ITEM(sp_document_root(document)), arena, dkey, SP_ITEM_SHOW_DISPLAY);
377     nr_arena_item_set_transform(NR_ARENA_ITEM(root), affine);
379     NRGC gc(NULL);
380     nr_matrix_set_identity(&gc.transform);
381     
382     NRRectL final_bbox;
383     final_bbox.x0 = 0;
384     final_bbox.y0 = 0;//row;
385     final_bbox.x1 = width;
386     final_bbox.y1 = height;//row + num_rows;
387     
388     nr_arena_item_invoke_update(root, &final_bbox, &gc, NR_ARENA_ITEM_STATE_ALL, NR_ARENA_ITEM_STATE_NONE);
390     guchar *px = g_new(guchar, 4 * width * height);
391     memset(px, 0x00, 4 * width * height);
393     NRPixBlock B;
394     nr_pixblock_setup_extern( &B, NR_PIXBLOCK_MODE_R8G8B8A8N,
395                               final_bbox.x0, final_bbox.y0, final_bbox.x1, final_bbox.y1,
396                               px, 4 * width, FALSE, FALSE );
397     
398     nr_arena_item_invoke_render( root, &final_bbox, &B, NR_ARENA_ITEM_RENDER_NO_CACHE );
399     nr_pixblock_release(&B);
400     
401     // Hide items
402     sp_item_invoke_hide(SP_ITEM(sp_document_root(document)), dkey);
403     
404     nr_arena_item_unref(root);
405     nr_object_unref((NRObject *) arena);
406     
407     double zoom_scale = desktop->current_zoom();
409     NR::Point pw = NR::Point(event->button.x / zoom_scale, sp_document_height(document) + (event->button.y / zoom_scale)) * affine;
410     
411     pw[NR::X] = (int)MIN(width - 1, MAX(0, pw[NR::X]));
412     pw[NR::Y] = (int)MIN(height - 1, MAX(0, pw[NR::Y]));
414     guchar *trace_px = g_new(guchar, 4 * width * height);
415     memset(trace_px, 0x00, 4 * width * height);
416     
417     std::queue<NR::Point> fill_queue;
418     fill_queue.push(pw);
419     
420     bool aborted = false;
421     int y_limit = height - 1;
422     
423     unsigned char orig_color[4];
424     unsigned char *orig_px = get_pixel(px, (int)pw[NR::X], (int)pw[NR::Y], width);
425     for (int i = 0; i < 4; i++) { orig_color[i] = orig_px[i]; }
427     while (!fill_queue.empty() && !aborted) {
428       NR::Point cp = fill_queue.front();
429       fill_queue.pop();
430       unsigned char *s = get_pixel(px, (int)cp[NR::X], (int)cp[NR::Y], width);
431       
432       // same color at this point
433       if (compare_pixels(s, orig_color, 0)) {
434         int left = (int)cp[NR::X];
435         int right = (int)cp[NR::X] + 1;
436         int x = (int)cp[NR::X];
437         int y = (int)cp[NR::Y];
438         
439         if (y > 0) { 
440           try_add_to_queue(&fill_queue, px, orig_color, x, y - 1, width);
441         } else {
442           aborted = true; break;
443         }
444         if (y < y_limit) { 
445           try_add_to_queue(&fill_queue, px, orig_color, x, y + 1, width);
446         } else {
447           aborted = true; break;
448         }
449         
450         unsigned char *t, *trace_t;
451         bool ok = false;
452         
453         do {
454           ok = false;
455           // go left
456           if (left >= 0) {
457             t = get_pixel(px, left, y, width);
458             if (compare_pixels(t, orig_color, 0)) {
459               for (int i = 0; i < 4; i++) { t[i] = 255 - t[i]; }
460               trace_t = get_pixel(trace_px, left, y, width);
461               trace_t[3] = 255;
462               if (y > 0) { try_add_to_queue(&fill_queue, px, orig_color, left, y - 1, width); }
463               if (y < y_limit) { try_add_to_queue(&fill_queue, px, orig_color, left, y + 1, width); }
464               left--; ok = true;
465             }
466           } else {
467             aborted = true; break;
468           }
469         } while (ok);
470       
471         do {
472           ok = false;
473           // go left
474           if (right < width) {
475             t = get_pixel(px, right, y, width);
476             if (compare_pixels(t, orig_color, 0)) {
477               for (int i = 0; i < 4; i++) { t[i] = 255 - t[i]; }
478               trace_t = get_pixel(trace_px, right, y, width);
479               trace_t[3] = 255; 
480               if (y > 0) { try_add_to_queue(&fill_queue, px, orig_color, right, y - 1, width); }
481               if (y < y_limit) { try_add_to_queue(&fill_queue, px, orig_color, right, y + 1, width); }
482               right++; ok = true;
483             }
484           } else {
485             aborted = true; break;
486           }
487         } while (ok);
488       }
489     }
490     
491     g_free(px);
492     
493     if (aborted) {
494       g_free(trace_px);
495       desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("<b>Area is not bounded</b>, cannot fill."));
496       return;
497     }
498     
499     GdkPixbuf* pixbuf = gdk_pixbuf_new_from_data(trace_px,
500                                       GDK_COLORSPACE_RGB,
501                                       TRUE,
502                                       8, width, height, width * 4,
503                                       (GdkPixbufDestroyNotify)g_free,
504                                       NULL);
506     NR::Matrix inverted_affine = NR::Matrix(affine).inverse();
507     
508     do_trace(pixbuf, desktop, inverted_affine);
510     g_free(trace_px);
511     
512     sp_document_done(document, SP_VERB_CONTEXT_PAINTBUCKET, _("Fill bounded area"));
515 static gint sp_flood_context_item_handler(SPEventContext *event_context, SPItem *item, GdkEvent *event)
517     gint ret = FALSE;
519     switch (event->type) {
520     case GDK_BUTTON_PRESS:
521         break;
522         // motion and release are always on root (why?)
523     default:
524         break;
525     }
527     if (((SPEventContextClass *) parent_class)->item_handler) {
528         ret = ((SPEventContextClass *) parent_class)->item_handler(event_context, item, event);
529     }
531     return ret;
534 static gint sp_flood_context_root_handler(SPEventContext *event_context, GdkEvent *event)
536     SPDesktop *desktop = event_context->desktop;
538     gint ret = FALSE;
539     switch (event->type) {
540     case GDK_BUTTON_PRESS:
541         if ( event->button.button == 1 ) {
542             sp_flood_do_flood_fill(event_context, event);
544             ret = TRUE;
545         }
546         break;
547     case GDK_KEY_PRESS:
548         switch (get_group0_keyval (&event->key)) {
549         case GDK_Up:
550         case GDK_Down:
551         case GDK_KP_Up:
552         case GDK_KP_Down:
553             // prevent the zoom field from activation
554             if (!MOD__CTRL_ONLY)
555                 ret = TRUE;
556             break;
557         case GDK_Escape:
558             sp_desktop_selection(desktop)->clear();
559         default:
560             break;
561         }
562         break;
563     default:
564         break;
565     }
567     if (!ret) {
568         if (((SPEventContextClass *) parent_class)->root_handler) {
569             ret = ((SPEventContextClass *) parent_class)->root_handler(event_context, event);
570         }
571     }
573     return ret;
577 static void sp_flood_finish(SPFloodContext *rc)
579     rc->_message_context->clear();
581     if ( rc->item != NULL ) {
582         SPDesktop * desktop;
584         desktop = SP_EVENT_CONTEXT_DESKTOP(rc);
586         SP_OBJECT(rc->item)->updateRepr();
588         sp_canvas_end_forced_full_redraws(desktop->canvas);
590         sp_desktop_selection(desktop)->set(rc->item);
591         sp_document_done(sp_desktop_document(desktop), SP_VERB_CONTEXT_PAINTBUCKET,
592                          _("Fill bounded area"));
594         rc->item = NULL;
595     }
598 /*
599   Local Variables:
600   mode:c++
601   c-file-style:"stroustrup"
602   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
603   indent-tabs-mode:nil
604   fill-column:99
605   End:
606 */
607 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :