Code

make win32 compile using libxslt
[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     if (item->display && item->display->arenaitem) {
627         NRRect item_bbox;
628         sp_item_invoke_bbox(item, &item_bbox, NR::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
629         NR::Maybe<NR::Rect> i_bbox = item_bbox;
630         nr_arena_item_set_item_bbox(item->display->arenaitem, i_bbox);
631     }
633     // Update libavoid with item geometry (for connector routing).
634     item->avoidRef->handleSettingChange();
637 static Inkscape::XML::Node *
638 sp_item_write(SPObject *const object, Inkscape::XML::Node *repr, guint flags)
640     SPItem *item = SP_ITEM(object);
642     gchar *c = sp_svg_transform_write(item->transform);
643     repr->setAttribute("transform", c);
644     g_free(c);
646     if (flags & SP_OBJECT_WRITE_EXT) {
647         repr->setAttribute("sodipodi:insensitive", ( item->sensitive ? NULL : "true" ));
648         if (item->transform_center_x != 0)
649             sp_repr_set_svg_double (repr, "inkscape:transform-center-x", item->transform_center_x);
650         else
651             repr->setAttribute ("inkscape:transform-center-x", NULL);
652         if (item->transform_center_y != 0)
653             sp_repr_set_svg_double (repr, "inkscape:transform-center-y", item->transform_center_y);
654         else
655             repr->setAttribute ("inkscape:transform-center-y", NULL);
656     }
658     if (item->clip_ref->getObject()) {
659         const gchar *value = g_strdup_printf ("url(%s)", item->clip_ref->getURI()->toString());
660         repr->setAttribute ("clip-path", value);
661         g_free ((void *) value);
662     }
663     if (item->mask_ref->getObject()) {
664         const gchar *value = g_strdup_printf ("url(%s)", item->mask_ref->getURI()->toString());
665         repr->setAttribute ("mask", value);
666         g_free ((void *) value);
667     }
669     if (((SPObjectClass *) (parent_class))->write) {
670         ((SPObjectClass *) (parent_class))->write(object, repr, flags);
671     }
673     return repr;
676 NR::Maybe<NR::Rect> SPItem::getBounds(NR::Matrix const &transform,
677                                       SPItem::BBoxType type,
678                                       unsigned int dkey) const
680     NRRect r;
681     sp_item_invoke_bbox_full(this, &r, transform, type, TRUE);
682     return r;
685 void
686 sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
688     sp_item_invoke_bbox_full(item, bbox, transform, type, clear);
691 /** Calls \a item's subclass' bounding box method; clips it by the bbox of clippath, if any; and
692  * unions the resulting bbox with \a bbox. If \a clear is true, empties \a bbox first. Passes the
693  * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
694  * clones), in turn, call this function in their bbox methods. */
695 void
696 sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear)
698     g_assert(item != NULL);
699     g_assert(SP_IS_ITEM(item));
700     g_assert(bbox != NULL);
702     if (clear) {
703         bbox->x0 = bbox->y0 = 1e18;
704         bbox->x1 = bbox->y1 = -1e18;
705     }
707     NRRect this_bbox;
708     this_bbox.x0 = this_bbox.y0 = 1e18;
709     this_bbox.x1 = this_bbox.y1 = -1e18;
711     // call the subclass method
712     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox) {
713         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox(item, &this_bbox, transform, flags);
714     }
716     // unless this is geometric bbox, crop the bbox by clip path, if any
717     if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX && item->clip_ref->getObject()) {
718         NRRect b;
719         sp_clippath_get_bbox(SP_CLIPPATH(item->clip_ref->getObject()), &b, transform, flags);
720         nr_rect_d_intersect (&this_bbox, &this_bbox, &b);
721     }
723     // if non-empty (with some tolerance - ?) union this_bbox with the bbox we've got passed
724     if ( fabs(this_bbox.x1-this_bbox.x0) > -0.00001 && fabs(this_bbox.y1-this_bbox.y0) > -0.00001 ) {
725         nr_rect_d_union (bbox, bbox, &this_bbox);
726     }
729 unsigned sp_item_pos_in_parent(SPItem *item)
731     g_assert(item != NULL);
732     g_assert(SP_IS_ITEM(item));
734     SPObject *parent = SP_OBJECT_PARENT(item);
735     g_assert(parent != NULL);
736     g_assert(SP_IS_OBJECT(parent));
738     SPObject *object = SP_OBJECT(item);
740     unsigned pos=0;
741     for ( SPObject *iter = sp_object_first_child(parent) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
742         if ( iter == object ) {
743             return pos;
744         }
745         if (SP_IS_ITEM(iter)) {
746             pos++;
747         }
748     }
750     g_assert_not_reached();
751     return 0;
754 void
755 sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type)
757     g_assert(item != NULL);
758     g_assert(SP_IS_ITEM(item));
759     g_assert(bbox != NULL);
761     sp_item_invoke_bbox(item, bbox, sp_item_i2d_affine(item), TRUE, type);
764 NR::Maybe<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type)
766     NRRect ret;
767     sp_item_invoke_bbox(item, &ret, sp_item_i2d_affine(item), TRUE, type);
768     return ret.upgrade();
771 static void sp_item_private_snappoints(SPItem const *item, SnapPointsIter p)
773     NR::Maybe<NR::Rect> bbox = item->getBounds(sp_item_i2d_affine(item));
774     /* Just the corners of the bounding box suffices given that we don't yet
775        support angled guide lines. */
777     if (bbox) {
778         NR::Point p1, p2;
779         p1 = bbox->min();
780         p2 = bbox->max();
781         *p = p1;
782         *p = NR::Point(p1[NR::X], p2[NR::Y]);
783         *p = p2;
784         *p = NR::Point(p1[NR::Y], p2[NR::X]);
785     }
788 void sp_item_snappoints(SPItem const *item, SnapPointsIter p)
790     g_assert (item != NULL);
791     g_assert (SP_IS_ITEM(item));
793     SPItemClass const &item_class = *(SPItemClass const *) G_OBJECT_GET_CLASS(item);
794     if (item_class.snappoints) {
795         item_class.snappoints(item, p);
796     }
799 void
800 sp_item_invoke_print(SPItem *item, SPPrintContext *ctx)
802     if (!item->isHidden()) {
803         if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->print) {
804             if (!item->transform.test_identity()
805                 || SP_OBJECT_STYLE(item)->opacity.value != SP_SCALE24_MAX)
806             {
807                 sp_print_bind(ctx, item->transform, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
808                 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
809                 sp_print_release(ctx);
810             } else {
811                 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
812             }
813         }
814     }
817 static gchar *
818 sp_item_private_description(SPItem *item)
820     return g_strdup(_("Object"));
823 /**
824  * Returns a string suitable for status bar, formatted in pango markup language.
825  *
826  * Must be freed by caller.
827  */
828 gchar *
829 sp_item_description(SPItem *item)
831     g_assert(item != NULL);
832     g_assert(SP_IS_ITEM(item));
834     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->description) {
835         gchar *s = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->description(item);
836         if (s && item->clip_ref->getObject()) {
837             gchar *snew = g_strdup_printf (_("%s; <i>clipped</i>"), s);
838             g_free (s);
839             s = snew;
840         }
841         if (s && item->mask_ref->getObject()) {
842             gchar *snew = g_strdup_printf (_("%s; <i>masked</i>"), s);
843             g_free (s);
844             s = snew;
845         }
846         return s;
847     }
849     g_assert_not_reached();
850     return NULL;
853 /**
854  * Allocates unique integer keys.
855  * \param numkeys Number of keys required.
856  * \return First allocated key; hence if the returned key is n
857  * you can use n, n + 1, ..., n + (numkeys - 1)
858  */
859 unsigned
860 sp_item_display_key_new(unsigned numkeys)
862     static unsigned dkey = 0;
864     dkey += numkeys;
866     return dkey - numkeys;
869 NRArenaItem *
870 sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned key, unsigned flags)
872     g_assert(item != NULL);
873     g_assert(SP_IS_ITEM(item));
874     g_assert(arena != NULL);
875     g_assert(NR_IS_ARENA(arena));
877     NRArenaItem *ai = NULL;
878     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->show) {
879         ai = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->show(item, arena, key, flags);
880     }
882     if (ai != NULL) {
883         item->display = sp_item_view_new_prepend(item->display, item, flags, key, ai);
884         nr_arena_item_set_transform(ai, item->transform);
885         nr_arena_item_set_opacity(ai, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
886         nr_arena_item_set_visible(ai, !item->isHidden());
887         nr_arena_item_set_sensitive(ai, item->sensitive);
888         if (item->clip_ref->getObject()) {
889             SPClipPath *cp = item->clip_ref->getObject();
891             if (!item->display->arenaitem->key) {
892                 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
893             }
894             int clip_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
896             // Show and set clip
897             NRArenaItem *ac = sp_clippath_show(cp, arena, clip_key);
898             nr_arena_item_set_clip(ai, ac);
899             nr_arena_item_unref(ac);
901             // Update bbox, in case the clip uses bbox units
902             NRRect bbox;
903             sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
904             sp_clippath_set_bbox(SP_CLIPPATH(cp), clip_key, &bbox);
905             SP_OBJECT(cp)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
906         }
907         if (item->mask_ref->getObject()) {
908             SPMask *mask = item->mask_ref->getObject();
910             if (!item->display->arenaitem->key) {
911                 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
912             }
913             int mask_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
915             // Show and set mask
916             NRArenaItem *ac = sp_mask_show(mask, arena, mask_key);
917             nr_arena_item_set_mask(ai, ac);
918             nr_arena_item_unref(ac);
920             // Update bbox, in case the mask uses bbox units
921             NRRect bbox;
922             sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
923             sp_mask_set_bbox(SP_MASK(mask), mask_key, &bbox);
924             SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
925         }
926         NR_ARENA_ITEM_SET_DATA(ai, item);
927         NRRect item_bbox;
928         sp_item_invoke_bbox(item, &item_bbox, NR::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
929         NR::Maybe<NR::Rect> i_bbox = item_bbox;
930         nr_arena_item_set_item_bbox(ai, i_bbox);
931     }
933     return ai;
936 void
937 sp_item_invoke_hide(SPItem *item, unsigned key)
939     g_assert(item != NULL);
940     g_assert(SP_IS_ITEM(item));
942     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide) {
943         ((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide(item, key);
944     }
946     SPItemView *ref = NULL;
947     SPItemView *v = item->display;
948     while (v != NULL) {
949         SPItemView *next = v->next;
950         if (v->key == key) {
951             if (item->clip_ref->getObject()) {
952                 sp_clippath_hide(item->clip_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
953                 nr_arena_item_set_clip(v->arenaitem, NULL);
954             }
955             if (item->mask_ref->getObject()) {
956                 sp_mask_hide(item->mask_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
957                 nr_arena_item_set_mask(v->arenaitem, NULL);
958             }
959             if (!ref) {
960                 item->display = v->next;
961             } else {
962                 ref->next = v->next;
963             }
964             nr_arena_item_unparent(v->arenaitem);
965             nr_arena_item_unref(v->arenaitem);
966             g_free(v);
967         } else {
968             ref = v;
969         }
970         v = next;
971     }
974 // Adjusters
976 void
977 sp_item_adjust_pattern (SPItem *item, NR::Matrix const &postmul, bool set)
979     SPStyle *style = SP_OBJECT_STYLE (item);
981     if (style && (style->fill.isPaintserver())) {
982         SPObject *server = SP_OBJECT_STYLE_FILL_SERVER (item);
983         if (SP_IS_PATTERN (server)) {
984             SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "fill");
985             sp_pattern_transform_multiply (pattern, postmul, set);
986         }
987     }
989     if (style && (style->stroke.isPaintserver())) {
990         SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER (item);
991         if (SP_IS_PATTERN (server)) {
992             SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "stroke");
993             sp_pattern_transform_multiply (pattern, postmul, set);
994         }
995     }
999 void
1000 sp_item_adjust_gradient (SPItem *item, NR::Matrix const &postmul, bool set)
1002     SPStyle *style = SP_OBJECT_STYLE (item);
1004     if (style && (style->fill.isPaintserver())) {
1005         SPObject *server = SP_OBJECT_STYLE_FILL_SERVER(item);
1006         if (SP_IS_GRADIENT (server)) {
1008             /**
1009              * \note Bbox units for a gradient are generally a bad idea because
1010              * with them, you cannot preserve the relative position of the
1011              * object and its gradient after rotation or skew. So now we
1012              * convert them to userspace units which are easy to keep in sync
1013              * just by adding the object's transform to gradientTransform.
1014              * \todo FIXME: convert back to bbox units after transforming with
1015              * the item, so as to preserve the original units.
1016              */
1017             SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "fill");
1019             sp_gradient_transform_multiply (gradient, postmul, set);
1020         }
1021     }
1023     if (style && (style->stroke.isPaintserver())) {
1024         SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER(item);
1025         if (SP_IS_GRADIENT (server)) {
1026             SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "stroke");
1027             sp_gradient_transform_multiply (gradient, postmul, set);
1028         }
1029     }
1032 void
1033 sp_item_adjust_stroke (SPItem *item, gdouble ex)
1035     SPStyle *style = SP_OBJECT_STYLE (item);
1037     if (style && !style->stroke.isNone() && !NR_DF_TEST_CLOSE (ex, 1.0, NR_EPSILON)) {
1039         style->stroke_width.computed *= ex;
1040         style->stroke_width.set = TRUE;
1042         if (style->stroke_dash.n_dash != 0) {
1043             int i;
1044             for (i = 0; i < style->stroke_dash.n_dash; i++) {
1045                 style->stroke_dash.dash[i] *= ex;
1046             }
1047             style->stroke_dash.offset *= ex;
1048         }
1050         SP_OBJECT(item)->updateRepr();
1051     }
1054 /**
1055  * Find out the inverse of previous transform of an item (from its repr)
1056  */
1057 NR::Matrix
1058 sp_item_transform_repr (SPItem *item)
1060     NR::Matrix t_old(NR::identity());
1061     gchar const *t_attr = SP_OBJECT_REPR(item)->attribute("transform");
1062     if (t_attr) {
1063         NR::Matrix t;
1064         if (sp_svg_transform_read(t_attr, &t)) {
1065             t_old = t;
1066         }
1067     }
1069     return t_old;
1073 /**
1074  * Recursively scale stroke width in \a item and its children by \a expansion.
1075  */
1076 void
1077 sp_item_adjust_stroke_width_recursive(SPItem *item, double expansion)
1079     sp_item_adjust_stroke (item, expansion);
1081 // A clone's child is the ghost of its original - we must not touch it, skip recursion
1082     if (item && SP_IS_USE(item))
1083         return;
1085     for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1086         if (SP_IS_ITEM(o))
1087             sp_item_adjust_stroke_width_recursive(SP_ITEM(o), expansion);
1088     }
1091 /**
1092  * Recursively adjust rx and ry of rects.
1093  */
1094 void
1095 sp_item_adjust_rects_recursive(SPItem *item, NR::Matrix advertized_transform)
1097     if (SP_IS_RECT (item)) {
1098         sp_rect_compensate_rxry (SP_RECT(item), advertized_transform);
1099     }
1101     for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1102         if (SP_IS_ITEM(o))
1103             sp_item_adjust_rects_recursive(SP_ITEM(o), advertized_transform);
1104     }
1107 /**
1108  * Recursively compensate pattern or gradient transform.
1109  */
1110 void
1111 sp_item_adjust_paint_recursive (SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern)
1113 // _Before_ full pattern/gradient transform: t_paint * t_item * t_ancestors
1114 // _After_ full pattern/gradient transform: t_paint_new * t_item * t_ancestors * advertised_transform
1115 // By equating these two expressions we get t_paint_new = t_paint * paint_delta, where:
1116     NR::Matrix t_item = sp_item_transform_repr (item);
1117     NR::Matrix paint_delta = t_item * t_ancestors * advertized_transform * t_ancestors.inverse() * t_item.inverse();
1119 // Within text, we do not fork gradients, and so must not recurse to avoid double compensation;
1120 // also we do not recurse into clones, because a clone's child is the ghost of its original - 
1121 // we must not touch it
1122     if (!(item && (SP_IS_TEXT(item) || SP_IS_USE(item)))) {
1123         for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1124             if (SP_IS_ITEM(o)) {
1125 // At the level of the transformed item, t_ancestors is identity;
1126 // below it, it is the accmmulated chain of transforms from this level to the top level
1127                 sp_item_adjust_paint_recursive (SP_ITEM(o), advertized_transform, t_item * t_ancestors, is_pattern);
1128             }
1129         }
1130     }
1132 // We recursed into children first, and are now adjusting this object second;
1133 // this is so that adjustments in a tree are done from leaves up to the root,
1134 // and paintservers on leaves inheriting their values from ancestors could adjust themselves properly
1135 // before ancestors themselves are adjusted, probably differently (bug 1286535)
1137     if (is_pattern)
1138         sp_item_adjust_pattern (item, paint_delta);
1139     else
1140         sp_item_adjust_gradient (item, paint_delta);
1144 /**
1145  * A temporary wrapper for the next function accepting the NRMatrix
1146  * instead of NR::Matrix
1147  */
1148 void
1149 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv)
1151     if (transform == NULL)
1152         sp_item_write_transform(item, repr, NR::identity(), adv);
1153     else
1154         sp_item_write_transform(item, repr, NR::Matrix (transform), adv);
1157 /**
1158  * Set a new transform on an object.
1159  *
1160  * Compensate for stroke scaling and gradient/pattern fill transform, if
1161  * necessary. Call the object's set_transform method if transforms are
1162  * stored optimized. Send _transformed_signal. Invoke _write method so that
1163  * the repr is updated with the new transform.
1164  */
1165 void
1166 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv, bool compensate)
1168     g_return_if_fail(item != NULL);
1169     g_return_if_fail(SP_IS_ITEM(item));
1170     g_return_if_fail(repr != NULL);
1172     // calculate the relative transform, if not given by the adv attribute
1173     NR::Matrix advertized_transform;
1174     if (adv != NULL) {
1175         advertized_transform = *adv;
1176     } else {
1177         advertized_transform = sp_item_transform_repr (item).inverse() * transform;
1178     }
1179     
1180     if (compensate) {
1181         
1182          // recursively compensate for stroke scaling, depending on user preference
1183         if (prefs_get_int_attribute("options.transform", "stroke", 1) == 0) {
1184             double const expansion = 1. / NR::expansion(advertized_transform);
1185             sp_item_adjust_stroke_width_recursive(item, expansion);
1186         }
1187     
1188         // recursively compensate rx/ry of a rect if requested
1189         if (prefs_get_int_attribute("options.transform", "rectcorners", 1) == 0) {
1190             sp_item_adjust_rects_recursive(item, advertized_transform);
1191         }
1192     
1193         // recursively compensate pattern fill if it's not to be transformed
1194         if (prefs_get_int_attribute("options.transform", "pattern", 1) == 0) {
1195             sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), NR::identity(), true);
1196         }
1197         /// \todo FIXME: add the same else branch as for gradients below, to convert patterns to userSpaceOnUse as well
1198         /// recursively compensate gradient fill if it's not to be transformed
1199         if (prefs_get_int_attribute("options.transform", "gradient", 1) == 0) {
1200             sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), NR::identity(), false);
1201         } else {
1202             // this converts the gradient/pattern fill/stroke, if any, to userSpaceOnUse; we need to do
1203             // it here _before_ the new transform is set, so as to use the pre-transform bbox
1204             sp_item_adjust_paint_recursive (item, NR::identity(), NR::identity(), false);
1205         }          
1206         
1207     } // endif(compensate)
1209     gint preserve = prefs_get_int_attribute("options.preservetransform", "value", 0);
1210     NR::Matrix transform_attr (transform);
1211     if ( // run the object's set_transform (i.e. embed transform) only if:
1212          ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform && // it does have a set_transform method
1213              !preserve && // user did not chose to preserve all transforms
1214              !item->clip_ref->getObject() && // the object does not have a clippath
1215              !item->mask_ref->getObject() && // the object does not have a mask
1216          !(!transform.is_translation() && SP_OBJECT_STYLE(item) && SP_OBJECT_STYLE(item)->getFilter()) 
1217              // the object does not have a filter, or the transform is translation (which is supposed to not affect filters)
1218         ) {
1219         transform_attr = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform(item, transform);
1220     }
1221     sp_item_set_item_transform(item, transform_attr);
1223     // Note: updateRepr comes before emitting the transformed signal since
1224     // it causes clone SPUse's copy of the original object to brought up to
1225     // date with the original.  Otherwise, sp_use_bbox returns incorrect
1226     // values if called in code handling the transformed signal.
1227     SP_OBJECT(item)->updateRepr();
1229     // send the relative transform with a _transformed_signal
1230     item->_transformed_signal.emit(&advertized_transform, item);
1233 gint
1234 sp_item_event(SPItem *item, SPEvent *event)
1236     g_return_val_if_fail(item != NULL, FALSE);
1237     g_return_val_if_fail(SP_IS_ITEM(item), FALSE);
1238     g_return_val_if_fail(event != NULL, FALSE);
1240     if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->event)
1241         return ((SPItemClass *) G_OBJECT_GET_CLASS(item))->event(item, event);
1243     return FALSE;
1246 /**
1247  * Sets item private transform (not propagated to repr), without compensating stroke widths,
1248  * gradients, patterns as sp_item_write_transform does.
1249  */
1250 void
1251 sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform)
1253     g_return_if_fail(item != NULL);
1254     g_return_if_fail(SP_IS_ITEM(item));
1256     if (!matrix_equalp(transform, item->transform, NR_EPSILON)) {
1257         item->transform = transform;
1258         /* The SP_OBJECT_USER_MODIFIED_FLAG_B is used to mark the fact that it's only a
1259            transformation.  It's apparently not used anywhere else. */
1260         item->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_USER_MODIFIED_FLAG_B);
1261         sp_item_rm_unsatisfied_cns(*item);
1262     }
1266 /**
1267  * \pre \a ancestor really is an ancestor (\>=) of \a object, or NULL.
1268  *   ("Ancestor (\>=)" here includes as far as \a object itself.)
1269  */
1270 NR::Matrix
1271 i2anc_affine(SPObject const *object, SPObject const *const ancestor) {
1272     NR::Matrix ret(NR::identity());
1273     g_return_val_if_fail(object != NULL, ret);
1275     /* stop at first non-renderable ancestor */
1276     while ( object != ancestor && SP_IS_ITEM(object) ) {
1277         if (SP_IS_ROOT(object)) {
1278             ret *= SP_ROOT(object)->c2p;
1279         }
1280         ret *= SP_ITEM(object)->transform;
1281         object = SP_OBJECT_PARENT(object);
1282     }
1283     return ret;
1286 NR::Matrix
1287 i2i_affine(SPObject const *src, SPObject const *dest) {
1288     g_return_val_if_fail(src != NULL && dest != NULL, NR::identity());
1289     SPObject const *ancestor = src->nearestCommonAncestor(dest);
1290     return i2anc_affine(src, ancestor) / i2anc_affine(dest, ancestor);
1293 NR::Matrix SPItem::getRelativeTransform(SPObject const *dest) const {
1294     return i2i_affine(this, dest);
1297 /**
1298  * Returns the accumulated transformation of the item and all its ancestors, including root's viewport.
1299  * \pre (item != NULL) and SP_IS_ITEM(item).
1300  */
1301 NR::Matrix sp_item_i2doc_affine(SPItem const *item)
1303     return i2anc_affine(item, NULL);
1306 /**
1307  * Returns the accumulated transformation of the item and all its ancestors, but excluding root's viewport.
1308  * Used in path operations mostly.
1309  * \pre (item != NULL) and SP_IS_ITEM(item).
1310  */
1311 NR::Matrix sp_item_i2root_affine(SPItem const *item)
1313     g_assert(item != NULL);
1314     g_assert(SP_IS_ITEM(item));
1316     NR::Matrix ret(NR::identity());
1317     g_assert(ret.test_identity());
1318     while ( NULL != SP_OBJECT_PARENT(item) ) {
1319         ret *= item->transform;
1320         item = SP_ITEM(SP_OBJECT_PARENT(item));
1321     }
1322     g_assert(SP_IS_ROOT(item));
1324     ret *= item->transform;
1326     return ret;
1329 /* fixme: This is EVIL!!! */
1331 NR::Matrix sp_item_i2d_affine(SPItem const *item)
1333     g_assert(item != NULL);
1334     g_assert(SP_IS_ITEM(item));
1336     NR::Matrix const ret( sp_item_i2doc_affine(item)
1337                           * NR::scale(1, -1)
1338                           * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1339     return ret;
1342 // same as i2d but with i2root instead of i2doc
1343 NR::Matrix sp_item_i2r_affine(SPItem const *item)
1345     g_assert(item != NULL);
1346     g_assert(SP_IS_ITEM(item));
1348     NR::Matrix const ret( sp_item_i2root_affine(item)
1349                           * NR::scale(1, -1)
1350                           * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1351     return ret;
1354 /**
1355  * Converts a matrix \a m into the desktop coords of the \a item.
1356  * Will become a noop when we eliminate the coordinate flipping.
1357  */
1358 NR::Matrix matrix_to_desktop(NR::Matrix const m, SPItem const *item)
1360     NR::Matrix const ret(m
1361                          * NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1362                          * NR::scale(1, -1));
1363     return ret;
1366 /**
1367  * Converts a matrix \a m from the desktop coords of the \a item.
1368  * Will become a noop when we eliminate the coordinate flipping.
1369  */
1370 NR::Matrix matrix_from_desktop(NR::Matrix const m, SPItem const *item)
1372     NR::Matrix const ret(NR::scale(1, -1)
1373                          * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item)))
1374                          * m);
1375     return ret;
1378 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &i2dt)
1380     g_return_if_fail( item != NULL );
1381     g_return_if_fail( SP_IS_ITEM(item) );
1383     NR::Matrix dt2p; /* desktop to item parent transform */
1384     if (SP_OBJECT_PARENT(item)) {
1385         dt2p = sp_item_i2d_affine((SPItem *) SP_OBJECT_PARENT(item)).inverse();
1386     } else {
1387         dt2p = ( NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1388                  * NR::scale(1, -1) );
1389     }
1391     NR::Matrix const i2p( i2dt * dt2p );
1392     sp_item_set_item_transform(item, i2p);
1396 NR::Matrix
1397 sp_item_dt2i_affine(SPItem const *item)
1399     /* fixme: Implement the right way (Lauris) */
1400     return sp_item_i2d_affine(item).inverse();
1403 /* Item views */
1405 static SPItemView *
1406 sp_item_view_new_prepend(SPItemView *list, SPItem *item, unsigned flags, unsigned key, NRArenaItem *arenaitem)
1408     SPItemView *new_view;
1410     g_assert(item != NULL);
1411     g_assert(SP_IS_ITEM(item));
1412     g_assert(arenaitem != NULL);
1413     g_assert(NR_IS_ARENA_ITEM(arenaitem));
1415     new_view = g_new(SPItemView, 1);
1417     new_view->next = list;
1418     new_view->flags = flags;
1419     new_view->key = key;
1420     new_view->arenaitem = nr_arena_item_ref(arenaitem);
1422     return new_view;
1425 static SPItemView *
1426 sp_item_view_list_remove(SPItemView *list, SPItemView *view)
1428     if (view == list) {
1429         list = list->next;
1430     } else {
1431         SPItemView *prev;
1432         prev = list;
1433         while (prev->next != view) prev = prev->next;
1434         prev->next = view->next;
1435     }
1437     nr_arena_item_unref(view->arenaitem);
1438     g_free(view);
1440     return list;
1443 /**
1444  * Return the arenaitem corresponding to the given item in the display
1445  * with the given key
1446  */
1447 NRArenaItem *
1448 sp_item_get_arenaitem(SPItem *item, unsigned key)
1450     for ( SPItemView *iv = item->display ; iv ; iv = iv->next ) {
1451         if ( iv->key == key ) {
1452             return iv->arenaitem;
1453         }
1454     }
1456     return NULL;
1459 int
1460 sp_item_repr_compare_position(SPItem *first, SPItem *second)
1462     return sp_repr_compare_position(SP_OBJECT_REPR(first),
1463                                     SP_OBJECT_REPR(second));
1466 SPItem *
1467 sp_item_first_item_child (SPObject *obj)
1469     for ( SPObject *iter = sp_object_first_child(obj) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
1470         if (SP_IS_ITEM (iter))
1471             return SP_ITEM (iter);
1472     }
1473     return NULL;
1477 /*
1478   Local Variables:
1479   mode:c++
1480   c-file-style:"stroustrup"
1481   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1482   indent-tabs-mode:nil
1483   fill-column:99
1484   End:
1485 */
1486 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :