src/sp-item.cpp

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