1 #define __SP_SHAPE_C__
3 /*
4 * Base class for shapes, including <path> element
5 *
6 * Author:
7 * Lauris Kaplinski <lauris@kaplinski.com>
8 *
9 * Copyright (C) 1999-2002 Lauris Kaplinski
10 * Copyright (C) 2000-2001 Ximian, Inc.
11 * Copyright (C) 2004 John Cliff
12 * Copyright (C) 2007-2008 Johan Engelen
13 *
14 * Released under GNU GPL, read the file 'COPYING' for more information
15 */
17 #ifdef HAVE_CONFIG_H
18 # include "config.h"
19 #endif
22 #include <libnr/n-art-bpath.h>
23 #include <libnr/nr-matrix-fns.h>
24 #include <libnr/nr-matrix-ops.h>
25 #include <libnr/nr-matrix-translate-ops.h>
26 #include <libnr/nr-scale-matrix-ops.h>
28 #include <sigc++/functors/ptr_fun.h>
29 #include <sigc++/adaptors/bind.h>
31 #include "macros.h"
32 #include "display/nr-arena-shape.h"
33 #include "print.h"
34 #include "document.h"
35 #include "style.h"
36 #include "marker.h"
37 #include "sp-path.h"
38 #include "prefs-utils.h"
39 #include "attributes.h"
41 #include "live_effects/effect.h"
42 #include "live_effects/lpeobject.h"
43 #include "live_effects/lpeobject-reference.h"
44 #include "uri.h"
45 #include "extract-uri.h"
46 #include "uri-references.h"
47 #include "bad-uri-exception.h"
48 #include "xml/repr.h"
50 #include "util/mathfns.h" // for triangle_area()
52 #define noSHAPE_VERBOSE
54 static void sp_shape_class_init (SPShapeClass *klass);
55 static void sp_shape_init (SPShape *shape);
56 static void sp_shape_finalize (GObject *object);
58 static void sp_shape_build (SPObject * object, SPDocument * document, Inkscape::XML::Node * repr);
59 static void sp_shape_release (SPObject *object);
61 static void sp_shape_set(SPObject *object, unsigned key, gchar const *value);
62 static void sp_shape_update (SPObject *object, SPCtx *ctx, unsigned int flags);
63 static void sp_shape_modified (SPObject *object, unsigned int flags);
64 static Inkscape::XML::Node *sp_shape_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
66 static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags);
67 void sp_shape_print (SPItem * item, SPPrintContext * ctx);
68 static NRArenaItem *sp_shape_show (SPItem *item, NRArena *arena, unsigned int key, unsigned int flags);
69 static void sp_shape_hide (SPItem *item, unsigned int key);
70 static void sp_shape_snappoints (SPItem const *item, SnapPointsIter p);
72 static void sp_shape_update_marker_view (SPShape *shape, NRArenaItem *ai);
74 static void lpeobject_ref_changed(SPObject *old_ref, SPObject *ref, SPShape *shape);
75 static void lpeobject_ref_modified(SPObject *href, guint flags, SPShape *shape);
77 static SPItemClass *parent_class;
79 /**
80 * Registers the SPShape class with Gdk and returns its type number.
81 */
82 GType
83 sp_shape_get_type (void)
84 {
85 static GType type = 0;
86 if (!type) {
87 GTypeInfo info = {
88 sizeof (SPShapeClass),
89 NULL, NULL,
90 (GClassInitFunc) sp_shape_class_init,
91 NULL, NULL,
92 sizeof (SPShape),
93 16,
94 (GInstanceInitFunc) sp_shape_init,
95 NULL, /* value_table */
96 };
97 type = g_type_register_static (SP_TYPE_ITEM, "SPShape", &info, (GTypeFlags)0);
98 }
99 return type;
100 }
102 /**
103 * Initializes a SPShapeClass object. Establishes the function pointers to the class'
104 * member routines in the class vtable, and sets pointers to parent classes.
105 */
106 static void
107 sp_shape_class_init (SPShapeClass *klass)
108 {
109 GObjectClass *gobject_class;
110 SPObjectClass *sp_object_class;
111 SPItemClass * item_class;
112 SPPathClass * path_class;
114 gobject_class = (GObjectClass *) klass;
115 sp_object_class = (SPObjectClass *) klass;
116 item_class = (SPItemClass *) klass;
117 path_class = (SPPathClass *) klass;
119 parent_class = (SPItemClass *)g_type_class_peek_parent (klass);
121 gobject_class->finalize = sp_shape_finalize;
123 sp_object_class->build = sp_shape_build;
124 sp_object_class->release = sp_shape_release;
125 sp_object_class->set = sp_shape_set;
126 sp_object_class->update = sp_shape_update;
127 sp_object_class->modified = sp_shape_modified;
128 sp_object_class->write = sp_shape_write;
130 item_class->bbox = sp_shape_bbox;
131 item_class->print = sp_shape_print;
132 item_class->show = sp_shape_show;
133 item_class->hide = sp_shape_hide;
134 item_class->snappoints = sp_shape_snappoints;
136 klass->set_shape = NULL;
137 klass->update_patheffect = NULL;
138 }
140 /**
141 * Initializes an SPShape object.
142 */
143 static void
144 sp_shape_init (SPShape *shape)
145 {
146 shape->path_effect_href = NULL;
147 shape->path_effect_ref = new Inkscape::LivePathEffect::LPEObjectReference(SP_OBJECT(shape));
148 new (&shape->lpe_modified_connection) sigc::connection();
150 for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
151 new (&shape->release_connect[i]) sigc::connection();
152 new (&shape->modified_connect[i]) sigc::connection();
153 }
154 }
156 static void
157 sp_shape_finalize (GObject *object)
158 {
159 SPShape *shape=(SPShape *)object;
161 for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
162 shape->release_connect[i].disconnect();
163 shape->release_connect[i].~connection();
164 shape->modified_connect[i].disconnect();
165 shape->modified_connect[i].~connection();
166 }
168 if (((GObjectClass *) (parent_class))->finalize) {
169 (* ((GObjectClass *) (parent_class))->finalize)(object);
170 }
171 }
173 /**
174 * Virtual build callback for SPMarker.
175 *
176 * This is to be invoked immediately after creation of an SPShape.
177 *
178 * \see sp_object_build()
179 */
180 static void
181 sp_shape_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
182 {
183 SP_SHAPE(object)->path_effect_ref->changedSignal().connect(sigc::bind(sigc::ptr_fun(lpeobject_ref_changed), SP_SHAPE(object)));
185 sp_object_read_attr(object, "inkscape:path-effect");
187 if (((SPObjectClass *) (parent_class))->build) {
188 (*((SPObjectClass *) (parent_class))->build) (object, document, repr);
189 }
190 }
192 /**
193 * Removes, releases and unrefs all children of object
194 *
195 * This is the inverse of sp_shape_build(). It must be invoked as soon
196 * as the shape is removed from the tree, even if it is still referenced
197 * by other objects. This routine also disconnects/unrefs markers and
198 * curves attached to it.
199 *
200 * \see sp_object_release()
201 */
202 static void
203 sp_shape_release (SPObject *object)
204 {
205 SPItem *item;
206 SPShape *shape;
207 SPItemView *v;
208 int i;
210 item = (SPItem *) object;
211 shape = (SPShape *) object;
213 for (i=SP_MARKER_LOC_START; i<SP_MARKER_LOC_QTY; i++) {
214 if (shape->marker[i]) {
215 sp_signal_disconnect_by_data (shape->marker[i], object);
216 for (v = item->display; v != NULL; v = v->next) {
217 sp_marker_hide ((SPMarker *) shape->marker[i], NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
218 }
219 shape->marker[i] = sp_object_hunref (shape->marker[i], object);
220 }
221 }
222 if (shape->curve) {
223 shape->curve = sp_curve_unref (shape->curve);
224 }
226 if (shape->path_effect_href) {
227 g_free(shape->path_effect_href);
228 }
229 shape->path_effect_ref->detach();
231 shape->lpe_modified_connection.disconnect();
232 shape->lpe_modified_connection.~connection();
234 if (((SPObjectClass *) parent_class)->release) {
235 ((SPObjectClass *) parent_class)->release (object);
236 }
237 }
241 static void
242 sp_shape_set(SPObject *object, unsigned int key, gchar const *value)
243 {
244 SPShape *shape = (SPShape *) object;
246 switch (key) {
247 case SP_ATTR_INKSCAPE_PATH_EFFECT:
248 if ( value && shape->path_effect_href && ( strcmp(value, shape->path_effect_href) == 0 ) ) {
249 /* No change, do nothing. */
250 } else {
251 if (shape->path_effect_href) {
252 g_free(shape->path_effect_href);
253 shape->path_effect_href = NULL;
254 }
255 if (value) {
256 shape->path_effect_href = g_strdup(value);
258 // Now do the attaching, which emits the changed signal.
259 try {
260 shape->path_effect_ref->attach(Inkscape::URI(value));
261 } catch (Inkscape::BadURIException &e) {
262 g_warning("%s", e.what());
263 shape->path_effect_ref->detach();
264 }
265 } else {
266 // Detach, which emits the changed signal.
267 shape->path_effect_ref->detach();
268 }
269 }
270 break;
271 default:
272 if (((SPObjectClass *) parent_class)->set) {
273 ((SPObjectClass *) parent_class)->set(object, key, value);
274 }
275 break;
276 }
277 }
279 static Inkscape::XML::Node *
280 sp_shape_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
281 {
282 SPShape *shape = (SPShape *) object;
284 if ( shape->path_effect_href ) {
285 repr->setAttribute("inkscape:path-effect", shape->path_effect_href);
286 } else {
287 repr->setAttribute("inkscape:path-effect", NULL);
288 }
290 if (((SPObjectClass *)(parent_class))->write) {
291 ((SPObjectClass *)(parent_class))->write(object, repr, flags);
292 }
294 return repr;
295 }
297 /**
298 * Updates the shape when its attributes have changed. Also establishes
299 * marker objects to match the style settings.
300 */
301 static void
302 sp_shape_update (SPObject *object, SPCtx *ctx, unsigned int flags)
303 {
304 SPItem *item = (SPItem *) object;
305 SPShape *shape = (SPShape *) object;
307 if (((SPObjectClass *) (parent_class))->update) {
308 (* ((SPObjectClass *) (parent_class))->update) (object, ctx, flags);
309 }
311 /* This stanza checks that an object's marker style agrees with
312 * the marker objects it has allocated. sp_shape_set_marker ensures
313 * that the appropriate marker objects are present (or absent) to
314 * match the style.
315 */
316 /* TODO: It would be nice if this could be done at an earlier level */
317 for (int i = 0 ; i < SP_MARKER_LOC_QTY ; i++) {
318 sp_shape_set_marker (object, i, object->style->marker[i].value);
319 }
321 if (flags & (SP_OBJECT_STYLE_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
322 SPStyle *style;
323 style = SP_OBJECT_STYLE (object);
324 if (style->stroke_width.unit == SP_CSS_UNIT_PERCENT) {
325 SPItemCtx *ictx = (SPItemCtx *) ctx;
326 double const aw = 1.0 / NR::expansion(ictx->i2vp);
327 style->stroke_width.computed = style->stroke_width.value * aw;
328 for (SPItemView *v = ((SPItem *) (shape))->display; v != NULL; v = v->next) {
329 nr_arena_shape_set_style ((NRArenaShape *) v->arenaitem, style);
330 }
331 }
332 }
334 if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG)) {
335 /* This is suboptimal, because changing parent style schedules recalculation */
336 /* But on the other hand - how can we know that parent does not tie style and transform */
337 NR::Maybe<NR::Rect> paintbox = SP_ITEM(object)->getBounds(NR::identity());
338 for (SPItemView *v = SP_ITEM (shape)->display; v != NULL; v = v->next) {
339 NRArenaShape * const s = NR_ARENA_SHAPE(v->arenaitem);
340 if (flags & SP_OBJECT_MODIFIED_FLAG) {
341 nr_arena_shape_set_path(s, shape->curve, (flags & SP_OBJECT_USER_MODIFIED_FLAG_B));
342 }
343 if (paintbox) {
344 s->setPaintBox(*paintbox);
345 }
346 }
347 }
349 if (sp_shape_has_markers (shape)) {
351 /* Dimension marker views */
352 for (SPItemView *v = item->display; v != NULL; v = v->next) {
354 if (!v->arenaitem->key) {
355 /* Get enough keys for all, start, mid and end marker types,
356 ** and set this view's arenaitem key to the first of these keys.
357 */
358 NR_ARENA_ITEM_SET_KEY (
359 v->arenaitem,
360 sp_item_display_key_new (SP_MARKER_LOC_QTY)
361 );
362 }
364 for (int i = 0 ; i < SP_MARKER_LOC_QTY ; i++) {
365 if (shape->marker[i]) {
366 sp_marker_show_dimension ((SPMarker *) shape->marker[i],
367 NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i - SP_MARKER_LOC,
368 sp_shape_number_of_markers (shape, i));
369 }
370 }
371 }
373 /* Update marker views */
374 for (SPItemView *v = item->display; v != NULL; v = v->next) {
375 sp_shape_update_marker_view (shape, v->arenaitem);
376 }
377 }
378 }
381 /**
382 * Works out whether a marker of a given type is required at a particular
383 * point on a shape.
384 *
385 * \param shape Shape of interest.
386 * \param m Marker type (e.g. SP_MARKER_LOC_START)
387 * \param bp Path segment.
388 * \return 1 if a marker is required here, otherwise 0.
389 */
390 bool
391 sp_shape_marker_required(SPShape const *shape, int const m, NArtBpath *bp)
392 {
393 if (shape->marker[m] == NULL) {
394 return false;
395 }
397 if (bp == SP_CURVE_BPATH(shape->curve))
398 return m == SP_MARKER_LOC_START;
399 else if (bp[1].code == NR_END)
400 return m == SP_MARKER_LOC_END;
401 else
402 return m == SP_MARKER_LOC_MID;
403 }
405 static bool
406 is_moveto(NRPathcode const c)
407 {
408 return c == NR_MOVETO || c == NR_MOVETO_OPEN;
409 }
411 /**
412 * Helper function that advances a subpath's bpath to the first subpath
413 * by checking for moveto segments.
414 *
415 * \pre The bpath[] containing bp begins with a moveto.
416 */
417 static NArtBpath const *
418 first_seg_in_subpath(NArtBpath const *bp)
419 {
420 while (!is_moveto(bp->code)) {
421 --bp;
422 }
423 return bp;
424 }
426 /**
427 * Advances the bpath to the last segment in the subpath.
428 */
429 static NArtBpath const *
430 last_seg_in_subpath(NArtBpath const *bp)
431 {
432 for(;;) {
433 ++bp;
434 switch (bp->code) {
435 case NR_MOVETO:
436 case NR_MOVETO_OPEN:
437 case NR_END:
438 --bp;
439 return bp;
441 default: continue;
442 }
443 }
444 }
447 /* A subpath begins with a moveto and ends immediately before the next moveto or NR_END.
448 * (`moveto' here means either NR_MOVETO or NR_MOVETO_OPEN.) I'm assuming that non-empty
449 * paths always begin with a moveto.
450 *
451 * The control points of the subpath are the control points of the path elements of the subpath.
452 *
453 * As usual, the control points of a moveto or NR_LINETO are {c(3)}, and
454 * the control points of a NR_CURVETO are {c(1), c(2), c(3)}.
455 * (It follows from the definition that NR_END isn't part of a subpath.)
456 *
457 * The initial control point is bpath[bi0].c(3).
458 *
459 * Reference: http://www.w3.org/TR/SVG11/painting.html#MarkerElement, the `orient' attribute.
460 * Reference for behaviour of zero-length segments:
461 * http://www.w3.org/TR/SVG11/implnote.html#PathElementImplementationNotes
462 */
464 static double const no_tangent = 128.0; /* arbitrarily-chosen value outside the range of atan2,
465 * i.e. outside of [-pi, pi]. This value is incremented by
466 * 1 and checked using > to be safe from floating-point
467 * equality comparison madness.*/
469 /**
470 * Helper function to calculate the outgoing tangent of a path
471 * ( atan2(other - p0) )
472 * \pre The bpath[] containing bp0 begins with a moveto.
473 */
474 static double
475 outgoing_tangent(NArtBpath const *bp0)
476 {
477 /* See notes in comment block above. */
479 g_assert(bp0->code != NR_END);
480 NR::Point const &p0 = bp0->c(3);
481 NR::Point other;
482 for (NArtBpath const *bp = bp0;;) {
483 ++bp;
484 switch (bp->code) {
485 case NR_LINETO:
486 other = bp->c(3);
487 if (other != p0) {
488 goto found;
489 }
490 break;
492 case NR_CURVETO:
493 for (unsigned ci = 1; ci <= 3; ++ci) {
494 other = bp->c(ci);
495 if (other != p0) {
496 goto found;
497 }
498 }
499 break;
501 case NR_MOVETO_OPEN:
502 case NR_END:
503 case NR_MOVETO:
504 bp = first_seg_in_subpath(bp0);
505 if (bp == bp0) {
506 /* Gone right around the subpath without finding any different point since the
507 * initial moveto. */
508 return no_tangent + 1;
509 }
510 if (bp->code != NR_MOVETO) {
511 /* Open subpath. */
512 return no_tangent + 1;
513 }
514 other = bp->c(3);
515 if (other != p0) {
516 goto found;
517 }
518 break;
519 }
521 if (bp == bp0) {
522 /* Back where we started, so zero-length subpath. */
523 return no_tangent + 1;
525 /* Note: this test must come after we've looked at element bp, in case bp0 is a curve:
526 * we must look at c(1) and c(2). (E.g. single-curve subpath.)
527 */
528 }
529 }
531 found:
532 return atan2( other - p0 );
533 }
535 /**
536 * Helper function to calculate the incoming tangent of a path
537 * ( atan2(p0 - other) )
538 *
539 * \pre The bpath[] containing bp0 begins with a moveto.
540 */
541 static double
542 incoming_tangent(NArtBpath const *bp0)
543 {
544 /* See notes in comment block before outgoing_tangent. */
546 g_assert(bp0->code != NR_END);
547 NR::Point const &p0 = bp0->c(3);
548 NR::Point other;
549 for (NArtBpath const *bp = bp0;;) {
550 switch (bp->code) {
551 case NR_LINETO:
552 other = bp->c(3);
553 if (other != p0) {
554 goto found;
555 }
556 --bp;
557 break;
559 case NR_CURVETO:
560 for (unsigned ci = 3; ci != 0; --ci) {
561 other = bp->c(ci);
562 if (other != p0) {
563 goto found;
564 }
565 }
566 --bp;
567 break;
569 case NR_MOVETO:
570 case NR_MOVETO_OPEN:
571 other = bp->c(3);
572 if (other != p0) {
573 goto found;
574 }
575 if (bp->code != NR_MOVETO) {
576 /* Open subpath. */
577 return no_tangent + 1;
578 }
579 bp = last_seg_in_subpath(bp0);
580 break;
582 default: /* includes NR_END */
583 g_error("Found invalid path code %u in middle of path.", bp->code);
584 return no_tangent + 1;
585 }
587 if (bp == bp0) {
588 /* Back where we started from: zero-length subpath. */
589 return no_tangent + 1;
590 }
591 }
593 found:
594 return atan2( p0 - other );
595 }
598 /**
599 * Calculate the transform required to get a marker's path object in the
600 * right place for particular path segment on a shape. You should
601 * call sp_shape_marker_required first to see if a marker is required
602 * at this point.
603 *
604 * \see sp_shape_marker_required.
605 *
606 * \param shape Shape which the marker is for.
607 * \param m Marker type (e.g. SP_MARKER_LOC_START)
608 * \param bp Path segment which the arrow is for.
609 * \return Transform matrix.
610 */
611 NR::Matrix
612 sp_shape_marker_get_transform(SPShape const *shape, NArtBpath const *bp)
613 {
614 g_return_val_if_fail(( is_moveto(SP_CURVE_BPATH(shape->curve)[0].code)
615 && ( 0 < shape->curve->end )
616 && ( SP_CURVE_BPATH(shape->curve)[shape->curve->end].code == NR_END ) ),
617 NR::Matrix(NR::translate(bp->c(3))));
618 double const angle1 = incoming_tangent(bp);
619 double const angle2 = outgoing_tangent(bp);
621 double ret_angle;
622 if (angle1 > no_tangent) {
623 /* First vertex of an open subpath. */
624 ret_angle = ( angle2 > no_tangent
625 ? 0.
626 : angle2 );
627 } else if (angle2 > no_tangent) {
628 /* Last vertex of an open subpath. */
629 ret_angle = angle1;
630 } else {
631 ret_angle = .5 * (angle1 + angle2);
633 if ( fabs( angle2 - angle1 ) > M_PI ) {
634 /* ret_angle is in the middle of the larger of the two sectors between angle1 and
635 * angle2, so flip it by 180degrees to force it to the middle of the smaller sector.
636 *
637 * (Imagine a circle with rays drawn at angle1 and angle2 from the centre of the
638 * circle. Those two rays divide the circle into two sectors.)
639 */
640 ret_angle += M_PI;
641 }
642 }
644 return NR::Matrix(NR::rotate(ret_angle)) * NR::translate(bp->c(3));
645 }
647 /**
648 * Updates the instances (views) of a given marker in a shape.
649 * Marker views have to be scaled already. The transformation
650 * is retrieved and then shown by calling sp_marker_show_instance.
651 */
652 static void
653 sp_shape_update_marker_view (SPShape *shape, NRArenaItem *ai)
654 {
655 SPStyle *style = ((SPObject *) shape)->style;
657 for (int i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
658 if (shape->marker[i] == NULL) {
659 continue;
660 }
662 int n = 0;
664 for (NArtBpath *bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
665 if (sp_shape_marker_required (shape, i, bp)) {
666 NR::Matrix const m(sp_shape_marker_get_transform(shape, bp));
667 sp_marker_show_instance ((SPMarker* ) shape->marker[i], ai,
668 NR_ARENA_ITEM_GET_KEY(ai) + i, n, m,
669 style->stroke_width.computed);
670 n++;
671 }
672 }
673 }
674 }
676 /**
677 * Sets modified flag for all sub-item views.
678 */
679 static void
680 sp_shape_modified (SPObject *object, unsigned int flags)
681 {
682 SPShape *shape = SP_SHAPE (object);
684 if (((SPObjectClass *) (parent_class))->modified) {
685 (* ((SPObjectClass *) (parent_class))->modified) (object, flags);
686 }
688 if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
689 for (SPItemView *v = SP_ITEM (shape)->display; v != NULL; v = v->next) {
690 nr_arena_shape_set_style (NR_ARENA_SHAPE (v->arenaitem), object->style);
691 }
692 }
693 }
695 /**
696 * Calculates the bounding box for item, storing it into bbox.
697 * This also includes the bounding boxes of any markers included in the shape.
698 */
699 static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags)
700 {
701 SPShape const *shape = SP_SHAPE (item);
703 if (shape->curve) {
705 NRRect cbbox;
706 NRBPath bp;
708 bp.path = SP_CURVE_BPATH (shape->curve);
710 cbbox.x0 = cbbox.y0 = NR_HUGE;
711 cbbox.x1 = cbbox.y1 = -NR_HUGE;
713 nr_path_matrix_bbox_union(&bp, transform, &cbbox);
715 if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX) {
717 SPStyle* style=SP_OBJECT_STYLE (item);
718 if (!style->stroke.isNone()) {
719 double const scale = expansion(transform);
720 if ( fabs(style->stroke_width.computed * scale) > 0.01 ) { // sinon c'est 0=oon veut pas de bord
721 double const width = MAX(0.125, style->stroke_width.computed * scale);
722 if ( fabs(cbbox.x1-cbbox.x0) > -0.00001 && fabs(cbbox.y1-cbbox.y0) > -0.00001 ) {
723 cbbox.x0-=0.5*width;
724 cbbox.x1+=0.5*width;
725 cbbox.y0-=0.5*width;
726 cbbox.y1+=0.5*width;
727 }
728 }
729 }
731 // Union with bboxes of the markers, if any
732 if (sp_shape_has_markers (shape)) {
733 for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
734 for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
735 if (sp_shape_marker_required (shape, m, bp)) {
737 SPMarker* marker = SP_MARKER (shape->marker[m]);
738 SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
740 NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
742 if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
743 tr = NR::scale(style->stroke_width.computed) * tr;
744 }
746 // total marker transform
747 tr = marker_item->transform * marker->c2p * tr * transform;
749 // get bbox of the marker with that transform
750 NRRect marker_bbox;
751 sp_item_invoke_bbox (marker_item, &marker_bbox, tr, true);
752 // union it with the shape bbox
753 nr_rect_d_union (&cbbox, &cbbox, &marker_bbox);
754 }
755 }
756 }
757 }
758 }
760 // copy our bbox to the variable we're given
761 *bbox = cbbox;
762 }
763 }
765 /**
766 * Prepares shape for printing. Handles printing of comments for printing
767 * debugging, sizes the item to fit into the document width/height,
768 * applies print fill/stroke, sets transforms for markers, and adds
769 * comment labels.
770 */
771 void
772 sp_shape_print (SPItem *item, SPPrintContext *ctx)
773 {
774 NRRect pbox, dbox, bbox;
776 SPShape *shape = SP_SHAPE(item);
778 if (!shape->curve) return;
780 gint add_comments = prefs_get_int_attribute_limited ("printing.debug", "add-label-comments", 0, 0, 1);
781 if (add_comments) {
782 gchar * comment = g_strdup_printf("begin '%s'",
783 SP_OBJECT(item)->defaultLabel());
784 sp_print_comment(ctx, comment);
785 g_free(comment);
786 }
788 /* fixme: Think (Lauris) */
789 sp_item_invoke_bbox(item, &pbox, NR::identity(), TRUE);
790 dbox.x0 = 0.0;
791 dbox.y0 = 0.0;
792 dbox.x1 = sp_document_width (SP_OBJECT_DOCUMENT (item));
793 dbox.y1 = sp_document_height (SP_OBJECT_DOCUMENT (item));
794 sp_item_bbox_desktop (item, &bbox);
795 NR::Matrix const i2d = sp_item_i2d_affine(item);
797 SPStyle* style = SP_OBJECT_STYLE (item);
799 if (!style->fill.isNone()) {
800 NRBPath bp;
801 bp.path = SP_CURVE_BPATH(shape->curve);
802 sp_print_fill (ctx, &bp, i2d, style, &pbox, &dbox, &bbox);
803 }
805 if (!style->stroke.isNone()) {
806 NRBPath bp;
807 bp.path = SP_CURVE_BPATH(shape->curve);
808 sp_print_stroke (ctx, &bp, i2d, style, &pbox, &dbox, &bbox);
809 }
811 for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
812 for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
813 if (sp_shape_marker_required (shape, m, bp)) {
815 SPMarker* marker = SP_MARKER (shape->marker[m]);
816 SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
818 NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
820 if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
821 tr = NR::scale(style->stroke_width.computed) * tr;
822 }
824 tr = marker_item->transform * marker->c2p * tr;
826 NR::Matrix old_tr = marker_item->transform;
827 marker_item->transform = tr;
828 sp_item_invoke_print (marker_item, ctx);
829 marker_item->transform = old_tr;
830 }
831 }
832 }
834 if (add_comments) {
835 gchar * comment = g_strdup_printf("end '%s'",
836 SP_OBJECT(item)->defaultLabel());
837 sp_print_comment(ctx, comment);
838 g_free(comment);
839 }
840 }
842 /**
843 * Sets style, path, and paintbox. Updates marker views, including dimensions.
844 */
845 static NRArenaItem *
846 sp_shape_show (SPItem *item, NRArena *arena, unsigned int /*key*/, unsigned int /*flags*/)
847 {
848 SPObject *object = SP_OBJECT(item);
849 SPShape *shape = SP_SHAPE(item);
851 NRArenaItem *arenaitem = NRArenaShape::create(arena);
852 NRArenaShape * const s = NR_ARENA_SHAPE(arenaitem);
853 nr_arena_shape_set_style(s, object->style);
854 nr_arena_shape_set_path(s, shape->curve, false);
855 NR::Maybe<NR::Rect> paintbox = item->getBounds(NR::identity());
856 if (paintbox) {
857 s->setPaintBox(*paintbox);
858 }
860 if (sp_shape_has_markers (shape)) {
862 /* Dimension the marker views */
863 if (!arenaitem->key) {
864 NR_ARENA_ITEM_SET_KEY (arenaitem, sp_item_display_key_new (SP_MARKER_LOC_QTY));
865 }
867 for (int i = 0; i < SP_MARKER_LOC_QTY; i++) {
868 if (shape->marker[i]) {
869 sp_marker_show_dimension ((SPMarker *) shape->marker[i],
870 NR_ARENA_ITEM_GET_KEY (arenaitem) + i - SP_MARKER_LOC,
871 sp_shape_number_of_markers (shape, i));
872 }
873 }
876 /* Update marker views */
877 sp_shape_update_marker_view (shape, arenaitem);
878 }
880 return arenaitem;
881 }
883 /**
884 * Hides/removes marker views from the shape.
885 */
886 static void
887 sp_shape_hide (SPItem *item, unsigned int key)
888 {
889 SPShape *shape;
890 SPItemView *v;
891 int i;
893 shape = (SPShape *) item;
895 for (i=0; i<SP_MARKER_LOC_QTY; i++) {
896 if (shape->marker[i]) {
897 for (v = item->display; v != NULL; v = v->next) {
898 if (key == v->key) {
899 sp_marker_hide ((SPMarker *) shape->marker[i],
900 NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
901 }
902 }
903 }
904 }
906 if (((SPItemClass *) parent_class)->hide) {
907 ((SPItemClass *) parent_class)->hide (item, key);
908 }
909 }
911 /**
912 * \param shape Shape.
913 * \return TRUE if the shape has any markers, or FALSE if not.
914 */
915 int
916 sp_shape_has_markers (SPShape const *shape)
917 {
918 /* Note, we're ignoring 'marker' settings, which technically should apply for
919 all three settings. This should be fixed later such that if 'marker' is
920 specified, then all three should appear. */
922 return (
923 shape->curve &&
924 (shape->marker[SP_MARKER_LOC_START] ||
925 shape->marker[SP_MARKER_LOC_MID] ||
926 shape->marker[SP_MARKER_LOC_END])
927 );
928 }
931 /**
932 * \param shape Shape.
933 * \param type Marker type (e.g. SP_MARKER_LOC_START)
934 * \return Number of markers that the shape has of this type.
935 */
936 int
937 sp_shape_number_of_markers (SPShape *shape, int type)
938 {
939 int n = 0;
940 for (NArtBpath* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
941 if (sp_shape_marker_required (shape, type, bp)) {
942 n++;
943 }
944 }
946 return n;
947 }
949 /**
950 * Checks if the given marker is used in the shape, and if so, it
951 * releases it by calling sp_marker_hide. Also detaches signals
952 * and unrefs the marker from the shape.
953 */
954 static void
955 sp_shape_marker_release (SPObject *marker, SPShape *shape)
956 {
957 SPItem *item;
958 int i;
960 item = (SPItem *) shape;
962 for (i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
963 if (marker == shape->marker[i]) {
964 SPItemView *v;
965 /* Hide marker */
966 for (v = item->display; v != NULL; v = v->next) {
967 sp_marker_hide ((SPMarker *) (shape->marker[i]), NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
968 /* fixme: Do we need explicit remove here? (Lauris) */
969 /* nr_arena_item_set_mask (v->arenaitem, NULL); */
970 }
971 /* Detach marker */
972 sp_signal_disconnect_by_data (shape->marker[i], item);
973 shape->marker[i] = sp_object_hunref (shape->marker[i], item);
974 }
975 }
976 }
978 /**
979 * No-op. Exists for handling 'modified' messages
980 */
981 static void
982 sp_shape_marker_modified (SPObject */*marker*/, guint /*flags*/, SPItem */*item*/)
983 {
984 /* I think mask does update automagically */
985 /* g_warning ("Item %s mask %s modified", SP_OBJECT_ID (item), SP_OBJECT_ID (mask)); */
986 }
988 /**
989 * Adds a new marker to shape object at the location indicated by key. value
990 * must be a valid URI reference resolvable from the shape object (i.e., present
991 * in the document <defs>). If the shape object already has a marker
992 * registered at the given position, it is removed first. Then the
993 * new marker is hrefed and its signals connected.
994 */
995 void
996 sp_shape_set_marker (SPObject *object, unsigned int key, const gchar *value)
997 {
998 SPItem *item = (SPItem *) object;
999 SPShape *shape = (SPShape *) object;
1001 if (key < SP_MARKER_LOC_START || key > SP_MARKER_LOC_END) {
1002 return;
1003 }
1005 SPObject *mrk = sp_css_uri_reference_resolve (SP_OBJECT_DOCUMENT (object), value);
1006 if (mrk != shape->marker[key]) {
1007 if (shape->marker[key]) {
1008 SPItemView *v;
1010 /* Detach marker */
1011 shape->release_connect[key].disconnect();
1012 shape->modified_connect[key].disconnect();
1014 /* Hide marker */
1015 for (v = item->display; v != NULL; v = v->next) {
1016 sp_marker_hide ((SPMarker *) (shape->marker[key]),
1017 NR_ARENA_ITEM_GET_KEY (v->arenaitem) + key);
1018 /* fixme: Do we need explicit remove here? (Lauris) */
1019 /* nr_arena_item_set_mask (v->arenaitem, NULL); */
1020 }
1022 /* Unref marker */
1023 shape->marker[key] = sp_object_hunref (shape->marker[key], object);
1024 }
1025 if (SP_IS_MARKER (mrk)) {
1026 shape->marker[key] = sp_object_href (mrk, object);
1027 shape->release_connect[key] = mrk->connectRelease(sigc::bind<1>(sigc::ptr_fun(&sp_shape_marker_release), shape));
1028 shape->modified_connect[key] = mrk->connectModified(sigc::bind<2>(sigc::ptr_fun(&sp_shape_marker_modified), shape));
1029 }
1030 }
1031 }
1035 /* Shape section */
1037 /**
1038 * Calls any registered handlers for the set_shape action
1039 */
1040 void
1041 sp_shape_set_shape (SPShape *shape)
1042 {
1043 g_return_if_fail (shape != NULL);
1044 g_return_if_fail (SP_IS_SHAPE (shape));
1046 if (SP_SHAPE_CLASS (G_OBJECT_GET_CLASS (shape))->set_shape) {
1047 SP_SHAPE_CLASS (G_OBJECT_GET_CLASS (shape))->set_shape (shape);
1048 }
1049 }
1051 /**
1052 * Adds a curve to the shape. If owner is specified, a reference
1053 * will be made, otherwise the curve will be copied into the shape.
1054 * Any existing curve in the shape will be unreferenced first.
1055 * This routine also triggers a request to update the display.
1056 */
1057 void
1058 sp_shape_set_curve (SPShape *shape, SPCurve *curve, unsigned int owner)
1059 {
1060 if (shape->curve) {
1061 shape->curve = sp_curve_unref (shape->curve);
1062 }
1063 if (curve) {
1064 if (owner) {
1065 shape->curve = sp_curve_ref (curve);
1066 } else {
1067 shape->curve = sp_curve_copy (curve);
1068 }
1069 }
1070 SP_OBJECT(shape)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
1071 }
1073 /**
1074 * Return duplicate of curve (if any exists) or NULL if there is no curve
1075 */
1076 SPCurve *
1077 sp_shape_get_curve (SPShape *shape)
1078 {
1079 if (shape->curve) {
1080 return sp_curve_copy (shape->curve);
1081 }
1082 return NULL;
1083 }
1085 /* NOT FOR GENERAL PUBLIC UNTIL SORTED OUT (Lauris) */
1086 void
1087 sp_shape_set_curve_insync (SPShape *shape, SPCurve *curve, unsigned int owner)
1088 {
1089 if (shape->curve) {
1090 shape->curve = sp_curve_unref (shape->curve);
1091 }
1092 if (curve) {
1093 if (owner) {
1094 shape->curve = sp_curve_ref (curve);
1095 } else {
1096 shape->curve = sp_curve_copy (curve);
1097 }
1098 }
1099 }
1101 /**
1102 * Return all nodes in a path that are to be considered for snapping
1103 */
1104 static void sp_shape_snappoints(SPItem const *item, SnapPointsIter p)
1105 {
1106 g_assert(item != NULL);
1107 g_assert(SP_IS_SHAPE(item));
1109 SPShape const *shape = SP_SHAPE(item);
1110 if (shape->curve == NULL) {
1111 return;
1112 }
1114 NR::Matrix const i2d (sp_item_i2d_affine (item));
1115 NArtBpath const *b = SP_CURVE_BPATH(shape->curve);
1117 // Cycle through the nodes in the concatenated subpaths
1118 while (b->code != NR_END) {
1119 NR::Point pos = b->c(3) * i2d; // this is the current node
1121 // NR_MOVETO Indicates the start of a closed subpath, see nr-path-code.h
1122 // If we're looking at a closed subpath, then we can skip this first
1123 // point of the subpath because it's coincident with the last point.
1124 if (b->code != NR_MOVETO) {
1125 if (b->code == NR_MOVETO_OPEN || b->code == NR_LINETO || b[1].code == NR_LINETO || b[1].code == NR_END) {
1126 // end points of a line segment are always considered for snapping
1127 *p = pos;
1128 } else {
1129 // g_assert(b->code == NR_CURVETO);
1130 NR::Point ppos, npos;
1131 ppos = b->code == NR_CURVETO ? b->c(2) * i2d : pos; // backward handle
1132 npos = b[1].code == NR_CURVETO ? b[1].c(1) * i2d : pos; // forward handle
1133 // Determine whether a node is at a smooth part of the path, by
1134 // calculating a measure for the collinearity of the handles
1135 bool c1 = fabs (Inkscape::Util::triangle_area (pos, ppos, npos)) < 1; // points are (almost) collinear
1136 bool c2 = NR::L2(pos - ppos) < 1e-6 || NR::L2(pos - npos) < 1e-6; // endnode, or a node with a retracted handle
1137 if (!(c1 & !c2)) {
1138 *p = pos; // only return non-smooth nodes ("cusps")
1139 }
1140 }
1141 }
1143 b++;
1144 }
1145 }
1148 LivePathEffectObject *
1149 sp_shape_get_livepatheffectobject(SPShape *shape) {
1150 if (!shape) return NULL;
1152 if (sp_shape_has_path_effect(shape)) {
1153 return shape->path_effect_ref->lpeobject;
1154 } else {
1155 return NULL;
1156 }
1157 }
1159 Inkscape::LivePathEffect::Effect *
1160 sp_shape_get_livepatheffect(SPShape *shape) {
1161 if (!shape) return NULL;
1163 LivePathEffectObject * lpeobj = sp_shape_get_livepatheffectobject(shape);
1164 if (lpeobj)
1165 return lpeobj->lpe;
1166 else
1167 return NULL;
1168 }
1170 /**
1171 * Calls any registered handlers for the update_patheffect action
1172 */
1173 void
1174 sp_shape_update_patheffect (SPShape *shape, bool write)
1175 {
1176 #ifdef SHAPE_VERBOSE
1177 g_message("sp_shape_update_patheffect: %p\n", shape);
1178 #endif
1179 g_return_if_fail (shape != NULL);
1180 g_return_if_fail (SP_IS_SHAPE (shape));
1182 if (SP_SHAPE_CLASS (G_OBJECT_GET_CLASS (shape))->update_patheffect) {
1183 SP_SHAPE_CLASS (G_OBJECT_GET_CLASS (shape))->update_patheffect (shape, write);
1184 }
1185 }
1187 void sp_shape_perform_path_effect(SPCurve *curve, SPShape *shape) {
1188 if (!shape) return;
1189 if (!curve) return;
1191 LivePathEffectObject *lpeobj = sp_shape_get_livepatheffectobject(shape);
1192 if (lpeobj && lpeobj->lpe) {
1193 lpeobj->lpe->doEffect(curve);
1194 }
1195 }
1197 /**
1198 * Gets called when (re)attached to another lpeobject.
1199 */
1200 static void
1201 lpeobject_ref_changed(SPObject *old_ref, SPObject *ref, SPShape *shape)
1202 {
1203 if (old_ref) {
1204 sp_signal_disconnect_by_data(old_ref, shape);
1205 }
1206 if ( IS_LIVEPATHEFFECT(ref) && ref != shape )
1207 {
1208 shape->lpe_modified_connection.disconnect();
1209 shape->lpe_modified_connection = ref->connectModified(sigc::bind(sigc::ptr_fun(&lpeobject_ref_modified), shape));
1210 lpeobject_ref_modified(ref, 0, shape);
1211 }
1212 }
1214 /**
1215 * Gets called when lpeobject repr contents change: i.e. parameter change.
1216 */
1217 static void
1218 lpeobject_ref_modified(SPObject */*href*/, guint /*flags*/, SPShape *shape)
1219 {
1220 sp_shape_update_patheffect (shape, true);
1221 }
1223 void sp_shape_set_path_effect(SPShape *shape, gchar *value)
1224 {
1225 if (!value) {
1226 sp_shape_remove_path_effect(shape);
1227 } else {
1228 SP_OBJECT_REPR(shape)->setAttribute("inkscape:path-effect", value);
1229 }
1230 }
1232 void sp_shape_set_path_effect(SPShape *shape, LivePathEffectObject * new_lpeobj)
1233 {
1234 const gchar * repr_id = SP_OBJECT_REPR(new_lpeobj)->attribute("id");
1235 gchar *hrefstr = g_strdup_printf("#%s", repr_id);
1236 sp_shape_set_path_effect(shape, hrefstr);
1237 g_free(hrefstr);
1238 }
1240 void sp_shape_remove_path_effect(SPShape *shape)
1241 {
1242 Inkscape::XML::Node *repr = SP_OBJECT_REPR(shape);
1243 repr->setAttribute("inkscape:path-effect", NULL);
1244 if (SP_IS_PATH(shape)) {
1245 repr->setAttribute("d", repr->attribute("inkscape:original-d"));
1246 repr->setAttribute("inkscape:original-d", NULL);
1247 }
1248 }
1250 bool sp_shape_has_path_effect(SPShape *shape)
1251 {
1252 return (shape->path_effect_href != NULL);
1253 }
1255 void sp_shape_edit_next_param_oncanvas(SPShape *shape, SPDesktop *dt)
1256 {
1257 LivePathEffectObject *lpeobj = sp_shape_get_livepatheffectobject(shape);
1258 if (lpeobj && lpeobj->lpe) {
1259 lpeobj->lpe->editNextParamOncanvas(SP_ITEM(shape), dt);
1260 }
1261 }
1263 /*
1264 Local Variables:
1265 mode:c++
1266 c-file-style:"stroustrup"
1267 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1268 indent-tabs-mode:nil
1269 fill-column:99
1270 End:
1271 */
1272 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :