src/sp-item.cpp

   1 /** \file
   2  * Base class for visual SVG elements
   3  */
   4 /*
   5  * Authors:
   6  *   Lauris Kaplinski <lauris@kaplinski.com>
   7  *   bulia byak <buliabyak@users.sf.net>
   8  *   Johan Engelen <j.b.c.engelen@ewi.utwente.nl>
   9  *
  10  * Copyright (C) 2001-2006 authors
  11  * Copyright (C) 2001 Ximian, Inc.
  12  *
  13  * Released under GNU GPL, read the file 'COPYING' for more information
  14  */
  15
  16 /** \class SPItem
  17  *
  18  * SPItem is an abstract base class for all graphic (visible) SVG nodes. It
  19  * is a subclass of SPObject, with great deal of specific functionality.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26
  27 #include "sp-item.h"
  28 #include "svg/svg.h"
  29 #include "print.h"
  30 #include "display/nr-arena.h"
  31 #include "display/nr-arena-item.h"
  32 #include "attributes.h"
  33 #include "document.h"
  34 #include "uri.h"
  35 #include "inkscape.h"
  36 #include "desktop.h"
  37 #include "desktop-handles.h"
  38
  39 #include "style.h"
  40 #include <glibmm/i18n.h>
  41 #include "sp-root.h"
  42 #include "sp-clippath.h"
  43 #include "sp-mask.h"
  44 #include "sp-rect.h"
  45 #include "sp-use.h"
  46 #include "sp-text.h"
  47 #include "sp-item-rm-unsatisfied-cns.h"
  48 #include "sp-pattern.h"
  49 #include "sp-switch.h"
  50 #include "sp-guide-constraint.h"
  51 #include "gradient-chemistry.h"
  52 #include "preferences.h"
  53 #include "conn-avoid-ref.h"
  54 #include "conditions.h"
  55 #include "sp-filter-reference.h"
  56 #include "filter-chemistry.h"
  57 #include "sp-guide.h"
  58 #include "sp-title.h"
  59 #include "sp-desc.h"
  60
  61 #include "libnr/nr-matrix-fns.h"
  62 #include "libnr/nr-matrix-scale-ops.h"
  63 #include "libnr/nr-matrix-translate-ops.h"
  64 #include "libnr/nr-scale-translate-ops.h"
  65 #include "libnr/nr-translate-scale-ops.h"
  66 #include "libnr/nr-convert2geom.h"
  67 #include "algorithms/find-last-if.h"
  68 #include "util/reverse-list.h"
  69 #include <2geom/rect.h>
  70 #include <2geom/matrix.h>
  71 #include <2geom/transforms.h>
  72
  73 #include "xml/repr.h"
  74 #include "extract-uri.h"
  75 #include "helper/geom.h"
  76
  77 #include "live_effects/lpeobject.h"
  78 #include "live_effects/effect.h"
  79 #include "live_effects/lpeobject-reference.h"
  80
  81 #define noSP_ITEM_DEBUG_IDLE
  82
  83 static void sp_item_class_init(SPItemClass *klass);
  84 static void sp_item_init(SPItem *item);
  85
  86 static void sp_item_build(SPObject *object, Document *document, Inkscape::XML::Node *repr);
  87 static void sp_item_release(SPObject *object);
  88 static void sp_item_set(SPObject *object, unsigned key, gchar const *value);
  89 static void sp_item_update(SPObject *object, SPCtx *ctx, guint flags);
  90 static Inkscape::XML::Node *sp_item_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
  91
  92 static gchar *sp_item_private_description(SPItem *item);
  93 static void sp_item_private_snappoints(SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const *snapprefs);
  94
  95 static SPItemView *sp_item_view_new_prepend(SPItemView *list, SPItem *item, unsigned flags, unsigned key, NRArenaItem *arenaitem);
  96 static SPItemView *sp_item_view_list_remove(SPItemView *list, SPItemView *view);
  97
  98 static SPObjectClass *parent_class;
  99
 100 static void clip_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item);
 101 static void mask_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item);
 102
 103 /**
 104  * Registers SPItem class and returns its type number.
 105  */
 106 GType
 107 sp_item_get_type(void)
 108 {
 109     static GType type = 0;
 110     if (!type) {
 111         GTypeInfo info = {
 112             sizeof(SPItemClass),
 113             NULL, NULL,
 114             (GClassInitFunc) sp_item_class_init,
 115             NULL, NULL,
 116             sizeof(SPItem),
 117             16,
 118             (GInstanceInitFunc) sp_item_init,
 119             NULL,   /* value_table */
 120         };
 121         type = g_type_register_static(SP_TYPE_OBJECT, "SPItem", &info, (GTypeFlags)0);
 122     }
 123     return type;
 124 }
 125
 126 /**
 127  * SPItem vtable initialization.
 128  */
 129 static void
 130 sp_item_class_init(SPItemClass *klass)
 131 {
 132     SPObjectClass *sp_object_class = (SPObjectClass *) klass;
 133
 134     parent_class = (SPObjectClass *)g_type_class_ref(SP_TYPE_OBJECT);
 135
 136     sp_object_class->build = sp_item_build;
 137     sp_object_class->release = sp_item_release;
 138     sp_object_class->set = sp_item_set;
 139     sp_object_class->update = sp_item_update;
 140     sp_object_class->write = sp_item_write;
 141
 142     klass->description = sp_item_private_description;
 143     klass->snappoints = sp_item_private_snappoints;
 144 }
 145
 146 /**
 147  * Callback for SPItem object initialization.
 148  */
 149 static void
 150 sp_item_init(SPItem *item)
 151 {
 152     item->init();
 153 }
 154
 155 void SPItem::init() {
 156     this->sensitive = TRUE;
 157
 158     this->transform_center_x = 0;
 159     this->transform_center_y = 0;
 160
 161     this->_is_evaluated = true;
 162     this->_evaluated_status = StatusUnknown;
 163
 164     this->transform = Geom::identity();
 165
 166     this->display = NULL;
 167
 168     this->clip_ref = new SPClipPathReference(this);
 169     sigc::signal<void, SPObject *, SPObject *> cs1=this->clip_ref->changedSignal();
 170     sigc::slot2<void,SPObject*, SPObject *> sl1=sigc::bind(sigc::ptr_fun(clip_ref_changed), this);
 171     _clip_ref_connection = cs1.connect(sl1);
 172
 173     this->mask_ref = new SPMaskReference(this);
 174     sigc::signal<void, SPObject *, SPObject *> cs2=this->mask_ref->changedSignal();
 175     sigc::slot2<void,SPObject*, SPObject *> sl2=sigc::bind(sigc::ptr_fun(mask_ref_changed), this);
 176     _mask_ref_connection = cs2.connect(sl2);
 177
 178     this->avoidRef = new SPAvoidRef(this);
 179
 180     new (&this->constraints) std::vector<SPGuideConstraint>();
 181
 182     new (&this->_transformed_signal) sigc::signal<void, Geom::Matrix const *, SPItem *>();
 183 }
 184
 185 bool SPItem::isVisibleAndUnlocked() const {
 186     return (!isHidden() && !isLocked());
 187 }
 188
 189 bool SPItem::isVisibleAndUnlocked(unsigned display_key) const {
 190     return (!isHidden(display_key) && !isLocked());
 191 }
 192
 193 bool SPItem::isLocked() const {
 194     for (SPObject *o = SP_OBJECT(this); o != NULL; o = SP_OBJECT_PARENT(o)) {
 195         if (SP_IS_ITEM(o) && !(SP_ITEM(o)->sensitive))
 196             return true;
 197     }
 198     return false;
 199 }
 200
 201 void SPItem::setLocked(bool locked) {
 202     SP_OBJECT_REPR(this)->setAttribute("sodipodi:insensitive",
 203                      ( locked ? "1" : NULL ));
 204     updateRepr();
 205 }
 206
 207 bool SPItem::isHidden() const {
 208     if (!isEvaluated())
 209         return true;
 210     return style->display.computed == SP_CSS_DISPLAY_NONE;
 211 }
 212
 213 void SPItem::setHidden(bool hide) {
 214     style->display.set = TRUE;
 215     style->display.value = ( hide ? SP_CSS_DISPLAY_NONE : SP_CSS_DISPLAY_INLINE );
 216     style->display.computed = style->display.value;
 217     style->display.inherit = FALSE;
 218     updateRepr();
 219 }
 220
 221 bool SPItem::isHidden(unsigned display_key) const {
 222     if (!isEvaluated())
 223         return true;
 224     for ( SPItemView *view(display) ; view ; view = view->next ) {
 225         if ( view->key == display_key ) {
 226             g_assert(view->arenaitem != NULL);
 227             for ( NRArenaItem *arenaitem = view->arenaitem ;
 228                   arenaitem ; arenaitem = arenaitem->parent )
 229             {
 230                 if (!arenaitem->visible) {
 231                     return true;
 232                 }
 233             }
 234             return false;
 235         }
 236     }
 237     return true;
 238 }
 239
 240 void SPItem::setEvaluated(bool evaluated) {
 241     _is_evaluated = evaluated;
 242     _evaluated_status = StatusSet;
 243 }
 244
 245 void SPItem::resetEvaluated() {
 246     if ( StatusCalculated == _evaluated_status ) {
 247         _evaluated_status = StatusUnknown;
 248         bool oldValue = _is_evaluated;
 249         if ( oldValue != isEvaluated() ) {
 250             requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
 251         }
 252     } if ( StatusSet == _evaluated_status ) {
 253         SPObject const *const parent = SP_OBJECT_PARENT(this);
 254         if (SP_IS_SWITCH(parent)) {
 255             SP_SWITCH(parent)->resetChildEvaluated();
 256         }
 257     }
 258 }
 259
 260 bool SPItem::isEvaluated() const {
 261     if ( StatusUnknown == _evaluated_status ) {
 262         _is_evaluated = sp_item_evaluate(this);
 263         _evaluated_status = StatusCalculated;
 264     }
 265     return _is_evaluated;
 266 }
 267
 268 /**
 269  * Returns something suitable for the `Hide' checkbox in the Object Properties dialog box.
 270  *  Corresponds to setExplicitlyHidden.
 271  */
 272 bool
 273 SPItem::isExplicitlyHidden() const
 274 {
 275     return (this->style->display.set
 276             && this->style->display.value == SP_CSS_DISPLAY_NONE);
 277 }
 278
 279 /**
 280  * Sets the display CSS property to `hidden' if \a val is true,
 281  * otherwise makes it unset
 282  */
 283 void
 284 SPItem::setExplicitlyHidden(bool const val) {
 285     this->style->display.set = val;
 286     this->style->display.value = ( val ? SP_CSS_DISPLAY_NONE : SP_CSS_DISPLAY_INLINE );
 287     this->style->display.computed = this->style->display.value;
 288     this->updateRepr();
 289 }
 290
 291 /**
 292  * Sets the transform_center_x and transform_center_y properties to retain the rotation centre
 293  */
 294 void
 295 SPItem::setCenter(Geom::Point object_centre) {
 296     // for getBounds() to work
 297     sp_document_ensure_up_to_date(SP_OBJECT_DOCUMENT(this));
 298
 299     Geom::OptRect bbox = getBounds(sp_item_i2d_affine(this));
 300     if (bbox) {
 301         transform_center_x = object_centre[Geom::X] - bbox->midpoint()[Geom::X];
 302         if (fabs(transform_center_x) < 1e-5) // rounding error
 303             transform_center_x = 0;
 304         transform_center_y = object_centre[Geom::Y] - bbox->midpoint()[Geom::Y];
 305         if (fabs(transform_center_y) < 1e-5) // rounding error
 306             transform_center_y = 0;
 307     }
 308 }
 309
 310 void
 311 SPItem::unsetCenter() {
 312     transform_center_x = 0;
 313     transform_center_y = 0;
 314 }
 315
 316 bool SPItem::isCenterSet() {
 317     return (transform_center_x != 0 || transform_center_y != 0);
 318 }
 319
 320 Geom::Point SPItem::getCenter() const {
 321     // for getBounds() to work
 322     sp_document_ensure_up_to_date(SP_OBJECT_DOCUMENT(this));
 323
 324     Geom::OptRect bbox = getBounds(sp_item_i2d_affine(this));
 325     if (bbox) {
 326         return to_2geom(bbox->midpoint()) + Geom::Point (this->transform_center_x, this->transform_center_y);
 327     } else {
 328         return Geom::Point (0, 0); // something's wrong!
 329     }
 330 }
 331
 332
 333 namespace {
 334
 335 bool is_item(SPObject const &object) {
 336     return SP_IS_ITEM(&object);
 337 }
 338
 339 }
 340
 341 void SPItem::raiseToTop() {
 342     using Inkscape::Algorithms::find_last_if;
 343
 344     SPObject *topmost=find_last_if<SPObject::SiblingIterator>(
 345         SP_OBJECT_NEXT(this), NULL, &is_item
 346     );
 347     if (topmost) {
 348         Inkscape::XML::Node *repr=SP_OBJECT_REPR(this);
 349         sp_repr_parent(repr)->changeOrder(repr, SP_OBJECT_REPR(topmost));
 350     }
 351 }
 352
 353 void SPItem::raiseOne() {
 354     SPObject *next_higher=std::find_if<SPObject::SiblingIterator>(
 355         SP_OBJECT_NEXT(this), NULL, &is_item
 356     );
 357     if (next_higher) {
 358         Inkscape::XML::Node *repr=SP_OBJECT_REPR(this);
 359         Inkscape::XML::Node *ref=SP_OBJECT_REPR(next_higher);
 360         sp_repr_parent(repr)->changeOrder(repr, ref);
 361     }
 362 }
 363
 364 void SPItem::lowerOne() {
 365     using Inkscape::Util::MutableList;
 366     using Inkscape::Util::reverse_list;
 367
 368     MutableList<SPObject &> next_lower=std::find_if(
 369         reverse_list<SPObject::SiblingIterator>(
 370             SP_OBJECT_PARENT(this)->firstChild(), this
 371         ),
 372         MutableList<SPObject &>(),
 373         &is_item
 374     );
 375     if (next_lower) {
 376         ++next_lower;
 377         Inkscape::XML::Node *repr=SP_OBJECT_REPR(this);
 378         Inkscape::XML::Node *ref=( next_lower ? SP_OBJECT_REPR(&*next_lower) : NULL );
 379         sp_repr_parent(repr)->changeOrder(repr, ref);
 380     }
 381 }
 382
 383 void SPItem::lowerToBottom() {
 384     using Inkscape::Algorithms::find_last_if;
 385     using Inkscape::Util::MutableList;
 386     using Inkscape::Util::reverse_list;
 387
 388     MutableList<SPObject &> bottom=find_last_if(
 389         reverse_list<SPObject::SiblingIterator>(
 390             SP_OBJECT_PARENT(this)->firstChild(), this
 391         ),
 392         MutableList<SPObject &>(),
 393         &is_item
 394     );
 395     if (bottom) {
 396         ++bottom;
 397         Inkscape::XML::Node *repr=SP_OBJECT_REPR(this);
 398         Inkscape::XML::Node *ref=( bottom ? SP_OBJECT_REPR(&*bottom) : NULL );
 399         sp_repr_parent(repr)->changeOrder(repr, ref);
 400     }
 401 }
 402
 403 static void
 404 sp_item_build(SPObject *object, Document *document, Inkscape::XML::Node *repr)
 405 {
 406     sp_object_read_attr(object, "style");
 407     sp_object_read_attr(object, "transform");
 408     sp_object_read_attr(object, "clip-path");
 409     sp_object_read_attr(object, "mask");
 410     sp_object_read_attr(object, "sodipodi:insensitive");
 411     sp_object_read_attr(object, "sodipodi:nonprintable");
 412     sp_object_read_attr(object, "inkscape:transform-center-x");
 413     sp_object_read_attr(object, "inkscape:transform-center-y");
 414     sp_object_read_attr(object, "inkscape:connector-avoid");
 415
 416     if (((SPObjectClass *) (parent_class))->build) {
 417         (* ((SPObjectClass *) (parent_class))->build)(object, document, repr);
 418     }
 419 }
 420
 421 static void
 422 sp_item_release(SPObject *object)
 423 {
 424     SPItem *item = (SPItem *) object;
 425
 426     item->_clip_ref_connection.disconnect();
 427     item->_mask_ref_connection.disconnect();
 428
 429     // Note: do this here before the clip_ref is deleted, since calling
 430     // sp_document_ensure_up_to_date for triggered routing may reference
 431     // the deleted clip_ref.
 432     if (item->avoidRef) {
 433         delete item->avoidRef;
 434         item->avoidRef = NULL;
 435     }
 436
 437     if (item->clip_ref) {
 438         item->clip_ref->detach();
 439         delete item->clip_ref;
 440         item->clip_ref = NULL;
 441     }
 442
 443     if (item->mask_ref) {
 444         item->mask_ref->detach();
 445         delete item->mask_ref;
 446         item->mask_ref = NULL;
 447     }
 448
 449     if (((SPObjectClass *) (parent_class))->release) {
 450         ((SPObjectClass *) parent_class)->release(object);
 451     }
 452
 453     while (item->display) {
 454         nr_arena_item_unparent(item->display->arenaitem);
 455         item->display = sp_item_view_list_remove(item->display, item->display);
 456     }
 457
 458     item->_transformed_signal.~signal();
 459 }
 460
 461 static void
 462 sp_item_set(SPObject *object, unsigned key, gchar const *value)
 463 {
 464     SPItem *item = (SPItem *) object;
 465
 466     switch (key) {
 467         case SP_ATTR_TRANSFORM: {
 468             Geom::Matrix t;
 469             if (value && sp_svg_transform_read(value, &t)) {
 470                 sp_item_set_item_transform(item, t);
 471             } else {
 472                 sp_item_set_item_transform(item, Geom::identity());
 473             }
 474             break;
 475         }
 476         case SP_PROP_CLIP_PATH: {
 477             gchar *uri = extract_uri(value);
 478             if (uri) {
 479                 try {
 480                     item->clip_ref->attach(Inkscape::URI(uri));
 481                 } catch (Inkscape::BadURIException &e) {
 482                     g_warning("%s", e.what());
 483                     item->clip_ref->detach();
 484                 }
 485                 g_free(uri);
 486             } else {
 487                 item->clip_ref->detach();
 488             }
 489
 490             break;
 491         }
 492         case SP_PROP_MASK: {
 493             gchar *uri = extract_uri(value);
 494             if (uri) {
 495                 try {
 496                     item->mask_ref->attach(Inkscape::URI(uri));
 497                 } catch (Inkscape::BadURIException &e) {
 498                     g_warning("%s", e.what());
 499                     item->mask_ref->detach();
 500                 }
 501                 g_free(uri);
 502             } else {
 503                 item->mask_ref->detach();
 504             }
 505
 506             break;
 507         }
 508         case SP_ATTR_SODIPODI_INSENSITIVE:
 509             item->sensitive = !value;
 510             for (SPItemView *v = item->display; v != NULL; v = v->next) {
 511                 nr_arena_item_set_sensitive(v->arenaitem, item->sensitive);
 512             }
 513             break;
 514         case SP_ATTR_CONNECTOR_AVOID:
 515             item->avoidRef->setAvoid(value);
 516             break;
 517         case SP_ATTR_TRANSFORM_CENTER_X:
 518             if (value) {
 519                 item->transform_center_x = g_strtod(value, NULL);
 520             } else {
 521                 item->transform_center_x = 0;
 522             }
 523             object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 524             break;
 525         case SP_ATTR_TRANSFORM_CENTER_Y:
 526             if (value) {
 527                 item->transform_center_y = g_strtod(value, NULL);
 528             } else {
 529                 item->transform_center_y = 0;
 530             }
 531             object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 532             break;
 533         case SP_PROP_SYSTEM_LANGUAGE:
 534         case SP_PROP_REQUIRED_FEATURES:
 535         case SP_PROP_REQUIRED_EXTENSIONS:
 536             {
 537                 item->resetEvaluated();
 538                 // pass to default handler
 539             }
 540         default:
 541             if (SP_ATTRIBUTE_IS_CSS(key)) {
 542                 sp_style_read_from_object(object->style, object);
 543                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
 544             } else {
 545                 if (((SPObjectClass *) (parent_class))->set) {
 546                     (* ((SPObjectClass *) (parent_class))->set)(object, key, value);
 547                 }
 548             }
 549             break;
 550     }
 551 }
 552
 553 static void
 554 clip_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item)
 555 {
 556     if (old_clip) {
 557         SPItemView *v;
 558         /* Hide clippath */
 559         for (v = item->display; v != NULL; v = v->next) {
 560             sp_clippath_hide(SP_CLIPPATH(old_clip), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
 561             nr_arena_item_set_clip(v->arenaitem, NULL);
 562         }
 563     }
 564     if (SP_IS_CLIPPATH(clip)) {
 565         NRRect bbox;
 566         sp_item_invoke_bbox(item, &bbox, Geom::identity(), TRUE);
 567         for (SPItemView *v = item->display; v != NULL; v = v->next) {
 568             if (!v->arenaitem->key) {
 569                 NR_ARENA_ITEM_SET_KEY(v->arenaitem, sp_item_display_key_new(3));
 570             }
 571             NRArenaItem *ai = sp_clippath_show(SP_CLIPPATH(clip),
 572                                                NR_ARENA_ITEM_ARENA(v->arenaitem),
 573                                                NR_ARENA_ITEM_GET_KEY(v->arenaitem));
 574             nr_arena_item_set_clip(v->arenaitem, ai);
 575             nr_arena_item_unref(ai);
 576             sp_clippath_set_bbox(SP_CLIPPATH(clip), NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
 577             SP_OBJECT(clip)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 578         }
 579     }
 580 }
 581
 582 static void
 583 mask_ref_changed(SPObject *old_mask, SPObject *mask, SPItem *item)
 584 {
 585     if (old_mask) {
 586         /* Hide mask */
 587         for (SPItemView *v = item->display; v != NULL; v = v->next) {
 588             sp_mask_hide(SP_MASK(old_mask), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
 589             nr_arena_item_set_mask(v->arenaitem, NULL);
 590         }
 591     }
 592     if (SP_IS_MASK(mask)) {
 593         NRRect bbox;
 594         sp_item_invoke_bbox(item, &bbox, Geom::identity(), TRUE);
 595         for (SPItemView *v = item->display; v != NULL; v = v->next) {
 596             if (!v->arenaitem->key) {
 597                 NR_ARENA_ITEM_SET_KEY(v->arenaitem, sp_item_display_key_new(3));
 598             }
 599             NRArenaItem *ai = sp_mask_show(SP_MASK(mask),
 600                                            NR_ARENA_ITEM_ARENA(v->arenaitem),
 601                                            NR_ARENA_ITEM_GET_KEY(v->arenaitem));
 602             nr_arena_item_set_mask(v->arenaitem, ai);
 603             nr_arena_item_unref(ai);
 604             sp_mask_set_bbox(SP_MASK(mask), NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
 605             SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
 606         }
 607     }
 608 }
 609
 610 static void
 611 sp_item_update(SPObject *object, SPCtx *ctx, guint flags)
 612 {
 613     SPItem *item = SP_ITEM(object);
 614
 615     if (((SPObjectClass *) (parent_class))->update)
 616         (* ((SPObjectClass *) (parent_class))->update)(object, ctx, flags);
 617
 618     if (flags & (SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG)) {
 619         if (flags & SP_OBJECT_MODIFIED_FLAG) {
 620             for (SPItemView *v = item->display; v != NULL; v = v->next) {
 621                 nr_arena_item_set_transform(v->arenaitem, item->transform);
 622             }
 623         }
 624
 625         SPClipPath *clip_path = item->clip_ref ? item->clip_ref->getObject() : NULL;
 626         SPMask *mask = item->mask_ref ? item->mask_ref->getObject() : NULL;
 627
 628         if ( clip_path || mask ) {
 629             NRRect bbox;
 630             sp_item_invoke_bbox(item, &bbox, Geom::identity(), TRUE);
 631             if (clip_path) {
 632                 for (SPItemView *v = item->display; v != NULL; v = v->next) {
 633                     sp_clippath_set_bbox(clip_path, NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
 634                 }
 635             }
 636             if (mask) {
 637                 for (SPItemView *v = item->display; v != NULL; v = v->next) {
 638                     sp_mask_set_bbox(mask, NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
 639                 }
 640             }
 641         }
 642
 643         if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
 644             for (SPItemView *v = item->display; v != NULL; v = v->next) {
 645                 nr_arena_item_set_opacity(v->arenaitem, SP_SCALE24_TO_FLOAT(object->style->opacity.value));
 646                 nr_arena_item_set_visible(v->arenaitem, !item->isHidden());
 647             }
 648         }
 649     }
 650
 651     /* Update bounding box data used by filters */
 652     if (item->style->filter.set && item->display) {
 653         Geom::OptRect item_bbox;
 654         sp_item_invoke_bbox(item, item_bbox, Geom::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
 655
 656         SPItemView *itemview = item->display;
 657         do {
 658             if (itemview->arenaitem)
 659                 nr_arena_item_set_item_bbox(itemview->arenaitem, item_bbox);
 660         } while ( (itemview = itemview->next) );
 661     }
 662
 663     // Update libavoid with item geometry (for connector routing).
 664     if (item->avoidRef)
 665         item->avoidRef->handleSettingChange();
 666 }
 667
 668 static Inkscape::XML::Node *
 669 sp_item_write(SPObject *const object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
 670 {
 671     SPObject *child;
 672     SPItem *item = SP_ITEM(object);
 673
 674     // in the case of SP_OBJECT_WRITE_BUILD, the item should always be newly created,
 675     // so we need to add any children from the underlying object to the new repr
 676     if (flags & SP_OBJECT_WRITE_BUILD) {
 677         Inkscape::XML::Node *crepr;
 678         GSList *l;
 679         l = NULL;
 680         for (child = sp_object_first_child(object); child != NULL; child = SP_OBJECT_NEXT(child) ) {
 681             if (!SP_IS_TITLE(child) && !SP_IS_DESC(child)) continue;
 682             crepr = child->updateRepr(xml_doc, NULL, flags);
 683             if (crepr) l = g_slist_prepend (l, crepr);
 684         }
 685         while (l) {
 686             repr->addChild((Inkscape::XML::Node *) l->data, NULL);
 687             Inkscape::GC::release((Inkscape::XML::Node *) l->data);
 688             l = g_slist_remove (l, l->data);
 689         }
 690     } else {
 691         for (child = sp_object_first_child(object) ; child != NULL; child = SP_OBJECT_NEXT(child) ) {
 692             if (!SP_IS_TITLE(child) && !SP_IS_DESC(child)) continue;
 693             child->updateRepr(flags);
 694         }
 695     }
 696
 697     gchar *c = sp_svg_transform_write(item->transform);
 698     repr->setAttribute("transform", c);
 699     g_free(c);
 700
 701     if (flags & SP_OBJECT_WRITE_EXT) {
 702         repr->setAttribute("sodipodi:insensitive", ( item->sensitive ? NULL : "true" ));
 703         if (item->transform_center_x != 0)
 704             sp_repr_set_svg_double (repr, "inkscape:transform-center-x", item->transform_center_x);
 705         else
 706             repr->setAttribute ("inkscape:transform-center-x", NULL);
 707         if (item->transform_center_y != 0)
 708             sp_repr_set_svg_double (repr, "inkscape:transform-center-y", item->transform_center_y);
 709         else
 710             repr->setAttribute ("inkscape:transform-center-y", NULL);
 711     }
 712
 713     if (item->clip_ref->getObject()) {
 714         const gchar *value = g_strdup_printf ("url(%s)", item->clip_ref->getURI()->toString());
 715         repr->setAttribute ("clip-path", value);
 716         g_free ((void *) value);
 717     }
 718     if (item->mask_ref->getObject()) {
 719         const gchar *value = g_strdup_printf ("url(%s)", item->mask_ref->getURI()->toString());
 720         repr->setAttribute ("mask", value);
 721         g_free ((void *) value);
 722     }
 723
 724     if (((SPObjectClass *) (parent_class))->write) {
 725         ((SPObjectClass *) (parent_class))->write(object, xml_doc, repr, flags);
 726     }
 727
 728     return repr;
 729 }
 730
 731 /**
 732  * \return  There is no guarantee that the return value will contain a rectangle.
 733             If this item does not have a boundingbox, it might well be empty.
 734  */
 735 Geom::OptRect SPItem::getBounds(Geom::Matrix const &transform,
 736                                       SPItem::BBoxType type,
 737                                       unsigned int /*dkey*/) const
 738 {
 739     Geom::OptRect r;
 740     sp_item_invoke_bbox_full(this, r, transform, type, TRUE);
 741     return r;
 742 }
 743
 744 void
 745 sp_item_invoke_bbox(SPItem const *item, Geom::OptRect &bbox, Geom::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
 746 {
 747     sp_item_invoke_bbox_full(item, bbox, transform, type, clear);
 748 }
 749
 750 // DEPRECATED to phase out the use of NRRect in favor of Geom::OptRect
 751 void
 752 sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, Geom::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
 753 {
 754     sp_item_invoke_bbox_full(item, bbox, transform, type, clear);
 755 }
 756
 757 /** Calls \a item's subclass' bounding box method; clips it by the bbox of clippath, if any; and
 758  * unions the resulting bbox with \a bbox. If \a clear is true, empties \a bbox first. Passes the
 759  * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
 760  * clones), in turn, call this function in their bbox methods.
 761  * \retval bbox  Note that there is no guarantee that bbox will contain a rectangle when the
 762  *               function returns. If this item does not have a boundingbox, this might well be empty.
 763  */
 764 void
 765 sp_item_invoke_bbox_full(SPItem const *item, Geom::OptRect &bbox, Geom::Matrix const &transform, unsigned const flags, unsigned const clear)
 766 {
 767     g_assert(item != NULL);
 768     g_assert(SP_IS_ITEM(item));
 769
 770     if (clear) {
 771         bbox = Geom::OptRect();
 772     }
 773
 774     // TODO: replace NRRect by Geom::Rect, for all SPItemClasses, and for SP_CLIPPATH
 775
 776     NRRect temp_bbox;
 777     temp_bbox.x0 = temp_bbox.y0 = NR_HUGE;
 778     temp_bbox.x1 = temp_bbox.y1 = -NR_HUGE;
 779
 780     // call the subclass method
 781     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox) {
 782         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox(item, &temp_bbox, transform, flags);
 783     }
 784
 785     // unless this is geometric bbox, extend by filter area and crop the bbox by clip path, if any
 786     if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX) {
 787         if (SP_OBJECT_STYLE(item) && SP_OBJECT_STYLE(item)->filter.href) {
 788             SPObject *filter = SP_OBJECT_STYLE(item)->getFilter();
 789             if (filter && SP_IS_FILTER(filter)) {
 790                 // default filer area per the SVG spec:
 791                 double x = -0.1;
 792                 double y = -0.1;
 793                 double w = 1.2;
 794                 double h = 1.2;
 795
 796                 // if area is explicitly set, override:
 797                 if (SP_FILTER(filter)->x._set)
 798                     x = SP_FILTER(filter)->x.computed;
 799                 if (SP_FILTER(filter)->y._set)
 800                     y = SP_FILTER(filter)->y.computed;
 801                 if (SP_FILTER(filter)->width._set)
 802                     w = SP_FILTER(filter)->width.computed;
 803                 if (SP_FILTER(filter)->height._set)
 804                     h = SP_FILTER(filter)->height.computed;
 805
 806                 double dx0 = 0;
 807                 double dx1 = 0;
 808                 double dy0 = 0;
 809                 double dy1 = 0;
 810                 if (filter_is_single_gaussian_blur(SP_FILTER(filter))) {
 811                     // if this is a single blur, use 2.4*radius
 812                     // which may be smaller than the default area;
 813                     // see set_filter_area for why it's 2.4
 814                     double r = get_single_gaussian_blur_radius (SP_FILTER(filter));
 815                     dx0 = -2.4 * r;
 816                     dx1 = 2.4 * r;
 817                     dy0 = -2.4 * r;
 818                     dy1 = 2.4 * r;
 819                 } else {
 820                     // otherwise, calculate expansion from relative to absolute units:
 821                     dx0 = x * (temp_bbox.x1 - temp_bbox.x0);
 822                     dx1 = (w + x - 1) * (temp_bbox.x1 - temp_bbox.x0);
 823                     dy0 = y * (temp_bbox.y1 - temp_bbox.y0);
 824                     dy1 = (h + y - 1) * (temp_bbox.y1 - temp_bbox.y0);
 825                 }
 826
 827                 // transform the expansions by the item's transform:
 828                 Geom::Matrix i2d(sp_item_i2d_affine (item));
 829                 dx0 *= i2d.expansionX();
 830                 dx1 *= i2d.expansionX();
 831                 dy0 *= i2d.expansionY();
 832                 dy1 *= i2d.expansionY();
 833
 834                 // expand the bbox
 835                 temp_bbox.x0 += dx0;
 836                 temp_bbox.x1 += dx1;
 837                 temp_bbox.y0 += dy0;
 838                 temp_bbox.y1 += dy1;
 839             }
 840         }
 841         if (item->clip_ref->getObject()) {
 842             NRRect b;
 843             sp_clippath_get_bbox(SP_CLIPPATH(item->clip_ref->getObject()), &b, transform, flags);
 844             nr_rect_d_intersect (&temp_bbox, &temp_bbox, &b);
 845         }
 846     }
 847
 848     if (temp_bbox.x0 > temp_bbox.x1 || temp_bbox.y0 > temp_bbox.y1) {
 849         // Either the bbox hasn't been touched by the SPItemClass' bbox method
 850         // (it still has its initial values, see above: x0 = y0 = NR_HUGE and x1 = y1 = -NR_HUGE)
 851         // or it has explicitely been set to be like this (e.g. in sp_shape_bbox)
 852
 853         // When x0 > x1 or y0 > y1, the bbox is considered to be "nothing", although it has not been
 854         // explicitely defined this way for NRRects (as opposed to Geom::OptRect)
 855         // So union bbox with nothing = do nothing, just return
 856         return;
 857     }
 858
 859     // Do not use temp_bbox.upgrade() here, because it uses a test that returns an empty Geom::OptRect()
 860     // for any rectangle with zero area. The geometrical bbox of for example a vertical line
 861     // would therefore be translated into empty Geom::OptRect() (see bug https://bugs.launchpad.net/inkscape/+bug/168684)
 862     Geom::OptRect temp_bbox_new = Geom::Rect(Geom::Point(temp_bbox.x0, temp_bbox.y0), Geom::Point(temp_bbox.x1, temp_bbox.y1));
 863
 864     bbox = Geom::unify(bbox, temp_bbox_new);
 865 }
 866
 867 // DEPRECATED to phase out the use of NRRect in favor of Geom::OptRect
 868 /** Calls \a item's subclass' bounding box method; clips it by the bbox of clippath, if any; and
 869  * unions the resulting bbox with \a bbox. If \a clear is true, empties \a bbox first. Passes the
 870  * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
 871  * clones), in turn, call this function in their bbox methods. */
 872 void
 873 sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, Geom::Matrix const &transform, unsigned const flags, unsigned const clear)
 874 {
 875     g_assert(item != NULL);
 876     g_assert(SP_IS_ITEM(item));
 877     g_assert(bbox != NULL);
 878
 879     if (clear) {
 880         bbox->x0 = bbox->y0 = 1e18;
 881         bbox->x1 = bbox->y1 = -1e18;
 882     }
 883
 884     NRRect this_bbox;
 885     this_bbox.x0 = this_bbox.y0 = 1e18;
 886     this_bbox.x1 = this_bbox.y1 = -1e18;
 887
 888     // call the subclass method
 889     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox) {
 890         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox(item, &this_bbox, transform, flags);
 891     }
 892
 893     // unless this is geometric bbox, crop the bbox by clip path, if any
 894     if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX && item->clip_ref->getObject()) {
 895         NRRect b;
 896         sp_clippath_get_bbox(SP_CLIPPATH(item->clip_ref->getObject()), &b, transform, flags);
 897         nr_rect_d_intersect (&this_bbox, &this_bbox, &b);
 898     }
 899
 900     // if non-empty (with some tolerance - ?) union this_bbox with the bbox we've got passed
 901     if ( fabs(this_bbox.x1-this_bbox.x0) > -0.00001 && fabs(this_bbox.y1-this_bbox.y0) > -0.00001 ) {
 902         nr_rect_d_union (bbox, bbox, &this_bbox);
 903     }
 904 }
 905
 906 unsigned sp_item_pos_in_parent(SPItem *item)
 907 {
 908     g_assert(item != NULL);
 909     g_assert(SP_IS_ITEM(item));
 910
 911     SPObject *parent = SP_OBJECT_PARENT(item);
 912     g_assert(parent != NULL);
 913     g_assert(SP_IS_OBJECT(parent));
 914
 915     SPObject *object = SP_OBJECT(item);
 916
 917     unsigned pos=0;
 918     for ( SPObject *iter = sp_object_first_child(parent) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
 919         if ( iter == object ) {
 920             return pos;
 921         }
 922         if (SP_IS_ITEM(iter)) {
 923             pos++;
 924         }
 925     }
 926
 927     g_assert_not_reached();
 928     return 0;
 929 }
 930
 931 void
 932 sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type)
 933 {
 934     g_assert(item != NULL);
 935     g_assert(SP_IS_ITEM(item));
 936     g_assert(bbox != NULL);
 937
 938     sp_item_invoke_bbox(item, bbox, sp_item_i2d_affine(item), TRUE, type);
 939 }
 940
 941 Geom::OptRect sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type)
 942 {
 943     Geom::OptRect rect = Geom::OptRect();
 944     sp_item_invoke_bbox(item, rect, sp_item_i2d_affine(item), TRUE, type);
 945     return rect;
 946 }
 947
 948 static void sp_item_private_snappoints(SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const */*snapprefs*/)
 949 {
 950     /* This will only be called if the derived class doesn't override this.
 951      * see for example sp_genericellipse_snappoints in sp-ellipse.cpp
 952      * We don't know what shape we could be dealing with here, so we'll just
 953      * return the corners of the bounding box */
 954
 955     Geom::OptRect bbox = item->getBounds(sp_item_i2d_affine(item));
 956
 957     if (bbox) {
 958         Geom::Point p1, p2;
 959         p1 = bbox->min();
 960         p2 = bbox->max();
 961         int type = target ? int(Inkscape::SNAPSOURCE_CONVEX_HULL_CORNER) : int(Inkscape::SNAPSOURCE_CONVEX_HULL_CORNER);
 962         p.push_back(std::make_pair(p1, type));
 963         p.push_back(std::make_pair(Geom::Point(p1[Geom::X], p2[Geom::Y]), type));
 964         p.push_back(std::make_pair(p2, type));
 965         p.push_back(std::make_pair(Geom::Point(p1[Geom::Y], p2[Geom::X]), type));
 966     }
 967
 968 }
 969
 970 void sp_item_snappoints(SPItem const *item, bool const target, SnapPointsWithType &p, Inkscape::SnapPreferences const *snapprefs)
 971 {
 972     g_assert (item != NULL);
 973     g_assert (SP_IS_ITEM(item));
 974
 975     // Get the snappoints of the item
 976     SPItemClass const &item_class = *(SPItemClass const *) G_OBJECT_GET_CLASS(item);
 977     if (item_class.snappoints) {
 978         item_class.snappoints(item, target, p, snapprefs);
 979     }
 980
 981     // Get the snappoints at the item's center
 982     if (snapprefs != NULL && snapprefs->getIncludeItemCenter()) {
 983         p.push_back(std::make_pair(item->getCenter(), target ? int(Inkscape::SNAPTARGET_ROTATION_CENTER) : int(Inkscape::SNAPSOURCE_ROTATION_CENTER)));
 984     }
 985
 986     // Get the snappoints of clipping paths and mask, if any
 987     std::list<SPObject const *> clips_and_masks;
 988
 989     clips_and_masks.push_back(SP_OBJECT(item->clip_ref->getObject()));
 990     clips_and_masks.push_back(SP_OBJECT(item->mask_ref->getObject()));
 991
 992     SPDesktop *desktop = inkscape_active_desktop();
 993     for (std::list<SPObject const *>::const_iterator o = clips_and_masks.begin(); o != clips_and_masks.end(); o++) {
 994         if (*o) {
 995             // obj is a group object, the children are the actual clippers
 996             for (SPObject *child = (*o)->children ; child ; child = child->next) {
 997                 if (SP_IS_ITEM(child)) {
 998                         SnapPointsWithType p_clip_or_mask;
 999                     // Please note the recursive call here!
1000                     sp_item_snappoints(SP_ITEM(child), target, p_clip_or_mask, snapprefs);
1001                     // Take into account the transformation of the item being clipped or masked
1002                     for (SnapPointsWithType::const_iterator p_orig = p_clip_or_mask.begin(); p_orig != p_clip_or_mask.end(); p_orig++) {
1003                         // All snappoints are in desktop coordinates, but the item's transformation is
1004                         // in document coordinates. Hence the awkward construction below
1005                         Geom::Point pt = desktop->dt2doc((*p_orig).first) * sp_item_i2d_affine(item);
1006                         p.push_back(std::make_pair(pt, (*p_orig).second));
1007                     }
1008                 }
1009             }
1010         }
1011     }
1012 }
1013
1014 void
1015 sp_item_invoke_print(SPItem *item, SPPrintContext *ctx)
1016 {
1017     if (!item->isHidden()) {
1018         if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->print) {
1019             if (!item->transform.isIdentity()
1020                 || SP_OBJECT_STYLE(item)->opacity.value != SP_SCALE24_MAX)
1021             {
1022                 sp_print_bind(ctx, item->transform, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
1023                 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
1024                 sp_print_release(ctx);
1025             } else {
1026                 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
1027             }
1028         }
1029     }
1030 }
1031
1032 static gchar *
1033 sp_item_private_description(SPItem */*item*/)
1034 {
1035     return g_strdup(_("Object"));
1036 }
1037
1038 /**
1039  * Returns a string suitable for status bar, formatted in pango markup language.
1040  *
1041  * Must be freed by caller.
1042  */
1043 gchar *
1044 sp_item_description(SPItem *item)
1045 {
1046     g_assert(item != NULL);
1047     g_assert(SP_IS_ITEM(item));
1048
1049     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->description) {
1050         gchar *s = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->description(item);
1051         if (s && item->clip_ref->getObject()) {
1052             gchar *snew = g_strdup_printf (_("%s; <i>clipped</i>"), s);
1053             g_free (s);
1054             s = snew;
1055         }
1056         if (s && item->mask_ref->getObject()) {
1057             gchar *snew = g_strdup_printf (_("%s; <i>masked</i>"), s);
1058             g_free (s);
1059             s = snew;
1060         }
1061         if (SP_OBJECT_STYLE(item) && SP_OBJECT_STYLE(item)->filter.href && SP_OBJECT_STYLE(item)->filter.href->getObject()) {
1062             const gchar *label = SP_OBJECT_STYLE(item)->filter.href->getObject()->label();
1063             gchar *snew;
1064             if (label) {
1065                 snew = g_strdup_printf (_("%s; <i>filtered (%s)</i>"), s, label);
1066             } else {
1067                 snew = g_strdup_printf (_("%s; <i>filtered</i>"), s);
1068             }
1069             g_free (s);
1070             s = snew;
1071         }
1072         return s;
1073     }
1074
1075     g_assert_not_reached();
1076     return NULL;
1077 }
1078
1079 /**
1080  * Allocates unique integer keys.
1081  * \param numkeys Number of keys required.
1082  * \return First allocated key; hence if the returned key is n
1083  * you can use n, n + 1, ..., n + (numkeys - 1)
1084  */
1085 unsigned
1086 sp_item_display_key_new(unsigned numkeys)
1087 {
1088     static unsigned dkey = 0;
1089
1090     dkey += numkeys;
1091
1092     return dkey - numkeys;
1093 }
1094
1095 NRArenaItem *
1096 sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned key, unsigned flags)
1097 {
1098     g_assert(item != NULL);
1099     g_assert(SP_IS_ITEM(item));
1100     g_assert(arena != NULL);
1101     g_assert(NR_IS_ARENA(arena));
1102
1103     NRArenaItem *ai = NULL;
1104     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->show) {
1105         ai = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->show(item, arena, key, flags);
1106     }
1107
1108     if (ai != NULL) {
1109         item->display = sp_item_view_new_prepend(item->display, item, flags, key, ai);
1110         nr_arena_item_set_transform(ai, item->transform);
1111         nr_arena_item_set_opacity(ai, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
1112         nr_arena_item_set_visible(ai, !item->isHidden());
1113         nr_arena_item_set_sensitive(ai, item->sensitive);
1114         if (item->clip_ref->getObject()) {
1115             SPClipPath *cp = item->clip_ref->getObject();
1116
1117             if (!item->display->arenaitem->key) {
1118                 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
1119             }
1120             int clip_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
1121
1122             // Show and set clip
1123             NRArenaItem *ac = sp_clippath_show(cp, arena, clip_key);
1124             nr_arena_item_set_clip(ai, ac);
1125             nr_arena_item_unref(ac);
1126
1127             // Update bbox, in case the clip uses bbox units
1128             NRRect bbox;
1129             sp_item_invoke_bbox(item, &bbox, Geom::identity(), TRUE);
1130             sp_clippath_set_bbox(SP_CLIPPATH(cp), clip_key, &bbox);
1131             SP_OBJECT(cp)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
1132         }
1133         if (item->mask_ref->getObject()) {
1134             SPMask *mask = item->mask_ref->getObject();
1135
1136             if (!item->display->arenaitem->key) {
1137                 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
1138             }
1139             int mask_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
1140
1141             // Show and set mask
1142             NRArenaItem *ac = sp_mask_show(mask, arena, mask_key);
1143             nr_arena_item_set_mask(ai, ac);
1144             nr_arena_item_unref(ac);
1145
1146             // Update bbox, in case the mask uses bbox units
1147             NRRect bbox;
1148             sp_item_invoke_bbox(item, &bbox, Geom::identity(), TRUE);
1149             sp_mask_set_bbox(SP_MASK(mask), mask_key, &bbox);
1150             SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
1151         }
1152         NR_ARENA_ITEM_SET_DATA(ai, item);
1153         Geom::OptRect item_bbox;
1154         sp_item_invoke_bbox(item, item_bbox, Geom::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
1155         nr_arena_item_set_item_bbox(ai, item_bbox);
1156     }
1157
1158     return ai;
1159 }
1160
1161 void
1162 sp_item_invoke_hide(SPItem *item, unsigned key)
1163 {
1164     g_assert(item != NULL);
1165     g_assert(SP_IS_ITEM(item));
1166
1167     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide) {
1168         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide(item, key);
1169     }
1170
1171     SPItemView *ref = NULL;
1172     SPItemView *v = item->display;
1173     while (v != NULL) {
1174         SPItemView *next = v->next;
1175         if (v->key == key) {
1176             if (item->clip_ref->getObject()) {
1177                 sp_clippath_hide(item->clip_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
1178                 nr_arena_item_set_clip(v->arenaitem, NULL);
1179             }
1180             if (item->mask_ref->getObject()) {
1181                 sp_mask_hide(item->mask_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
1182                 nr_arena_item_set_mask(v->arenaitem, NULL);
1183             }
1184             if (!ref) {
1185                 item->display = v->next;
1186             } else {
1187                 ref->next = v->next;
1188             }
1189             nr_arena_item_unparent(v->arenaitem);
1190             nr_arena_item_unref(v->arenaitem);
1191             g_free(v);
1192         } else {
1193             ref = v;
1194         }
1195         v = next;
1196     }
1197 }
1198
1199 // Adjusters
1200
1201 void
1202 sp_item_adjust_pattern (SPItem *item, Geom::Matrix const &postmul, bool set)
1203 {
1204     SPStyle *style = SP_OBJECT_STYLE (item);
1205
1206     if (style && (style->fill.isPaintserver())) {
1207         SPObject *server = SP_OBJECT_STYLE_FILL_SERVER (item);
1208         if (SP_IS_PATTERN (server)) {
1209             SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "fill");
1210             sp_pattern_transform_multiply (pattern, postmul, set);
1211         }
1212     }
1213
1214     if (style && (style->stroke.isPaintserver())) {
1215         SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER (item);
1216         if (SP_IS_PATTERN (server)) {
1217             SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "stroke");
1218             sp_pattern_transform_multiply (pattern, postmul, set);
1219         }
1220     }
1221
1222 }
1223
1224 void
1225 sp_item_adjust_gradient (SPItem *item, Geom::Matrix const &postmul, bool set)
1226 {
1227     SPStyle *style = SP_OBJECT_STYLE (item);
1228
1229     if (style && (style->fill.isPaintserver())) {
1230         SPObject *server = SP_OBJECT_STYLE_FILL_SERVER(item);
1231         if (SP_IS_GRADIENT (server)) {
1232
1233             /**
1234              * \note Bbox units for a gradient are generally a bad idea because
1235              * with them, you cannot preserve the relative position of the
1236              * object and its gradient after rotation or skew. So now we
1237              * convert them to userspace units which are easy to keep in sync
1238              * just by adding the object's transform to gradientTransform.
1239              * \todo FIXME: convert back to bbox units after transforming with
1240              * the item, so as to preserve the original units.
1241              */
1242             SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "fill");
1243
1244             sp_gradient_transform_multiply (gradient, postmul, set);
1245         }
1246     }
1247
1248     if (style && (style->stroke.isPaintserver())) {
1249         SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER(item);
1250         if (SP_IS_GRADIENT (server)) {
1251             SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "stroke");
1252             sp_gradient_transform_multiply (gradient, postmul, set);
1253         }
1254     }
1255 }
1256
1257 void
1258 sp_item_adjust_stroke (SPItem *item, gdouble ex)
1259 {
1260     SPStyle *style = SP_OBJECT_STYLE (item);
1261
1262     if (style && !style->stroke.isNone() && !NR_DF_TEST_CLOSE (ex, 1.0, NR_EPSILON)) {
1263
1264         style->stroke_width.computed *= ex;
1265         style->stroke_width.set = TRUE;
1266
1267         if (style->stroke_dash.n_dash != 0) {
1268             int i;
1269             for (i = 0; i < style->stroke_dash.n_dash; i++) {
1270                 style->stroke_dash.dash[i] *= ex;
1271             }
1272             style->stroke_dash.offset *= ex;
1273         }
1274
1275         SP_OBJECT(item)->updateRepr();
1276     }
1277 }
1278
1279 /**
1280  * Find out the inverse of previous transform of an item (from its repr)
1281  */
1282 Geom::Matrix
1283 sp_item_transform_repr (SPItem *item)
1284 {
1285     Geom::Matrix t_old(Geom::identity());
1286     gchar const *t_attr = SP_OBJECT_REPR(item)->attribute("transform");
1287     if (t_attr) {
1288         Geom::Matrix t;
1289         if (sp_svg_transform_read(t_attr, &t)) {
1290             t_old = t;
1291         }
1292     }
1293
1294     return t_old;
1295 }
1296
1297
1298 /**
1299  * Recursively scale stroke width in \a item and its children by \a expansion.
1300  */
1301 void
1302 sp_item_adjust_stroke_width_recursive(SPItem *item, double expansion)
1303 {
1304     sp_item_adjust_stroke (item, expansion);
1305
1306 // A clone's child is the ghost of its original - we must not touch it, skip recursion
1307     if (item && SP_IS_USE(item))
1308         return;
1309
1310     for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1311         if (SP_IS_ITEM(o))
1312             sp_item_adjust_stroke_width_recursive(SP_ITEM(o), expansion);
1313     }
1314 }
1315
1316 /**
1317  * Recursively adjust rx and ry of rects.
1318  */
1319 void
1320 sp_item_adjust_rects_recursive(SPItem *item, Geom::Matrix advertized_transform)
1321 {
1322     if (SP_IS_RECT (item)) {
1323         sp_rect_compensate_rxry (SP_RECT(item), advertized_transform);
1324     }
1325
1326     for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1327         if (SP_IS_ITEM(o))
1328             sp_item_adjust_rects_recursive(SP_ITEM(o), advertized_transform);
1329     }
1330 }
1331
1332 /**
1333  * Recursively compensate pattern or gradient transform.
1334  */
1335 void
1336 sp_item_adjust_paint_recursive (SPItem *item, Geom::Matrix advertized_transform, Geom::Matrix t_ancestors, bool is_pattern)
1337 {
1338 // _Before_ full pattern/gradient transform: t_paint * t_item * t_ancestors
1339 // _After_ full pattern/gradient transform: t_paint_new * t_item * t_ancestors * advertised_transform
1340 // By equating these two expressions we get t_paint_new = t_paint * paint_delta, where:
1341     Geom::Matrix t_item = sp_item_transform_repr (item);
1342     Geom::Matrix paint_delta = t_item * t_ancestors * advertized_transform * t_ancestors.inverse() * t_item.inverse();
1343
1344 // Within text, we do not fork gradients, and so must not recurse to avoid double compensation;
1345 // also we do not recurse into clones, because a clone's child is the ghost of its original -
1346 // we must not touch it
1347     if (!(item && (SP_IS_TEXT(item) || SP_IS_USE(item)))) {
1348         for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1349             if (SP_IS_ITEM(o)) {
1350 // At the level of the transformed item, t_ancestors is identity;
1351 // below it, it is the accmmulated chain of transforms from this level to the top level
1352                 sp_item_adjust_paint_recursive (SP_ITEM(o), advertized_transform, t_item * t_ancestors, is_pattern);
1353             }
1354         }
1355     }
1356
1357 // We recursed into children first, and are now adjusting this object second;
1358 // this is so that adjustments in a tree are done from leaves up to the root,
1359 // and paintservers on leaves inheriting their values from ancestors could adjust themselves properly
1360 // before ancestors themselves are adjusted, probably differently (bug 1286535)
1361
1362     if (is_pattern)
1363         sp_item_adjust_pattern (item, paint_delta);
1364     else
1365         sp_item_adjust_gradient (item, paint_delta);
1366
1367 }
1368
1369 void
1370 sp_item_adjust_livepatheffect (SPItem *item, Geom::Matrix const &postmul, bool set)
1371 {
1372     if ( !SP_IS_LPE_ITEM(item) )
1373         return;
1374
1375     SPLPEItem *lpeitem = SP_LPE_ITEM (item);
1376     if ( sp_lpe_item_has_path_effect(lpeitem) ) {
1377         PathEffectList effect_list =  sp_lpe_item_get_effect_list(lpeitem);
1378         for (PathEffectList::iterator it = effect_list.begin(); it != effect_list.end(); it++)
1379         {
1380             // If the path effect is used by 2 or more items, fork it
1381             // so that each object has its own independent copy of the effect
1382             LivePathEffectObject *lpeobj = (*it)->lpeobject;
1383             if (lpeobj) {
1384                 LivePathEffectObject *new_lpeobj = lpeobj->fork_private_if_necessary();
1385                 if (new_lpeobj != lpeobj) {
1386                     sp_lpe_item_replace_path_effect(lpeitem, lpeobj, new_lpeobj);
1387                 }
1388
1389                 if (lpeobj->get_lpe()) {
1390                     Inkscape::LivePathEffect::Effect * effect = lpeobj->get_lpe();
1391                     effect->transform_multiply(postmul, set);
1392                 }
1393             }
1394         }
1395     }
1396 }
1397
1398 /**
1399  * Set a new transform on an object.
1400  *
1401  * Compensate for stroke scaling and gradient/pattern fill transform, if
1402  * necessary. Call the object's set_transform method if transforms are
1403  * stored optimized. Send _transformed_signal. Invoke _write method so that
1404  * the repr is updated with the new transform.
1405  */
1406 void
1407 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, Geom::Matrix const &transform, Geom::Matrix const *adv, bool compensate)
1408 {
1409     g_return_if_fail(item != NULL);
1410     g_return_if_fail(SP_IS_ITEM(item));
1411     g_return_if_fail(repr != NULL);
1412
1413     // calculate the relative transform, if not given by the adv attribute
1414     Geom::Matrix advertized_transform;
1415     if (adv != NULL) {
1416         advertized_transform = *adv;
1417     } else {
1418         advertized_transform = sp_item_transform_repr (item).inverse() * transform;
1419     }
1420
1421     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
1422     if (compensate) {
1423
1424          // recursively compensate for stroke scaling, depending on user preference
1425         if (!prefs->getBool("/options/transform/stroke", true)) {
1426             double const expansion = 1. / advertized_transform.descrim();
1427             sp_item_adjust_stroke_width_recursive(item, expansion);
1428         }
1429
1430         // recursively compensate rx/ry of a rect if requested
1431         if (!prefs->getBool("/options/transform/rectcorners", true)) {
1432             sp_item_adjust_rects_recursive(item, advertized_transform);
1433         }
1434
1435         // recursively compensate pattern fill if it's not to be transformed
1436         if (!prefs->getBool("/options/transform/pattern", true)) {
1437             sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), Geom::identity(), true);
1438         }
1439         /// \todo FIXME: add the same else branch as for gradients below, to convert patterns to userSpaceOnUse as well
1440         /// recursively compensate gradient fill if it's not to be transformed
1441         if (!prefs->getBool("/options/transform/gradient", true)) {
1442             sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), Geom::identity(), false);
1443         } else {
1444             // this converts the gradient/pattern fill/stroke, if any, to userSpaceOnUse; we need to do
1445             // it here _before_ the new transform is set, so as to use the pre-transform bbox
1446             sp_item_adjust_paint_recursive (item, Geom::identity(), Geom::identity(), false);
1447         }
1448
1449     } // endif(compensate)
1450
1451     gint preserve = prefs->getBool("/options/preservetransform/value", 0);
1452     Geom::Matrix transform_attr (transform);
1453     if ( // run the object's set_transform (i.e. embed transform) only if:
1454          ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform && // it does have a set_transform method
1455              !preserve && // user did not chose to preserve all transforms
1456              !item->clip_ref->getObject() && // the object does not have a clippath
1457              !item->mask_ref->getObject() && // the object does not have a mask
1458          !(!transform.isTranslation() && SP_OBJECT_STYLE(item) && SP_OBJECT_STYLE(item)->getFilter())
1459              // the object does not have a filter, or the transform is translation (which is supposed to not affect filters)
1460         ) {
1461         transform_attr = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform(item, transform);
1462     }
1463     sp_item_set_item_transform(item, transform_attr);
1464
1465     // Note: updateRepr comes before emitting the transformed signal since
1466     // it causes clone SPUse's copy of the original object to brought up to
1467     // date with the original.  Otherwise, sp_use_bbox returns incorrect
1468     // values if called in code handling the transformed signal.
1469     SP_OBJECT(item)->updateRepr();
1470
1471     // send the relative transform with a _transformed_signal
1472     item->_transformed_signal.emit(&advertized_transform, item);
1473 }
1474
1475 gint
1476 sp_item_event(SPItem *item, SPEvent *event)
1477 {
1478     g_return_val_if_fail(item != NULL, FALSE);
1479     g_return_val_if_fail(SP_IS_ITEM(item), FALSE);
1480     g_return_val_if_fail(event != NULL, FALSE);
1481
1482     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->event)
1483         return ((SPItemClass *) G_OBJECT_GET_CLASS(item))->event(item, event);
1484
1485     return FALSE;
1486 }
1487
1488 /**
1489  * Sets item private transform (not propagated to repr), without compensating stroke widths,
1490  * gradients, patterns as sp_item_write_transform does.
1491  */
1492 void
1493 sp_item_set_item_transform(SPItem *item, Geom::Matrix const &transform)
1494 {
1495     g_return_if_fail(item != NULL);
1496     g_return_if_fail(SP_IS_ITEM(item));
1497
1498     if (!matrix_equalp(transform, item->transform, NR_EPSILON)) {
1499         item->transform = transform;
1500         /* The SP_OBJECT_USER_MODIFIED_FLAG_B is used to mark the fact that it's only a
1501            transformation.  It's apparently not used anywhere else. */
1502         item->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_USER_MODIFIED_FLAG_B);
1503         sp_item_rm_unsatisfied_cns(*item);
1504     }
1505 }
1506
1507 void
1508 sp_item_convert_item_to_guides(SPItem *item) {
1509     g_return_if_fail(item != NULL);
1510     g_return_if_fail(SP_IS_ITEM(item));
1511
1512     /* Use derived method if present ... */
1513     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->convert_to_guides) {
1514         (*((SPItemClass *) G_OBJECT_GET_CLASS(item))->convert_to_guides)(item);
1515         return;
1516     }
1517
1518     /* .. otherwise simply place the guides around the item's bounding box */
1519
1520     sp_item_convert_to_guides(item);
1521 }
1522
1523
1524 /**
1525  * \pre \a ancestor really is an ancestor (\>=) of \a object, or NULL.
1526  *   ("Ancestor (\>=)" here includes as far as \a object itself.)
1527  */
1528 Geom::Matrix
1529 i2anc_affine(SPObject const *object, SPObject const *const ancestor) {
1530     Geom::Matrix ret(Geom::identity());
1531     g_return_val_if_fail(object != NULL, ret);
1532
1533     /* stop at first non-renderable ancestor */
1534     while ( object != ancestor && SP_IS_ITEM(object) ) {
1535         if (SP_IS_ROOT(object)) {
1536             ret *= SP_ROOT(object)->c2p;
1537         } else {
1538             ret *= SP_ITEM(object)->transform;
1539         }
1540         object = SP_OBJECT_PARENT(object);
1541     }
1542     return ret;
1543 }
1544
1545 Geom::Matrix
1546 i2i_affine(SPObject const *src, SPObject const *dest) {
1547     g_return_val_if_fail(src != NULL && dest != NULL, Geom::identity());
1548     SPObject const *ancestor = src->nearestCommonAncestor(dest);
1549     return i2anc_affine(src, ancestor) * i2anc_affine(dest, ancestor).inverse();
1550 }
1551
1552 Geom::Matrix SPItem::getRelativeTransform(SPObject const *dest) const {
1553     return i2i_affine(this, dest);
1554 }
1555
1556 /**
1557  * Returns the accumulated transformation of the item and all its ancestors, including root's viewport.
1558  * \pre (item != NULL) and SP_IS_ITEM(item).
1559  */
1560 Geom::Matrix sp_item_i2doc_affine(SPItem const *item)
1561 {
1562     return i2anc_affine(item, NULL);
1563 }
1564
1565 /**
1566  * Returns the transformation from item to desktop coords
1567  */
1568 Geom::Matrix sp_item_i2d_affine(SPItem const *item)
1569 {
1570     g_assert(item != NULL);
1571     g_assert(SP_IS_ITEM(item));
1572
1573     Geom::Matrix const ret( sp_item_i2doc_affine(item)
1574                           * Geom::Scale(1, -1)
1575                           * Geom::Translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1576     return ret;
1577 }
1578
1579 void sp_item_set_i2d_affine(SPItem *item, Geom::Matrix const &i2dt)
1580 {
1581     g_return_if_fail( item != NULL );
1582     g_return_if_fail( SP_IS_ITEM(item) );
1583
1584     Geom::Matrix dt2p; /* desktop to item parent transform */
1585     if (SP_OBJECT_PARENT(item)) {
1586         dt2p = sp_item_i2d_affine((SPItem *) SP_OBJECT_PARENT(item)).inverse();
1587     } else {
1588         dt2p = ( Geom::Translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1589                  * Geom::Scale(1, -1) );
1590     }
1591
1592     Geom::Matrix const i2p( i2dt * dt2p );
1593     sp_item_set_item_transform(item, i2p);
1594 }
1595
1596
1597 /**
1598  * should rather be named "sp_item_d2i_affine" to match "sp_item_i2d_affine" (or vice versa)
1599  */
1600 Geom::Matrix
1601 sp_item_dt2i_affine(SPItem const *item)
1602 {
1603     /* fixme: Implement the right way (Lauris) */
1604     return sp_item_i2d_affine(item).inverse();
1605 }
1606
1607 /* Item views */
1608
1609 static SPItemView *
1610 sp_item_view_new_prepend(SPItemView *list, SPItem *item, unsigned flags, unsigned key, NRArenaItem *arenaitem)
1611 {
1612     SPItemView *new_view;
1613
1614     g_assert(item != NULL);
1615     g_assert(SP_IS_ITEM(item));
1616     g_assert(arenaitem != NULL);
1617     g_assert(NR_IS_ARENA_ITEM(arenaitem));
1618
1619     new_view = g_new(SPItemView, 1);
1620
1621     new_view->next = list;
1622     new_view->flags = flags;
1623     new_view->key = key;
1624     new_view->arenaitem = arenaitem;
1625
1626     return new_view;
1627 }
1628
1629 static SPItemView *
1630 sp_item_view_list_remove(SPItemView *list, SPItemView *view)
1631 {
1632     if (view == list) {
1633         list = list->next;
1634     } else {
1635         SPItemView *prev;
1636         prev = list;
1637         while (prev->next != view) prev = prev->next;
1638         prev->next = view->next;
1639     }
1640
1641     nr_arena_item_unref(view->arenaitem);
1642     g_free(view);
1643
1644     return list;
1645 }
1646
1647 /**
1648  * Return the arenaitem corresponding to the given item in the display
1649  * with the given key
1650  */
1651 NRArenaItem *
1652 sp_item_get_arenaitem(SPItem *item, unsigned key)
1653 {
1654     for ( SPItemView *iv = item->display ; iv ; iv = iv->next ) {
1655         if ( iv->key == key ) {
1656             return iv->arenaitem;
1657         }
1658     }
1659
1660     return NULL;
1661 }
1662
1663 int
1664 sp_item_repr_compare_position(SPItem *first, SPItem *second)
1665 {
1666     return sp_repr_compare_position(SP_OBJECT_REPR(first),
1667                                     SP_OBJECT_REPR(second));
1668 }
1669
1670 SPItem *
1671 sp_item_first_item_child (SPObject *obj)
1672 {
1673     for ( SPObject *iter = sp_object_first_child(obj) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
1674         if (SP_IS_ITEM (iter))
1675             return SP_ITEM (iter);
1676     }
1677     return NULL;
1678 }
1679
1680 void
1681 sp_item_convert_to_guides(SPItem *item) {
1682     SPDesktop *dt = inkscape_active_desktop();
1683     SPNamedView *nv = sp_desktop_namedview(dt);
1684     (void)nv;
1685
1686     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
1687     int prefs_bbox = prefs->getInt("/tools/bounding_box", 0);
1688     SPItem::BBoxType bbox_type = (prefs_bbox ==0)?
1689         SPItem::APPROXIMATE_BBOX : SPItem::GEOMETRIC_BBOX;
1690
1691     Geom::OptRect bbox = sp_item_bbox_desktop(item, bbox_type);
1692     if (!bbox) {
1693         g_warning ("Cannot determine item's bounding box during conversion to guides.\n");
1694         return;
1695     }
1696
1697     std::list<std::pair<Geom::Point, Geom::Point> > pts;
1698
1699     Geom::Point A((*bbox).min());
1700     Geom::Point C((*bbox).max());
1701     Geom::Point B(A[Geom::X], C[Geom::Y]);
1702     Geom::Point D(C[Geom::X], A[Geom::Y]);
1703
1704     pts.push_back(std::make_pair(A, B));
1705     pts.push_back(std::make_pair(B, C));
1706     pts.push_back(std::make_pair(C, D));
1707     pts.push_back(std::make_pair(D, A));
1708
1709     sp_guide_pt_pairs_to_guides(dt, pts);
1710 }
1711
1712 /*
1713   Local Variables:
1714   mode:c++
1715   c-file-style:"stroustrup"
1716   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1717   indent-tabs-mode:nil
1718   fill-column:99
1719   End:
1720 */
1721 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :