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;
110 }
112 /**
113 * SPItem vtable initialization.
114 */
115 static void
116 sp_item_class_init(SPItemClass *klass)
117 {
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;
130 }
132 /**
133 * Callback for SPItem object initialization.
134 */
135 static void
136 sp_item_init(SPItem *item)
137 {
138 item->init();
139 }
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 *>();
167 }
169 bool SPItem::isVisibleAndUnlocked() const {
170 return (!isHidden() && !isLocked());
171 }
173 bool SPItem::isVisibleAndUnlocked(unsigned display_key) const {
174 return (!isHidden(display_key) && !isLocked());
175 }
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;
183 }
185 void SPItem::setLocked(bool locked) {
186 SP_OBJECT_REPR(this)->setAttribute("sodipodi:insensitive",
187 ( locked ? "1" : NULL ));
188 updateRepr();
189 }
191 bool SPItem::isHidden() const {
192 if (!isEvaluated())
193 return true;
194 return style->display.computed == SP_CSS_DISPLAY_NONE;
195 }
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();
203 }
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;
222 }
224 void SPItem::setEvaluated(bool evaluated) {
225 _is_evaluated = evaluated;
226 _evaluated_status = StatusSet;
227 }
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 }
242 }
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;
250 }
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
258 {
259 return (this->style->display.set
260 && this->style->display.value == SP_CSS_DISPLAY_NONE);
261 }
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();
273 }
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 }
289 }
291 void
292 SPItem::unsetCenter() {
293 transform_center_x = 0;
294 transform_center_y = 0;
295 }
297 bool SPItem::isCenterSet() {
298 return (transform_center_x != 0 || transform_center_y != 0);
299 }
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 }
308 }
311 namespace {
313 bool is_item(SPObject const &object) {
314 return SP_IS_ITEM(&object);
315 }
317 }
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 }
329 }
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 }
340 }
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 }
359 }
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 }
379 }
381 static void
382 sp_item_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
383 {
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 }
397 }
399 static void
400 sp_item_release(SPObject *object)
401 {
402 SPItem *item = (SPItem *) object;
404 item->_clip_ref_connection.disconnect();
405 item->_mask_ref_connection.disconnect();
407 // Note: do this here before the clip_ref is deleted, since calling
408 // sp_document_ensure_up_to_date for triggered routing may reference
409 // the deleted clip_ref.
410 if (item->avoidRef) {
411 delete item->avoidRef;
412 item->avoidRef = NULL;
413 }
415 if (item->clip_ref) {
416 item->clip_ref->detach();
417 delete item->clip_ref;
418 item->clip_ref = NULL;
419 }
421 if (item->mask_ref) {
422 item->mask_ref->detach();
423 delete item->mask_ref;
424 item->mask_ref = NULL;
425 }
427 if (((SPObjectClass *) (parent_class))->release) {
428 ((SPObjectClass *) parent_class)->release(object);
429 }
431 while (item->display) {
432 nr_arena_item_unparent(item->display->arenaitem);
433 item->display = sp_item_view_list_remove(item->display, item->display);
434 }
436 item->_transformed_signal.~signal();
437 }
439 static void
440 sp_item_set(SPObject *object, unsigned key, gchar const *value)
441 {
442 SPItem *item = (SPItem *) object;
444 switch (key) {
445 case SP_ATTR_TRANSFORM: {
446 NR::Matrix t;
447 if (value && sp_svg_transform_read(value, &t)) {
448 sp_item_set_item_transform(item, t);
449 } else {
450 sp_item_set_item_transform(item, NR::identity());
451 }
452 break;
453 }
454 case SP_PROP_CLIP_PATH: {
455 gchar *uri = extract_uri(value);
456 if (uri) {
457 try {
458 item->clip_ref->attach(Inkscape::URI(uri));
459 } catch (Inkscape::BadURIException &e) {
460 g_warning("%s", e.what());
461 item->clip_ref->detach();
462 }
463 g_free(uri);
464 } else {
465 item->clip_ref->detach();
466 }
468 break;
469 }
470 case SP_PROP_MASK: {
471 gchar *uri = extract_uri(value);
472 if (uri) {
473 try {
474 item->mask_ref->attach(Inkscape::URI(uri));
475 } catch (Inkscape::BadURIException &e) {
476 g_warning("%s", e.what());
477 item->mask_ref->detach();
478 }
479 g_free(uri);
480 } else {
481 item->mask_ref->detach();
482 }
484 break;
485 }
486 case SP_ATTR_SODIPODI_INSENSITIVE:
487 item->sensitive = !value;
488 for (SPItemView *v = item->display; v != NULL; v = v->next) {
489 nr_arena_item_set_sensitive(v->arenaitem, item->sensitive);
490 }
491 break;
492 case SP_ATTR_CONNECTOR_AVOID:
493 item->avoidRef->setAvoid(value);
494 break;
495 case SP_ATTR_TRANSFORM_CENTER_X:
496 if (value) {
497 item->transform_center_x = g_strtod(value, NULL);
498 } else {
499 item->transform_center_x = 0;
500 }
501 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
502 break;
503 case SP_ATTR_TRANSFORM_CENTER_Y:
504 if (value) {
505 item->transform_center_y = g_strtod(value, NULL);
506 } else {
507 item->transform_center_y = 0;
508 }
509 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
510 break;
511 case SP_PROP_SYSTEM_LANGUAGE:
512 case SP_PROP_REQUIRED_FEATURES:
513 case SP_PROP_REQUIRED_EXTENSIONS:
514 {
515 item->resetEvaluated();
516 // pass to default handler
517 }
518 default:
519 if (SP_ATTRIBUTE_IS_CSS(key)) {
520 sp_style_read_from_object(object->style, object);
521 object->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
522 } else {
523 if (((SPObjectClass *) (parent_class))->set) {
524 (* ((SPObjectClass *) (parent_class))->set)(object, key, value);
525 }
526 }
527 break;
528 }
529 }
531 static void
532 clip_ref_changed(SPObject *old_clip, SPObject *clip, SPItem *item)
533 {
534 if (old_clip) {
535 SPItemView *v;
536 /* Hide clippath */
537 for (v = item->display; v != NULL; v = v->next) {
538 sp_clippath_hide(SP_CLIPPATH(old_clip), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
539 nr_arena_item_set_clip(v->arenaitem, NULL);
540 }
541 }
542 if (SP_IS_CLIPPATH(clip)) {
543 NRRect bbox;
544 sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
545 for (SPItemView *v = item->display; v != NULL; v = v->next) {
546 if (!v->arenaitem->key) {
547 NR_ARENA_ITEM_SET_KEY(v->arenaitem, sp_item_display_key_new(3));
548 }
549 NRArenaItem *ai = sp_clippath_show(SP_CLIPPATH(clip),
550 NR_ARENA_ITEM_ARENA(v->arenaitem),
551 NR_ARENA_ITEM_GET_KEY(v->arenaitem));
552 nr_arena_item_set_clip(v->arenaitem, ai);
553 nr_arena_item_unref(ai);
554 sp_clippath_set_bbox(SP_CLIPPATH(clip), NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
555 SP_OBJECT(clip)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
556 }
557 }
558 }
560 static void
561 mask_ref_changed(SPObject *old_mask, SPObject *mask, SPItem *item)
562 {
563 if (old_mask) {
564 /* Hide mask */
565 for (SPItemView *v = item->display; v != NULL; v = v->next) {
566 sp_mask_hide(SP_MASK(old_mask), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
567 nr_arena_item_set_mask(v->arenaitem, NULL);
568 }
569 }
570 if (SP_IS_MASK(mask)) {
571 NRRect bbox;
572 sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
573 for (SPItemView *v = item->display; v != NULL; v = v->next) {
574 if (!v->arenaitem->key) {
575 NR_ARENA_ITEM_SET_KEY(v->arenaitem, sp_item_display_key_new(3));
576 }
577 NRArenaItem *ai = sp_mask_show(SP_MASK(mask),
578 NR_ARENA_ITEM_ARENA(v->arenaitem),
579 NR_ARENA_ITEM_GET_KEY(v->arenaitem));
580 nr_arena_item_set_mask(v->arenaitem, ai);
581 nr_arena_item_unref(ai);
582 sp_mask_set_bbox(SP_MASK(mask), NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
583 SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
584 }
585 }
586 }
588 static void
589 sp_item_update(SPObject *object, SPCtx *ctx, guint flags)
590 {
591 SPItem *item = SP_ITEM(object);
593 if (((SPObjectClass *) (parent_class))->update)
594 (* ((SPObjectClass *) (parent_class))->update)(object, ctx, flags);
596 if (flags & (SP_OBJECT_CHILD_MODIFIED_FLAG | SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG)) {
597 if (flags & SP_OBJECT_MODIFIED_FLAG) {
598 for (SPItemView *v = item->display; v != NULL; v = v->next) {
599 nr_arena_item_set_transform(v->arenaitem, item->transform);
600 }
601 }
603 SPClipPath *clip_path = item->clip_ref ? item->clip_ref->getObject() : NULL;
604 SPMask *mask = item->mask_ref ? item->mask_ref->getObject() : NULL;
606 if ( clip_path || mask ) {
607 NRRect bbox;
608 sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
609 if (clip_path) {
610 for (SPItemView *v = item->display; v != NULL; v = v->next) {
611 sp_clippath_set_bbox(clip_path, NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
612 }
613 }
614 if (mask) {
615 for (SPItemView *v = item->display; v != NULL; v = v->next) {
616 sp_mask_set_bbox(mask, NR_ARENA_ITEM_GET_KEY(v->arenaitem), &bbox);
617 }
618 }
619 }
621 if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
622 for (SPItemView *v = item->display; v != NULL; v = v->next) {
623 nr_arena_item_set_opacity(v->arenaitem, SP_SCALE24_TO_FLOAT(object->style->opacity.value));
624 nr_arena_item_set_visible(v->arenaitem, !item->isHidden());
625 }
626 }
627 }
629 /* Update bounding box data used by filters */
630 if (item->style->filter.set && item->display) {
631 NRRect item_bbox;
632 sp_item_invoke_bbox(item, &item_bbox, NR::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
633 NR::Maybe<NR::Rect> i_bbox = item_bbox;
635 SPItemView *itemview = item->display;
636 do {
637 if (itemview->arenaitem)
638 nr_arena_item_set_item_bbox(itemview->arenaitem, i_bbox);
639 } while ( (itemview = itemview->next) );
640 }
642 // Update libavoid with item geometry (for connector routing).
643 if (item->avoidRef)
644 item->avoidRef->handleSettingChange();
645 }
647 static Inkscape::XML::Node *
648 sp_item_write(SPObject *const object, Inkscape::XML::Node *repr, guint flags)
649 {
650 SPItem *item = SP_ITEM(object);
652 gchar *c = sp_svg_transform_write(item->transform);
653 repr->setAttribute("transform", c);
654 g_free(c);
656 if (flags & SP_OBJECT_WRITE_EXT) {
657 repr->setAttribute("sodipodi:insensitive", ( item->sensitive ? NULL : "true" ));
658 if (item->transform_center_x != 0)
659 sp_repr_set_svg_double (repr, "inkscape:transform-center-x", item->transform_center_x);
660 else
661 repr->setAttribute ("inkscape:transform-center-x", NULL);
662 if (item->transform_center_y != 0)
663 sp_repr_set_svg_double (repr, "inkscape:transform-center-y", item->transform_center_y);
664 else
665 repr->setAttribute ("inkscape:transform-center-y", NULL);
666 }
668 if (item->clip_ref->getObject()) {
669 const gchar *value = g_strdup_printf ("url(%s)", item->clip_ref->getURI()->toString());
670 repr->setAttribute ("clip-path", value);
671 g_free ((void *) value);
672 }
673 if (item->mask_ref->getObject()) {
674 const gchar *value = g_strdup_printf ("url(%s)", item->mask_ref->getURI()->toString());
675 repr->setAttribute ("mask", value);
676 g_free ((void *) value);
677 }
679 if (((SPObjectClass *) (parent_class))->write) {
680 ((SPObjectClass *) (parent_class))->write(object, repr, flags);
681 }
683 return repr;
684 }
686 NR::Maybe<NR::Rect> SPItem::getBounds(NR::Matrix const &transform,
687 SPItem::BBoxType type,
688 unsigned int /*dkey*/) const
689 {
690 NRRect r;
691 sp_item_invoke_bbox_full(this, &r, transform, type, TRUE);
692 return r;
693 }
695 void
696 sp_item_invoke_bbox(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const clear, SPItem::BBoxType type)
697 {
698 sp_item_invoke_bbox_full(item, bbox, transform, type, clear);
699 }
701 /** Calls \a item's subclass' bounding box method; clips it by the bbox of clippath, if any; and
702 * unions the resulting bbox with \a bbox. If \a clear is true, empties \a bbox first. Passes the
703 * transform and the flags to the actual bbox methods. Note that many of subclasses (e.g. groups,
704 * clones), in turn, call this function in their bbox methods. */
705 void
706 sp_item_invoke_bbox_full(SPItem const *item, NRRect *bbox, NR::Matrix const &transform, unsigned const flags, unsigned const clear)
707 {
708 g_assert(item != NULL);
709 g_assert(SP_IS_ITEM(item));
710 g_assert(bbox != NULL);
712 if (clear) {
713 bbox->x0 = bbox->y0 = 1e18;
714 bbox->x1 = bbox->y1 = -1e18;
715 }
717 NRRect this_bbox;
718 this_bbox.x0 = this_bbox.y0 = 1e18;
719 this_bbox.x1 = this_bbox.y1 = -1e18;
721 // call the subclass method
722 if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox) {
723 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->bbox(item, &this_bbox, transform, flags);
724 }
726 // unless this is geometric bbox, crop the bbox by clip path, if any
727 if ((SPItem::BBoxType) flags != SPItem::GEOMETRIC_BBOX && item->clip_ref->getObject()) {
728 NRRect b;
729 sp_clippath_get_bbox(SP_CLIPPATH(item->clip_ref->getObject()), &b, transform, flags);
730 nr_rect_d_intersect (&this_bbox, &this_bbox, &b);
731 }
733 // if non-empty (with some tolerance - ?) union this_bbox with the bbox we've got passed
734 if ( fabs(this_bbox.x1-this_bbox.x0) > -0.00001 && fabs(this_bbox.y1-this_bbox.y0) > -0.00001 ) {
735 nr_rect_d_union (bbox, bbox, &this_bbox);
736 }
737 }
739 unsigned sp_item_pos_in_parent(SPItem *item)
740 {
741 g_assert(item != NULL);
742 g_assert(SP_IS_ITEM(item));
744 SPObject *parent = SP_OBJECT_PARENT(item);
745 g_assert(parent != NULL);
746 g_assert(SP_IS_OBJECT(parent));
748 SPObject *object = SP_OBJECT(item);
750 unsigned pos=0;
751 for ( SPObject *iter = sp_object_first_child(parent) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
752 if ( iter == object ) {
753 return pos;
754 }
755 if (SP_IS_ITEM(iter)) {
756 pos++;
757 }
758 }
760 g_assert_not_reached();
761 return 0;
762 }
764 void
765 sp_item_bbox_desktop(SPItem *item, NRRect *bbox, SPItem::BBoxType type)
766 {
767 g_assert(item != NULL);
768 g_assert(SP_IS_ITEM(item));
769 g_assert(bbox != NULL);
771 sp_item_invoke_bbox(item, bbox, sp_item_i2d_affine(item), TRUE, type);
772 }
774 NR::Maybe<NR::Rect> sp_item_bbox_desktop(SPItem *item, SPItem::BBoxType type)
775 {
776 NRRect ret;
777 sp_item_invoke_bbox(item, &ret, sp_item_i2d_affine(item), TRUE, type);
778 return ret.upgrade();
779 }
781 static void sp_item_private_snappoints(SPItem const *item, SnapPointsIter p)
782 {
783 NR::Maybe<NR::Rect> bbox = item->getBounds(sp_item_i2d_affine(item));
784 /* Just the corners of the bounding box suffices given that we don't yet
785 support angled guide lines. */
787 if (bbox) {
788 NR::Point p1, p2;
789 p1 = bbox->min();
790 p2 = bbox->max();
791 *p = p1;
792 *p = NR::Point(p1[NR::X], p2[NR::Y]);
793 *p = p2;
794 *p = NR::Point(p1[NR::Y], p2[NR::X]);
795 }
796 }
798 void sp_item_snappoints(SPItem const *item, bool includeItemCenter, SnapPointsIter p)
799 {
800 g_assert (item != NULL);
801 g_assert (SP_IS_ITEM(item));
803 SPItemClass const &item_class = *(SPItemClass const *) G_OBJECT_GET_CLASS(item);
804 if (item_class.snappoints) {
805 item_class.snappoints(item, p);
806 }
808 if (includeItemCenter) {
809 *p = item->getCenter();
810 }
811 }
813 void
814 sp_item_invoke_print(SPItem *item, SPPrintContext *ctx)
815 {
816 if (!item->isHidden()) {
817 if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->print) {
818 if (!item->transform.test_identity()
819 || SP_OBJECT_STYLE(item)->opacity.value != SP_SCALE24_MAX)
820 {
821 sp_print_bind(ctx, item->transform, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
822 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
823 sp_print_release(ctx);
824 } else {
825 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->print(item, ctx);
826 }
827 }
828 }
829 }
831 static gchar *
832 sp_item_private_description(SPItem */*item*/)
833 {
834 return g_strdup(_("Object"));
835 }
837 /**
838 * Returns a string suitable for status bar, formatted in pango markup language.
839 *
840 * Must be freed by caller.
841 */
842 gchar *
843 sp_item_description(SPItem *item)
844 {
845 g_assert(item != NULL);
846 g_assert(SP_IS_ITEM(item));
848 if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->description) {
849 gchar *s = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->description(item);
850 if (s && item->clip_ref->getObject()) {
851 gchar *snew = g_strdup_printf (_("%s; <i>clipped</i>"), s);
852 g_free (s);
853 s = snew;
854 }
855 if (s && item->mask_ref->getObject()) {
856 gchar *snew = g_strdup_printf (_("%s; <i>masked</i>"), s);
857 g_free (s);
858 s = snew;
859 }
860 return s;
861 }
863 g_assert_not_reached();
864 return NULL;
865 }
867 /**
868 * Allocates unique integer keys.
869 * \param numkeys Number of keys required.
870 * \return First allocated key; hence if the returned key is n
871 * you can use n, n + 1, ..., n + (numkeys - 1)
872 */
873 unsigned
874 sp_item_display_key_new(unsigned numkeys)
875 {
876 static unsigned dkey = 0;
878 dkey += numkeys;
880 return dkey - numkeys;
881 }
883 NRArenaItem *
884 sp_item_invoke_show(SPItem *item, NRArena *arena, unsigned key, unsigned flags)
885 {
886 g_assert(item != NULL);
887 g_assert(SP_IS_ITEM(item));
888 g_assert(arena != NULL);
889 g_assert(NR_IS_ARENA(arena));
891 NRArenaItem *ai = NULL;
892 if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->show) {
893 ai = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->show(item, arena, key, flags);
894 }
896 if (ai != NULL) {
897 item->display = sp_item_view_new_prepend(item->display, item, flags, key, ai);
898 nr_arena_item_set_transform(ai, item->transform);
899 nr_arena_item_set_opacity(ai, SP_SCALE24_TO_FLOAT(SP_OBJECT_STYLE(item)->opacity.value));
900 nr_arena_item_set_visible(ai, !item->isHidden());
901 nr_arena_item_set_sensitive(ai, item->sensitive);
902 if (item->clip_ref->getObject()) {
903 SPClipPath *cp = item->clip_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 clip_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
910 // Show and set clip
911 NRArenaItem *ac = sp_clippath_show(cp, arena, clip_key);
912 nr_arena_item_set_clip(ai, ac);
913 nr_arena_item_unref(ac);
915 // Update bbox, in case the clip uses bbox units
916 NRRect bbox;
917 sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
918 sp_clippath_set_bbox(SP_CLIPPATH(cp), clip_key, &bbox);
919 SP_OBJECT(cp)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
920 }
921 if (item->mask_ref->getObject()) {
922 SPMask *mask = item->mask_ref->getObject();
924 if (!item->display->arenaitem->key) {
925 NR_ARENA_ITEM_SET_KEY(item->display->arenaitem, sp_item_display_key_new(3));
926 }
927 int mask_key = NR_ARENA_ITEM_GET_KEY(item->display->arenaitem);
929 // Show and set mask
930 NRArenaItem *ac = sp_mask_show(mask, arena, mask_key);
931 nr_arena_item_set_mask(ai, ac);
932 nr_arena_item_unref(ac);
934 // Update bbox, in case the mask uses bbox units
935 NRRect bbox;
936 sp_item_invoke_bbox(item, &bbox, NR::identity(), TRUE);
937 sp_mask_set_bbox(SP_MASK(mask), mask_key, &bbox);
938 SP_OBJECT(mask)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
939 }
940 NR_ARENA_ITEM_SET_DATA(ai, item);
941 NRRect item_bbox;
942 sp_item_invoke_bbox(item, &item_bbox, NR::identity(), TRUE, SPItem::GEOMETRIC_BBOX);
943 NR::Maybe<NR::Rect> i_bbox = item_bbox;
944 nr_arena_item_set_item_bbox(ai, i_bbox);
945 }
947 return ai;
948 }
950 void
951 sp_item_invoke_hide(SPItem *item, unsigned key)
952 {
953 g_assert(item != NULL);
954 g_assert(SP_IS_ITEM(item));
956 if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide) {
957 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->hide(item, key);
958 }
960 SPItemView *ref = NULL;
961 SPItemView *v = item->display;
962 while (v != NULL) {
963 SPItemView *next = v->next;
964 if (v->key == key) {
965 if (item->clip_ref->getObject()) {
966 sp_clippath_hide(item->clip_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
967 nr_arena_item_set_clip(v->arenaitem, NULL);
968 }
969 if (item->mask_ref->getObject()) {
970 sp_mask_hide(item->mask_ref->getObject(), NR_ARENA_ITEM_GET_KEY(v->arenaitem));
971 nr_arena_item_set_mask(v->arenaitem, NULL);
972 }
973 if (!ref) {
974 item->display = v->next;
975 } else {
976 ref->next = v->next;
977 }
978 nr_arena_item_unparent(v->arenaitem);
979 nr_arena_item_unref(v->arenaitem);
980 g_free(v);
981 } else {
982 ref = v;
983 }
984 v = next;
985 }
986 }
988 // Adjusters
990 void
991 sp_item_adjust_pattern (SPItem *item, NR::Matrix const &postmul, bool set)
992 {
993 SPStyle *style = SP_OBJECT_STYLE (item);
995 if (style && (style->fill.isPaintserver())) {
996 SPObject *server = SP_OBJECT_STYLE_FILL_SERVER (item);
997 if (SP_IS_PATTERN (server)) {
998 SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "fill");
999 sp_pattern_transform_multiply (pattern, postmul, set);
1000 }
1001 }
1003 if (style && (style->stroke.isPaintserver())) {
1004 SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER (item);
1005 if (SP_IS_PATTERN (server)) {
1006 SPPattern *pattern = sp_pattern_clone_if_necessary (item, SP_PATTERN (server), "stroke");
1007 sp_pattern_transform_multiply (pattern, postmul, set);
1008 }
1009 }
1011 }
1013 void
1014 sp_item_adjust_gradient (SPItem *item, NR::Matrix const &postmul, bool set)
1015 {
1016 SPStyle *style = SP_OBJECT_STYLE (item);
1018 if (style && (style->fill.isPaintserver())) {
1019 SPObject *server = SP_OBJECT_STYLE_FILL_SERVER(item);
1020 if (SP_IS_GRADIENT (server)) {
1022 /**
1023 * \note Bbox units for a gradient are generally a bad idea because
1024 * with them, you cannot preserve the relative position of the
1025 * object and its gradient after rotation or skew. So now we
1026 * convert them to userspace units which are easy to keep in sync
1027 * just by adding the object's transform to gradientTransform.
1028 * \todo FIXME: convert back to bbox units after transforming with
1029 * the item, so as to preserve the original units.
1030 */
1031 SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "fill");
1033 sp_gradient_transform_multiply (gradient, postmul, set);
1034 }
1035 }
1037 if (style && (style->stroke.isPaintserver())) {
1038 SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER(item);
1039 if (SP_IS_GRADIENT (server)) {
1040 SPGradient *gradient = sp_gradient_convert_to_userspace (SP_GRADIENT (server), item, "stroke");
1041 sp_gradient_transform_multiply (gradient, postmul, set);
1042 }
1043 }
1044 }
1046 void
1047 sp_item_adjust_stroke (SPItem *item, gdouble ex)
1048 {
1049 SPStyle *style = SP_OBJECT_STYLE (item);
1051 if (style && !style->stroke.isNone() && !NR_DF_TEST_CLOSE (ex, 1.0, NR_EPSILON)) {
1053 style->stroke_width.computed *= ex;
1054 style->stroke_width.set = TRUE;
1056 if (style->stroke_dash.n_dash != 0) {
1057 int i;
1058 for (i = 0; i < style->stroke_dash.n_dash; i++) {
1059 style->stroke_dash.dash[i] *= ex;
1060 }
1061 style->stroke_dash.offset *= ex;
1062 }
1064 SP_OBJECT(item)->updateRepr();
1065 }
1066 }
1068 /**
1069 * Find out the inverse of previous transform of an item (from its repr)
1070 */
1071 NR::Matrix
1072 sp_item_transform_repr (SPItem *item)
1073 {
1074 NR::Matrix t_old(NR::identity());
1075 gchar const *t_attr = SP_OBJECT_REPR(item)->attribute("transform");
1076 if (t_attr) {
1077 NR::Matrix t;
1078 if (sp_svg_transform_read(t_attr, &t)) {
1079 t_old = t;
1080 }
1081 }
1083 return t_old;
1084 }
1087 /**
1088 * Recursively scale stroke width in \a item and its children by \a expansion.
1089 */
1090 void
1091 sp_item_adjust_stroke_width_recursive(SPItem *item, double expansion)
1092 {
1093 sp_item_adjust_stroke (item, expansion);
1095 // A clone's child is the ghost of its original - we must not touch it, skip recursion
1096 if (item && SP_IS_USE(item))
1097 return;
1099 for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1100 if (SP_IS_ITEM(o))
1101 sp_item_adjust_stroke_width_recursive(SP_ITEM(o), expansion);
1102 }
1103 }
1105 /**
1106 * Recursively adjust rx and ry of rects.
1107 */
1108 void
1109 sp_item_adjust_rects_recursive(SPItem *item, NR::Matrix advertized_transform)
1110 {
1111 if (SP_IS_RECT (item)) {
1112 sp_rect_compensate_rxry (SP_RECT(item), advertized_transform);
1113 }
1115 for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1116 if (SP_IS_ITEM(o))
1117 sp_item_adjust_rects_recursive(SP_ITEM(o), advertized_transform);
1118 }
1119 }
1121 /**
1122 * Recursively compensate pattern or gradient transform.
1123 */
1124 void
1125 sp_item_adjust_paint_recursive (SPItem *item, NR::Matrix advertized_transform, NR::Matrix t_ancestors, bool is_pattern)
1126 {
1127 // _Before_ full pattern/gradient transform: t_paint * t_item * t_ancestors
1128 // _After_ full pattern/gradient transform: t_paint_new * t_item * t_ancestors * advertised_transform
1129 // By equating these two expressions we get t_paint_new = t_paint * paint_delta, where:
1130 NR::Matrix t_item = sp_item_transform_repr (item);
1131 NR::Matrix paint_delta = t_item * t_ancestors * advertized_transform * t_ancestors.inverse() * t_item.inverse();
1133 // Within text, we do not fork gradients, and so must not recurse to avoid double compensation;
1134 // also we do not recurse into clones, because a clone's child is the ghost of its original -
1135 // we must not touch it
1136 if (!(item && (SP_IS_TEXT(item) || SP_IS_USE(item)))) {
1137 for (SPObject *o = SP_OBJECT(item)->children; o != NULL; o = o->next) {
1138 if (SP_IS_ITEM(o)) {
1139 // At the level of the transformed item, t_ancestors is identity;
1140 // below it, it is the accmmulated chain of transforms from this level to the top level
1141 sp_item_adjust_paint_recursive (SP_ITEM(o), advertized_transform, t_item * t_ancestors, is_pattern);
1142 }
1143 }
1144 }
1146 // We recursed into children first, and are now adjusting this object second;
1147 // this is so that adjustments in a tree are done from leaves up to the root,
1148 // and paintservers on leaves inheriting their values from ancestors could adjust themselves properly
1149 // before ancestors themselves are adjusted, probably differently (bug 1286535)
1151 if (is_pattern)
1152 sp_item_adjust_pattern (item, paint_delta);
1153 else
1154 sp_item_adjust_gradient (item, paint_delta);
1156 }
1158 /**
1159 * A temporary wrapper for the next function accepting the NRMatrix
1160 * instead of NR::Matrix
1161 */
1162 void
1163 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NRMatrix const *transform, NR::Matrix const *adv)
1164 {
1165 if (transform == NULL)
1166 sp_item_write_transform(item, repr, NR::identity(), adv);
1167 else
1168 sp_item_write_transform(item, repr, NR::Matrix (transform), adv);
1169 }
1171 /**
1172 * Set a new transform on an object.
1173 *
1174 * Compensate for stroke scaling and gradient/pattern fill transform, if
1175 * necessary. Call the object's set_transform method if transforms are
1176 * stored optimized. Send _transformed_signal. Invoke _write method so that
1177 * the repr is updated with the new transform.
1178 */
1179 void
1180 sp_item_write_transform(SPItem *item, Inkscape::XML::Node *repr, NR::Matrix const &transform, NR::Matrix const *adv, bool compensate)
1181 {
1182 g_return_if_fail(item != NULL);
1183 g_return_if_fail(SP_IS_ITEM(item));
1184 g_return_if_fail(repr != NULL);
1186 // calculate the relative transform, if not given by the adv attribute
1187 NR::Matrix advertized_transform;
1188 if (adv != NULL) {
1189 advertized_transform = *adv;
1190 } else {
1191 advertized_transform = sp_item_transform_repr (item).inverse() * transform;
1192 }
1194 if (compensate) {
1196 // recursively compensate for stroke scaling, depending on user preference
1197 if (prefs_get_int_attribute("options.transform", "stroke", 1) == 0) {
1198 double const expansion = 1. / NR::expansion(advertized_transform);
1199 sp_item_adjust_stroke_width_recursive(item, expansion);
1200 }
1202 // recursively compensate rx/ry of a rect if requested
1203 if (prefs_get_int_attribute("options.transform", "rectcorners", 1) == 0) {
1204 sp_item_adjust_rects_recursive(item, advertized_transform);
1205 }
1207 // recursively compensate pattern fill if it's not to be transformed
1208 if (prefs_get_int_attribute("options.transform", "pattern", 1) == 0) {
1209 sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), NR::identity(), true);
1210 }
1211 /// \todo FIXME: add the same else branch as for gradients below, to convert patterns to userSpaceOnUse as well
1212 /// recursively compensate gradient fill if it's not to be transformed
1213 if (prefs_get_int_attribute("options.transform", "gradient", 1) == 0) {
1214 sp_item_adjust_paint_recursive (item, advertized_transform.inverse(), NR::identity(), false);
1215 } else {
1216 // this converts the gradient/pattern fill/stroke, if any, to userSpaceOnUse; we need to do
1217 // it here _before_ the new transform is set, so as to use the pre-transform bbox
1218 sp_item_adjust_paint_recursive (item, NR::identity(), NR::identity(), false);
1219 }
1221 } // endif(compensate)
1223 gint preserve = prefs_get_int_attribute("options.preservetransform", "value", 0);
1224 NR::Matrix transform_attr (transform);
1225 if ( // run the object's set_transform (i.e. embed transform) only if:
1226 ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform && // it does have a set_transform method
1227 !preserve && // user did not chose to preserve all transforms
1228 !item->clip_ref->getObject() && // the object does not have a clippath
1229 !item->mask_ref->getObject() && // the object does not have a mask
1230 !(!transform.is_translation() && SP_OBJECT_STYLE(item) && SP_OBJECT_STYLE(item)->getFilter())
1231 // the object does not have a filter, or the transform is translation (which is supposed to not affect filters)
1232 ) {
1233 transform_attr = ((SPItemClass *) G_OBJECT_GET_CLASS(item))->set_transform(item, transform);
1234 }
1235 sp_item_set_item_transform(item, transform_attr);
1237 // Note: updateRepr comes before emitting the transformed signal since
1238 // it causes clone SPUse's copy of the original object to brought up to
1239 // date with the original. Otherwise, sp_use_bbox returns incorrect
1240 // values if called in code handling the transformed signal.
1241 SP_OBJECT(item)->updateRepr();
1243 // send the relative transform with a _transformed_signal
1244 item->_transformed_signal.emit(&advertized_transform, item);
1245 }
1247 gint
1248 sp_item_event(SPItem *item, SPEvent *event)
1249 {
1250 g_return_val_if_fail(item != NULL, FALSE);
1251 g_return_val_if_fail(SP_IS_ITEM(item), FALSE);
1252 g_return_val_if_fail(event != NULL, FALSE);
1254 if (((SPItemClass *) G_OBJECT_GET_CLASS(item))->event)
1255 return ((SPItemClass *) G_OBJECT_GET_CLASS(item))->event(item, event);
1257 return FALSE;
1258 }
1260 /**
1261 * Sets item private transform (not propagated to repr), without compensating stroke widths,
1262 * gradients, patterns as sp_item_write_transform does.
1263 */
1264 void
1265 sp_item_set_item_transform(SPItem *item, NR::Matrix const &transform)
1266 {
1267 g_return_if_fail(item != NULL);
1268 g_return_if_fail(SP_IS_ITEM(item));
1270 if (!matrix_equalp(transform, item->transform, NR_EPSILON)) {
1271 item->transform = transform;
1272 /* The SP_OBJECT_USER_MODIFIED_FLAG_B is used to mark the fact that it's only a
1273 transformation. It's apparently not used anywhere else. */
1274 item->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_USER_MODIFIED_FLAG_B);
1275 sp_item_rm_unsatisfied_cns(*item);
1276 }
1277 }
1280 /**
1281 * \pre \a ancestor really is an ancestor (\>=) of \a object, or NULL.
1282 * ("Ancestor (\>=)" here includes as far as \a object itself.)
1283 */
1284 NR::Matrix
1285 i2anc_affine(SPObject const *object, SPObject const *const ancestor) {
1286 NR::Matrix ret(NR::identity());
1287 g_return_val_if_fail(object != NULL, ret);
1289 /* stop at first non-renderable ancestor */
1290 while ( object != ancestor && SP_IS_ITEM(object) ) {
1291 if (SP_IS_ROOT(object)) {
1292 ret *= SP_ROOT(object)->c2p;
1293 }
1294 ret *= SP_ITEM(object)->transform;
1295 object = SP_OBJECT_PARENT(object);
1296 }
1297 return ret;
1298 }
1300 NR::Matrix
1301 i2i_affine(SPObject const *src, SPObject const *dest) {
1302 g_return_val_if_fail(src != NULL && dest != NULL, NR::identity());
1303 SPObject const *ancestor = src->nearestCommonAncestor(dest);
1304 return i2anc_affine(src, ancestor) / i2anc_affine(dest, ancestor);
1305 }
1307 NR::Matrix SPItem::getRelativeTransform(SPObject const *dest) const {
1308 return i2i_affine(this, dest);
1309 }
1311 /**
1312 * Returns the accumulated transformation of the item and all its ancestors, including root's viewport.
1313 * \pre (item != NULL) and SP_IS_ITEM(item).
1314 */
1315 NR::Matrix sp_item_i2doc_affine(SPItem const *item)
1316 {
1317 return i2anc_affine(item, NULL);
1318 }
1320 /**
1321 * Returns the accumulated transformation of the item and all its ancestors, but excluding root's viewport.
1322 * Used in path operations mostly.
1323 * \pre (item != NULL) and SP_IS_ITEM(item).
1324 */
1325 NR::Matrix sp_item_i2root_affine(SPItem const *item)
1326 {
1327 g_assert(item != NULL);
1328 g_assert(SP_IS_ITEM(item));
1330 NR::Matrix ret(NR::identity());
1331 g_assert(ret.test_identity());
1332 while ( NULL != SP_OBJECT_PARENT(item) ) {
1333 ret *= item->transform;
1334 item = SP_ITEM(SP_OBJECT_PARENT(item));
1335 }
1336 g_assert(SP_IS_ROOT(item));
1338 ret *= item->transform;
1340 return ret;
1341 }
1343 /* fixme: This is EVIL!!! */
1345 NR::Matrix sp_item_i2d_affine(SPItem const *item)
1346 {
1347 g_assert(item != NULL);
1348 g_assert(SP_IS_ITEM(item));
1350 NR::Matrix const ret( sp_item_i2doc_affine(item)
1351 * NR::scale(1, -1)
1352 * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1353 return ret;
1354 }
1356 // same as i2d but with i2root instead of i2doc
1357 NR::Matrix sp_item_i2r_affine(SPItem const *item)
1358 {
1359 g_assert(item != NULL);
1360 g_assert(SP_IS_ITEM(item));
1362 NR::Matrix const ret( sp_item_i2root_affine(item)
1363 * NR::scale(1, -1)
1364 * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item))) );
1365 return ret;
1366 }
1368 /**
1369 * Converts a matrix \a m into the desktop coords of the \a item.
1370 * Will become a noop when we eliminate the coordinate flipping.
1371 */
1372 NR::Matrix matrix_to_desktop(NR::Matrix const m, SPItem const *item)
1373 {
1374 NR::Matrix const ret(m
1375 * NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1376 * NR::scale(1, -1));
1377 return ret;
1378 }
1380 /**
1381 * Converts a matrix \a m from the desktop coords of the \a item.
1382 * Will become a noop when we eliminate the coordinate flipping.
1383 */
1384 NR::Matrix matrix_from_desktop(NR::Matrix const m, SPItem const *item)
1385 {
1386 NR::Matrix const ret(NR::scale(1, -1)
1387 * NR::translate(0, sp_document_height(SP_OBJECT_DOCUMENT(item)))
1388 * m);
1389 return ret;
1390 }
1392 void sp_item_set_i2d_affine(SPItem *item, NR::Matrix const &i2dt)
1393 {
1394 g_return_if_fail( item != NULL );
1395 g_return_if_fail( SP_IS_ITEM(item) );
1397 NR::Matrix dt2p; /* desktop to item parent transform */
1398 if (SP_OBJECT_PARENT(item)) {
1399 dt2p = sp_item_i2d_affine((SPItem *) SP_OBJECT_PARENT(item)).inverse();
1400 } else {
1401 dt2p = ( NR::translate(0, -sp_document_height(SP_OBJECT_DOCUMENT(item)))
1402 * NR::scale(1, -1) );
1403 }
1405 NR::Matrix const i2p( i2dt * dt2p );
1406 sp_item_set_item_transform(item, i2p);
1407 }
1410 NR::Matrix
1411 sp_item_dt2i_affine(SPItem const *item)
1412 {
1413 /* fixme: Implement the right way (Lauris) */
1414 return sp_item_i2d_affine(item).inverse();
1415 }
1417 /* Item views */
1419 static SPItemView *
1420 sp_item_view_new_prepend(SPItemView *list, SPItem *item, unsigned flags, unsigned key, NRArenaItem *arenaitem)
1421 {
1422 SPItemView *new_view;
1424 g_assert(item != NULL);
1425 g_assert(SP_IS_ITEM(item));
1426 g_assert(arenaitem != NULL);
1427 g_assert(NR_IS_ARENA_ITEM(arenaitem));
1429 new_view = g_new(SPItemView, 1);
1431 new_view->next = list;
1432 new_view->flags = flags;
1433 new_view->key = key;
1434 new_view->arenaitem = nr_arena_item_ref(arenaitem);
1436 return new_view;
1437 }
1439 static SPItemView *
1440 sp_item_view_list_remove(SPItemView *list, SPItemView *view)
1441 {
1442 if (view == list) {
1443 list = list->next;
1444 } else {
1445 SPItemView *prev;
1446 prev = list;
1447 while (prev->next != view) prev = prev->next;
1448 prev->next = view->next;
1449 }
1451 nr_arena_item_unref(view->arenaitem);
1452 g_free(view);
1454 return list;
1455 }
1457 /**
1458 * Return the arenaitem corresponding to the given item in the display
1459 * with the given key
1460 */
1461 NRArenaItem *
1462 sp_item_get_arenaitem(SPItem *item, unsigned key)
1463 {
1464 for ( SPItemView *iv = item->display ; iv ; iv = iv->next ) {
1465 if ( iv->key == key ) {
1466 return iv->arenaitem;
1467 }
1468 }
1470 return NULL;
1471 }
1473 int
1474 sp_item_repr_compare_position(SPItem *first, SPItem *second)
1475 {
1476 return sp_repr_compare_position(SP_OBJECT_REPR(first),
1477 SP_OBJECT_REPR(second));
1478 }
1480 SPItem *
1481 sp_item_first_item_child (SPObject *obj)
1482 {
1483 for ( SPObject *iter = sp_object_first_child(obj) ; iter ; iter = SP_OBJECT_NEXT(iter)) {
1484 if (SP_IS_ITEM (iter))
1485 return SP_ITEM (iter);
1486 }
1487 return NULL;
1488 }
1491 /*
1492 Local Variables:
1493 mode:c++
1494 c-file-style:"stroustrup"
1495 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1496 indent-tabs-mode:nil
1497 fill-column:99
1498 End:
1499 */
1500 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :