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