05045e96993652859384e96c0af7f25457f990fd
1 #define __SP_DRAW_CONTEXT_C__
3 /*
4 * Generic drawing context
5 *
6 * Author:
7 * Lauris Kaplinski <lauris@kaplinski.com>
8 *
9 * Copyright (C) 2000 Lauris Kaplinski
10 * Copyright (C) 2000-2001 Ximian, Inc.
11 * Copyright (C) 2002 Lauris Kaplinski
12 *
13 * Released under GNU GPL, read the file 'COPYING' for more information
14 */
16 #define DRAW_VERBOSE
18 #ifdef HAVE_CONFIG_H
19 # include "config.h"
20 #endif
21 #include <gdk/gdkkeysyms.h>
23 #include "display/canvas-bpath.h"
24 #include "xml/repr.h"
25 #include "svg/svg.h"
26 #include <glibmm/i18n.h>
27 #include "libnr/n-art-bpath.h"
28 #include "desktop.h"
29 #include "desktop-affine.h"
30 #include "desktop-handles.h"
31 #include "desktop-style.h"
32 #include "document.h"
33 #include "draw-anchor.h"
34 #include "macros.h"
35 #include "message-stack.h"
36 #include "pen-context.h"
37 #include "prefs-utils.h"
38 #include "selection.h"
39 #include "selection-chemistry.h"
40 #include "snap.h"
41 #include "sp-path.h"
42 #include "sp-namedview.h"
44 static void sp_draw_context_class_init(SPDrawContextClass *klass);
45 static void sp_draw_context_init(SPDrawContext *dc);
46 static void sp_draw_context_dispose(GObject *object);
48 static void sp_draw_context_setup(SPEventContext *ec);
49 static void sp_draw_context_set(SPEventContext *ec, gchar const *key, gchar const *value);
50 static void sp_draw_context_finish(SPEventContext *ec);
52 static gint sp_draw_context_root_handler(SPEventContext *event_context, GdkEvent *event);
54 static void spdc_selection_changed(Inkscape::Selection *sel, SPDrawContext *dc);
55 static void spdc_selection_modified(Inkscape::Selection *sel, guint flags, SPDrawContext *dc);
57 static void spdc_attach_selection(SPDrawContext *dc, Inkscape::Selection *sel);
59 static void spdc_flush_white(SPDrawContext *dc, SPCurve *gc);
61 static void spdc_reset_white(SPDrawContext *dc);
62 static void spdc_free_colors(SPDrawContext *dc);
65 static SPEventContextClass *draw_parent_class;
68 GType
69 sp_draw_context_get_type(void)
70 {
71 static GType type = 0;
72 if (!type) {
73 GTypeInfo info = {
74 sizeof(SPDrawContextClass),
75 NULL, NULL,
76 (GClassInitFunc) sp_draw_context_class_init,
77 NULL, NULL,
78 sizeof(SPDrawContext),
79 4,
80 (GInstanceInitFunc) sp_draw_context_init,
81 NULL, /* value_table */
82 };
83 type = g_type_register_static(SP_TYPE_EVENT_CONTEXT, "SPDrawContext", &info, (GTypeFlags)0);
84 }
85 return type;
86 }
88 static void
89 sp_draw_context_class_init(SPDrawContextClass *klass)
90 {
91 GObjectClass *object_class;
92 SPEventContextClass *ec_class;
94 object_class = (GObjectClass *)klass;
95 ec_class = (SPEventContextClass *) klass;
97 draw_parent_class = (SPEventContextClass*)g_type_class_peek_parent(klass);
99 object_class->dispose = sp_draw_context_dispose;
101 ec_class->setup = sp_draw_context_setup;
102 ec_class->set = sp_draw_context_set;
103 ec_class->finish = sp_draw_context_finish;
104 ec_class->root_handler = sp_draw_context_root_handler;
105 }
107 static void
108 sp_draw_context_init(SPDrawContext *dc)
109 {
110 dc->attach = FALSE;
112 dc->red_color = 0xff00007f;
113 dc->blue_color = 0x0000ff7f;
114 dc->green_color = 0x00ff007f;
115 dc->red_curve_is_valid = false;
117 new (&dc->sel_changed_connection) sigc::connection();
118 new (&dc->sel_modified_connection) sigc::connection();
119 }
121 static void
122 sp_draw_context_dispose(GObject *object)
123 {
124 SPDrawContext *dc = SP_DRAW_CONTEXT(object);
126 dc->sel_changed_connection.~connection();
127 dc->sel_modified_connection.~connection();
129 if (dc->grab) {
130 sp_canvas_item_ungrab(dc->grab, GDK_CURRENT_TIME);
131 dc->grab = NULL;
132 }
134 if (dc->selection) {
135 dc->selection = NULL;
136 }
138 spdc_free_colors(dc);
140 G_OBJECT_CLASS(draw_parent_class)->dispose(object);
141 }
143 static void
144 sp_draw_context_setup(SPEventContext *ec)
145 {
146 SPDrawContext *dc = SP_DRAW_CONTEXT(ec);
147 SPDesktop *dt = ec->desktop;
149 if (((SPEventContextClass *) draw_parent_class)->setup) {
150 ((SPEventContextClass *) draw_parent_class)->setup(ec);
151 }
153 dc->selection = sp_desktop_selection(dt);
155 /* Connect signals to track selection changes */
156 dc->sel_changed_connection = dc->selection->connectChanged(
157 sigc::bind(sigc::ptr_fun(&spdc_selection_changed), dc)
158 );
159 dc->sel_modified_connection = dc->selection->connectModified(
160 sigc::bind(sigc::ptr_fun(&spdc_selection_modified), dc)
161 );
163 /* Create red bpath */
164 dc->red_bpath = sp_canvas_bpath_new(sp_desktop_sketch(ec->desktop), NULL);
165 sp_canvas_bpath_set_stroke(SP_CANVAS_BPATH(dc->red_bpath), dc->red_color, 1.0, SP_STROKE_LINEJOIN_MITER, SP_STROKE_LINECAP_BUTT);
166 /* Create red curve */
167 dc->red_curve = sp_curve_new_sized(4);
169 /* Create blue bpath */
170 dc->blue_bpath = sp_canvas_bpath_new(sp_desktop_sketch(ec->desktop), NULL);
171 sp_canvas_bpath_set_stroke(SP_CANVAS_BPATH(dc->blue_bpath), dc->blue_color, 1.0, SP_STROKE_LINEJOIN_MITER, SP_STROKE_LINECAP_BUTT);
172 /* Create blue curve */
173 dc->blue_curve = sp_curve_new_sized(8);
175 /* Create green curve */
176 dc->green_curve = sp_curve_new_sized(64);
177 /* No green anchor by default */
178 dc->green_anchor = NULL;
179 dc->green_closed = FALSE;
181 dc->attach = TRUE;
182 spdc_attach_selection(dc, dc->selection);
183 }
185 static void
186 sp_draw_context_finish(SPEventContext *ec)
187 {
188 SPDrawContext *dc = SP_DRAW_CONTEXT(ec);
190 dc->sel_changed_connection.disconnect();
191 dc->sel_modified_connection.disconnect();
193 if (dc->grab) {
194 sp_canvas_item_ungrab(dc->grab, GDK_CURRENT_TIME);
195 }
197 if (dc->selection) {
198 dc->selection = NULL;
199 }
201 spdc_free_colors(dc);
202 }
204 static void
205 sp_draw_context_set(SPEventContext */*ec*/, const gchar */*key*/, const gchar */*value*/)
206 {
207 }
209 gint
210 sp_draw_context_root_handler(SPEventContext *ec, GdkEvent *event)
211 {
212 gint ret = FALSE;
214 switch (event->type) {
215 case GDK_KEY_PRESS:
216 switch (get_group0_keyval (&event->key)) {
217 case GDK_Up:
218 case GDK_Down:
219 case GDK_KP_Up:
220 case GDK_KP_Down:
221 // prevent the zoom field from activation
222 if (!MOD__CTRL_ONLY) {
223 ret = TRUE;
224 }
225 break;
226 default:
227 break;
228 }
229 break;
230 default:
231 break;
232 }
234 if (!ret) {
235 if (((SPEventContextClass *) draw_parent_class)->root_handler) {
236 ret = ((SPEventContextClass *) draw_parent_class)->root_handler(ec, event);
237 }
238 }
240 return ret;
241 }
244 /*
245 * Selection handlers
246 */
248 static void
249 spdc_selection_changed(Inkscape::Selection *sel, SPDrawContext *dc)
250 {
251 if (dc->attach) {
252 spdc_attach_selection(dc, sel);
253 }
254 }
256 /* fixme: We have to ensure this is not delayed (Lauris) */
258 static void
259 spdc_selection_modified(Inkscape::Selection *sel, guint /*flags*/, SPDrawContext *dc)
260 {
261 if (dc->attach) {
262 spdc_attach_selection(dc, sel);
263 }
264 }
266 static void
267 spdc_attach_selection(SPDrawContext *dc, Inkscape::Selection */*sel*/)
268 {
269 /* We reset white and forget white/start/end anchors */
270 spdc_reset_white(dc);
271 dc->sa = NULL;
272 dc->ea = NULL;
274 SPItem *item = dc->selection ? dc->selection->singleItem() : NULL;
276 if ( item && SP_IS_PATH(item) ) {
277 /* Create new white data */
278 /* Item */
279 dc->white_item = item;
280 /* Curve list */
281 /* We keep it in desktop coordinates to eliminate calculation errors */
282 SPCurve *norm = sp_path_get_curve_for_edit (SP_PATH(item));
283 sp_curve_transform(norm, sp_item_i2d_affine(dc->white_item));
284 g_return_if_fail( norm != NULL );
285 dc->white_curves = g_slist_reverse(sp_curve_split(norm));
286 sp_curve_unref(norm);
287 /* Anchor list */
288 for (GSList *l = dc->white_curves; l != NULL; l = l->next) {
289 SPCurve *c;
290 c = (SPCurve*)l->data;
291 g_return_if_fail( c->end > 1 );
292 if ( SP_CURVE_BPATH(c)->code == NR_MOVETO_OPEN ) {
293 NArtBpath *s, *e;
294 SPDrawAnchor *a;
295 s = sp_curve_first_bpath(c);
296 e = sp_curve_last_bpath(c);
297 a = sp_draw_anchor_new(dc, c, TRUE, NR::Point(s->x3, s->y3));
298 dc->white_anchors = g_slist_prepend(dc->white_anchors, a);
299 a = sp_draw_anchor_new(dc, c, FALSE, NR::Point(e->x3, e->y3));
300 dc->white_anchors = g_slist_prepend(dc->white_anchors, a);
301 }
302 }
303 /* fixme: recalculate active anchor? */
304 }
305 }
308 /**
309 * Snaps node or handle to PI/rotationsnapsperpi degree increments.
310 *
311 * \param dc draw context
312 * \param p cursor point (to be changed by snapping)
313 * \param o origin point
314 * \param state keyboard state to check if ctrl was pressed
315 */
317 void spdc_endpoint_snap_rotation(SPEventContext const *const ec, NR::Point &p, NR::Point const o,
318 guint state)
319 {
320 /* Control must be down for this snap to work */
321 if ((state & GDK_CONTROL_MASK) == 0) {
322 return;
323 }
325 unsigned const snaps = abs(prefs_get_int_attribute("options.rotationsnapsperpi", "value", 12));
326 /* 0 means no snapping. */
328 /* mirrored by fabs, so this corresponds to 15 degrees */
329 NR::Point best; /* best solution */
330 double bn = NR_HUGE; /* best normal */
331 double bdot = 0;
332 NR::Point v = NR::Point(0, 1);
333 double const r00 = cos(M_PI / snaps), r01 = sin(M_PI / snaps);
334 double const r10 = -r01, r11 = r00;
336 NR::Point delta = p - o;
338 for (unsigned i = 0; i < snaps; i++) {
339 double const ndot = fabs(dot(v,NR::rot90(delta)));
340 NR::Point t(r00*v[NR::X] + r01*v[NR::Y],
341 r10*v[NR::X] + r11*v[NR::Y]);
342 if (ndot < bn) {
343 /* I think it is better numerically to use the normal, rather than the dot product
344 * to assess solutions, but I haven't proven it. */
345 bn = ndot;
346 best = v;
347 bdot = dot(v, delta);
348 }
349 v = t;
350 }
352 if (fabs(bdot) > 0) {
353 p = o + bdot * best;
355 /* Snap it along best vector */
356 SnapManager &m = SP_EVENT_CONTEXT_DESKTOP(ec)->namedview->snap_manager;
357 m.setup(SP_EVENT_CONTEXT_DESKTOP(ec), NULL);
358 Inkscape::SnappedPoint const s = m.constrainedSnap( Inkscape::Snapper::SNAPPOINT_NODE,
359 p, Inkscape::Snapper::ConstraintLine(best));
360 p = s.getPoint();
361 }
362 }
365 void spdc_endpoint_snap_free(SPEventContext const * const ec, NR::Point& p, guint const state)
366 {
367 /* Shift disables this snap */
368 if (state & GDK_SHIFT_MASK) {
369 return;
370 }
372 SnapManager &m = SP_EVENT_CONTEXT_DESKTOP(ec)->namedview->snap_manager;
373 m.setup(SP_EVENT_CONTEXT_DESKTOP(ec), NULL);
374 Inkscape::SnappedPoint const s = m.freeSnap(Inkscape::Snapper::SNAPPOINT_NODE, p);
375 p = s.getPoint();
376 }
378 static SPCurve *
379 reverse_then_unref(SPCurve *orig)
380 {
381 SPCurve *ret = sp_curve_reverse(orig);
382 sp_curve_unref(orig);
383 return ret;
384 }
386 /**
387 * Concats red, blue and green.
388 * If any anchors are defined, process these, optionally removing curves from white list
389 * Invoke _flush_white to write result back to object.
390 */
391 void
392 spdc_concat_colors_and_flush(SPDrawContext *dc, gboolean forceclosed)
393 {
394 /* Concat RBG */
395 SPCurve *c = dc->green_curve;
397 /* Green */
398 dc->green_curve = sp_curve_new_sized(64);
399 while (dc->green_bpaths) {
400 gtk_object_destroy(GTK_OBJECT(dc->green_bpaths->data));
401 dc->green_bpaths = g_slist_remove(dc->green_bpaths, dc->green_bpaths->data);
402 }
403 /* Blue */
404 sp_curve_append_continuous(c, dc->blue_curve, 0.0625);
405 sp_curve_reset(dc->blue_curve);
406 sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(dc->blue_bpath), NULL);
407 /* Red */
408 if (dc->red_curve_is_valid) {
409 sp_curve_append_continuous(c, dc->red_curve, 0.0625);
410 }
411 sp_curve_reset(dc->red_curve);
412 sp_canvas_bpath_set_bpath(SP_CANVAS_BPATH(dc->red_bpath), NULL);
414 if (sp_curve_empty(c)) {
415 sp_curve_unref(c);
416 return;
417 }
419 /* Step A - test, whether we ended on green anchor */
420 if ( forceclosed || ( dc->green_anchor && dc->green_anchor->active ) ) {
421 // We hit green anchor, closing Green-Blue-Red
422 SP_EVENT_CONTEXT_DESKTOP(dc)->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Path is closed."));
423 sp_curve_closepath_current(c);
424 /* Closed path, just flush */
425 spdc_flush_white(dc, c);
426 sp_curve_unref(c);
427 return;
428 }
430 /* Step B - both start and end anchored to same curve */
431 if ( dc->sa && dc->ea
432 && ( dc->sa->curve == dc->ea->curve )
433 && ( ( dc->sa != dc->ea )
434 || dc->sa->curve->closed ) )
435 {
436 // We hit bot start and end of single curve, closing paths
437 SP_EVENT_CONTEXT_DESKTOP(dc)->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Closing path."));
438 if (dc->sa->start && !(dc->sa->curve->closed) ) {
439 c = reverse_then_unref(c);
440 }
441 sp_curve_append_continuous(dc->sa->curve, c, 0.0625);
442 sp_curve_unref(c);
443 sp_curve_closepath_current(dc->sa->curve);
444 spdc_flush_white(dc, NULL);
445 return;
446 }
448 /* Step C - test start */
449 if (dc->sa) {
450 SPCurve *s = dc->sa->curve;
451 dc->white_curves = g_slist_remove(dc->white_curves, s);
452 if (dc->sa->start) {
453 s = reverse_then_unref(s);
454 }
455 sp_curve_append_continuous(s, c, 0.0625);
456 sp_curve_unref(c);
457 c = s;
458 } else /* Step D - test end */ if (dc->ea) {
459 SPCurve *e = dc->ea->curve;
460 dc->white_curves = g_slist_remove(dc->white_curves, e);
461 if (!dc->ea->start) {
462 e = reverse_then_unref(e);
463 }
464 sp_curve_append_continuous(c, e, 0.0625);
465 sp_curve_unref(e);
466 }
469 spdc_flush_white(dc, c);
471 sp_curve_unref(c);
472 }
474 static char const *
475 tool_name(SPDrawContext *dc)
476 {
477 return ( SP_IS_PEN_CONTEXT(dc)
478 ? "tools.freehand.pen"
479 : "tools.freehand.pencil" );
480 }
482 /*
483 * Flushes white curve(s) and additional curve into object
484 *
485 * No cleaning of colored curves - this has to be done by caller
486 * No rereading of white data, so if you cannot rely on ::modified, do it in caller
487 *
488 */
490 static void
491 spdc_flush_white(SPDrawContext *dc, SPCurve *gc)
492 {
493 SPCurve *c;
495 if (dc->white_curves) {
496 g_assert(dc->white_item);
497 c = sp_curve_concat(dc->white_curves);
498 g_slist_free(dc->white_curves);
499 dc->white_curves = NULL;
500 if (gc) {
501 sp_curve_append(c, gc, FALSE);
502 }
503 } else if (gc) {
504 c = gc;
505 sp_curve_ref(c);
506 } else {
507 return;
508 }
510 /* Now we have to go back to item coordinates at last */
511 sp_curve_transform(c, ( dc->white_item
512 ? sp_item_dt2i_affine(dc->white_item)
513 : sp_desktop_dt2root_affine(SP_EVENT_CONTEXT_DESKTOP(dc)) ));
515 SPDesktop *desktop = SP_EVENT_CONTEXT_DESKTOP(dc);
516 SPDocument *doc = sp_desktop_document(desktop);
517 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(doc);
519 if ( c && !sp_curve_empty(c) ) {
520 /* We actually have something to write */
522 bool has_lpe = false;
523 Inkscape::XML::Node *repr;
524 if (dc->white_item) {
525 repr = SP_OBJECT_REPR(dc->white_item);
526 has_lpe = sp_lpe_item_has_path_effect_recursive(SP_LPE_ITEM(dc->white_item));
527 } else {
528 repr = xml_doc->createElement("svg:path");
529 /* Set style */
530 sp_desktop_apply_style_tool(desktop, repr, tool_name(dc), false);
531 }
533 gchar *str = sp_svg_write_path(SP_CURVE_BPATH(c));
534 g_assert( str != NULL );
535 if (has_lpe)
536 repr->setAttribute("inkscape:original-d", str);
537 else
538 repr->setAttribute("d", str);
539 g_free(str);
541 if (!dc->white_item) {
542 /* Attach repr */
543 SPItem *item = SP_ITEM(desktop->currentLayer()->appendChildRepr(repr));
544 dc->selection->set(repr);
545 Inkscape::GC::release(repr);
546 item->transform = i2i_affine(desktop->currentRoot(), desktop->currentLayer());
547 item->updateRepr();
548 }
550 sp_document_done(doc, SP_IS_PEN_CONTEXT(dc)? SP_VERB_CONTEXT_PEN : SP_VERB_CONTEXT_PENCIL,
551 _("Draw path"));
553 // When quickly drawing several subpaths with Shift, the next subpath may be finished and
554 // flushed before the selection_modified signal is fired by the previous change, which
555 // results in the tool losing all of the selected path's curve except that last subpath. To
556 // fix this, we force the selection_modified callback now, to make sure the tool's curve is
557 // in sync immediately.
558 spdc_selection_modified(sp_desktop_selection(desktop), 0, dc);
559 }
561 sp_curve_unref(c);
563 /* Flush pending updates */
564 sp_document_ensure_up_to_date(doc);
565 }
567 /**
568 * Returns FIRST active anchor (the activated one).
569 */
570 SPDrawAnchor *
571 spdc_test_inside(SPDrawContext *dc, NR::Point p)
572 {
573 SPDrawAnchor *active = NULL;
575 /* Test green anchor */
576 if (dc->green_anchor) {
577 active = sp_draw_anchor_test(dc->green_anchor, p, TRUE);
578 }
580 for (GSList *l = dc->white_anchors; l != NULL; l = l->next) {
581 SPDrawAnchor *na = sp_draw_anchor_test((SPDrawAnchor *) l->data, p, !active);
582 if ( !active && na ) {
583 active = na;
584 }
585 }
587 return active;
588 }
590 static void
591 spdc_reset_white(SPDrawContext *dc)
592 {
593 if (dc->white_item) {
594 /* We do not hold refcount */
595 dc->white_item = NULL;
596 }
597 while (dc->white_curves) {
598 sp_curve_unref((SPCurve *) dc->white_curves->data);
599 dc->white_curves = g_slist_remove(dc->white_curves, dc->white_curves->data);
600 }
601 while (dc->white_anchors) {
602 sp_draw_anchor_destroy((SPDrawAnchor *) dc->white_anchors->data);
603 dc->white_anchors = g_slist_remove(dc->white_anchors, dc->white_anchors->data);
604 }
605 }
607 static void
608 spdc_free_colors(SPDrawContext *dc)
609 {
610 /* Red */
611 if (dc->red_bpath) {
612 gtk_object_destroy(GTK_OBJECT(dc->red_bpath));
613 dc->red_bpath = NULL;
614 }
615 if (dc->red_curve) {
616 dc->red_curve = sp_curve_unref(dc->red_curve);
617 }
618 /* Blue */
619 if (dc->blue_bpath) {
620 gtk_object_destroy(GTK_OBJECT(dc->blue_bpath));
621 dc->blue_bpath = NULL;
622 }
623 if (dc->blue_curve) {
624 dc->blue_curve = sp_curve_unref(dc->blue_curve);
625 }
626 /* Green */
627 while (dc->green_bpaths) {
628 gtk_object_destroy(GTK_OBJECT(dc->green_bpaths->data));
629 dc->green_bpaths = g_slist_remove(dc->green_bpaths, dc->green_bpaths->data);
630 }
631 if (dc->green_curve) {
632 dc->green_curve = sp_curve_unref(dc->green_curve);
633 }
634 if (dc->green_anchor) {
635 dc->green_anchor = sp_draw_anchor_destroy(dc->green_anchor);
636 }
637 /* White */
638 if (dc->white_item) {
639 /* We do not hold refcount */
640 dc->white_item = NULL;
641 }
642 while (dc->white_curves) {
643 sp_curve_unref((SPCurve *) dc->white_curves->data);
644 dc->white_curves = g_slist_remove(dc->white_curves, dc->white_curves->data);
645 }
646 while (dc->white_anchors) {
647 sp_draw_anchor_destroy((SPDrawAnchor *) dc->white_anchors->data);
648 dc->white_anchors = g_slist_remove(dc->white_anchors, dc->white_anchors->data);
649 }
650 }
653 /*
654 Local Variables:
655 mode:c++
656 c-file-style:"stroustrup"
657 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
658 indent-tabs-mode:nil
659 fill-column:99
660 End:
661 */
662 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :