Code

switch to using extract_uri
[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"
53 #include "sp-filter-reference.h"
55 #include "libnr/nr-matrix-div.h"
56 #include "libnr/nr-matrix-fns.h"
57 #include "libnr/nr-matrix-scale-ops.h"
58 #include "libnr/nr-matrix-translate-ops.h"
59 #include "libnr/nr-scale-translate-ops.h"
60 #include "libnr/nr-translate-scale-ops.h"
61 #include "algorithms/find-last-if.h"
62 #include "util/reverse-list.h"
64 #include "xml/repr.h"
65 #include "extract-uri.h"
67 #define noSP_ITEM_DEBUG_IDLE
69 static void sp_item_class_init(SPItemClass *klass);
70 static void sp_item_init(SPItem *item);
72 static void sp_item_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
73 static void sp_item_release(SPObject *object);
74 static void sp_item_set(SPObject *object, unsigned key, gchar const *value);
75 static void sp_item_update(SPObject *object, SPCtx *ctx, guint flags);
76 static Inkscape::XML::Node *sp_item_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
78 static gchar *sp_item_private_description(SPItem *item);
79 static void sp_item_private_snappoints(SPItem const *item, SnapPointsIter p);
81 static SPItemView *sp_item_view_new_prepend(SPItemView *list, SPItem *item, unsigned flags, unsigned key, NRArenaItem *arenaitem);
82 static SPItemView *sp_item_view_list_remove(SPItemView *list, SPItemView *view);
84 static SPObjectClass *parent_class;
86 static void clip_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item);
87 static void mask_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item);
89 /**
90  * Registers SPItem class and returns its type number.
91  */
92 GType
93 sp_item_get_type(void)
94 {
95     static GType type = 0;
96     if (!type) {
97         GTypeInfo info = {
98             sizeof(SPItemClass),
99             NULL, NULL,
100             (GClassInitFunc) sp_item_class_init,
101             NULL, NULL,
102             sizeof(SPItem),
103             16,
104             (GInstanceInitFunc) sp_item_init,
105             NULL,   /* value_table */
106         };
107         type = g_type_register_static(SP_TYPE_OBJECT, "SPItem", &info, (GTypeFlags)0);
108     }
109     return type;
112 /**
113  * SPItem vtable initialization.
114  */
115 static void
116 sp_item_class_init(SPItemClass *klass)
118     SPObjectClass *sp_object_class = (SPObjectClass *) klass;
120     parent_class = (SPObjectClass *)g_type_class_ref(SP_TYPE_OBJECT);
122     sp_object_class->build = sp_item_build;
123     sp_object_class->release = sp_item_release;
124     sp_object_class->set = sp_item_set;
125     sp_object_class->update = sp_item_update;
126     sp_object_class->write = sp_item_write;
128     klass->description = sp_item_private_description;
129     klass->snappoints = sp_item_private_snappoints;
132 /**
133  * Callback for SPItem object initialization.
134  */
135 static void
136 sp_item_init(SPItem *item)
138     item->init();
141 void SPItem::init() {
142     this->sensitive = TRUE;
144     this->transform_center_x = 0;
145     this->transform_center_y = 0;
147     this->_is_evaluated = true;
148     this->_evaluated_status = StatusUnknown;
150     this->transform = NR::identity();
152     this->display = NULL;
154     this->clip_ref = new SPClipPathReference(this);
155                 sigc::signal<void, SPObject *, SPObject *> cs1=this->clip_ref->changedSignal();
156                 sigc::slot2<void,SPObject*, SPObject *> sl1=sigc::bind(sigc::ptr_fun(clip_ref_changed), this);
157     _clip_ref_connection = cs1.connect(sl1);
159     this->mask_ref = new SPMaskReference(this);
160                 sigc::signal<void, SPObject *, SPObject *> cs2=this->mask_ref->changedSignal();
161                 sigc::slot2<void,SPObject*, SPObject *> sl2=sigc::bind(sigc::ptr_fun(mask_ref_changed), this);
162     _mask_ref_connection = cs2.connect(sl2);
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() const {
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 = extract_uri(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 = extract_uri(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_CONNECTOR_AVOID:
490             item->avoidRef->setAvoid(value);
491             break;
492         case SP_ATTR_TRANSFORM_CENTER_X:
493             if (value) {
494                 item->transform_center_x = g_strtod(value, NULL);
495             } else {
496                 item->transform_center_x = 0;
497             }
498             object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
499             break;
500         case SP_ATTR_TRANSFORM_CENTER_Y:
501             if (value) {
502                 item->transform_center_y = g_strtod(value, NULL);
503             } else {
504                 item->transform_center_y = 0;
505             }
506             object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
507             break;
508         case SP_PROP_SYSTEM_LANGUAGE:
509         case SP_PROP_REQUIRED_FEATURES:
510         case SP_PROP_REQUIRED_EXTENSIONS:
511             {
512                 item->resetEvaluated();
513                 // pass to default handler
514             }
515         default:
516             if (SP_ATTRIBUTE_IS_CSS(key)) {
517                 sp_style_read_from_object(object->style, object);
518                 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
519             } else {
520                 if (((SPObjectClass *) (parent_class))->set) {
521                     (* ((SPObjectClass *) (parent_class))->set)(object, key, value);
522                 }
523             }
524             break;
525     }
528 static void
529 clip_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item)
531     if (old_clip) {
532         SPItemView *v;
533         /* Hide clippath */
534         for (v = item->display; v != NULL; v = v->next) {
535             sp_clippath_hide(SP_CLIPPATH(old_clip), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
536             nr_arena_item_set_clip(v->arenaitem, NULL);
537         }
538     }
539     if (SP_IS_CLIPPATH(clip)) {
540         NRRect bbox;
541         sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
542         for (SPItemView *v = item->display; v != NULL; v = v->next) {
543             if (!v->arenaitem->key) {
544                 NR_ARENA_ITEM_SET_KEY(v->arenaitem, sp_item_display_key_new(3));
545             }
546             NRArenaItem *ai = sp_clippath_show(SP_CLIPPATH(clip),
547                                                NR_ARENA_ITEM_ARENA(v->arenaitem),
548                                                NR_ARENA_ITEM_GET_KEY(v->arenaitem));
549             nr_arena_item_set_clip(v->arenaitem, ai);
550             nr_arena_item_unref(ai);
551             sp_clippath_set_bbox(SP_CLIPPATH(clip), NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
552             SP_OBJECT(clip)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
553         }
554     }
557 static void
558 mask_ref_changed(SPObject *old_mask, SPObject *mask, SPItem *item)
560     if (old_mask) {
561         /* Hide mask */
562         for (SPItemView *v = item->display; v != NULL; v = v->next) {
563             sp_mask_hide(SP_MASK(old_mask), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
564             nr_arena_item_set_mask(v->arenaitem, NULL);
565         }
566     }
567     if (SP_IS_MASK(mask)) {
568         NRRect bbox;
569         sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
570         for (SPItemView *v = item->display; v != NULL; v = v->next) {
571             if (!v->arenaitem->key) {
572                 NR_ARENA_ITEM_SET_KEY(v->arenaitem, sp_item_display_key_new(3));
573             }
574             NRArenaItem *ai = sp_mask_show(SP_MASK(mask),
575                                            NR_ARENA_ITEM_ARENA(v->arenaitem),
576                                            NR_ARENA_ITEM_GET_KEY(v->arenaitem));
577             nr_arena_item_set_mask(v->arenaitem, ai);
578             nr_arena_item_unref(ai);
579             sp_mask_set_bbox(SP_MASK(mask), NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
580             SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
581         }
582     }
585 static void
586 sp_item_update(SPObject *object, SPCtx *ctx, guint flags)
588     SPItem *item = SP_ITEM(object);
590     if (((SPObjectClass *) (parent_class))->update)
591         (* ((SPObjectClass *) (parent_class))->update)(object, ctx, flags);
593     if (flags & (SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG)) {
594         if (flags & SP_OBJECT_MODIFIED_FLAG) {
595             for (SPItemView *v = item->display; v != NULL; v = v->next) {
596                 nr_arena_item_set_transform(v->arenaitem, item->transform);
597             }
598         }
600         SPClipPath *clip_path = item->clip_ref->getObject();
601         SPMask *mask = item->mask_ref->getObject();
603         if ( clip_path || mask ) {
604             NRRect bbox;
605             sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
606             if (clip_path) {
607                 for (SPItemView *v = item->display; v != NULL; v = v->next) {
608                     sp_clippath_set_bbox(clip_path, NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
609                 }
610             }
611             if (mask) {
612                 for (SPItemView *v = item->display; v != NULL; v = v->next) {
613                     sp_mask_set_bbox(mask, NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
614                 }
615             }
616         }
618         if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
619             for (SPItemView *v = item->display; v != NULL; v = v->next) {
620                 nr_arena_item_set_opacity(v->arenaitem, SP_SCALE24_TO_FLOAT(object->style->opacity.value));
621                 nr_arena_item_set_visible(v->arenaitem, !item->isHidden());
622             }
623         }
624     }
626     // Update libavoid with item geometry (for connector routing).
627     item->avoidRef->handleSettingChange();
630 static Inkscape::XML::Node *
631 sp_item_write(SPObject *const object, Inkscape::XML::Node *repr, guint flags)
633     SPItem *item = SP_ITEM(object);
635     gchar *c = sp_svg_transform_write(item->transform);
636     repr->setAttribute("transform", c);
637     g_free(c);
639     if (flags & SP_OBJECT_WRITE_EXT) {
640         repr->setAttribute("sodipodi:insensitive", ( item->sensitive ? NULL : "true" ));
641         if (item->transform_center_x != 0)
642             sp_repr_set_svg_double (repr, "inkscape:transform-center-x", item->transform_center_x);
643         else
644             repr->setAttribute ("inkscape:transform-center-x", NULL);
645         if (item->transform_center_y != 0)
646             sp_repr_set_svg_double (repr, "inkscape:transform-center-y", item->transform_center_y);
647         else
648             repr->setAttribute ("inkscape:transform-center-y", NULL);
649     }
651     if (item->clip_ref->getObject()) {
652         const gchar *value = g_strdup_printf ("url(%s)", item->clip_ref->getURI()->toString());
653         repr->setAttribute ("clip-path", value);
654         g_free ((void *) value);
655     }
656     if (item->mask_ref->getObject()) {
657         const gchar *value = g_strdup_printf ("url(%s)", item->mask_ref->getURI()->toString());
658         repr->setAttribute ("mask", value);
659         g_free ((void *) value);
660     }
662     if (((SPObjectClass *) (parent_class))->write) {
663         ((SPObjectClass *) (parent_class))->write(object, repr, flags);
664     }
666     return repr;
669 NR::Maybe<NR::Rect> SPItem::getBounds(NR::Matrix const &transform,
670                                       SPItem::BBoxType type,
671                                       unsigned int dkey) const
673     NRRect r;
674     sp_item_invoke_bbox_full(this, &r, transform, type, TRUE);
675     return r;
678 void
679 sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
681     sp_item_invoke_bbox_full(item, bbox, transform, type, clear);
684 /** Calls \a item's subclass' bounding box method; clips it by the bbox of clippath, if any; and
685  * unions the resulting bbox with \a bbox. If \a clear is true, empties \a bbox first. Passes the
686  * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
687  * clones), in turn, call this function in their bbox methods. */
688 void
689 sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear)
691     g_assert(item != NULL);
692     g_assert(SP_IS_ITEM(item));
693     g_assert(bbox != NULL);
695     if (clear) {
696         bbox->x0 = bbox->y0 = 1e18;
697         bbox->x1 = bbox->y1 = -1e18;
698     }
700     NRRect this_bbox;
701     this_bbox.x0 = this_bbox.y0 = 1e18;
702     this_bbox.x1 = this_bbox.y1 = -1e18;
704     // call the subclass method
705     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox) {
706         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox(item, &this_bbox, transform, flags);
707     }
709     // unless this is geometric bbox, crop the bbox by clip path, if any
710     if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX && item->clip_ref->getObject()) {
711         NRRect b;
712         sp_clippath_get_bbox(SP_CLIPPATH(item->clip_ref->getObject()), &b, transform, flags);
713         nr_rect_d_intersect (&this_bbox, &this_bbox, &b);
714     }
716     // if non-empty (with some tolerance - ?) union this_bbox with the bbox we've got passed
717     if ( fabs(this_bbox.x1-this_bbox.x0) > -0.00001 && fabs(this_bbox.y1-this_bbox.y0) > -0.00001 ) {
718         nr_rect_d_union (bbox, bbox, &this_bbox);
719     }
722 unsigned sp_item_pos_in_parent(SPItem *item)
724     g_assert(item != NULL);
725     g_assert(SP_IS_ITEM(item));
727     SPObject *parent = SP_OBJECT_PARENT(item);
728     g_assert(parent != NULL);
729     g_assert(SP_IS_OBJECT(parent));
731     SPObject *object = SP_OBJECT(item);
733     unsigned pos=0;
734     for ( SPObject *iter = sp_object_first_child(parent) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
735         if ( iter == object ) {
736             return pos;
737         }
738         if (SP_IS_ITEM(iter)) {
739             pos++;
740         }
741     }
743     g_assert_not_reached();
744     return 0;
747 void
748 sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type)
750     g_assert(item != NULL);
751     g_assert(SP_IS_ITEM(item));
752     g_assert(bbox != NULL);
754     sp_item_invoke_bbox(item, bbox, sp_item_i2d_affine(item), TRUE, type);
757 NR::Maybe<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type)
759     NRRect ret;
760     sp_item_invoke_bbox(item, &ret, sp_item_i2d_affine(item), TRUE, type);
761     return ret.upgrade();
764 static void sp_item_private_snappoints(SPItem const *item, SnapPointsIter p)
766     NR::Maybe<NR::Rect> bbox = item->getBounds(sp_item_i2d_affine(item));
767     /* Just the corners of the bounding box suffices given that we don't yet
768        support angled guide lines. */
770     if (bbox) {
771         NR::Point p1, p2;
772         p1 = bbox->min();
773         p2 = bbox->max();
774         *p = p1;
775         *p = NR::Point(p1[NR::X], p2[NR::Y]);
776         *p = p2;
777         *p = NR::Point(p1[NR::Y], p2[NR::X]);
778     }
781 void sp_item_snappoints(SPItem const *item, SnapPointsIter p)
783     g_assert (item != NULL);
784     g_assert (SP_IS_ITEM(item));
786     SPItemClass const &item_class = *(SPItemClass const *) G_OBJECT_GET_CLASS(item);
787     if (item_class.snappoints) {
788         item_class.snappoints(item, p);
789     }
790     
791     *p = item->getCenter();
794 void
795 sp_item_invoke_print(SPItem *item, SPPrintContext *ctx)
797     if (!item->isHidden()) {
798         if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->print) {
799             if (!item->transform.test_identity()
800                 || SP_OBJECT_STYLE(item)->opacity.value != SP_SCALE24_MAX)
801             {
802                 sp_print_bind(ctx, item->transform, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
803                 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
804                 sp_print_release(ctx);
805             } else {
806                 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
807             }
808         }
809     }
812 static gchar *
813 sp_item_private_description(SPItem *item)
815     return g_strdup(_("Object"));
818 /**
819  * Returns a string suitable for status bar, formatted in pango markup language.
820  *
821  * Must be freed by caller.
822  */
823 gchar *
824 sp_item_description(SPItem *item)
826     g_assert(item != NULL);
827     g_assert(SP_IS_ITEM(item));
829     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->description) {
830         gchar *s = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->description(item);
831         if (s && item->clip_ref->getObject()) {
832             gchar *snew = g_strdup_printf (_("%s; <i>clipped</i>"), s);
833             g_free (s);
834             s = snew;
835         }
836         if (s && item->mask_ref->getObject()) {
837             gchar *snew = g_strdup_printf (_("%s; <i>masked</i>"), s);
838             g_free (s);
839             s = snew;
840         }
841         return s;
842     }
844     g_assert_not_reached();
845     return NULL;
848 /**
849  * Allocates unique integer keys.
850  * \param numkeys Number of keys required.
851  * \return First allocated key; hence if the returned key is n
852  * you can use n, n + 1, ..., n + (numkeys - 1)
853  */
854 unsigned
855 sp_item_display_key_new(unsigned numkeys)
857     static unsigned dkey = 0;
859     dkey += numkeys;
861     return dkey - numkeys;
864 NRArenaItem *
865 sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned key, unsigned flags)
867     g_assert(item != NULL);
868     g_assert(SP_IS_ITEM(item));
869     g_assert(arena != NULL);
870     g_assert(NR_IS_ARENA(arena));
872     NRArenaItem *ai = NULL;
873     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->show) {
874         ai = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->show(item, arena, key, flags);
875     }
877     if (ai != NULL) {
878         item->display = sp_item_view_new_prepend(item->display, item, flags, key, ai);
879         nr_arena_item_set_transform(ai, item->transform);
880         nr_arena_item_set_opacity(ai, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
881         nr_arena_item_set_visible(ai, !item->isHidden());
882         nr_arena_item_set_sensitive(ai, item->sensitive);
883         if (item->clip_ref->getObject()) {
884             SPClipPath *cp = item->clip_ref->getObject();
886             if (!item->display->arenaitem->key) {
887                 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
888             }
889             int clip_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
891             // Show and set clip
892             NRArenaItem *ac = sp_clippath_show(cp, arena, clip_key);
893             nr_arena_item_set_clip(ai, ac);
894             nr_arena_item_unref(ac);
896             // Update bbox, in case the clip uses bbox units
897             NRRect bbox;
898             sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
899             sp_clippath_set_bbox(SP_CLIPPATH(cp), clip_key, &bbox);
900             SP_OBJECT(cp)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
901         }
902         if (item->mask_ref->getObject()) {
903             SPMask *mask = item->mask_ref->getObject();
905             if (!item->display->arenaitem->key) {
906                 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
907             }
908             int mask_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
910             // Show and set mask
911             NRArenaItem *ac = sp_mask_show(mask, arena, mask_key);
912             nr_arena_item_set_mask(ai, ac);
913             nr_arena_item_unref(ac);
915             // Update bbox, in case the mask uses bbox units
916             NRRect bbox;
917             sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
918             sp_mask_set_bbox(SP_MASK(mask), mask_key, &bbox);
919             SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
920         }
921         NR_ARENA_ITEM_SET_DATA(ai, item);
922     }
924     return ai;
927 void
928 sp_item_invoke_hide(SPItem *item, unsigned key)
930     g_assert(item != NULL);
931     g_assert(SP_IS_ITEM(item));
933     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide) {
934         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide(item, key);
935     }
937     SPItemView *ref = NULL;
938     SPItemView *v = item->display;
939     while (v != NULL) {
940         SPItemView *next = v->next;
941         if (v->key == key) {
942             if (item->clip_ref->getObject()) {
943                 sp_clippath_hide(item->clip_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
944                 nr_arena_item_set_clip(v->arenaitem, NULL);
945             }
946             if (item->mask_ref->getObject()) {
947                 sp_mask_hide(item->mask_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
948                 nr_arena_item_set_mask(v->arenaitem, NULL);
949             }
950             if (!ref) {
951                 item->display = v->next;
952             } else {
953                 ref->next = v->next;
954             }
955             nr_arena_item_unparent(v->arenaitem);
956             nr_arena_item_unref(v->arenaitem);
957             g_free(v);
958         } else {
959             ref = v;
960         }
961         v = next;
962     }
965 // Adjusters
967 void
968 sp_item_adjust_pattern (SPItem *item, NR::Matrix const &postmul, bool set)
970     SPStyle *style = SP_OBJECT_STYLE (item);
972     if (style && (style->fill.type == SP_PAINT_TYPE_PAINTSERVER)) {
973         SPObject *server = SP_OBJECT_STYLE_FILL_SERVER (item);
974         if (SP_IS_PATTERN (server)) {
975             SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "fill");
976             sp_pattern_transform_multiply (pattern, postmul, set);
977         }
978     }
980     if (style && (style->stroke.type == SP_PAINT_TYPE_PAINTSERVER)) {
981         SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER (item);
982         if (SP_IS_PATTERN (server)) {
983             SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "stroke");
984             sp_pattern_transform_multiply (pattern, postmul, set);
985         }
986     }
990 void
991 sp_item_adjust_gradient (SPItem *item, NR::Matrix const &postmul, bool set)
993     SPStyle *style = SP_OBJECT_STYLE (item);
995     if (style && (style->fill.type == SP_PAINT_TYPE_PAINTSERVER)) {
996         SPObject *server = SP_OBJECT_STYLE_FILL_SERVER(item);
997         if (SP_IS_GRADIENT (server)) {
999             /**
1000              * \note Bbox units for a gradient are generally a bad idea because
1001              * with them, you cannot preserve the relative position of the
1002              * object and its gradient after rotation or skew. So now we
1003              * convert them to userspace units which are easy to keep in sync
1004              * just by adding the object's transform to gradientTransform.
1005              * \todo FIXME: convert back to bbox units after transforming with
1006              * the item, so as to preserve the original units.
1007              */
1008             SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "fill");
1010             sp_gradient_transform_multiply (gradient, postmul, set);
1011         }
1012     }
1014     if (style && (style->stroke.type == SP_PAINT_TYPE_PAINTSERVER)) {
1015         SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER(item);
1016         if (SP_IS_GRADIENT (server)) {
1017             SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "stroke");
1018             sp_gradient_transform_multiply (gradient, postmul, set);
1019         }
1020     }
1023 void
1024 sp_item_adjust_stroke (SPItem *item, gdouble ex)
1026     SPStyle *style = SP_OBJECT_STYLE (item);
1028     if (style && style->stroke.type != SP_PAINT_TYPE_NONE && !NR_DF_TEST_CLOSE (ex, 1.0, NR_EPSILON)) {
1030         style->stroke_width.computed *= ex;
1031         style->stroke_width.set = TRUE;
1033         if (style->stroke_dash.n_dash != 0) {
1034             int i;
1035             for (i = 0; i < style->stroke_dash.n_dash; i++) {
1036                 style->stroke_dash.dash[i] *= ex;
1037             }
1038             style->stroke_dash.offset *= ex;
1039         }
1041         SP_OBJECT(item)->updateRepr();
1042     }
1045 /**
1046  * Find out the inverse of previous transform of an item (from its repr)
1047  */
1048 NR::Matrix
1049 sp_item_transform_repr (SPItem *item)
1051     NR::Matrix t_old(NR::identity());
1052     gchar const *t_attr = SP_OBJECT_REPR(item)->attribute("transform");
1053     if (t_attr) {
1054         NR::Matrix t;
1055         if (sp_svg_transform_read(t_attr, &t)) {
1056             t_old = t;
1057         }
1058     }
1060     return t_old;
1064 /**
1065  * Recursively scale stroke width in \a item and its children by \a expansion.
1066  */
1067 void
1068 sp_item_adjust_stroke_width_recursive(SPItem *item, double expansion)
1070     sp_item_adjust_stroke (item, expansion);
1072 // A clone's child is the ghost of its original - we must not touch it, skip recursion
1073     if (item && SP_IS_USE(item))
1074         return;
1076     for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1077         if (SP_IS_ITEM(o))
1078             sp_item_adjust_stroke_width_recursive(SP_ITEM(o), expansion);
1079     }
1082 /**
1083  * Recursively adjust rx and ry of rects.
1084  */
1085 void
1086 sp_item_adjust_rects_recursive(SPItem *item, NR::Matrix advertized_transform)
1088     if (SP_IS_RECT (item)) {
1089         sp_rect_compensate_rxry (SP_RECT(item), advertized_transform);
1090     }
1092     for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1093         if (SP_IS_ITEM(o))
1094             sp_item_adjust_rects_recursive(SP_ITEM(o), advertized_transform);
1095     }
1098 /**
1099  * Recursively compensate pattern or gradient transform.
1100  */
1101 void
1102 sp_item_adjust_paint_recursive (SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern)
1104 // _Before_ full pattern/gradient transform: t_paint * t_item * t_ancestors
1105 // _After_ full pattern/gradient transform: t_paint_new * t_item * t_ancestors * advertised_transform
1106 // By equating these two expressions we get t_paint_new = t_paint * paint_delta, where:
1107     NR::Matrix t_item = sp_item_transform_repr (item);
1108     NR::Matrix paint_delta = t_item * t_ancestors * advertized_transform * t_ancestors.inverse() * t_item.inverse();
1110 // Within text, we do not fork gradients, and so must not recurse to avoid double compensation;
1111 // also we do not recurse into clones, because a clone's child is the ghost of its original - 
1112 // we must not touch it
1113     if (!(item && (SP_IS_TEXT(item) || SP_IS_USE(item)))) {
1114         for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1115             if (SP_IS_ITEM(o)) {
1116 // At the level of the transformed item, t_ancestors is identity;
1117 // below it, it is the accmmulated chain of transforms from this level to the top level
1118                 sp_item_adjust_paint_recursive (SP_ITEM(o), advertized_transform, t_item * t_ancestors, is_pattern);
1119             }
1120         }
1121     }
1123 // We recursed into children first, and are now adjusting this object second;
1124 // this is so that adjustments in a tree are done from leaves up to the root,
1125 // and paintservers on leaves inheriting their values from ancestors could adjust themselves properly
1126 // before ancestors themselves are adjusted, probably differently (bug 1286535)
1128     if (is_pattern)
1129         sp_item_adjust_pattern (item, paint_delta);
1130     else
1131         sp_item_adjust_gradient (item, paint_delta);
1135 /**
1136  * A temporary wrapper for the next function accepting the NRMatrix
1137  * instead of NR::Matrix
1138  */
1139 void
1140 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv)
1142     if (transform == NULL)
1143         sp_item_write_transform(item, repr, NR::identity(), adv);
1144     else
1145         sp_item_write_transform(item, repr, NR::Matrix (transform), adv);
1148 /**
1149  * Set a new transform on an object.
1150  *
1151  * Compensate for stroke scaling and gradient/pattern fill transform, if
1152  * necessary. Call the object's set_transform method if transforms are
1153  * stored optimized. Send _transformed_signal. Invoke _write method so that
1154  * the repr is updated with the new transform.
1155  */
1156 void
1157 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv, bool compensate)
1159     g_return_if_fail(item != NULL);
1160     g_return_if_fail(SP_IS_ITEM(item));
1161     g_return_if_fail(repr != NULL);
1163     // calculate the relative transform, if not given by the adv attribute
1164     NR::Matrix advertized_transform;
1165     if (adv != NULL) {
1166         advertized_transform = *adv;
1167     } else {
1168         advertized_transform = sp_item_transform_repr (item).inverse() * transform;
1169     }
1170     
1171     if (compensate) {
1172         
1173          // recursively compensate for stroke scaling, depending on user preference
1174         if (prefs_get_int_attribute("options.transform", "stroke", 1) == 0) {
1175             double const expansion = 1. / NR::expansion(advertized_transform);
1176             sp_item_adjust_stroke_width_recursive(item, expansion);
1177         }
1178     
1179         // recursively compensate rx/ry of a rect if requested
1180         if (prefs_get_int_attribute("options.transform", "rectcorners", 1) == 0) {
1181             sp_item_adjust_rects_recursive(item, advertized_transform);
1182         }
1183     
1184         // recursively compensate pattern fill if it's not to be transformed
1185         if (prefs_get_int_attribute("options.transform", "pattern", 1) == 0) {
1186             sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), NR::identity(), true);
1187         }
1188         /// \todo FIXME: add the same else branch as for gradients below, to convert patterns to userSpaceOnUse as well
1189         /// recursively compensate gradient fill if it's not to be transformed
1190         if (prefs_get_int_attribute("options.transform", "gradient", 1) == 0) {
1191             sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), NR::identity(), false);
1192         } else {
1193             // this converts the gradient/pattern fill/stroke, if any, to userSpaceOnUse; we need to do
1194             // it here _before_ the new transform is set, so as to use the pre-transform bbox
1195             sp_item_adjust_paint_recursive (item, NR::identity(), NR::identity(), false);
1196         }          
1197         
1198     } // endif(compensate)
1200     gint preserve = prefs_get_int_attribute("options.preservetransform", "value", 0);
1201     NR::Matrix transform_attr (transform);
1202     if ( // run the object's set_transform (i.e. embed transform) only if:
1203          ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform && // it does have a set_transform method
1204              !preserve && // user did not chose to preserve all transforms
1205              !item->clip_ref->getObject() && // the object does not have a clippath
1206              !item->mask_ref->getObject() && // the object does not have a mask
1207          !(!transform.is_translation() && SP_OBJECT_STYLE(item) && SP_OBJECT_STYLE(item)->getFilter()) 
1208              // the object does not have a filter, or the transform is translation (which is supposed to not affect filters)
1209         ) {
1210         transform_attr = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform(item, transform);
1211     }
1212     sp_item_set_item_transform(item, transform_attr);
1214     // Note: updateRepr comes before emitting the transformed signal since
1215     // it causes clone SPUse's copy of the original object to brought up to
1216     // date with the original.  Otherwise, sp_use_bbox returns incorrect
1217     // values if called in code handling the transformed signal.
1218     SP_OBJECT(item)->updateRepr();
1220     // send the relative transform with a _transformed_signal
1221     item->_transformed_signal.emit(&advertized_transform, item);
1224 gint
1225 sp_item_event(SPItem *item, SPEvent *event)
1227     g_return_val_if_fail(item != NULL, FALSE);
1228     g_return_val_if_fail(SP_IS_ITEM(item), FALSE);
1229     g_return_val_if_fail(event != NULL, FALSE);
1231     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->event)
1232         return ((SPItemClass *) G_OBJECT_GET_CLASS(item))->event(item, event);
1234     return FALSE;
1237 /**
1238  * Sets item private transform (not propagated to repr), without compensating stroke widths,
1239  * gradients, patterns as sp_item_write_transform does.
1240  */
1241 void
1242 sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform)
1244     g_return_if_fail(item != NULL);
1245     g_return_if_fail(SP_IS_ITEM(item));
1247     if (!matrix_equalp(transform, item->transform, NR_EPSILON)) {
1248         item->transform = transform;
1249         /* The SP_OBJECT_USER_MODIFIED_FLAG_B is used to mark the fact that it's only a
1250            transformation.  It's apparently not used anywhere else. */
1251         item->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_USER_MODIFIED_FLAG_B);
1252         sp_item_rm_unsatisfied_cns(*item);
1253     }
1257 /**
1258  * \pre \a ancestor really is an ancestor (\>=) of \a object, or NULL.
1259  *   ("Ancestor (\>=)" here includes as far as \a object itself.)
1260  */
1261 NR::Matrix
1262 i2anc_affine(SPObject const *object, SPObject const *const ancestor) {
1263     NR::Matrix ret(NR::identity());
1264     g_return_val_if_fail(object != NULL, ret);
1266     /* stop at first non-renderable ancestor */
1267     while ( object != ancestor && SP_IS_ITEM(object) ) {
1268         if (SP_IS_ROOT(object)) {
1269             ret *= SP_ROOT(object)->c2p;
1270         }
1271         ret *= SP_ITEM(object)->transform;
1272         object = SP_OBJECT_PARENT(object);
1273     }
1274     return ret;
1277 NR::Matrix
1278 i2i_affine(SPObject const *src, SPObject const *dest) {
1279     g_return_val_if_fail(src != NULL && dest != NULL, NR::identity());
1280     SPObject const *ancestor = src->nearestCommonAncestor(dest);
1281     return i2anc_affine(src, ancestor) / i2anc_affine(dest, ancestor);
1284 NR::Matrix SPItem::getRelativeTransform(SPObject const *dest) const {
1285     return i2i_affine(this, dest);
1288 /**
1289  * Returns the accumulated transformation of the item and all its ancestors, including root's viewport.
1290  * \pre (item != NULL) and SP_IS_ITEM(item).
1291  */
1292 NR::Matrix sp_item_i2doc_affine(SPItem const *item)
1294     return i2anc_affine(item, NULL);
1297 /**
1298  * Returns the accumulated transformation of the item and all its ancestors, but excluding root's viewport.
1299  * Used in path operations mostly.
1300  * \pre (item != NULL) and SP_IS_ITEM(item).
1301  */
1302 NR::Matrix sp_item_i2root_affine(SPItem const *item)
1304     g_assert(item != NULL);
1305     g_assert(SP_IS_ITEM(item));
1307     NR::Matrix ret(NR::identity());
1308     g_assert(ret.test_identity());
1309     while ( NULL != SP_OBJECT_PARENT(item) ) {
1310         ret *= item->transform;
1311         item = SP_ITEM(SP_OBJECT_PARENT(item));
1312     }
1313     g_assert(SP_IS_ROOT(item));
1315     ret *= item->transform;
1317     return ret;
1320 /* fixme: This is EVIL!!! */
1322 NR::Matrix sp_item_i2d_affine(SPItem const *item)
1324     g_assert(item != NULL);
1325     g_assert(SP_IS_ITEM(item));
1327     NR::Matrix const ret( sp_item_i2doc_affine(item)
1328                           * NR::scale(1, -1)
1329                           * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1330     return ret;
1333 // same as i2d but with i2root instead of i2doc
1334 NR::Matrix sp_item_i2r_affine(SPItem const *item)
1336     g_assert(item != NULL);
1337     g_assert(SP_IS_ITEM(item));
1339     NR::Matrix const ret( sp_item_i2root_affine(item)
1340                           * NR::scale(1, -1)
1341                           * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1342     return ret;
1345 /**
1346  * Converts a matrix \a m into the desktop coords of the \a item.
1347  * Will become a noop when we eliminate the coordinate flipping.
1348  */
1349 NR::Matrix matrix_to_desktop(NR::Matrix const m, SPItem const *item)
1351     NR::Matrix const ret(m
1352                          * NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1353                          * NR::scale(1, -1));
1354     return ret;
1357 /**
1358  * Converts a matrix \a m from the desktop coords of the \a item.
1359  * Will become a noop when we eliminate the coordinate flipping.
1360  */
1361 NR::Matrix matrix_from_desktop(NR::Matrix const m, SPItem const *item)
1363     NR::Matrix const ret(NR::scale(1, -1)
1364                          * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item)))
1365                          * m);
1366     return ret;
1369 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &i2dt)
1371     g_return_if_fail( item != NULL );
1372     g_return_if_fail( SP_IS_ITEM(item) );
1374     NR::Matrix dt2p; /* desktop to item parent transform */
1375     if (SP_OBJECT_PARENT(item)) {
1376         dt2p = sp_item_i2d_affine((SPItem *) SP_OBJECT_PARENT(item)).inverse();
1377     } else {
1378         dt2p = ( NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1379                  * NR::scale(1, -1) );
1380     }
1382     NR::Matrix const i2p( i2dt * dt2p );
1383     sp_item_set_item_transform(item, i2p);
1387 NR::Matrix
1388 sp_item_dt2i_affine(SPItem const *item)
1390     /* fixme: Implement the right way (Lauris) */
1391     return sp_item_i2d_affine(item).inverse();
1394 /* Item views */
1396 static SPItemView *
1397 sp_item_view_new_prepend(SPItemView *list, SPItem *item, unsigned flags, unsigned key, NRArenaItem *arenaitem)
1399     SPItemView *new_view;
1401     g_assert(item != NULL);
1402     g_assert(SP_IS_ITEM(item));
1403     g_assert(arenaitem != NULL);
1404     g_assert(NR_IS_ARENA_ITEM(arenaitem));
1406     new_view = g_new(SPItemView, 1);
1408     new_view->next = list;
1409     new_view->flags = flags;
1410     new_view->key = key;
1411     new_view->arenaitem = nr_arena_item_ref(arenaitem);
1413     return new_view;
1416 static SPItemView *
1417 sp_item_view_list_remove(SPItemView *list, SPItemView *view)
1419     if (view == list) {
1420         list = list->next;
1421     } else {
1422         SPItemView *prev;
1423         prev = list;
1424         while (prev->next != view) prev = prev->next;
1425         prev->next = view->next;
1426     }
1428     nr_arena_item_unref(view->arenaitem);
1429     g_free(view);
1431     return list;
1434 /**
1435  * Return the arenaitem corresponding to the given item in the display
1436  * with the given key
1437  */
1438 NRArenaItem *
1439 sp_item_get_arenaitem(SPItem *item, unsigned key)
1441     for ( SPItemView *iv = item->display ; iv ; iv = iv->next ) {
1442         if ( iv->key == key ) {
1443             return iv->arenaitem;
1444         }
1445     }
1447     return NULL;
1450 int
1451 sp_item_repr_compare_position(SPItem *first, SPItem *second)
1453     return sp_repr_compare_position(SP_OBJECT_REPR(first),
1454                                     SP_OBJECT_REPR(second));
1457 SPItem *
1458 sp_item_first_item_child (SPObject *obj)
1460     for ( SPObject *iter = sp_object_first_child(obj) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
1461         if (SP_IS_ITEM (iter))
1462             return SP_ITEM (iter);
1463     }
1464     return NULL;
1468 /*
1469   Local Variables:
1470   mode:c++
1471   c-file-style:"stroustrup"
1472   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1473   indent-tabs-mode:nil
1474   fill-column:99
1475   End:
1476 */
1477 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :