src/sp-shape.cpp

   1 /*
   2  * Base class for shapes, including <path> element
   3  *
   4  * Author:
   5  *   Lauris Kaplinski <lauris@kaplinski.com>
   6  *
   7  * Copyright (C) 1999-2002 Lauris Kaplinski
   8  * Copyright (C) 2000-2001 Ximian, Inc.
   9  * Copyright (C) 2004 John Cliff
  10  * Copyright (C) 2007-2008 Johan Engelen
  11  *
  12  * Released under GNU GPL, read the file 'COPYING' for more information
  13  */
  14
  15 #ifdef HAVE_CONFIG_H
  16 # include "config.h"
  17 #endif
  18
  19 #include <libnr/n-art-bpath.h>
  20 #include <libnr/nr-matrix-fns.h>
  21 #include <libnr/nr-matrix-ops.h>
  22 #include <libnr/nr-matrix-translate-ops.h>
  23 #include <libnr/nr-scale-matrix-ops.h>
  24 #include <2geom/rect.h>
  25 #include <2geom/transforms.h>
  26 #include <2geom/pathvector.h>
  27 #include "helper/geom.h"
  28
  29 #include <sigc++/functors/ptr_fun.h>
  30 #include <sigc++/adaptors/bind.h>
  31
  32 #include "macros.h"
  33 #include "display/nr-arena-shape.h"
  34 #include "display/curve.h"
  35 #include "print.h"
  36 #include "document.h"
  37 #include "style.h"
  38 #include "marker.h"
  39 #include "sp-path.h"
  40 #include "prefs-utils.h"
  41 #include "attributes.h"
  42
  43 #include "live_effects/lpeobject.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"
  49
  50 #include "util/mathfns.h" // for triangle_area()
  51
  52 #define noSHAPE_VERBOSE
  53
  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);
  57
  58 static void sp_shape_build (SPObject * object, SPDocument * document, Inkscape::XML::Node * repr);
  59 static void sp_shape_release (SPObject *object);
  60
  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::Document *doc, Inkscape::XML::Node *repr, guint flags);
  65
  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);
  71
  72 static void sp_shape_update_marker_view (SPShape *shape, NRArenaItem *ai);
  73
  74 static SPLPEItemClass *parent_class;
  75
  76 /**
  77  * Registers the SPShape class with Gdk and returns its type number.
  78  */
  79 GType
  80 sp_shape_get_type (void)
  81 {
  82         static GType type = 0;
  83         if (!type) {
  84                 GTypeInfo info = {
  85                         sizeof (SPShapeClass),
  86                         NULL, NULL,
  87                         (GClassInitFunc) sp_shape_class_init,
  88                         NULL, NULL,
  89                         sizeof (SPShape),
  90                         16,
  91                         (GInstanceInitFunc) sp_shape_init,
  92                         NULL,   /* value_table */
  93                 };
  94                 type = g_type_register_static (SP_TYPE_LPE_ITEM, "SPShape", &info, (GTypeFlags)0);
  95         }
  96         return type;
  97 }
  98
  99 /**
 100  * Initializes a SPShapeClass object.  Establishes the function pointers to the class'
 101  * member routines in the class vtable, and sets pointers to parent classes.
 102  */
 103 static void
 104 sp_shape_class_init (SPShapeClass *klass)
 105 {
 106     GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
 107     SPObjectClass *sp_object_class = SP_OBJECT_CLASS(klass);
 108     SPItemClass * item_class = SP_ITEM_CLASS(klass);
 109     SPLPEItemClass * lpe_item_class = SP_LPE_ITEM_CLASS(klass);
 110
 111     parent_class = (SPLPEItemClass *)g_type_class_peek_parent (klass);
 112
 113     gobject_class->finalize = sp_shape_finalize;
 114
 115         sp_object_class->build = sp_shape_build;
 116         sp_object_class->release = sp_shape_release;
 117     sp_object_class->set = sp_shape_set;
 118         sp_object_class->update = sp_shape_update;
 119         sp_object_class->modified = sp_shape_modified;
 120     sp_object_class->write = sp_shape_write;
 121
 122         item_class->bbox = sp_shape_bbox;
 123         item_class->print = sp_shape_print;
 124         item_class->show = sp_shape_show;
 125         item_class->hide = sp_shape_hide;
 126     item_class->snappoints = sp_shape_snappoints;
 127     lpe_item_class->update_patheffect = NULL;
 128
 129     klass->set_shape = NULL;
 130 }
 131
 132 /**
 133  * Initializes an SPShape object.
 134  */
 135 static void
 136 sp_shape_init (SPShape *shape)
 137 {
 138     for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
 139         new (&shape->release_connect[i]) sigc::connection();
 140         new (&shape->modified_connect[i]) sigc::connection();
 141     }
 142 }
 143
 144 static void
 145 sp_shape_finalize (GObject *object)
 146 {
 147     SPShape *shape=(SPShape *)object;
 148
 149     for ( int i = 0 ; i < SP_MARKER_LOC_QTY ; i++ ) {
 150         shape->release_connect[i].disconnect();
 151         shape->release_connect[i].~connection();
 152         shape->modified_connect[i].disconnect();
 153         shape->modified_connect[i].~connection();
 154     }
 155
 156     if (((GObjectClass *) (parent_class))->finalize) {
 157         (* ((GObjectClass *) (parent_class))->finalize)(object);
 158     }
 159 }
 160
 161 /**
 162  * Virtual build callback for SPMarker.
 163  *
 164  * This is to be invoked immediately after creation of an SPShape.
 165  *
 166  * \see sp_object_build()
 167  */
 168 static void
 169 sp_shape_build (SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
 170 {
 171     if (((SPObjectClass *) (parent_class))->build) {
 172        (*((SPObjectClass *) (parent_class))->build) (object, document, repr);
 173     }
 174 }
 175
 176 /**
 177  * Removes, releases and unrefs all children of object
 178  *
 179  * This is the inverse of sp_shape_build().  It must be invoked as soon
 180  * as the shape is removed from the tree, even if it is still referenced
 181  * by other objects.  This routine also disconnects/unrefs markers and
 182  * curves attached to it.
 183  *
 184  * \see sp_object_release()
 185  */
 186 static void
 187 sp_shape_release (SPObject *object)
 188 {
 189         SPItem *item;
 190         SPShape *shape;
 191         SPItemView *v;
 192         int i;
 193
 194         item = (SPItem *) object;
 195         shape = (SPShape *) object;
 196
 197         for (i=SP_MARKER_LOC_START; i<SP_MARKER_LOC_QTY; i++) {
 198           if (shape->marker[i]) {
 199             sp_signal_disconnect_by_data (shape->marker[i], object);
 200             for (v = item->display; v != NULL; v = v->next) {
 201               sp_marker_hide ((SPMarker *) shape->marker[i], NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
 202             }
 203             shape->marker[i] = sp_object_hunref (shape->marker[i], object);
 204           }
 205         }
 206         if (shape->curve) {
 207                 shape->curve = shape->curve->unref();
 208         }
 209
 210         if (((SPObjectClass *) parent_class)->release) {
 211           ((SPObjectClass *) parent_class)->release (object);
 212         }
 213 }
 214
 215
 216
 217 static void
 218 sp_shape_set(SPObject *object, unsigned int key, gchar const *value)
 219 {
 220     if (((SPObjectClass *) parent_class)->set) {
 221         ((SPObjectClass *) parent_class)->set(object, key, value);
 222     }
 223 }
 224
 225 static Inkscape::XML::Node *
 226 sp_shape_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags)
 227 {
 228     if (((SPObjectClass *)(parent_class))->write) {
 229         ((SPObjectClass *)(parent_class))->write(object, doc, repr, flags);
 230     }
 231
 232     return repr;
 233 }
 234
 235 /**
 236  * Updates the shape when its attributes have changed.  Also establishes
 237  * marker objects to match the style settings.
 238  */
 239 static void
 240 sp_shape_update (SPObject *object, SPCtx *ctx, unsigned int flags)
 241 {
 242     SPItem *item = (SPItem *) object;
 243     SPShape *shape = (SPShape *) object;
 244
 245         if (((SPObjectClass *) (parent_class))->update) {
 246           (* ((SPObjectClass *) (parent_class))->update) (object, ctx, flags);
 247         }
 248
 249         /* This stanza checks that an object's marker style agrees with
 250          * the marker objects it has allocated.  sp_shape_set_marker ensures
 251          * that the appropriate marker objects are present (or absent) to
 252          * match the style.
 253          */
 254         /* TODO:  It would be nice if this could be done at an earlier level */
 255         for (int i = 0 ; i < SP_MARKER_LOC_QTY ; i++) {
 256             sp_shape_set_marker (object, i, object->style->marker[i].value);
 257           }
 258
 259         if (flags & (SP_OBJECT_STYLE_MODIFIED_FLAG | SP_OBJECT_VIEWPORT_MODIFIED_FLAG)) {
 260                 SPStyle *style;
 261                 style = SP_OBJECT_STYLE (object);
 262                 if (style->stroke_width.unit == SP_CSS_UNIT_PERCENT) {
 263                         SPItemCtx *ictx = (SPItemCtx *) ctx;
 264                         double const aw = 1.0 / NR::expansion(ictx->i2vp);
 265                         style->stroke_width.computed = style->stroke_width.value * aw;
 266                         for (SPItemView *v = ((SPItem *) (shape))->display; v != NULL; v = v->next) {
 267                                 nr_arena_shape_set_style ((NRArenaShape *) v->arenaitem, style);
 268                         }
 269                 }
 270         }
 271
 272         if (flags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_PARENT_MODIFIED_FLAG)) {
 273                 /* This is suboptimal, because changing parent style schedules recalculation */
 274                 /* But on the other hand - how can we know that parent does not tie style and transform */
 275                 NR::Maybe<NR::Rect> paintbox = SP_ITEM(object)->getBounds(NR::identity());
 276                 for (SPItemView *v = SP_ITEM (shape)->display; v != NULL; v = v->next) {
 277                     NRArenaShape * const s = NR_ARENA_SHAPE(v->arenaitem);
 278                     if (flags & SP_OBJECT_MODIFIED_FLAG) {
 279                         nr_arena_shape_set_path(s, shape->curve, (flags & SP_OBJECT_USER_MODIFIED_FLAG_B));
 280                     }
 281                     if (paintbox) {
 282                         s->setPaintBox(*paintbox);
 283                     }
 284                 }
 285         }
 286
 287         if (sp_shape_has_markers (shape)) {
 288
 289             /* Dimension marker views */
 290             for (SPItemView *v = item->display; v != NULL; v = v->next) {
 291
 292                 if (!v->arenaitem->key) {
 293                     /* Get enough keys for all, start, mid and end marker types,
 294                     ** and set this view's arenaitem key to the first of these keys.
 295                     */
 296                     NR_ARENA_ITEM_SET_KEY (
 297                         v->arenaitem,
 298                         sp_item_display_key_new (SP_MARKER_LOC_QTY)
 299                         );
 300                 }
 301
 302                 for (int i = 0 ; i < SP_MARKER_LOC_QTY ; i++) {
 303                     if (shape->marker[i]) {
 304                         sp_marker_show_dimension ((SPMarker *) shape->marker[i],
 305                                                   NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i - SP_MARKER_LOC,
 306                                                   sp_shape_number_of_markers (shape, i));
 307                     }
 308                 }
 309             }
 310
 311             /* Update marker views */
 312             for (SPItemView *v = item->display; v != NULL; v = v->next) {
 313                 sp_shape_update_marker_view (shape, v->arenaitem);
 314             }
 315         }
 316 }
 317
 318
 319 /**
 320 * Works out whether a marker of a given type is required at a particular
 321 * point on a shape.
 322 *
 323 * \param shape Shape of interest.
 324 * \param m Marker type (e.g. SP_MARKER_LOC_START)
 325 * \param bp Path segment.
 326 * \return 1 if a marker is required here, otherwise 0.
 327 */
 328 bool
 329 sp_shape_marker_required(SPShape const *shape, int const m, NArtBpath const *bp)
 330 {
 331     if (shape->marker[m] == NULL) {
 332         return false;
 333     }
 334
 335     if (bp == SP_CURVE_BPATH(shape->curve))
 336         return m == SP_MARKER_LOC_START;
 337     else if (bp[1].code == NR_END)
 338         return m == SP_MARKER_LOC_END;
 339     else
 340         return m == SP_MARKER_LOC_MID;
 341 }
 342
 343 static bool
 344 is_moveto(NRPathcode const c)
 345 {
 346     return c == NR_MOVETO || c == NR_MOVETO_OPEN;
 347 }
 348
 349 /**
 350  * Helper function that advances a subpath's bpath to the first subpath
 351  * by checking for moveto segments.
 352  *
 353  * \pre The bpath[] containing bp begins with a moveto.
 354  */
 355 static NArtBpath const *
 356 first_seg_in_subpath(NArtBpath const *bp)
 357 {
 358     while (!is_moveto(bp->code)) {
 359         --bp;
 360     }
 361     return bp;
 362 }
 363
 364 /**
 365  * Advances the bpath to the last segment in the subpath.
 366  */
 367 static NArtBpath const *
 368 last_seg_in_subpath(NArtBpath const *bp)
 369 {
 370     for(;;) {
 371         ++bp;
 372         switch (bp->code) {
 373             case NR_MOVETO:
 374             case NR_MOVETO_OPEN:
 375             case NR_END:
 376                 --bp;
 377                 return bp;
 378
 379             default: continue;
 380         }
 381     }
 382 }
 383
 384
 385 /* A subpath begins with a moveto and ends immediately before the next moveto or NR_END.
 386  * (`moveto' here means either NR_MOVETO or NR_MOVETO_OPEN.)  I'm assuming that non-empty
 387  * paths always begin with a moveto.
 388  *
 389  * The control points of the subpath are the control points of the path elements of the subpath.
 390  *
 391  * As usual, the control points of a moveto or NR_LINETO are {c(3)}, and
 392  * the control points of a NR_CURVETO are {c(1), c(2), c(3)}.
 393  * (It follows from the definition that NR_END isn't part of a subpath.)
 394  *
 395  * The initial control point is bpath[bi0].c(3).
 396  *
 397  * Reference: http://www.w3.org/TR/SVG11/painting.html#MarkerElement, the `orient' attribute.
 398  * Reference for behaviour of zero-length segments:
 399  * http://www.w3.org/TR/SVG11/implnote.html#PathElementImplementationNotes
 400  */
 401
 402 static double const no_tangent = 128.0;  /* arbitrarily-chosen value outside the range of atan2,
 403                                           * i.e. outside of [-pi, pi]. This value is incremented by
 404                                           * 1 and checked using > to be safe from floating-point
 405                                           * equality comparison madness.*/
 406
 407 /**
 408  * Helper function to calculate the outgoing tangent of a path
 409  * ( atan2(other - p0) )
 410  * \pre The bpath[] containing bp0 begins with a moveto.
 411  */
 412 static double
 413 outgoing_tangent(NArtBpath const *bp0)
 414 {
 415     /* See notes in comment block above. */
 416
 417     g_assert(bp0->code != NR_END);
 418     NR::Point const &p0 = bp0->c(3);
 419     NR::Point other;
 420     for (NArtBpath const *bp = bp0;;) {
 421         ++bp;
 422         switch (bp->code) {
 423             case NR_LINETO:
 424                 other = bp->c(3);
 425                 if (other != p0) {
 426                     goto found;
 427                 }
 428                 break;
 429
 430             case NR_CURVETO:
 431                 for (unsigned ci = 1; ci <= 3; ++ci) {
 432                     other = bp->c(ci);
 433                     if (other != p0) {
 434                         goto found;
 435                     }
 436                 }
 437                 break;
 438
 439             case NR_MOVETO_OPEN:
 440             case NR_END:
 441             case NR_MOVETO:
 442                 bp = first_seg_in_subpath(bp0);
 443                 if (bp == bp0) {
 444                     /* Gone right around the subpath without finding any different point since the
 445                      * initial moveto. */
 446                     return no_tangent + 1;
 447                 }
 448                 if (bp->code != NR_MOVETO) {
 449                     /* Open subpath. */
 450                     return no_tangent + 1;
 451                 }
 452                 other = bp->c(3);
 453                 if (other != p0) {
 454                     goto found;
 455                 }
 456                 break;
 457         }
 458
 459         if (bp == bp0) {
 460             /* Back where we started, so zero-length subpath. */
 461             return no_tangent + 1;
 462
 463             /* Note: this test must come after we've looked at element bp, in case bp0 is a curve:
 464              * we must look at c(1) and c(2).  (E.g. single-curve subpath.)
 465              */
 466         }
 467     }
 468
 469 found:
 470     return atan2( other - p0 );
 471 }
 472
 473 /**
 474  * Helper function to calculate the incoming tangent of a path
 475  * ( atan2(p0 - other) )
 476  *
 477  * \pre The bpath[] containing bp0 begins with a moveto.
 478  */
 479 static double
 480 incoming_tangent(NArtBpath const *bp0)
 481 {
 482     /* See notes in comment block before outgoing_tangent. */
 483
 484     g_assert(bp0->code != NR_END);
 485     NR::Point const &p0 = bp0->c(3);
 486     NR::Point other;
 487     for (NArtBpath const *bp = bp0;;) {
 488         switch (bp->code) {
 489             case NR_LINETO:
 490                 other = bp->c(3);
 491                 if (other != p0) {
 492                     goto found;
 493                 }
 494                 --bp;
 495                 break;
 496
 497             case NR_CURVETO:
 498                 for (unsigned ci = 3; ci != 0; --ci) {
 499                     other = bp->c(ci);
 500                     if (other != p0) {
 501                         goto found;
 502                     }
 503                 }
 504                 --bp;
 505                 break;
 506
 507             case NR_MOVETO:
 508             case NR_MOVETO_OPEN:
 509                 other = bp->c(3);
 510                 if (other != p0) {
 511                     goto found;
 512                 }
 513                 if (bp->code != NR_MOVETO) {
 514                     /* Open subpath. */
 515                     return no_tangent + 1;
 516                 }
 517                 bp = last_seg_in_subpath(bp0);
 518                 break;
 519
 520             default: /* includes NR_END */
 521                 g_error("Found invalid path code %u in middle of path.", bp->code);
 522                 return no_tangent + 1;
 523         }
 524
 525         if (bp == bp0) {
 526             /* Back where we started from: zero-length subpath. */
 527             return no_tangent + 1;
 528         }
 529     }
 530
 531 found:
 532     return atan2( p0 - other );
 533 }
 534
 535
 536 /**
 537  * Calculate the transform required to get a marker's path object in the
 538  * right place for particular path segment on a shape.  You should
 539  * call sp_shape_marker_required first to see if a marker is required
 540  * at this point.
 541  *
 542  * \see sp_shape_marker_required.
 543  *
 544  * \param shape Shape which the marker is for.
 545  * \param m Marker type (e.g. SP_MARKER_LOC_START)
 546  * \param bp Path segment which the arrow is for.
 547  * \return Transform matrix.
 548  */
 549 NR::Matrix
 550 sp_shape_marker_get_transform(SPShape const *shape, NArtBpath const *bp)
 551 {
 552     g_return_val_if_fail(( is_moveto(SP_CURVE_BPATH(shape->curve)[0].code)
 553                            && ( 0 < shape->curve->get_length() )
 554                            && ( SP_CURVE_BPATH(shape->curve)[shape->curve->get_length()].code == NR_END ) ),
 555                          NR::Matrix(NR::translate(bp->c(3))));
 556     double const angle1 = incoming_tangent(bp);
 557     double const angle2 = outgoing_tangent(bp);
 558
 559     double ret_angle;
 560     if (angle1 > no_tangent) {
 561         /* First vertex of an open subpath. */
 562         ret_angle = ( angle2 > no_tangent
 563                       ? 0.
 564                       : angle2 );
 565     } else if (angle2 > no_tangent) {
 566         /* Last vertex of an open subpath. */
 567         ret_angle = angle1;
 568     } else {
 569         ret_angle = .5 * (angle1 + angle2);
 570
 571         if ( fabs( angle2 - angle1 ) > M_PI ) {
 572             /* ret_angle is in the middle of the larger of the two sectors between angle1 and
 573              * angle2, so flip it by 180degrees to force it to the middle of the smaller sector.
 574              *
 575              * (Imagine a circle with rays drawn at angle1 and angle2 from the centre of the
 576              * circle.  Those two rays divide the circle into two sectors.)
 577              */
 578             ret_angle += M_PI;
 579         }
 580     }
 581
 582     return NR::Matrix(NR::rotate(ret_angle)) * NR::translate(bp->c(3));
 583 }
 584
 585 /**
 586  * Calculate the transform required to get a marker's path object in the
 587  * right place for particular path segment on a shape.
 588  *
 589  * \see sp_shape_marker_update_marker_view.
 590  *
 591  * \param p Point where the marker should be placed.
 592  * \param t1 Tangent of end of curvesegment before marker
 593  * \param t2 Tangent of start of curvesegment after marker
 594  * \return Transform matrix.
 595  *
 596  * From SVG spec:
 597  * The axes of the temporary new user coordinate system are aligned according to the orient attribute on the 'marker'
 598  * element and the slope of the curve at the given vertex. (Note: if there is a discontinuity at a vertex, the slope
 599  * is the average of the slopes of the two segments of the curve that join at the given vertex. If a slope cannot be
 600  * determined, the slope is assumed to be zero.)
 601  */
 602 Geom::Matrix
 603 sp_shape_marker_get_transform(Geom::Point p, Geom::Point t1, Geom::Point t2)
 604 {
 605     double const angle1 = Geom::atan2(t1);
 606     double const angle2 = Geom::atan2(t2);
 607
 608     double ret_angle;
 609     ret_angle = .5 * (angle1 + angle2);
 610
 611     if ( fabs( angle2 - angle1 ) > M_PI ) {
 612         /* ret_angle is in the middle of the larger of the two sectors between angle1 and
 613          * angle2, so flip it by 180degrees to force it to the middle of the smaller sector.
 614          *
 615          * (Imagine a circle with rays drawn at angle1 and angle2 from the centre of the
 616          * circle.  Those two rays divide the circle into two sectors.)
 617          */
 618         ret_angle += M_PI;
 619     }
 620
 621     return Geom::Rotate(ret_angle) * Geom::Translate(p);
 622 }
 623
 624 /**
 625  * Updates the instances (views) of a given marker in a shape.
 626  * Marker views have to be scaled already.  The transformation
 627  * is retrieved and then shown by calling sp_marker_show_instance.
 628  *
 629  * TODO: correctly handle the 'marker' attribute.
 630  * "Using the marker property from a style sheet is equivalent to using all three (start, mid, end)."
 631  * See painting-marker-03-f.svg in SVG 1.1 Full test suite.
 632  */
 633 static void
 634 sp_shape_update_marker_view (SPShape *shape, NRArenaItem *ai)
 635 {
 636     SPStyle *style = ((SPObject *) shape)->style;
 637
 638     // position arguments to sp_marker_show_instance, basically counts the amount of markers.
 639     int start_pos = 0;
 640     int mid_pos = 0;
 641     int end_pos = 0;
 642
 643     Geom::PathVector const & pathv = shape->curve->get_pathvector();
 644     for(Geom::PathVector::const_iterator path_it = pathv.begin(); path_it != pathv.end(); ++path_it) {
 645         if ( shape->marker[SP_MARKER_LOC_START] ) {
 646             Geom::Point p = path_it->front().pointAt(0);
 647             Geom::Point tang = path_it->front().unitTangentAt(0);
 648             Geom::Matrix const m (sp_shape_marker_get_transform(p, tang, tang));
 649             sp_marker_show_instance ((SPMarker* ) shape->marker[SP_MARKER_LOC_START], ai,
 650                                      NR_ARENA_ITEM_GET_KEY(ai) + SP_MARKER_LOC_START, start_pos, m,
 651                                      style->stroke_width.computed);
 652              start_pos++;
 653         }
 654
 655         if ( shape->marker[SP_MARKER_LOC_MID] ) {
 656             Geom::Path::const_iterator curve_it1 = path_it->begin();      // incoming curve
 657             Geom::Path::const_iterator curve_it2 = ++(path_it->begin());  // outgoing curve
 658             while (curve_it2 != path_it->end_default())
 659             {
 660                 /* Put marker between curve_it1 and curve_it2.
 661                  * Loop to end_default (so including closing segment), because when a path is closed,
 662                  * there should be a midpoint marker between last segment and closing straight line segment
 663                  */
 664                 Geom::Point p = curve_it1->pointAt(1);
 665                 Geom::Point tang1 = curve_it1->unitTangentAt(1);
 666                 Geom::Point tang2 = curve_it2->unitTangentAt(0);
 667                 Geom::Matrix const m (sp_shape_marker_get_transform(p, tang1, tang2));
 668                 sp_marker_show_instance ((SPMarker* ) shape->marker[SP_MARKER_LOC_MID], ai,
 669                                          NR_ARENA_ITEM_GET_KEY(ai) + SP_MARKER_LOC_MID, mid_pos, m,
 670                                          style->stroke_width.computed);
 671                 mid_pos++;
 672
 673                 ++curve_it1;
 674                 ++curve_it2;
 675             }
 676         }
 677
 678         if ( shape->marker[SP_MARKER_LOC_END] ) {
 679             Geom::Point p = path_it->back_default().pointAt(1);
 680             Geom::Point tang = path_it->back_default().unitTangentAt(1);
 681             Geom::Matrix const m (sp_shape_marker_get_transform(p, tang, tang));
 682             sp_marker_show_instance ((SPMarker* ) shape->marker[SP_MARKER_LOC_END], ai,
 683                                      NR_ARENA_ITEM_GET_KEY(ai) + SP_MARKER_LOC_END, end_pos, m,
 684                                      style->stroke_width.computed);
 685             end_pos++;
 686         }
 687     }
 688 }
 689
 690 /**
 691  * Sets modified flag for all sub-item views.
 692  */
 693 static void
 694 sp_shape_modified (SPObject *object, unsigned int flags)
 695 {
 696         SPShape *shape = SP_SHAPE (object);
 697
 698         if (((SPObjectClass *) (parent_class))->modified) {
 699           (* ((SPObjectClass *) (parent_class))->modified) (object, flags);
 700         }
 701
 702         if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
 703                 for (SPItemView *v = SP_ITEM (shape)->display; v != NULL; v = v->next) {
 704                         nr_arena_shape_set_style (NR_ARENA_SHAPE (v->arenaitem), object->style);
 705                 }
 706         }
 707 }
 708
 709 /**
 710  * Calculates the bounding box for item, storing it into bbox.
 711  * This also includes the bounding boxes of any markers included in the shape.
 712  */
 713 static void sp_shape_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags)
 714 {
 715     SPShape const *shape = SP_SHAPE (item);
 716
 717     if (shape->curve) {
 718
 719         NRRect  cbbox;
 720
 721         Geom::Rect geombbox = bounds_exact_transformed(shape->curve->get_pathvector(), to_2geom(transform));
 722         cbbox.x0 = geombbox[0][0];
 723         cbbox.y0 = geombbox[1][0];
 724         cbbox.x1 = geombbox[0][1];
 725         cbbox.y1 = geombbox[1][1];
 726
 727         if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX) {
 728
 729             SPStyle* style=SP_OBJECT_STYLE (item);
 730             if (!style->stroke.isNone()) {
 731                 double const scale = expansion(transform);
 732                 if ( fabs(style->stroke_width.computed * scale) > 0.01 ) { // sinon c'est 0=oon veut pas de bord
 733                     double const width = MAX(0.125, style->stroke_width.computed * scale);
 734                     if ( fabs(cbbox.x1-cbbox.x0) > -0.00001 && fabs(cbbox.y1-cbbox.y0) > -0.00001 ) {
 735                         cbbox.x0-=0.5*width;
 736                         cbbox.x1+=0.5*width;
 737                         cbbox.y0-=0.5*width;
 738                         cbbox.y1+=0.5*width;
 739                     }
 740                 }
 741             }
 742
 743             // Union with bboxes of the markers, if any
 744             if (sp_shape_has_markers (shape)) {
 745                 for (NArtBpath const* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
 746                     for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
 747                         if (sp_shape_marker_required (shape, m, bp)) {
 748
 749                             SPMarker* marker = SP_MARKER (shape->marker[m]);
 750                             SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
 751
 752                             NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
 753
 754                             if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
 755                                 tr = NR::scale(style->stroke_width.computed) * tr;
 756                             }
 757
 758                             // total marker transform
 759                             tr = marker_item->transform * marker->c2p * tr * transform;
 760
 761                             // get bbox of the marker with that transform
 762                             NRRect marker_bbox;
 763                             sp_item_invoke_bbox (marker_item, &marker_bbox, tr, true);
 764                             // union it with the shape bbox
 765                             nr_rect_d_union (&cbbox, &cbbox, &marker_bbox);
 766                         }
 767                     }
 768                 }
 769             }
 770         }
 771
 772         // copy our bbox to the variable we're given
 773         *bbox = cbbox;
 774     }
 775 }
 776
 777 /**
 778  * Prepares shape for printing.  Handles printing of comments for printing
 779  * debugging, sizes the item to fit into the document width/height,
 780  * applies print fill/stroke, sets transforms for markers, and adds
 781  * comment labels.
 782  */
 783 void
 784 sp_shape_print (SPItem *item, SPPrintContext *ctx)
 785 {
 786         NRRect pbox, dbox, bbox;
 787
 788         SPShape *shape = SP_SHAPE(item);
 789
 790         if (!shape->curve) return;
 791
 792         gint add_comments = prefs_get_int_attribute_limited ("printing.debug", "add-label-comments", 0, 0, 1);
 793         if (add_comments) {
 794             gchar * comment = g_strdup_printf("begin '%s'",
 795                                               SP_OBJECT(item)->defaultLabel());
 796             sp_print_comment(ctx, comment);
 797             g_free(comment);
 798         }
 799
 800         /* fixme: Think (Lauris) */
 801         sp_item_invoke_bbox(item, &pbox, NR::identity(), TRUE);
 802         dbox.x0 = 0.0;
 803         dbox.y0 = 0.0;
 804         dbox.x1 = sp_document_width (SP_OBJECT_DOCUMENT (item));
 805         dbox.y1 = sp_document_height (SP_OBJECT_DOCUMENT (item));
 806         sp_item_bbox_desktop (item, &bbox);
 807         NR::Matrix const i2d = from_2geom(sp_item_i2d_affine(item));
 808
 809         SPStyle* style = SP_OBJECT_STYLE (item);
 810
 811     if (!style->fill.isNone()) {
 812         const_NRBPath bp;
 813         bp.path = SP_CURVE_BPATH(shape->curve);
 814         sp_print_fill (ctx, &bp, &i2d, style, &pbox, &dbox, &bbox);
 815     }
 816
 817     if (!style->stroke.isNone()) {
 818         const_NRBPath bp;
 819         bp.path = SP_CURVE_BPATH(shape->curve);
 820         sp_print_stroke (ctx, &bp, &i2d, style, &pbox, &dbox, &bbox);
 821     }
 822
 823         for (NArtBpath const* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
 824             for (int m = SP_MARKER_LOC_START; m < SP_MARKER_LOC_QTY; m++) {
 825                 if (sp_shape_marker_required (shape, m, bp)) {
 826
 827                     SPMarker* marker = SP_MARKER (shape->marker[m]);
 828                     SPItem* marker_item = sp_item_first_item_child (SP_OBJECT (shape->marker[m]));
 829
 830                     NR::Matrix tr(sp_shape_marker_get_transform(shape, bp));
 831
 832                     if (marker->markerUnits == SP_MARKER_UNITS_STROKEWIDTH) {
 833                         tr = NR::scale(style->stroke_width.computed) * tr;
 834                     }
 835
 836                     tr = marker_item->transform * marker->c2p * tr;
 837
 838                     NR::Matrix old_tr = marker_item->transform;
 839                     marker_item->transform = tr;
 840                     sp_item_invoke_print (marker_item, ctx);
 841                     marker_item->transform = old_tr;
 842                 }
 843             }
 844         }
 845
 846         if (add_comments) {
 847             gchar * comment = g_strdup_printf("end '%s'",
 848                                               SP_OBJECT(item)->defaultLabel());
 849             sp_print_comment(ctx, comment);
 850             g_free(comment);
 851         }
 852 }
 853
 854 /**
 855  * Sets style, path, and paintbox.  Updates marker views, including dimensions.
 856  */
 857 static NRArenaItem *
 858 sp_shape_show (SPItem *item, NRArena *arena, unsigned int /*key*/, unsigned int /*flags*/)
 859 {
 860         SPObject *object = SP_OBJECT(item);
 861         SPShape *shape = SP_SHAPE(item);
 862
 863         NRArenaItem *arenaitem = NRArenaShape::create(arena);
 864         NRArenaShape * const s = NR_ARENA_SHAPE(arenaitem);
 865         nr_arena_shape_set_style(s, object->style);
 866         nr_arena_shape_set_path(s, shape->curve, false);
 867         NR::Maybe<NR::Rect> paintbox = item->getBounds(NR::identity());
 868         if (paintbox) {
 869             s->setPaintBox(*paintbox);
 870         }
 871
 872         if (sp_shape_has_markers (shape)) {
 873
 874             /* Dimension the marker views */
 875             if (!arenaitem->key) {
 876                 NR_ARENA_ITEM_SET_KEY (arenaitem, sp_item_display_key_new (SP_MARKER_LOC_QTY));
 877             }
 878
 879             for (int i = 0; i < SP_MARKER_LOC_QTY; i++) {
 880                 if (shape->marker[i]) {
 881                     sp_marker_show_dimension ((SPMarker *) shape->marker[i],
 882                                               NR_ARENA_ITEM_GET_KEY (arenaitem) + i - SP_MARKER_LOC,
 883                                               sp_shape_number_of_markers (shape, i));
 884                 }
 885             }
 886
 887
 888             /* Update marker views */
 889             sp_shape_update_marker_view (shape, arenaitem);
 890         }
 891
 892         return arenaitem;
 893 }
 894
 895 /**
 896  * Hides/removes marker views from the shape.
 897  */
 898 static void
 899 sp_shape_hide (SPItem *item, unsigned int key)
 900 {
 901         SPShape *shape;
 902         SPItemView *v;
 903         int i;
 904
 905         shape = (SPShape *) item;
 906
 907         for (i=0; i<SP_MARKER_LOC_QTY; i++) {
 908           if (shape->marker[i]) {
 909             for (v = item->display; v != NULL; v = v->next) {
 910                 if (key == v->key) {
 911               sp_marker_hide ((SPMarker *) shape->marker[i],
 912                                     NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
 913                 }
 914             }
 915           }
 916         }
 917
 918         if (((SPItemClass *) parent_class)->hide) {
 919           ((SPItemClass *) parent_class)->hide (item, key);
 920         }
 921 }
 922
 923 /**
 924 * \param shape Shape.
 925 * \return TRUE if the shape has any markers, or FALSE if not.
 926 */
 927 int
 928 sp_shape_has_markers (SPShape const *shape)
 929 {
 930     /* Note, we're ignoring 'marker' settings, which technically should apply for
 931        all three settings.  This should be fixed later such that if 'marker' is
 932        specified, then all three should appear. */
 933
 934     return (
 935         shape->curve &&
 936         (shape->marker[SP_MARKER_LOC_START] ||
 937          shape->marker[SP_MARKER_LOC_MID] ||
 938          shape->marker[SP_MARKER_LOC_END])
 939         );
 940 }
 941
 942
 943 /**
 944 * \param shape Shape.
 945 * \param type Marker type (e.g. SP_MARKER_LOC_START)
 946 * \return Number of markers that the shape has of this type.
 947 */
 948 int
 949 sp_shape_number_of_markers (SPShape *shape, int type)
 950 {
 951     int n = 0;
 952     for (NArtBpath const* bp = SP_CURVE_BPATH(shape->curve); bp->code != NR_END; bp++) {
 953         if (sp_shape_marker_required (shape, type, bp)) {
 954             n++;
 955         }
 956     }
 957
 958     return n;
 959 }
 960
 961 /**
 962  * Checks if the given marker is used in the shape, and if so, it
 963  * releases it by calling sp_marker_hide.  Also detaches signals
 964  * and unrefs the marker from the shape.
 965  */
 966 static void
 967 sp_shape_marker_release (SPObject *marker, SPShape *shape)
 968 {
 969         SPItem *item;
 970         int i;
 971
 972         item = (SPItem *) shape;
 973
 974         for (i = SP_MARKER_LOC_START; i < SP_MARKER_LOC_QTY; i++) {
 975           if (marker == shape->marker[i]) {
 976             SPItemView *v;
 977             /* Hide marker */
 978             for (v = item->display; v != NULL; v = v->next) {
 979               sp_marker_hide ((SPMarker *) (shape->marker[i]), NR_ARENA_ITEM_GET_KEY (v->arenaitem) + i);
 980               /* fixme: Do we need explicit remove here? (Lauris) */
 981               /* nr_arena_item_set_mask (v->arenaitem, NULL); */
 982             }
 983             /* Detach marker */
 984             sp_signal_disconnect_by_data (shape->marker[i], item);
 985             shape->marker[i] = sp_object_hunref (shape->marker[i], item);
 986           }
 987         }
 988 }
 989
 990 /**
 991  * No-op.  Exists for handling 'modified' messages
 992  */
 993 static void
 994 sp_shape_marker_modified (SPObject */*marker*/, guint /*flags*/, SPItem */*item*/)
 995 {
 996         /* I think mask does update automagically */
 997         /* g_warning ("Item %s mask %s modified", SP_OBJECT_ID (item), SP_OBJECT_ID (mask)); */
 998 }
 999
1000 /**
1001  * Adds a new marker to shape object at the location indicated by key.  value
1002  * must be a valid URI reference resolvable from the shape object (i.e., present
1003  * in the document <defs>).  If the shape object already has a marker
1004  * registered at the given position, it is removed first.  Then the
1005  * new marker is hrefed and its signals connected.
1006  */
1007 void
1008 sp_shape_set_marker (SPObject *object, unsigned int key, const gchar *value)
1009 {
1010     SPItem *item = (SPItem *) object;
1011     SPShape *shape = (SPShape *) object;
1012
1013     if (key < SP_MARKER_LOC_START || key > SP_MARKER_LOC_END) {
1014         return;
1015     }
1016
1017     SPObject *mrk = sp_css_uri_reference_resolve (SP_OBJECT_DOCUMENT (object), value);
1018     if (mrk != shape->marker[key]) {
1019         if (shape->marker[key]) {
1020             SPItemView *v;
1021
1022             /* Detach marker */
1023             shape->release_connect[key].disconnect();
1024             shape->modified_connect[key].disconnect();
1025
1026             /* Hide marker */
1027             for (v = item->display; v != NULL; v = v->next) {
1028                 sp_marker_hide ((SPMarker *) (shape->marker[key]),
1029                                 NR_ARENA_ITEM_GET_KEY (v->arenaitem) + key);
1030                 /* fixme: Do we need explicit remove here? (Lauris) */
1031                 /* nr_arena_item_set_mask (v->arenaitem, NULL); */
1032             }
1033
1034             /* Unref marker */
1035             shape->marker[key] = sp_object_hunref (shape->marker[key], object);
1036         }
1037         if (SP_IS_MARKER (mrk)) {
1038             shape->marker[key] = sp_object_href (mrk, object);
1039             shape->release_connect[key] = mrk->connectRelease(sigc::bind<1>(sigc::ptr_fun(&sp_shape_marker_release), shape));
1040             shape->modified_connect[key] = mrk->connectModified(sigc::bind<2>(sigc::ptr_fun(&sp_shape_marker_modified), shape));
1041         }
1042     }
1043 }
1044
1045
1046
1047 /* Shape section */
1048
1049 /**
1050  * Calls any registered handlers for the set_shape action
1051  */
1052 void
1053 sp_shape_set_shape (SPShape *shape)
1054 {
1055         g_return_if_fail (shape != NULL);
1056         g_return_if_fail (SP_IS_SHAPE (shape));
1057
1058         if (SP_SHAPE_CLASS (G_OBJECT_GET_CLASS (shape))->set_shape) {
1059           SP_SHAPE_CLASS (G_OBJECT_GET_CLASS (shape))->set_shape (shape);
1060         }
1061 }
1062
1063 /**
1064  * Adds a curve to the shape.  If owner is specified, a reference
1065  * will be made, otherwise the curve will be copied into the shape.
1066  * Any existing curve in the shape will be unreferenced first.
1067  * This routine also triggers a request to update the display.
1068  */
1069 void
1070 sp_shape_set_curve (SPShape *shape, SPCurve *curve, unsigned int owner)
1071 {
1072         if (shape->curve) {
1073                 shape->curve = shape->curve->unref();
1074         }
1075         if (curve) {
1076                 if (owner) {
1077                         shape->curve = curve->ref();
1078                 } else {
1079                         shape->curve = curve->copy();
1080                 }
1081         }
1082         SP_OBJECT(shape)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
1083 }
1084
1085 /**
1086  * Return duplicate of curve (if any exists) or NULL if there is no curve
1087  */
1088 SPCurve *
1089 sp_shape_get_curve (SPShape *shape)
1090 {
1091         if (shape->curve) {
1092                 return shape->curve->copy();
1093         }
1094         return NULL;
1095 }
1096
1097 /**
1098  * Same as sp_shape_set_curve but without updating the display
1099  */
1100 void
1101 sp_shape_set_curve_insync (SPShape *shape, SPCurve *curve, unsigned int owner)
1102 {
1103         if (shape->curve) {
1104                 shape->curve = shape->curve->unref();
1105         }
1106         if (curve) {
1107                 if (owner) {
1108                         shape->curve = curve->ref();
1109                 } else {
1110                         shape->curve = curve->copy();
1111                 }
1112         }
1113 }
1114
1115 /**
1116  * Return all nodes in a path that are to be considered for snapping
1117  */
1118 static void sp_shape_snappoints(SPItem const *item, SnapPointsIter p)
1119 {
1120     g_assert(item != NULL);
1121     g_assert(SP_IS_SHAPE(item));
1122
1123     SPShape const *shape = SP_SHAPE(item);
1124     if (shape->curve == NULL) {
1125         return;
1126     }
1127
1128     NR::Matrix const i2d (from_2geom(sp_item_i2d_affine (item)));
1129     NArtBpath const *b = SP_CURVE_BPATH(shape->curve);
1130
1131     // Cycle through the nodes in the concatenated subpaths
1132     while (b->code != NR_END) {
1133         NR::Point pos = b->c(3) * i2d; // this is the current node
1134
1135         // NR_MOVETO Indicates the start of a closed subpath, see nr-path-code.h
1136         // If we're looking at a closed subpath, then we can skip this first
1137         // point of the subpath because it's coincident with the last point.
1138         if (b->code != NR_MOVETO) {
1139             if (b->code == NR_MOVETO_OPEN || b->code == NR_LINETO || b[1].code == NR_LINETO || b[1].code == NR_END) {
1140                 // end points of a line segment are always considered for snapping
1141                 *p = pos;
1142             } else {
1143                 // g_assert(b->code == NR_CURVETO);
1144                 NR::Point ppos, npos;
1145                 ppos = b->code == NR_CURVETO ? b->c(2) * i2d : pos; // backward handle
1146                 npos = b[1].code == NR_CURVETO ? b[1].c(1) * i2d : pos; // forward handle
1147                 // Determine whether a node is at a smooth part of the path, by
1148                 // calculating a measure for the collinearity of the handles
1149                 bool c1 = fabs (Inkscape::Util::triangle_area (pos, ppos, npos)) < 1; // points are (almost) collinear
1150                 bool c2 = NR::L2(pos - ppos) < 1e-6 || NR::L2(pos - npos) < 1e-6; // endnode, or a node with a retracted handle
1151                 if (!(c1 & !c2)) {
1152                     *p = pos; // only return non-smooth nodes ("cusps")
1153                 }
1154             }
1155         }
1156
1157         b++;
1158     }
1159 }
1160
1161 /*
1162   Local Variables:
1163   mode:c++
1164   c-file-style:"stroustrup"
1165   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1166   indent-tabs-mode:nil
1167   fill-column:99
1168   End:
1169 */
1170 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :