Code

#include svg/svg-color.h instead of or as well as (as appropriate) svg/svg.h.
[inkscape.git] / src / gradient-chemistry.cpp
1 #define __SP_GRADIENT_CHEMISTRY_C__
3 /*
4  * Various utility methods for gradients
5  *
6  * Authors:
7  *   Lauris Kaplinski <lauris@kaplinski.com>
8  *   bulia byak
9  *
10  * Copyright (C) 2001-2005 authors
11  * Copyright (C) 2001 Ximian, Inc.
12  *
13  * Released under GNU GPL, read the file 'COPYING' for more information
14  */
17 #include "style.h"
18 #include "document-private.h"
19 #include "desktop-style.h"
21 #include "sp-gradient-reference.h"
22 #include "sp-linear-gradient.h"
23 #include "sp-radial-gradient.h"
24 #include "sp-stop.h"
25 #include "widgets/gradient-vector.h"
27 #include "sp-text.h"
28 #include "sp-tspan.h"
29 #include <libnr/nr-matrix-fns.h>
30 #include "xml/repr.h"
31 #include "svg/svg.h"
32 #include "svg/svg-color.h"
35 // Terminology:
36 //
37 // "vector" is a gradient that has stops but not position coords. It can be referenced by one or
38 // more privates. Objects should not refer to it directly. It has no radial/linear distinction.
39 //
40 // "private" is a gradient that has no stops but has position coords (e.g. center, radius etc for a
41 // radial). It references a vector for the actual colors. Each private is only used by one
42 // object. It is either linear or radial.
44 static void sp_gradient_repr_set_link(Inkscape::XML::Node *repr, SPGradient *gr);
45 static void sp_item_repr_set_style_gradient(Inkscape::XML::Node *repr, gchar const *property,
46                                             SPGradient *gr, bool recursive);
48 SPGradient *
49 sp_gradient_ensure_vector_normalized(SPGradient *gr)
50 {
51     g_return_val_if_fail(gr != NULL, NULL);
52     g_return_val_if_fail(SP_IS_GRADIENT(gr), NULL);
54     /* If we are already normalized vector, just return */
55     if (gr->state == SP_GRADIENT_STATE_VECTOR) return gr;
56     /* Fail, if we have wrong state set */
57     if (gr->state != SP_GRADIENT_STATE_UNKNOWN) {
58         g_warning("file %s: line %d: Cannot normalize private gradient to vector (%s)", __FILE__, __LINE__, SP_OBJECT_ID(gr));
59         return NULL;
60     }
62     /* First make sure we have vector directly defined (i.e. gr has its own stops) */
63     if (!gr->has_stops) {
64         /* We do not have stops ourselves, so flatten stops as well */
65         sp_gradient_ensure_vector(gr);
66         g_assert(gr->vector.built);
67         // this adds stops from gr->vector as children to gr
68         sp_gradient_repr_write_vector (gr);
69     }
71     /* If gr hrefs some other gradient, remove the href */
72     if (gr->ref->getObject()) {
73         /* We are hrefing someone, so require flattening */
74         SP_OBJECT(gr)->updateRepr(((SPObject *) gr)->repr, SP_OBJECT_WRITE_EXT | SP_OBJECT_WRITE_ALL);
75         sp_gradient_repr_set_link(SP_OBJECT_REPR(gr), NULL);
76     }
78     /* Everything is OK, set state flag */
79     gr->state = SP_GRADIENT_STATE_VECTOR;
80     return gr;
81 }
83 /**
84  * Creates new private gradient for the given vector
85  */
87 static SPGradient *
88 sp_gradient_get_private_normalized(SPDocument *document, SPGradient *vector, SPGradientType type)
89 {
90     g_return_val_if_fail(document != NULL, NULL);
91     g_return_val_if_fail(vector != NULL, NULL);
92     g_return_val_if_fail(SP_IS_GRADIENT(vector), NULL);
93     g_return_val_if_fail(SP_GRADIENT_HAS_STOPS(vector), NULL);
95     SPDefs *defs = (SPDefs *) SP_DOCUMENT_DEFS(document);
97     // create a new private gradient of the requested type
98     Inkscape::XML::Node *repr;
99     if (type == SP_GRADIENT_TYPE_LINEAR) {
100         repr = sp_repr_new("svg:linearGradient");
101     } else {
102         repr = sp_repr_new("svg:radialGradient");
103     }
105     // privates are garbage-collectable
106     repr->setAttribute("inkscape:collect", "always");
108     // link to vector
109     sp_gradient_repr_set_link(repr, vector);
111     /* Append the new private gradient to defs */
112     SP_OBJECT_REPR(defs)->appendChild(repr);
113     Inkscape::GC::release(repr);
115     // get corresponding object
116     SPGradient *gr = (SPGradient *) document->getObjectByRepr(repr);
117     g_assert(gr != NULL);
118     g_assert(SP_IS_GRADIENT(gr));
120     return gr;
123 /**
124 Count how many times gr is used by the styles of o and its descendants
125 */
126 guint
127 count_gradient_hrefs(SPObject *o, SPGradient *gr)
129     if (!o)
130         return 1;
132     guint i = 0;
134     SPStyle *style = SP_OBJECT_STYLE(o);
135     if (style
136         && style->fill.type == SP_PAINT_TYPE_PAINTSERVER
137         && SP_IS_GRADIENT(SP_STYLE_FILL_SERVER(style))
138         && SP_GRADIENT(SP_STYLE_FILL_SERVER(style)) == gr)
139     {
140         i ++;
141     }
142     if (style
143         && style->stroke.type == SP_PAINT_TYPE_PAINTSERVER
144         && SP_IS_GRADIENT(SP_STYLE_STROKE_SERVER(style))
145         && SP_GRADIENT(SP_STYLE_STROKE_SERVER(style)) == gr)
146     {
147         i ++;
148     }
150     for (SPObject *child = sp_object_first_child(o);
151          child != NULL; child = SP_OBJECT_NEXT(child)) {
152         i += count_gradient_hrefs(child, gr);
153     }
155     return i;
159 /**
160  * If gr has other users, create a new private; also check if gr links to vector, relink if not
161  */
162 SPGradient *
163 sp_gradient_fork_private_if_necessary(SPGradient *gr, SPGradient *vector,
164                                       SPGradientType type, SPObject *o)
166     g_return_val_if_fail(gr != NULL, NULL);
167     g_return_val_if_fail(SP_IS_GRADIENT(gr), NULL);
169     // Orphaned gradient, no vector with stops at the end of the line; this used to be an assert
170     // but i think we should not abort on this - maybe just write a validity warning into some sort
171     // of log
172     if (!vector || !SP_GRADIENT_HAS_STOPS(vector))
173         return (gr);
175     // user is the object that uses this gradient; normally it's item but for tspans, we
176     // check its ancestor text so that tspans don't get different gradients from their
177     // texts.
178     SPObject *user = o;
179     while (SP_IS_TSPAN(user)) {
180         user = SP_OBJECT_PARENT(user);
181     }
183     // Check the number of uses of the gradient within this object;
184     // if we are private and there are no other users,
185     if (SP_OBJECT_HREFCOUNT(gr) <= count_gradient_hrefs(user, gr)) {
186         // check vector
187         if ( gr != vector && gr->ref->getObject() != vector ) {
188             /* our href is not the vector, and vector is different from gr; relink */
189             sp_gradient_repr_set_link(SP_OBJECT_REPR(gr), vector);
190         }
191         return gr;
192     }
194     SPDocument *doc = SP_OBJECT_DOCUMENT(gr);
195     SPObject *defs = SP_DOCUMENT_DEFS(doc);
197     if ((gr->has_stops) ||
198         (gr->state != SP_GRADIENT_STATE_UNKNOWN) ||
199         (SP_OBJECT_PARENT(gr) != SP_OBJECT(defs)) ||
200         (SP_OBJECT_HREFCOUNT(gr) > 1)) {
201         // we have to clone a fresh new private gradient for the given vector
203         // create an empty one
204         SPGradient *gr_new = sp_gradient_get_private_normalized(doc, vector, type);
206         // copy all the attributes to it
207         Inkscape::XML::Node *repr_new = SP_OBJECT_REPR(gr_new);
208         Inkscape::XML::Node *repr = SP_OBJECT_REPR(gr);
209         repr_new->setAttribute("gradientUnits", repr->attribute("gradientUnits"));
210         repr_new->setAttribute("gradientTransform", repr->attribute("gradientTransform"));
211         repr_new->setAttribute("spreadMethod", repr->attribute("spreadMethod"));
212         if (SP_IS_RADIALGRADIENT(gr)) {
213             repr_new->setAttribute("cx", repr->attribute("cx"));
214             repr_new->setAttribute("cy", repr->attribute("cy"));
215             repr_new->setAttribute("fx", repr->attribute("fx"));
216             repr_new->setAttribute("fy", repr->attribute("fy"));
217             repr_new->setAttribute("r", repr->attribute("r"));
218         } else {
219             repr_new->setAttribute("x1", repr->attribute("x1"));
220             repr_new->setAttribute("y1", repr->attribute("y1"));
221             repr_new->setAttribute("x2", repr->attribute("x2"));
222             repr_new->setAttribute("y2", repr->attribute("y2"));
223         }
225         return gr_new;
226     } else {
227         return gr;
228     }
231 SPGradient *
232 sp_gradient_fork_vector_if_necessary (SPGradient *gr)
234     if (SP_OBJECT_HREFCOUNT(gr) > 1) {
235         SPDocument *document = SP_OBJECT_DOCUMENT(gr);
237         Inkscape::XML::Node *repr = SP_OBJECT_REPR (gr)->duplicate();
238         SP_OBJECT_REPR (SP_DOCUMENT_DEFS (document))->addChild(repr, NULL);
239         SPGradient *gr_new = (SPGradient *) document->getObjectByRepr(repr);
240         gr_new = sp_gradient_ensure_vector_normalized (gr_new);
241         Inkscape::GC::release(repr);
242         return gr_new;
243     }
244     return gr;
247 /**
248  * Convert an item's gradient to userspace _without_ preserving coords, setting them to defaults
249  * instead. No forking or reapplying is done because this is only called for newly created privates.
250  * @return The new gradient.
251  */
252 SPGradient *
253 sp_gradient_reset_to_userspace (SPGradient *gr, SPItem *item)
255     Inkscape::XML::Node *repr = SP_OBJECT_REPR(gr);
257     // calculate the bbox of the item
258     sp_document_ensure_up_to_date(SP_OBJECT_DOCUMENT(item));
259     NR::Rect const bbox = item->invokeBbox(NR::identity()); // we need "true" bbox without item_i2d_affine
261     NR::Coord const width = bbox.dimensions()[NR::X];
262     NR::Coord const height = bbox.dimensions()[NR::Y];
263     g_assert(width > 0 && height > 0);
265     NR::Point const center = bbox.midpoint();
267     if (SP_IS_RADIALGRADIENT(gr)) {
268         sp_repr_set_svg_double(repr, "cx", center[NR::X]);
269         sp_repr_set_svg_double(repr, "cy", center[NR::Y]);
270         sp_repr_set_svg_double(repr, "fx", center[NR::X]);
271         sp_repr_set_svg_double(repr, "fy", center[NR::Y]);
272         sp_repr_set_svg_double(repr, "r", width/2);
274         // we want it to be elliptic, not circular
275         NR::Matrix squeeze = NR::Matrix (NR::translate (-center)) *
276             NR::Matrix (NR::scale(1, height/width)) *
277             NR::Matrix (NR::translate (center));
279         gr->gradientTransform = squeeze;
280         {
281             gchar c[256];
282             if (sp_svg_transform_write(c, 256, gr->gradientTransform)) {
283                 SP_OBJECT_REPR(gr)->setAttribute("gradientTransform", c);
284             } else {
285                 SP_OBJECT_REPR(gr)->setAttribute("gradientTransform", NULL);
286             }
287         }
288     } else {
289         sp_repr_set_svg_double(repr, "x1", (center - NR::Point(width/2, 0))[NR::X]);
290         sp_repr_set_svg_double(repr, "y1", (center - NR::Point(width/2, 0))[NR::Y]);
291         sp_repr_set_svg_double(repr, "x2", (center + NR::Point(width/2, 0))[NR::X]);
292         sp_repr_set_svg_double(repr, "y2", (center + NR::Point(width/2, 0))[NR::Y]);
293     }
295     // set the gradientUnits
296     repr->setAttribute("gradientUnits", "userSpaceOnUse");
298     return gr;
301 /**
302  * Convert an item's gradient to userspace if necessary, also fork it if necessary.
303  * @return The new gradient.
304  */
305 SPGradient *
306 sp_gradient_convert_to_userspace(SPGradient *gr, SPItem *item, gchar const *property)
308     g_return_val_if_fail(SP_IS_GRADIENT(gr), NULL);
310     // First, fork it if it is shared
311     gr = sp_gradient_fork_private_if_necessary(gr, sp_gradient_get_vector(gr, FALSE),
312                                                SP_IS_RADIALGRADIENT(gr) ? SP_GRADIENT_TYPE_RADIAL : SP_GRADIENT_TYPE_LINEAR, SP_OBJECT(item));
314     if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
316         Inkscape::XML::Node *repr = SP_OBJECT_REPR(gr);
318         // calculate the bbox of the item
319         sp_document_ensure_up_to_date(SP_OBJECT_DOCUMENT(item));
320         NR::Rect const bbox = item->invokeBbox(NR::identity()); // we need "true" bbox without item_i2d_affine
321         NR::Matrix bbox2user(bbox.dimensions()[NR::X], 0,
322                              0, bbox.dimensions()[NR::Y],
323                              bbox.min()[NR::X], bbox.min()[NR::Y]);
325         /* skew is the additional transform, defined by the proportions of the item, that we need
326          * to apply to the gradient in order to work around this weird bit from SVG 1.1
327          * (http://www.w3.org/TR/SVG11/pservers.html#LinearGradients):
328          *
329          *   When gradientUnits="objectBoundingBox" and gradientTransform is the identity
330          *   matrix, the stripes of the linear gradient are perpendicular to the gradient
331          *   vector in object bounding box space (i.e., the abstract coordinate system where
332          *   (0,0) is at the top/left of the object bounding box and (1,1) is at the
333          *   bottom/right of the object bounding box). When the object's bounding box is not
334          *   square, the stripes that are conceptually perpendicular to the gradient vector
335          *   within object bounding box space will render non-perpendicular relative to the
336          *   gradient vector in user space due to application of the non-uniform scaling
337          *   transformation from bounding box space to user space.
338          */
339         NR::Matrix skew = bbox2user;
340         double exp = skew.expansion();
341         skew[0] /= exp;
342         skew[1] /= exp;
343         skew[2] /= exp;
344         skew[3] /= exp;
345         skew[4] = 0;
346         skew[5] = 0;
348         // apply skew to the gradient
349         gr->gradientTransform = skew;
350         {
351             gchar c[256];
352             if (sp_svg_transform_write(c, 256, gr->gradientTransform)) {
353                 SP_OBJECT_REPR(gr)->setAttribute("gradientTransform", c);
354             } else {
355                 SP_OBJECT_REPR(gr)->setAttribute("gradientTransform", NULL);
356             }
357         }
359         // Matrix to convert points to userspace coords; postmultiply by inverse of skew so
360         // as to cancel it out when it's applied to the gradient during rendering
361         NR::Matrix point_convert = bbox2user * skew.inverse();
363         if (SP_IS_RADIALGRADIENT(gr)) {
364             SPRadialGradient *rg = SP_RADIALGRADIENT(gr);
366             // original points in the bbox coords
367             NR::Point c_b = NR::Point(rg->cx.computed, rg->cy.computed);
368             NR::Point f_b = NR::Point(rg->fx.computed, rg->fy.computed);
369             double r_b = rg->r.computed;
371             // converted points in userspace coords
372             NR::Point c_u = c_b * point_convert;
373             NR::Point f_u = f_b * point_convert;
374             double r_u = r_b * point_convert.expansion();
376             sp_repr_set_svg_double(repr, "cx", c_u[NR::X]);
377             sp_repr_set_svg_double(repr, "cy", c_u[NR::Y]);
378             sp_repr_set_svg_double(repr, "fx", f_u[NR::X]);
379             sp_repr_set_svg_double(repr, "fy", f_u[NR::Y]);
380             sp_repr_set_svg_double(repr, "r", r_u);
382         } else {
383             SPLinearGradient *lg = SP_LINEARGRADIENT(gr);
385             NR::Point p1_b = NR::Point(lg->x1.computed, lg->y1.computed);
386             NR::Point p2_b = NR::Point(lg->x2.computed, lg->y2.computed);
388             NR::Point p1_u = p1_b * point_convert;
389             NR::Point p2_u = p2_b * point_convert;
391             sp_repr_set_svg_double(repr, "x1", p1_u[NR::X]);
392             sp_repr_set_svg_double(repr, "y1", p1_u[NR::Y]);
393             sp_repr_set_svg_double(repr, "x2", p2_u[NR::X]);
394             sp_repr_set_svg_double(repr, "y2", p2_u[NR::Y]);
395         }
397         // set the gradientUnits
398         repr->setAttribute("gradientUnits", "userSpaceOnUse");
399     }
401     // apply the gradient to the item (may be necessary if we forked it); not recursive
402     // generally because grouped items will be taken care of later (we're being called
403     // from sp_item_adjust_paint_recursive); however text and all its children should all
404     // refer to one gradient, hence the recursive call for text (because we can't/don't
405     // want to access tspans and set gradients on them separately)
406     if (SP_IS_TEXT(item))
407         sp_item_repr_set_style_gradient(SP_OBJECT_REPR(item), property, gr, true);
408     else
409         sp_item_repr_set_style_gradient(SP_OBJECT_REPR(item), property, gr, false);
411     return gr;
414 void
415 sp_gradient_transform_multiply(SPGradient *gradient, NR::Matrix postmul, bool set)
417     if (set) {
418         gradient->gradientTransform = postmul;
419     } else {
420         gradient->gradientTransform *= postmul; // fixme: get gradient transform by climbing to hrefs?
421     }
422     gradient->gradientTransform_set = TRUE;
424     gchar c[256];
425     if (sp_svg_transform_write(c, 256, gradient->gradientTransform)) {
426         SP_OBJECT_REPR(gradient)->setAttribute("gradientTransform", c);
427     } else {
428         SP_OBJECT_REPR(gradient)->setAttribute("gradientTransform", NULL);
429     }
432 SPGradient *
433 sp_item_gradient (SPItem *item, bool fill_or_stroke)
435     SPStyle *style = SP_OBJECT_STYLE (item);
436     SPGradient *gradient = NULL;
438     if (fill_or_stroke) {
439         if (style && (style->fill.type == SP_PAINT_TYPE_PAINTSERVER)) {
440             SPObject *server = SP_OBJECT_STYLE_FILL_SERVER(item);
441             if (SP_IS_GRADIENT (server)) {
442                 gradient = SP_GRADIENT (server);
443             }
444         }
445     } else {
446         if (style && (style->stroke.type == SP_PAINT_TYPE_PAINTSERVER)) {
447             SPObject *server = SP_OBJECT_STYLE_STROKE_SERVER(item);
448             if (SP_IS_GRADIENT (server)) {
449                 gradient = SP_GRADIENT (server);
450             }
451         }
452     }
454    return gradient;
458 SPStop*
459 sp_first_stop(SPGradient *gradient)
461   for (SPObject *ochild = sp_object_first_child(gradient); ochild != NULL; ochild = SP_OBJECT_NEXT(ochild)) {
462         if (SP_IS_STOP (ochild))
463                 return SP_STOP(ochild);
464   }
465   return NULL;
468 SPStop*
469 sp_prev_stop(SPStop *stop, SPGradient *gradient)
471         if (sp_object_first_child(SP_OBJECT(gradient)) == SP_OBJECT(stop))
472                 return NULL;
473         SPObject *found = NULL;
474         for ( SPObject *ochild = sp_object_first_child(SP_OBJECT(gradient)) ; ochild != NULL ; ochild = SP_OBJECT_NEXT(ochild) ) {
475                 if (SP_IS_STOP (ochild)) {
476                         found = ochild;
477                 }
478                 if (SP_OBJECT_NEXT(ochild) == SP_OBJECT(stop) || SP_OBJECT(ochild) == SP_OBJECT(stop)) {
479                         break;
480                 }
481         }
482         return SP_STOP(found);
485 SPStop*
486 sp_next_stop(SPStop *stop)
488   for (SPObject *ochild = SP_OBJECT_NEXT(stop); ochild != NULL; ochild = SP_OBJECT_NEXT(ochild)) {
489         if (SP_IS_STOP (ochild))
490                 return SP_STOP(ochild);
491   }
492   return NULL;
495 SPStop*
496 sp_last_stop(SPGradient *gradient)
498     for (SPStop *stop = sp_first_stop (gradient); stop != NULL; stop = sp_next_stop (stop)) {
499         if (sp_next_stop (stop) == NULL)
500                 return stop;
501   }
502   return NULL;
506 void
507 sp_item_gradient_edit_stop (SPItem *item, guint point_num, bool fill_or_stroke)
509     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
511     if (!gradient || !SP_IS_GRADIENT(gradient))
512         return;
514     SPGradient *vector = sp_gradient_get_vector (gradient, false);
515     switch (point_num) {
516         case POINT_LG_P1:
517         case POINT_RG_CENTER:
518         case POINT_RG_FOCUS:
519         {
520             GtkWidget *dialog = sp_gradient_vector_editor_new (vector, sp_first_stop (vector));
521             gtk_widget_show (dialog);
522         }
523         break;
525         case POINT_LG_P2:
526         case POINT_RG_R1:
527         case POINT_RG_R2:
528         {
529             GtkWidget *dialog = sp_gradient_vector_editor_new (vector, sp_last_stop (vector));
530             gtk_widget_show (dialog);
531         }
532         break;
533         default:
534             break;
535     }
538 guint32
539 sp_item_gradient_stop_query_style (SPItem *item, guint point_num, bool fill_or_stroke)
541     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
543     if (!gradient || !SP_IS_GRADIENT(gradient))
544         return 0;
546     SPGradient *vector = sp_gradient_get_vector (gradient, false);
548     if (!vector) // orphan!
549         return 0; // what else to do?
551     switch (point_num) {
552         case POINT_LG_P1:
553         case POINT_RG_CENTER:
554         case POINT_RG_FOCUS:
555         {
556             SPStop *first = sp_first_stop (vector);
557             if (first) {
558                 return sp_stop_get_rgba32(first);
559             }
560         }
561         break;
563         case POINT_LG_P2:
564         case POINT_RG_R1:
565         case POINT_RG_R2:
566         {
567             SPStop *last = sp_last_stop (vector);
568             if (last) {
569                 return sp_stop_get_rgba32(last);
570             }
571         }
572         break;
573         default:
574             break;
575     }
576     return 0;
579 void
580 sp_item_gradient_stop_set_style (SPItem *item, guint point_num, bool fill_or_stroke, SPCSSAttr *stop)
582     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
584     if (!gradient || !SP_IS_GRADIENT(gradient))
585         return;
587     SPGradient *vector = sp_gradient_get_vector (gradient, false);
589     if (!vector) // orphan!
590         return;
592     vector = sp_gradient_fork_vector_if_necessary (vector);
593     if ( gradient != vector && gradient->ref->getObject() != vector ) {
594         sp_gradient_repr_set_link(SP_OBJECT_REPR(gradient), vector);
595     }
597     switch (point_num) {
598         case POINT_LG_P1:
599         case POINT_RG_CENTER:
600         case POINT_RG_FOCUS:
601         {
602             SPStop *first = sp_first_stop (vector);
603             if (first) {
604                 sp_repr_css_change (SP_OBJECT_REPR (first), stop, "style");
605             }
606         }
607         break;
609         case POINT_LG_P2:
610         case POINT_RG_R1:
611         case POINT_RG_R2:
612         {
613             SPStop *last = sp_last_stop (vector);
614             if (last) {
615                 sp_repr_css_change (SP_OBJECT_REPR (last), stop, "style");
616             }
617         }
618         break;
619         default:
620             break;
621     }
624 void
625 sp_item_gradient_reverse_vector (SPItem *item, bool fill_or_stroke)
627     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
628     if (!gradient || !SP_IS_GRADIENT(gradient))
629         return;
631     SPGradient *vector = sp_gradient_get_vector (gradient, false);
632     if (!vector) // orphan!
633         return;
635     vector = sp_gradient_fork_vector_if_necessary (vector);
636     if ( gradient != vector && gradient->ref->getObject() != vector ) {
637         sp_gradient_repr_set_link(SP_OBJECT_REPR(gradient), vector);
638     }
640     GSList *child_reprs = NULL;
641     GSList *child_objects = NULL;
642     std::vector<double> offsets;
643     for (SPObject *child = sp_object_first_child(vector);
644          child != NULL; child = SP_OBJECT_NEXT(child)) {
645         child_reprs = g_slist_prepend (child_reprs, SP_OBJECT_REPR(child));
646         child_objects = g_slist_prepend (child_objects, child);
647         offsets.push_back(sp_repr_get_double_attribute(SP_OBJECT_REPR(child), "offset", 0));
648     }
650     GSList *child_copies = NULL;
651     for (GSList *i = child_reprs; i != NULL; i = i->next) {
652         Inkscape::XML::Node *repr = (Inkscape::XML::Node *) i->data;
653         child_copies = g_slist_append (child_copies, repr->duplicate());
654     }
657     for (GSList *i = child_objects; i != NULL; i = i->next) {
658         SPObject *child = SP_OBJECT (i->data);
659         child->deleteObject();
660     }
662     std::vector<double>::iterator iter = offsets.end() - 1;
663     for (GSList *i = child_copies; i != NULL; i = i->next) {
664         Inkscape::XML::Node *copy = (Inkscape::XML::Node *) i->data;
665         vector->appendChildRepr(copy);
666         sp_repr_set_svg_double (copy, "offset", 1 - *iter);
667         iter --;
668         Inkscape::GC::release(copy);
669     }
671     g_slist_free (child_reprs);
672     g_slist_free (child_copies);
673     g_slist_free (child_objects);
678 /**
679 Set the position of point point_num of the gradient applied to item (either fill_or_stroke) to
680 p_w (in desktop coordinates). Write_repr if you want the change to become permanent.
681 */
682 void
683 sp_item_gradient_set_coords (SPItem *item, guint point_num, NR::Point p_w, bool fill_or_stroke, bool write_repr, bool scale)
685     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
687     if (!gradient || !SP_IS_GRADIENT(gradient))
688         return;
690     gradient = sp_gradient_convert_to_userspace (gradient, item, fill_or_stroke? "fill" : "stroke");
692     NR::Matrix i2d = sp_item_i2d_affine (item);
693     NR::Point p = p_w * i2d.inverse();
694     p *= (gradient->gradientTransform).inverse();
695     // now p is in gradient's original coordinates
697     Inkscape::XML::Node *repr = SP_OBJECT_REPR(gradient);
699     if (SP_IS_LINEARGRADIENT(gradient)) {
700         SPLinearGradient *lg = SP_LINEARGRADIENT(gradient);
701         switch (point_num) {
702             case POINT_LG_P1:
703                 if (scale) {
704                     lg->x2.computed += (lg->x1.computed - p[NR::X]);
705                     lg->y2.computed += (lg->y1.computed - p[NR::Y]);
706                 }
707                 lg->x1.computed = p[NR::X];
708                 lg->y1.computed = p[NR::Y];
709                 if (write_repr) {
710                     if (scale) {
711                         sp_repr_set_svg_double(repr, "x2", lg->x2.computed);
712                         sp_repr_set_svg_double(repr, "y2", lg->y2.computed);
713                     }
714                     sp_repr_set_svg_double(repr, "x1", lg->x1.computed);
715                     sp_repr_set_svg_double(repr, "y1", lg->y1.computed);
716                 } else {
717                     SP_OBJECT (gradient)->requestModified(SP_OBJECT_MODIFIED_FLAG);
718                 }
719                 break;
720             case POINT_LG_P2:
721                 if (scale) {
722                     lg->x1.computed += (lg->x2.computed - p[NR::X]);
723                     lg->y1.computed += (lg->y2.computed - p[NR::Y]);
724                 }
725                 lg->x2.computed = p[NR::X];
726                 lg->y2.computed = p[NR::Y];
727                 if (write_repr) {
728                     if (scale) {
729                         sp_repr_set_svg_double(repr, "x1", lg->x1.computed);
730                         sp_repr_set_svg_double(repr, "y1", lg->y1.computed);
731                     }
732                     sp_repr_set_svg_double(repr, "x2", lg->x2.computed);
733                     sp_repr_set_svg_double(repr, "y2", lg->y2.computed);
734                 } else {
735                     SP_OBJECT (gradient)->requestModified(SP_OBJECT_MODIFIED_FLAG);
736                 }
737                         break;
738                 default:
739                         break;
740                 }
741         } else if (SP_IS_RADIALGRADIENT(gradient)) {
743                 SPRadialGradient *rg = SP_RADIALGRADIENT(gradient);
744                 NR::Point c (rg->cx.computed, rg->cy.computed);
745                 NR::Point c_w = c * gradient->gradientTransform * i2d; // now in desktop coords
746            if ((point_num == POINT_RG_R1 || point_num == POINT_RG_R2) && NR::L2 (p_w - c_w) < 1e-3) {
747                // prevent setting a radius too close to the center
748                return;
749            }
750                 NR::Matrix new_transform;
751                 bool transform_set = false;
753                 switch (point_num) {
754                 case POINT_RG_CENTER:
755                         rg->fx.computed = p[NR::X] + (rg->fx.computed - rg->cx.computed);
756                         rg->fy.computed = p[NR::Y] + (rg->fy.computed - rg->cy.computed);
757                         rg->cx.computed = p[NR::X];
758                         rg->cy.computed = p[NR::Y];
759                         if (write_repr) {
760                                 sp_repr_set_svg_double(repr, "fx", rg->fx.computed);
761                                 sp_repr_set_svg_double(repr, "fy", rg->fy.computed);
762                                 sp_repr_set_svg_double(repr, "cx", rg->cx.computed);
763                                 sp_repr_set_svg_double(repr, "cy", rg->cy.computed);
764                         } else {
765                                 SP_OBJECT (gradient)->requestModified(SP_OBJECT_MODIFIED_FLAG);
766                         }
767                         break;
768                 case POINT_RG_FOCUS:
769                         rg->fx.computed = p[NR::X];
770                         rg->fy.computed = p[NR::Y];
771                         if (write_repr) {
772                                 sp_repr_set_svg_double(repr, "fx", rg->fx.computed);
773                                 sp_repr_set_svg_double(repr, "fy", rg->fy.computed);
774                         } else {
775                                 SP_OBJECT (gradient)->requestModified(SP_OBJECT_MODIFIED_FLAG);
776                         }
777                         break;
778                 case POINT_RG_R1:
779                         {
780                                 NR::Point r1_w = (c + NR::Point(rg->r.computed, 0)) * gradient->gradientTransform * i2d;
781                                 double r1_angle = NR::atan2(r1_w - c_w);
782                                 double move_angle = NR::atan2(p_w - c_w) - r1_angle;
783                                 double move_stretch = NR::L2(p_w - c_w) / NR::L2(r1_w - c_w);
785                                 NR::Matrix move = NR::Matrix (NR::translate (-c_w)) *
786                                                                                                  NR::Matrix (NR::rotate(-r1_angle)) *
787                                                                                                  NR::Matrix (NR::scale(move_stretch, scale? move_stretch : 1)) *
788                                                                                                  NR::Matrix (NR::rotate(r1_angle)) *
789                                                                                                  NR::Matrix (NR::rotate(move_angle)) *
790                                                                                                  NR::Matrix (NR::translate (c_w));
792                                 new_transform = gradient->gradientTransform * i2d * move * i2d.inverse();
793                                 transform_set = true;
795                                 break;
796                         }
797                 case POINT_RG_R2:
798                         {
799                                 NR::Point r2_w = (c + NR::Point(0, -rg->r.computed)) * gradient->gradientTransform * i2d;
800                                 double r2_angle = NR::atan2(r2_w - c_w);
801                                 double move_angle = NR::atan2(p_w - c_w) - r2_angle;
802                                 double move_stretch = NR::L2(p_w - c_w) / NR::L2(r2_w - c_w);
804                                 NR::Matrix move = NR::Matrix (NR::translate (-c_w)) *
805                                                                                                  NR::Matrix (NR::rotate(-r2_angle)) *
806                                                                                                  NR::Matrix (NR::scale(move_stretch, scale? move_stretch : 1)) *
807                                                                                                  NR::Matrix (NR::rotate(r2_angle)) *
808                                                                                                  NR::Matrix (NR::rotate(move_angle)) *
809                                                                                                  NR::Matrix (NR::translate (c_w));
811                                 new_transform = gradient->gradientTransform * i2d * move * i2d.inverse();
812                                 transform_set = true;
814                                 break;
815                         }
816                 }
818                 if (transform_set) {
819                                 gradient->gradientTransform = new_transform;
820                                 gradient->gradientTransform_set = TRUE;
821                                 if (write_repr) {
822                                         gchar s[256];
823                                         if (sp_svg_transform_write(s, 256, gradient->gradientTransform)) {
824                                                 SP_OBJECT_REPR(gradient)->setAttribute("gradientTransform", s);
825                                         } else {
826                                                 SP_OBJECT_REPR(gradient)->setAttribute("gradientTransform", NULL);
827                                         }
828                                 } else {
829                                         SP_OBJECT (gradient)->requestModified(SP_OBJECT_MODIFIED_FLAG);
830                                 }
831                 }
832         }
835 SPGradient *
836 sp_item_gradient_get_vector (SPItem *item, bool fill_or_stroke)
838     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
840     if (gradient)
841         return sp_gradient_get_vector (gradient, false);
842     return NULL;
845 SPGradientSpread
846 sp_item_gradient_get_spread (SPItem *item, bool fill_or_stroke)
848     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
850     if (gradient)
851         return sp_gradient_get_spread (gradient);
852     return SP_GRADIENT_SPREAD_PAD;
856 /**
857 Returns the position of point point_num of the gradient applied to item (either fill_or_stroke),
858 in desktop coordinates.
859 */
861 NR::Point
862 sp_item_gradient_get_coords (SPItem *item, guint point_num, bool fill_or_stroke)
864     SPGradient *gradient = sp_item_gradient (item, fill_or_stroke);
866     NR::Point p (0, 0);
868     if (!gradient)
869         return p;
871     if (SP_IS_LINEARGRADIENT(gradient)) {
872         SPLinearGradient *lg = SP_LINEARGRADIENT(gradient);
873         switch (point_num) {
874             case POINT_LG_P1:
875                 p = NR::Point (lg->x1.computed, lg->y1.computed);
876                 break;
877             case POINT_LG_P2:
878                 p = NR::Point (lg->x2.computed, lg->y2.computed);
879                 break;
880         }
881     } else     if (SP_IS_RADIALGRADIENT(gradient)) {
882         SPRadialGradient *rg = SP_RADIALGRADIENT(gradient);
883         switch (point_num) {
884             case POINT_RG_CENTER:
885                 p = NR::Point (rg->cx.computed, rg->cy.computed);
886                 break;
887             case POINT_RG_FOCUS:
888                 p = NR::Point (rg->fx.computed, rg->fy.computed);
889                 break;
890             case POINT_RG_R1:
891                 p = NR::Point (rg->cx.computed + rg->r.computed, rg->cy.computed);
892                 break;
893             case POINT_RG_R2:
894                 p = NR::Point (rg->cx.computed, rg->cy.computed - rg->r.computed);
895                 break;
896         }
897     }
899     if (SP_GRADIENT(gradient)->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
900         sp_document_ensure_up_to_date(SP_OBJECT_DOCUMENT(item));
901         NR::Rect const bbox = item->invokeBbox(NR::identity()); // we need "true" bbox without item_i2d_affine
902         p *= NR::Matrix(bbox.dimensions()[NR::X], 0,
903                         0, bbox.dimensions()[NR::Y],
904                         bbox.min()[NR::X], bbox.min()[NR::Y]);
905     }
906     p *= NR::Matrix(gradient->gradientTransform) * sp_item_i2d_affine(item);
907     return p;
911 /**
912  * Sets item fill or stroke to the gradient of the specified type with given vector, creating
913  * new private gradient, if needed.
914  * gr has to be a normalized vector.
915  */
917 SPGradient *
918 sp_item_set_gradient(SPItem *item, SPGradient *gr, SPGradientType type, bool is_fill)
920     g_return_val_if_fail(item != NULL, NULL);
921     g_return_val_if_fail(SP_IS_ITEM(item), NULL);
922     g_return_val_if_fail(gr != NULL, NULL);
923     g_return_val_if_fail(SP_IS_GRADIENT(gr), NULL);
924     g_return_val_if_fail(gr->state == SP_GRADIENT_STATE_VECTOR, NULL);
926     SPStyle *style = SP_OBJECT_STYLE(item);
927     g_assert(style != NULL);
929     guint style_type = is_fill? style->fill.type : style->stroke.type;
930     SPPaintServer *ps = NULL;
931     if (style_type == SP_PAINT_TYPE_PAINTSERVER)
932         ps = is_fill? SP_STYLE_FILL_SERVER(style) : SP_STYLE_STROKE_SERVER(style);
934     if (ps
935         && ( (type == SP_GRADIENT_TYPE_LINEAR && SP_IS_LINEARGRADIENT(ps)) ||
936              (type == SP_GRADIENT_TYPE_RADIAL && SP_IS_RADIALGRADIENT(ps))   ) )
937     {
939         /* Current fill style is the gradient of the required type */
940         SPGradient *current = SP_GRADIENT(ps);
942         //g_print("hrefcount %d   count %d\n", SP_OBJECT_HREFCOUNT(ig), count_gradient_hrefs(SP_OBJECT(item), ig));
944         if (SP_OBJECT_HREFCOUNT(current) == 1 ||
945             SP_OBJECT_HREFCOUNT(current) == count_gradient_hrefs(SP_OBJECT(item), current)) {
947             // current is private and it's either used once, or all its uses are by children of item;
948             // so just change its href to vector
950             if ( current != gr && sp_gradient_get_vector(current, false) != gr ) {
951                 /* href is not the vector */
952                 sp_gradient_repr_set_link(SP_OBJECT_REPR(current), gr);
953             }
954             SP_OBJECT(item)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
955             return current;
957         } else {
959             // the gradient is not private, or it is shared with someone else;
960             // normalize it (this includes creating new private if necessary)
961             SPGradient *normalized = sp_gradient_fork_private_if_necessary(current, gr, type, item);
963             g_return_val_if_fail(normalized != NULL, NULL);
965             if (normalized != current) {
967                 /* We have to change object style here; recursive because this is used from
968                  * fill&stroke and must work for groups etc. */
969                 sp_item_repr_set_style_gradient(SP_OBJECT_REPR(item), is_fill? "fill" : "stroke", normalized, true);
970             }
971             SP_OBJECT(item)->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
972             return normalized;
973         }
975     } else {
976         /* Current fill style is not a gradient or wrong type, so construct everything */
977         SPGradient *constructed = sp_gradient_get_private_normalized(SP_OBJECT_DOCUMENT(item), gr, type);
978         constructed = sp_gradient_reset_to_userspace(constructed, item);
979         sp_item_repr_set_style_gradient(SP_OBJECT_REPR(item),
980                                         ( is_fill ? "fill" : "stroke" ),
981                                         constructed, true);
982         SP_OBJECT(item)->requestDisplayUpdate(( SP_OBJECT_MODIFIED_FLAG |
983                                                 SP_OBJECT_STYLE_MODIFIED_FLAG ));
984         return constructed;
985     }
988 static void
989 sp_gradient_repr_set_link(Inkscape::XML::Node *repr, SPGradient *link)
991     g_return_if_fail(repr != NULL);
992     g_return_if_fail(link != NULL);
993     g_return_if_fail(SP_IS_GRADIENT(link));
995     gchar *ref;
996     if (link) {
997         gchar const *id = SP_OBJECT_ID(link);
998         size_t const len = strlen(id);
999         ref = (gchar*) alloca(len + 2);
1000         *ref = '#';
1001         memcpy(ref + 1, id, len + 1);
1002     } else {
1003         ref = NULL;
1004     }
1006     repr->setAttribute("xlink:href", ref);
1009 static void
1010 sp_item_repr_set_style_gradient(Inkscape::XML::Node *repr, gchar const *property,
1011                                 SPGradient *gr, bool recursive)
1013     g_return_if_fail(repr != NULL);
1014     g_return_if_fail(gr != NULL);
1015     g_return_if_fail(SP_IS_GRADIENT(gr));
1017     gchar *val = g_strdup_printf("url(#%s)", SP_OBJECT_ID(gr));
1019     SPCSSAttr *css = sp_repr_css_attr_new();
1020     sp_repr_css_set_property(css, property, val);
1021     g_free(val);
1022     if (recursive) {
1023         sp_repr_css_change_recursive(repr, css, "style");
1024     } else {
1025         sp_repr_css_change(repr, css, "style");
1026     }
1027     sp_repr_css_attr_unref(css);
1030 /*
1031  * Get default normalized gradient vector of document, create if there is none
1032  */
1034 SPGradient *
1035 sp_document_default_gradient_vector(SPDocument *document, guint32 color)
1037     SPDefs *defs = (SPDefs *) SP_DOCUMENT_DEFS(document);
1039     Inkscape::XML::Node *repr = sp_repr_new("svg:linearGradient");
1041     repr->setAttribute("inkscape:collect", "always");
1042     // set here, but removed when it's edited in the gradient editor
1043     // to further reduce clutter, we could
1044     // (1) here, search gradients by color and return what is found without duplication
1045     // (2) in fill & stroke, show only one copy of each gradient in list
1047     Inkscape::XML::Node *stop = sp_repr_new("svg:stop");
1049     gchar b[64];
1050     sp_svg_write_color(b, 64, color);
1052     {
1053         gchar *t = g_strdup_printf("stop-color:%s;stop-opacity:1;", b);
1054         stop->setAttribute("style", t);
1055         g_free(t);
1056     }
1058     stop->setAttribute("offset", "0");
1060     repr->appendChild(stop);
1061     Inkscape::GC::release(stop);
1063     stop = sp_repr_new("svg:stop");
1065     {
1066         gchar *t = g_strdup_printf("stop-color:%s;stop-opacity:0;", b);
1067         stop->setAttribute("style", t);
1068         g_free(t);
1069     }
1071     stop->setAttribute("offset", "1");
1073     repr->appendChild(stop);
1074     Inkscape::GC::release(stop);
1076     SP_OBJECT_REPR(defs)->addChild(repr, NULL);
1077     Inkscape::GC::release(repr);
1079     /* fixme: This does not look like nice */
1080     SPGradient *gr;
1081     gr = (SPGradient *) document->getObjectByRepr(repr);
1082     g_assert(gr != NULL);
1083     g_assert(SP_IS_GRADIENT(gr));
1084     /* fixme: Maybe add extra sanity check here */
1085     gr->state = SP_GRADIENT_STATE_VECTOR;
1087     return gr;
1090 /**
1091 Return the preferred vector for \a o, made from (in order of preference) its current vector,
1092 current fill or stroke color, or from desktop style if \a o is NULL or doesn't have style.
1093 */
1094 SPGradient *
1095 sp_gradient_vector_for_object(SPDocument *const doc, SPDesktop *const desktop,
1096                               SPObject *const o, bool const is_fill)
1098     guint32 rgba = 0;
1099     if (o == NULL || SP_OBJECT_STYLE(o) == NULL) {
1100         rgba = sp_desktop_get_color(desktop, is_fill);
1101     } else {
1102         // take the color of the object
1103         SPStyle const &style = *SP_OBJECT_STYLE(o);
1104         SPIPaint const &paint = ( is_fill
1105                                   ? style.fill
1106                                   : style.stroke );
1107         if (paint.type == SP_PAINT_TYPE_COLOR) {
1108             rgba = sp_color_get_rgba32_ualpha(&paint.value.color, 0xff);
1109         } else if (paint.type == SP_PAINT_TYPE_PAINTSERVER) {
1110             SPObject *server = is_fill? SP_OBJECT_STYLE_FILL_SERVER(o) : SP_OBJECT_STYLE_STROKE_SERVER(o);
1111             if (SP_IS_GRADIENT (server)) {
1112                 return sp_gradient_get_vector(SP_GRADIENT (server), TRUE);
1113             } else {
1114                 rgba = sp_desktop_get_color(desktop, is_fill);
1115             }
1116         } else {
1117             // if o doesn't use flat color, then take current color of the desktop.
1118             rgba = sp_desktop_get_color(desktop, is_fill);
1119         }
1120     }
1122     return sp_document_default_gradient_vector(doc, rgba);
1125 /*
1126   Local Variables:
1127   mode:c++
1128   c-file-style:"stroustrup"
1129   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1130   indent-tabs-mode:nil
1131   fill-column:99
1132   End:
1133 */
1134 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :