Code

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