Code

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