8fad6074abec95235be7761e9e09915f9352e6bb
1 #define __SP_GRADIENT_C__
3 /** \file
4 * SPGradient, SPStop, SPLinearGradient, SPRadialGradient.
5 */
6 /*
7 * Authors:
8 * Lauris Kaplinski <lauris@kaplinski.com>
9 * bulia byak <buliabyak@users.sf.net>
10 *
11 * Copyright (C) 1999-2002 Lauris Kaplinski
12 * Copyright (C) 2000-2001 Ximian, Inc.
13 * Copyright (C) 2004 David Turner
14 *
15 * Released under GNU GPL, read the file 'COPYING' for more information
16 *
17 */
19 #define noSP_GRADIENT_VERBOSE
22 #include <libnr/nr-matrix-div.h>
23 #include <libnr/nr-matrix-fns.h>
24 #include <libnr/nr-matrix-ops.h>
25 #include <libnr/nr-matrix-scale-ops.h>
26 #include <libnr/nr-matrix-translate-ops.h>
27 #include "libnr/nr-scale-translate-ops.h"
29 #include <sigc++/functors/ptr_fun.h>
30 #include <sigc++/adaptors/bind.h>
32 #include "libnr/nr-gradient.h"
33 #include "svg/svg.h"
34 #include "svg/svg-color.h"
35 #include "svg/css-ostringstream.h"
36 #include "attributes.h"
37 #include "document-private.h"
38 #include "gradient-chemistry.h"
39 #include "sp-gradient-reference.h"
40 #include "sp-linear-gradient.h"
41 #include "sp-radial-gradient.h"
42 #include "sp-stop.h"
43 #include "streq.h"
44 #include "uri.h"
45 #include "xml/repr.h"
47 #define SP_MACROS_SILENT
48 #include "macros.h"
50 /// Has to be power of 2
51 #define NCOLORS NR_GRADIENT_VECTOR_LENGTH
53 static void sp_stop_class_init(SPStopClass *klass);
54 static void sp_stop_init(SPStop *stop);
56 static void sp_stop_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
57 static void sp_stop_set(SPObject *object, unsigned key, gchar const *value);
58 static Inkscape::XML::Node *sp_stop_write(SPObject *object, Inkscape::XML::Node *repr, guint flags);
60 static SPObjectClass *stop_parent_class;
62 /**
63 * Registers SPStop class and returns its type.
64 */
65 GType
66 sp_stop_get_type()
67 {
68 static GType type = 0;
69 if (!type) {
70 GTypeInfo info = {
71 sizeof(SPStopClass),
72 NULL, NULL,
73 (GClassInitFunc) sp_stop_class_init,
74 NULL, NULL,
75 sizeof(SPStop),
76 16,
77 (GInstanceInitFunc) sp_stop_init,
78 NULL, /* value_table */
79 };
80 type = g_type_register_static(SP_TYPE_OBJECT, "SPStop", &info, (GTypeFlags)0);
81 }
82 return type;
83 }
85 /**
86 * Callback to initialize SPStop vtable.
87 */
88 static void sp_stop_class_init(SPStopClass *klass)
89 {
90 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
92 stop_parent_class = (SPObjectClass *) g_type_class_ref(SP_TYPE_OBJECT);
94 sp_object_class->build = sp_stop_build;
95 sp_object_class->set = sp_stop_set;
96 sp_object_class->write = sp_stop_write;
97 }
99 /**
100 * Callback to initialize SPStop object.
101 */
102 static void
103 sp_stop_init(SPStop *stop)
104 {
105 stop->offset = 0.0;
106 stop->currentColor = false;
107 sp_color_set_rgb_rgba32(&stop->specified_color, 0x000000ff);
108 stop->opacity = 1.0;
109 }
111 /**
112 * Virtual build: set stop attributes from its associated XML node.
113 */
114 static void sp_stop_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
115 {
116 if (((SPObjectClass *) stop_parent_class)->build)
117 (* ((SPObjectClass *) stop_parent_class)->build)(object, document, repr);
119 sp_object_read_attr(object, "offset");
120 sp_object_read_attr(object, "stop-color");
121 sp_object_read_attr(object, "stop-opacity");
122 sp_object_read_attr(object, "style");
123 }
125 /**
126 * Virtual set: set attribute to value.
127 */
128 static void
129 sp_stop_set(SPObject *object, unsigned key, gchar const *value)
130 {
131 SPStop *stop = SP_STOP(object);
133 switch (key) {
134 case SP_ATTR_STYLE: {
135 /** \todo
136 * fixme: We are reading simple values 3 times during build (Lauris).
137 * \par
138 * We need presentation attributes etc.
139 * \par
140 * remove the hackish "style reading" from here: see comments in
141 * sp_object_get_style_property about the bugs in our current
142 * approach. However, note that SPStyle doesn't currently have
143 * stop-color and stop-opacity properties.
144 */
145 {
146 gchar const *p = sp_object_get_style_property(object, "stop-color", "black");
147 if (streq(p, "currentColor")) {
148 stop->currentColor = true;
149 } else {
150 guint32 const color = sp_svg_read_color(p, 0);
151 sp_color_set_rgb_rgba32(&stop->specified_color, color);
152 }
153 }
154 {
155 gchar const *p = sp_object_get_style_property(object, "stop-opacity", "1");
156 gdouble opacity = sp_svg_read_percentage(p, stop->opacity);
157 stop->opacity = opacity;
158 }
159 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
160 break;
161 }
162 case SP_PROP_STOP_COLOR: {
163 {
164 gchar const *p = sp_object_get_style_property(object, "stop-color", "black");
165 if (streq(p, "currentColor")) {
166 stop->currentColor = true;
167 } else {
168 stop->currentColor = false;
169 guint32 const color = sp_svg_read_color(p, 0);
170 sp_color_set_rgb_rgba32(&stop->specified_color, color);
171 }
172 }
173 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
174 break;
175 }
176 case SP_PROP_STOP_OPACITY: {
177 {
178 gchar const *p = sp_object_get_style_property(object, "stop-opacity", "1");
179 gdouble opacity = sp_svg_read_percentage(p, stop->opacity);
180 stop->opacity = opacity;
181 }
182 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
183 break;
184 }
185 case SP_ATTR_OFFSET: {
186 stop->offset = sp_svg_read_percentage(value, 0.0);
187 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
188 break;
189 }
190 default: {
191 if (((SPObjectClass *) stop_parent_class)->set)
192 (* ((SPObjectClass *) stop_parent_class)->set)(object, key, value);
193 break;
194 }
195 }
196 }
198 /**
199 * Virtual write: write object attributes to repr.
200 */
201 static Inkscape::XML::Node *
202 sp_stop_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
203 {
204 SPStop *stop = SP_STOP(object);
206 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
207 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_OBJECT_DOCUMENT(object));
208 repr = xml_doc->createElement("svg:stop");
209 }
211 guint32 specifiedcolor = sp_color_get_rgba32_ualpha(&stop->specified_color, 255);
213 if (((SPObjectClass *) stop_parent_class)->write)
214 (* ((SPObjectClass *) stop_parent_class)->write)(object, repr, flags);
216 // Since we do a hackish style setting here (because SPStyle does not support stop-color and
217 // stop-opacity), we must do it AFTER calling the parent write method; otherwise
218 // sp_object_write would clear our style= attribute (bug 1695287)
220 Inkscape::CSSOStringStream os;
221 os << "stop-color:";
222 if (stop->currentColor) {
223 os << "currentColor";
224 } else {
225 gchar c[64];
226 sp_svg_write_color(c, 64, specifiedcolor);
227 os << c;
228 }
229 os << ";stop-opacity:" << stop->opacity;
230 repr->setAttribute("style", os.str().c_str());
231 repr->setAttribute("stop-color", NULL);
232 repr->setAttribute("stop-opacity", NULL);
233 sp_repr_set_css_double(repr, "offset", stop->offset);
234 /* strictly speaking, offset an SVG <number> rather than a CSS one, but exponents make no sense
235 * for offset proportions. */
237 return repr;
238 }
240 /**
241 * Return stop's color as 32bit value.
242 */
243 guint32
244 sp_stop_get_rgba32(SPStop const *const stop)
245 {
246 guint32 rgb0 = 0;
247 /* Default value: arbitrarily black. (SVG1.1 and CSS2 both say that the initial
248 * value depends on user agent, and don't give any further restrictions that I can
249 * see.) */
250 if (stop->currentColor) {
251 char const *str = sp_object_get_style_property(stop, "color", NULL);
252 if (str) {
253 rgb0 = sp_svg_read_color(str, rgb0);
254 }
255 unsigned const alpha = static_cast<unsigned>(stop->opacity * 0xff + 0.5);
256 g_return_val_if_fail((alpha & ~0xff) == 0,
257 rgb0 | 0xff);
258 return rgb0 | alpha;
259 } else {
260 return sp_color_get_rgba32_falpha(&stop->specified_color, stop->opacity);
261 }
262 }
264 /**
265 * Return stop's color as SPColor.
266 */
267 static SPColor
268 sp_stop_get_color(SPStop const *const stop)
269 {
270 if (stop->currentColor) {
271 char const *str = sp_object_get_style_property(stop, "color", NULL);
272 guint32 const dfl = 0;
273 /* Default value: arbitrarily black. (SVG1.1 and CSS2 both say that the initial
274 * value depends on user agent, and don't give any further restrictions that I can
275 * see.) */
276 guint32 color = dfl;
277 if (str) {
278 color = sp_svg_read_color(str, dfl);
279 }
280 SPColor ret;
281 sp_color_set_rgb_rgba32(&ret, color);
282 return ret;
283 } else {
284 return stop->specified_color;
285 }
286 }
288 /*
289 * Gradient
290 */
292 static void sp_gradient_class_init(SPGradientClass *klass);
293 static void sp_gradient_init(SPGradient *gr);
295 static void sp_gradient_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
296 static void sp_gradient_release(SPObject *object);
297 static void sp_gradient_set(SPObject *object, unsigned key, gchar const *value);
298 static void sp_gradient_child_added(SPObject *object,
299 Inkscape::XML::Node *child,
300 Inkscape::XML::Node *ref);
301 static void sp_gradient_remove_child(SPObject *object, Inkscape::XML::Node *child);
302 static void sp_gradient_modified(SPObject *object, guint flags);
303 static Inkscape::XML::Node *sp_gradient_write(SPObject *object, Inkscape::XML::Node *repr,
304 guint flags);
306 static void gradient_ref_modified(SPObject *href, guint flags, SPGradient *gradient);
308 static bool sp_gradient_invalidate_vector(SPGradient *gr);
309 static void sp_gradient_rebuild_vector(SPGradient *gr);
311 static void gradient_ref_changed(SPObject *old_ref, SPObject *ref, SPGradient *gradient);
313 SPGradientSpread sp_gradient_get_spread(SPGradient *gradient);
314 SPGradientUnits sp_gradient_get_units(SPGradient *gradient);
316 static SPPaintServerClass *gradient_parent_class;
318 /**
319 * Registers SPGradient class and returns its type.
320 */
321 GType
322 sp_gradient_get_type()
323 {
324 static GType gradient_type = 0;
325 if (!gradient_type) {
326 GTypeInfo gradient_info = {
327 sizeof(SPGradientClass),
328 NULL, NULL,
329 (GClassInitFunc) sp_gradient_class_init,
330 NULL, NULL,
331 sizeof(SPGradient),
332 16,
333 (GInstanceInitFunc) sp_gradient_init,
334 NULL, /* value_table */
335 };
336 gradient_type = g_type_register_static(SP_TYPE_PAINT_SERVER, "SPGradient",
337 &gradient_info, (GTypeFlags)0);
338 }
339 return gradient_type;
340 }
342 /**
343 * SPGradient vtable initialization.
344 */
345 static void
346 sp_gradient_class_init(SPGradientClass *klass)
347 {
348 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
350 gradient_parent_class = (SPPaintServerClass *)g_type_class_ref(SP_TYPE_PAINT_SERVER);
352 sp_object_class->build = sp_gradient_build;
353 sp_object_class->release = sp_gradient_release;
354 sp_object_class->set = sp_gradient_set;
355 sp_object_class->child_added = sp_gradient_child_added;
356 sp_object_class->remove_child = sp_gradient_remove_child;
357 sp_object_class->modified = sp_gradient_modified;
358 sp_object_class->write = sp_gradient_write;
359 }
361 /**
362 * Callback for SPGradient object initialization.
363 */
364 static void
365 sp_gradient_init(SPGradient *gr)
366 {
367 gr->ref = new SPGradientReference(SP_OBJECT(gr));
368 gr->ref->changedSignal().connect(sigc::bind(sigc::ptr_fun(gradient_ref_changed), gr));
370 /** \todo
371 * Fixme: reprs being rearranged (e.g. via the XML editor)
372 * may require us to clear the state.
373 */
374 gr->state = SP_GRADIENT_STATE_UNKNOWN;
376 gr->units = SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX;
377 gr->units_set = FALSE;
379 gr->gradientTransform = NR::identity();
380 gr->gradientTransform_set = FALSE;
382 gr->spread = SP_GRADIENT_SPREAD_PAD;
383 gr->spread_set = FALSE;
385 gr->has_stops = FALSE;
387 gr->vector.built = false;
388 gr->vector.stops.clear();
390 gr->color = NULL;
392 new (&gr->modified_connection) sigc::connection();
393 }
395 /**
396 * Virtual build: set gradient attributes from its associated repr.
397 */
398 static void
399 sp_gradient_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
400 {
401 SPGradient *gradient = SP_GRADIENT(object);
403 if (((SPObjectClass *) gradient_parent_class)->build)
404 (* ((SPObjectClass *) gradient_parent_class)->build)(object, document, repr);
406 SPObject *ochild;
407 for ( ochild = sp_object_first_child(object) ; ochild ; ochild = SP_OBJECT_NEXT(ochild) ) {
408 if (SP_IS_STOP(ochild)) {
409 gradient->has_stops = TRUE;
410 break;
411 }
412 }
414 sp_object_read_attr(object, "gradientUnits");
415 sp_object_read_attr(object, "gradientTransform");
416 sp_object_read_attr(object, "spreadMethod");
417 sp_object_read_attr(object, "xlink:href");
419 /* Register ourselves */
420 sp_document_add_resource(document, "gradient", object);
421 }
423 /**
424 * Virtual release of SPGradient members before destruction.
425 */
426 static void
427 sp_gradient_release(SPObject *object)
428 {
429 SPGradient *gradient = (SPGradient *) object;
431 #ifdef SP_GRADIENT_VERBOSE
432 g_print("Releasing gradient %s\n", SP_OBJECT_ID(object));
433 #endif
435 if (SP_OBJECT_DOCUMENT(object)) {
436 /* Unregister ourselves */
437 sp_document_remove_resource(SP_OBJECT_DOCUMENT(object), "gradient", SP_OBJECT(object));
438 }
440 if (gradient->ref) {
441 gradient->modified_connection.disconnect();
442 gradient->ref->detach();
443 delete gradient->ref;
444 gradient->ref = NULL;
445 }
447 if (gradient->color) {
448 g_free(gradient->color);
449 gradient->color = NULL;
450 }
452 gradient->modified_connection.~connection();
454 if (((SPObjectClass *) gradient_parent_class)->release)
455 ((SPObjectClass *) gradient_parent_class)->release(object);
456 }
458 /**
459 * Set gradient attribute to value.
460 */
461 static void
462 sp_gradient_set(SPObject *object, unsigned key, gchar const *value)
463 {
464 SPGradient *gr = SP_GRADIENT(object);
466 switch (key) {
467 case SP_ATTR_GRADIENTUNITS:
468 if (value) {
469 if (!strcmp(value, "userSpaceOnUse")) {
470 gr->units = SP_GRADIENT_UNITS_USERSPACEONUSE;
471 } else {
472 gr->units = SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX;
473 }
474 gr->units_set = TRUE;
475 } else {
476 gr->units = SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX;
477 gr->units_set = FALSE;
478 }
479 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
480 break;
481 case SP_ATTR_GRADIENTTRANSFORM: {
482 NR::Matrix t;
483 if (value && sp_svg_transform_read(value, &t)) {
484 gr->gradientTransform = t;
485 gr->gradientTransform_set = TRUE;
486 } else {
487 gr->gradientTransform = NR::identity();
488 gr->gradientTransform_set = FALSE;
489 }
490 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
491 break;
492 }
493 case SP_ATTR_SPREADMETHOD:
494 if (value) {
495 if (!strcmp(value, "reflect")) {
496 gr->spread = SP_GRADIENT_SPREAD_REFLECT;
497 } else if (!strcmp(value, "repeat")) {
498 gr->spread = SP_GRADIENT_SPREAD_REPEAT;
499 } else {
500 gr->spread = SP_GRADIENT_SPREAD_PAD;
501 }
502 gr->spread_set = TRUE;
503 } else {
504 gr->spread_set = FALSE;
505 }
506 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
507 break;
508 case SP_ATTR_XLINK_HREF:
509 if (value) {
510 try {
511 gr->ref->attach(Inkscape::URI(value));
512 } catch (Inkscape::BadURIException &e) {
513 g_warning("%s", e.what());
514 gr->ref->detach();
515 }
516 } else {
517 gr->ref->detach();
518 }
519 break;
520 default:
521 if (((SPObjectClass *) gradient_parent_class)->set)
522 ((SPObjectClass *) gradient_parent_class)->set(object, key, value);
523 break;
524 }
525 }
527 /**
528 * Gets called when the gradient is (re)attached to another gradient.
529 */
530 static void
531 gradient_ref_changed(SPObject *old_ref, SPObject *ref, SPGradient *gr)
532 {
533 if (old_ref) {
534 gr->modified_connection.disconnect();
535 }
536 if ( SP_IS_GRADIENT(ref)
537 && ref != gr )
538 {
539 gr->modified_connection = ref->connectModified(sigc::bind<2>(sigc::ptr_fun(&gradient_ref_modified), gr));
540 }
542 // Per SVG, all unset attributes must be inherited from linked gradient.
543 // So, as we're now (re)linked, we assign linkee's values to this gradient if they are not yet set -
544 // but without setting the _set flags.
545 // FIXME: do the same for gradientTransform too
546 if (!gr->units_set)
547 gr->units = sp_gradient_get_units (gr);
548 if (!gr->spread_set)
549 gr->spread = sp_gradient_get_spread (gr);
551 /// \todo Fixme: what should the flags (second) argument be? */
552 gradient_ref_modified(ref, 0, gr);
553 }
555 /**
556 * Callback for child_added event.
557 */
558 static void
559 sp_gradient_child_added(SPObject *object, Inkscape::XML::Node *child, Inkscape::XML::Node *ref)
560 {
561 SPGradient *gr = SP_GRADIENT(object);
563 sp_gradient_invalidate_vector(gr);
565 if (((SPObjectClass *) gradient_parent_class)->child_added)
566 (* ((SPObjectClass *) gradient_parent_class)->child_added)(object, child, ref);
568 SPObject *ochild = sp_object_get_child_by_repr(object, child);
569 if ( ochild && SP_IS_STOP(ochild) ) {
570 gr->has_stops = TRUE;
571 }
573 /// \todo Fixme: should we schedule "modified" here?
574 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
575 }
577 /**
578 * Callback for remove_child event.
579 */
580 static void
581 sp_gradient_remove_child(SPObject *object, Inkscape::XML::Node *child)
582 {
583 SPGradient *gr = SP_GRADIENT(object);
585 sp_gradient_invalidate_vector(gr);
587 if (((SPObjectClass *) gradient_parent_class)->remove_child)
588 (* ((SPObjectClass *) gradient_parent_class)->remove_child)(object, child);
590 gr->has_stops = FALSE;
591 SPObject *ochild;
592 for ( ochild = sp_object_first_child(object) ; ochild ; ochild = SP_OBJECT_NEXT(ochild) ) {
593 if (SP_IS_STOP(ochild)) {
594 gr->has_stops = TRUE;
595 break;
596 }
597 }
599 /* Fixme: should we schedule "modified" here? */
600 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
601 }
603 /**
604 * Callback for modified event.
605 */
606 static void
607 sp_gradient_modified(SPObject *object, guint flags)
608 {
609 SPGradient *gr = SP_GRADIENT(object);
611 if (flags & SP_OBJECT_CHILD_MODIFIED_FLAG) {
612 sp_gradient_invalidate_vector(gr);
613 }
615 if (flags & SP_OBJECT_STYLE_MODIFIED_FLAG) {
616 sp_gradient_ensure_colors(gr);
617 }
619 if (flags & SP_OBJECT_MODIFIED_FLAG) flags |= SP_OBJECT_PARENT_MODIFIED_FLAG;
620 flags &= SP_OBJECT_MODIFIED_CASCADE;
622 // FIXME: climb up the ladder of hrefs
623 GSList *l = NULL;
624 for (SPObject *child = sp_object_first_child(object) ; child != NULL; child = SP_OBJECT_NEXT(child) ) {
625 g_object_ref(G_OBJECT(child));
626 l = g_slist_prepend(l, child);
627 }
628 l = g_slist_reverse(l);
629 while (l) {
630 SPObject *child = SP_OBJECT(l->data);
631 l = g_slist_remove(l, child);
632 if (flags || (child->mflags & (SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_CHILD_MODIFIED_FLAG))) {
633 child->emitModified(flags);
634 }
635 g_object_unref(G_OBJECT(child));
636 }
637 }
639 /**
640 * Write gradient attributes to repr.
641 */
642 static Inkscape::XML::Node *
643 sp_gradient_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
644 {
645 SPGradient *gr = SP_GRADIENT(object);
647 if (((SPObjectClass *) gradient_parent_class)->write)
648 (* ((SPObjectClass *) gradient_parent_class)->write)(object, repr, flags);
650 if (flags & SP_OBJECT_WRITE_BUILD) {
651 GSList *l = NULL;
652 for (SPObject *child = sp_object_first_child(object); child; child = SP_OBJECT_NEXT(child)) {
653 Inkscape::XML::Node *crepr;
654 crepr = child->updateRepr(NULL, flags);
655 if (crepr) l = g_slist_prepend(l, crepr);
656 }
657 while (l) {
658 repr->addChild((Inkscape::XML::Node *) l->data, NULL);
659 Inkscape::GC::release((Inkscape::XML::Node *) l->data);
660 l = g_slist_remove(l, l->data);
661 }
662 }
664 if (gr->ref->getURI()) {
665 gchar *uri_string = gr->ref->getURI()->toString();
666 repr->setAttribute("xlink:href", uri_string);
667 g_free(uri_string);
668 }
670 if ((flags & SP_OBJECT_WRITE_ALL) || gr->units_set) {
671 switch (gr->units) {
672 case SP_GRADIENT_UNITS_USERSPACEONUSE:
673 repr->setAttribute("gradientUnits", "userSpaceOnUse");
674 break;
675 default:
676 repr->setAttribute("gradientUnits", "objectBoundingBox");
677 break;
678 }
679 }
681 if ((flags & SP_OBJECT_WRITE_ALL) || gr->gradientTransform_set) {
682 gchar *c=sp_svg_transform_write(gr->gradientTransform);
683 repr->setAttribute("gradientTransform", c);
684 g_free(c);
685 }
687 if ((flags & SP_OBJECT_WRITE_ALL) || gr->spread_set) {
688 /* FIXME: Ensure that gr->spread is the inherited value
689 * if !gr->spread_set. Not currently happening: see sp_gradient_modified.
690 */
691 switch (gr->spread) {
692 case SP_GRADIENT_SPREAD_REFLECT:
693 repr->setAttribute("spreadMethod", "reflect");
694 break;
695 case SP_GRADIENT_SPREAD_REPEAT:
696 repr->setAttribute("spreadMethod", "repeat");
697 break;
698 default:
699 repr->setAttribute("spreadMethod", "pad");
700 break;
701 }
702 }
704 return repr;
705 }
707 /**
708 * Forces the vector to be built, if not present (i.e., changed).
709 *
710 * \pre SP_IS_GRADIENT(gradient).
711 */
712 void
713 sp_gradient_ensure_vector(SPGradient *gradient)
714 {
715 g_return_if_fail(gradient != NULL);
716 g_return_if_fail(SP_IS_GRADIENT(gradient));
718 if (!gradient->vector.built) {
719 sp_gradient_rebuild_vector(gradient);
720 }
721 }
723 /**
724 * Set units property of gradient and emit modified.
725 */
726 void
727 sp_gradient_set_units(SPGradient *gr, SPGradientUnits units)
728 {
729 if (units != gr->units) {
730 gr->units = units;
731 gr->units_set = TRUE;
732 SP_OBJECT(gr)->requestModified(SP_OBJECT_MODIFIED_FLAG);
733 }
734 }
736 /**
737 * Set spread property of gradient and emit modified.
738 */
739 void
740 sp_gradient_set_spread(SPGradient *gr, SPGradientSpread spread)
741 {
742 if (spread != gr->spread) {
743 gr->spread = spread;
744 gr->spread_set = TRUE;
745 SP_OBJECT(gr)->requestModified(SP_OBJECT_MODIFIED_FLAG);
746 }
747 }
749 /**
750 * Returns the first of {src, src-\>ref-\>getObject(),
751 * src-\>ref-\>getObject()-\>ref-\>getObject(),...}
752 * for which \a match is true, or NULL if none found.
753 *
754 * The raison d'être of this routine is that it correctly handles cycles in the href chain (e.g., if
755 * a gradient gives itself as its href, or if each of two gradients gives the other as its href).
756 *
757 * \pre SP_IS_GRADIENT(src).
758 */
759 static SPGradient *
760 chase_hrefs(SPGradient *const src, bool (*match)(SPGradient const *))
761 {
762 g_return_val_if_fail(SP_IS_GRADIENT(src), NULL);
764 /* Use a pair of pointers for detecting loops: p1 advances half as fast as p2. If there is a
765 loop, then once p1 has entered the loop, we'll detect it the next time the distance between
766 p1 and p2 is a multiple of the loop size. */
767 SPGradient *p1 = src, *p2 = src;
768 bool do1 = false;
769 for (;;) {
770 if (match(p2)) {
771 return p2;
772 }
774 p2 = p2->ref->getObject();
775 if (!p2) {
776 return p2;
777 }
778 if (do1) {
779 p1 = p1->ref->getObject();
780 }
781 do1 = !do1;
783 if ( p2 == p1 ) {
784 /* We've been here before, so return NULL to indicate that no matching gradient found
785 * in the chain. */
786 return NULL;
787 }
788 }
789 }
791 /**
792 * True if gradient has stops.
793 */
794 static bool
795 has_stops(SPGradient const *gr)
796 {
797 return SP_GRADIENT_HAS_STOPS(gr);
798 }
800 /**
801 * True if gradient has spread set.
802 */
803 static bool
804 has_spread_set(SPGradient const *gr)
805 {
806 return gr->spread_set;
807 }
809 /**
810 * True if gradient has units set.
811 */
812 static bool
813 has_units_set(SPGradient const *gr)
814 {
815 return gr->units_set;
816 }
819 /**
820 * Returns private vector of given gradient (the gradient at the end of the href chain which has
821 * stops), optionally normalizing it.
822 *
823 * \pre SP_IS_GRADIENT(gradient).
824 * \pre There exists a gradient in the chain that has stops.
825 */
826 SPGradient *
827 sp_gradient_get_vector(SPGradient *gradient, bool force_vector)
828 {
829 g_return_val_if_fail(gradient != NULL, NULL);
830 g_return_val_if_fail(SP_IS_GRADIENT(gradient), NULL);
832 SPGradient *const src = chase_hrefs(gradient, has_stops);
833 return ( force_vector
834 ? sp_gradient_ensure_vector_normalized(src)
835 : src );
836 }
838 /**
839 * Returns the effective spread of given gradient (climbing up the refs chain if needed).
840 *
841 * \pre SP_IS_GRADIENT(gradient).
842 */
843 SPGradientSpread
844 sp_gradient_get_spread(SPGradient *gradient)
845 {
846 g_return_val_if_fail(SP_IS_GRADIENT(gradient), SP_GRADIENT_SPREAD_PAD);
848 SPGradient const *src = chase_hrefs(gradient, has_spread_set);
849 return ( src
850 ? src->spread
851 : SP_GRADIENT_SPREAD_PAD ); // pad is the default
852 }
854 /**
855 * Returns the effective units of given gradient (climbing up the refs chain if needed).
856 *
857 * \pre SP_IS_GRADIENT(gradient).
858 */
859 SPGradientUnits
860 sp_gradient_get_units(SPGradient *gradient)
861 {
862 g_return_val_if_fail(SP_IS_GRADIENT(gradient), SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX);
864 SPGradient const *src = chase_hrefs(gradient, has_units_set);
865 return ( src
866 ? src->units
867 : SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX ); // bbox is the default
868 }
871 /**
872 * Clears the gradient's svg:stop children from its repr.
873 */
874 void
875 sp_gradient_repr_clear_vector(SPGradient *gr)
876 {
877 Inkscape::XML::Node *repr = SP_OBJECT_REPR(gr);
879 /* Collect stops from original repr */
880 GSList *sl = NULL;
881 for (Inkscape::XML::Node *child = repr->firstChild() ; child != NULL; child = child->next() ) {
882 if (!strcmp(child->name(), "svg:stop")) {
883 sl = g_slist_prepend(sl, child);
884 }
885 }
886 /* Remove all stops */
887 while (sl) {
888 /** \todo
889 * fixme: This should work, unless we make gradient
890 * into generic group.
891 */
892 sp_repr_unparent((Inkscape::XML::Node *)sl->data);
893 sl = g_slist_remove(sl, sl->data);
894 }
895 }
897 /**
898 * Writes the gradient's internal vector (whether from its own stops, or
899 * inherited from refs) into the gradient repr as svg:stop elements.
900 */
901 void
902 sp_gradient_repr_write_vector(SPGradient *gr)
903 {
904 g_return_if_fail(gr != NULL);
905 g_return_if_fail(SP_IS_GRADIENT(gr));
907 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_OBJECT_DOCUMENT(gr));
908 Inkscape::XML::Node *repr = SP_OBJECT_REPR(gr);
910 /* We have to be careful, as vector may be our own, so construct repr list at first */
911 GSList *cl = NULL;
913 for (guint i = 0; i < gr->vector.stops.size(); i++) {
914 Inkscape::CSSOStringStream os;
915 Inkscape::XML::Node *child = xml_doc->createElement("svg:stop");
916 sp_repr_set_css_double(child, "offset", gr->vector.stops[i].offset);
917 /* strictly speaking, offset an SVG <number> rather than a CSS one, but exponents make no
918 * sense for offset proportions. */
919 gchar c[64];
920 sp_svg_write_color(c, 64, sp_color_get_rgba32_ualpha(&gr->vector.stops[i].color, 0x00));
921 os << "stop-color:" << c << ";stop-opacity:" << gr->vector.stops[i].opacity;
922 child->setAttribute("style", os.str().c_str());
923 /* Order will be reversed here */
924 cl = g_slist_prepend(cl, child);
925 }
927 sp_gradient_repr_clear_vector(gr);
929 /* And insert new children from list */
930 while (cl) {
931 Inkscape::XML::Node *child = static_cast<Inkscape::XML::Node *>(cl->data);
932 repr->addChild(child, NULL);
933 Inkscape::GC::release(child);
934 cl = g_slist_remove(cl, child);
935 }
936 }
939 static void
940 gradient_ref_modified(SPObject *href, guint flags, SPGradient *gradient)
941 {
942 if (sp_gradient_invalidate_vector(gradient)) {
943 SP_OBJECT(gradient)->requestModified(SP_OBJECT_MODIFIED_FLAG);
944 /* Conditional to avoid causing infinite loop if there's a cycle in the href chain. */
945 }
946 }
948 /** Return true iff change made. */
949 static bool
950 sp_gradient_invalidate_vector(SPGradient *gr)
951 {
952 bool ret = false;
954 if (gr->color != NULL) {
955 g_free(gr->color);
956 gr->color = NULL;
957 ret = true;
958 }
960 if (gr->vector.built) {
961 gr->vector.built = false;
962 gr->vector.stops.clear();
963 ret = true;
964 }
966 return ret;
967 }
969 /** Creates normalized color vector */
970 static void
971 sp_gradient_rebuild_vector(SPGradient *gr)
972 {
973 gint len = 0;
974 for ( SPObject *child = sp_object_first_child(SP_OBJECT(gr)) ;
975 child != NULL ;
976 child = SP_OBJECT_NEXT(child) ) {
977 if (SP_IS_STOP(child)) {
978 len ++;
979 }
980 }
982 gr->has_stops = (len != 0);
984 gr->vector.stops.clear();
986 SPGradient *ref = gr->ref->getObject();
987 if ( !gr->has_stops && ref ) {
988 /* Copy vector from referenced gradient */
989 gr->vector.built = true; // Prevent infinite recursion.
990 sp_gradient_ensure_vector(ref);
991 if (!ref->vector.stops.empty()) {
992 gr->vector.built = ref->vector.built;
993 gr->vector.stops.assign(ref->vector.stops.begin(), ref->vector.stops.end());
994 return;
995 }
996 }
998 for (SPObject *child = sp_object_first_child(SP_OBJECT(gr)) ;
999 child != NULL;
1000 child = SP_OBJECT_NEXT(child) ) {
1001 if (SP_IS_STOP(child)) {
1002 SPStop *stop = SP_STOP(child);
1004 SPGradientStop gstop;
1005 if (gr->vector.stops.size() > 0) {
1006 // "Each gradient offset value is required to be equal to or greater than the
1007 // previous gradient stop's offset value. If a given gradient stop's offset
1008 // value is not equal to or greater than all previous offset values, then the
1009 // offset value is adjusted to be equal to the largest of all previous offset
1010 // values."
1011 gstop.offset = MAX(stop->offset, gr->vector.stops.back().offset);
1012 } else {
1013 gstop.offset = stop->offset;
1014 }
1016 // "Gradient offset values less than 0 (or less than 0%) are rounded up to
1017 // 0%. Gradient offset values greater than 1 (or greater than 100%) are rounded
1018 // down to 100%."
1019 gstop.offset = CLAMP(gstop.offset, 0, 1);
1021 gstop.color = sp_stop_get_color(stop);
1022 gstop.opacity = stop->opacity;
1024 gr->vector.stops.push_back(gstop);
1025 }
1026 }
1028 // Normalize per section 13.2.4 of SVG 1.1.
1029 if (gr->vector.stops.size() == 0) {
1030 /* "If no stops are defined, then painting shall occur as if 'none' were specified as the
1031 * paint style."
1032 */
1033 {
1034 SPGradientStop gstop;
1035 gstop.offset = 0.0;
1036 sp_color_set_rgb_rgba32(&gstop.color, 0x00000000);
1037 gstop.opacity = 0.0;
1038 gr->vector.stops.push_back(gstop);
1039 }
1040 {
1041 SPGradientStop gstop;
1042 gstop.offset = 1.0;
1043 sp_color_set_rgb_rgba32(&gstop.color, 0x00000000);
1044 gstop.opacity = 0.0;
1045 gr->vector.stops.push_back(gstop);
1046 }
1047 } else {
1048 /* "If one stop is defined, then paint with the solid color fill using the color defined
1049 * for that gradient stop."
1050 */
1051 if (gr->vector.stops.front().offset > 0.0) {
1052 // If the first one is not at 0, then insert a copy of the first at 0.
1053 SPGradientStop gstop;
1054 gstop.offset = 0.0;
1055 sp_color_copy(&gstop.color, &gr->vector.stops.front().color);
1056 gstop.opacity = gr->vector.stops.front().opacity;
1057 gr->vector.stops.insert(gr->vector.stops.begin(), gstop);
1058 }
1059 if (gr->vector.stops.back().offset < 1.0) {
1060 // If the last one is not at 1, then insert a copy of the last at 1.
1061 SPGradientStop gstop;
1062 gstop.offset = 1.0;
1063 sp_color_copy(&gstop.color, &gr->vector.stops.back().color);
1064 gstop.opacity = gr->vector.stops.back().opacity;
1065 gr->vector.stops.push_back(gstop);
1066 }
1067 }
1069 gr->vector.built = true;
1070 }
1072 /**
1073 * The gradient's color array is newly created and set up from vector.
1074 */
1075 void
1076 sp_gradient_ensure_colors(SPGradient *gr)
1077 {
1078 if (!gr->vector.built) {
1079 sp_gradient_rebuild_vector(gr);
1080 }
1081 g_return_if_fail(!gr->vector.stops.empty());
1083 /// \todo Where is the memory freed?
1084 if (!gr->color) {
1085 gr->color = g_new(guchar, 4 * NCOLORS);
1086 }
1088 for (guint i = 0; i < gr->vector.stops.size() - 1; i++) {
1089 guint32 color = sp_color_get_rgba32_falpha(&gr->vector.stops[i].color,
1090 gr->vector.stops[i].opacity);
1091 gint r0 = (color >> 24) & 0xff;
1092 gint g0 = (color >> 16) & 0xff;
1093 gint b0 = (color >> 8) & 0xff;
1094 gint a0 = color & 0xff;
1095 color = sp_color_get_rgba32_falpha(&gr->vector.stops[i + 1].color,
1096 gr->vector.stops[i + 1].opacity);
1097 gint r1 = (color >> 24) & 0xff;
1098 gint g1 = (color >> 16) & 0xff;
1099 gint b1 = (color >> 8) & 0xff;
1100 gint a1 = color & 0xff;
1101 gint o0 = (gint) floor(gr->vector.stops[i].offset * (NCOLORS - 0.001));
1102 gint o1 = (gint) floor(gr->vector.stops[i + 1].offset * (NCOLORS - 0.001));
1103 if (o1 > o0) {
1104 gint dr = ((r1 - r0) << 16) / (o1 - o0);
1105 gint dg = ((g1 - g0) << 16) / (o1 - o0);
1106 gint db = ((b1 - b0) << 16) / (o1 - o0);
1107 gint da = ((a1 - a0) << 16) / (o1 - o0);
1108 gint r = r0 << 16;
1109 gint g = g0 << 16;
1110 gint b = b0 << 16;
1111 gint a = a0 << 16;
1112 for (int j = o0; j < o1 + 1; j++) {
1113 gr->color[4 * j] = r >> 16;
1114 gr->color[4 * j + 1] = g >> 16;
1115 gr->color[4 * j + 2] = b >> 16;
1116 gr->color[4 * j + 3] = a >> 16;
1117 r += dr;
1118 g += dg;
1119 b += db;
1120 a += da;
1121 }
1122 }
1123 }
1124 }
1126 /**
1127 * Renders gradient vector to buffer as line.
1128 *
1129 * RGB buffer background should be set up beforehand.
1130 *
1131 * @param len,width,height,rowstride Buffer parameters (1 or 2 dimensional).
1132 * @param span Full integer width of requested gradient.
1133 * @param pos Buffer starting position in span.
1134 */
1135 static void
1136 sp_gradient_render_vector_line_rgba(SPGradient *const gradient, guchar *buf,
1137 gint const len, gint const pos, gint const span)
1138 {
1139 g_return_if_fail(gradient != NULL);
1140 g_return_if_fail(SP_IS_GRADIENT(gradient));
1141 g_return_if_fail(buf != NULL);
1142 g_return_if_fail(len > 0);
1143 g_return_if_fail(pos >= 0);
1144 g_return_if_fail(pos + len <= span);
1145 g_return_if_fail(span > 0);
1147 if (!gradient->color) {
1148 sp_gradient_ensure_colors(gradient);
1149 }
1151 gint idx = (pos * 1024 << 8) / span;
1152 gint didx = (1024 << 8) / span;
1154 for (gint x = 0; x < len; x++) {
1155 /// \todo Can this be done with 4 byte copies?
1156 *buf++ = gradient->color[4 * (idx >> 8)];
1157 *buf++ = gradient->color[4 * (idx >> 8) + 1];
1158 *buf++ = gradient->color[4 * (idx >> 8) + 2];
1159 *buf++ = gradient->color[4 * (idx >> 8) + 3];
1160 idx += didx;
1161 }
1162 }
1164 /**
1165 * Render rectangular RGBA area from gradient vector.
1166 */
1167 void
1168 sp_gradient_render_vector_block_rgba(SPGradient *const gradient, guchar *buf,
1169 gint const width, gint const height, gint const rowstride,
1170 gint const pos, gint const span, bool const horizontal)
1171 {
1172 g_return_if_fail(gradient != NULL);
1173 g_return_if_fail(SP_IS_GRADIENT(gradient));
1174 g_return_if_fail(buf != NULL);
1175 g_return_if_fail(width > 0);
1176 g_return_if_fail(height > 0);
1177 g_return_if_fail(pos >= 0);
1178 g_return_if_fail((horizontal && (pos + width <= span)) || (!horizontal && (pos + height <= span)));
1179 g_return_if_fail(span > 0);
1181 if (horizontal) {
1182 sp_gradient_render_vector_line_rgba(gradient, buf, width, pos, span);
1183 for (gint y = 1; y < height; y++) {
1184 memcpy(buf + y * rowstride, buf, 4 * width);
1185 }
1186 } else {
1187 guchar *tmp = (guchar *)alloca(4 * height);
1188 sp_gradient_render_vector_line_rgba(gradient, tmp, height, pos, span);
1189 for (gint y = 0; y < height; y++) {
1190 guchar *b = buf + y * rowstride;
1191 for (gint x = 0; x < width; x++) {
1192 *b++ = tmp[0];
1193 *b++ = tmp[1];
1194 *b++ = tmp[2];
1195 *b++ = tmp[3];
1196 }
1197 tmp += 4;
1198 }
1199 }
1200 }
1202 /**
1203 * Render rectangular RGB area from gradient vector.
1204 */
1205 void
1206 sp_gradient_render_vector_block_rgb(SPGradient *gradient, guchar *buf,
1207 gint const width, gint const height, gint const rowstride,
1208 gint const pos, gint const span, bool const horizontal)
1209 {
1210 g_return_if_fail(gradient != NULL);
1211 g_return_if_fail(SP_IS_GRADIENT(gradient));
1212 g_return_if_fail(buf != NULL);
1213 g_return_if_fail(width > 0);
1214 g_return_if_fail(height > 0);
1215 g_return_if_fail(pos >= 0);
1216 g_return_if_fail((horizontal && (pos + width <= span)) || (!horizontal && (pos + height <= span)));
1217 g_return_if_fail(span > 0);
1219 if (horizontal) {
1220 guchar *tmp = (guchar*)alloca(4 * width);
1221 sp_gradient_render_vector_line_rgba(gradient, tmp, width, pos, span);
1222 for (gint y = 0; y < height; y++) {
1223 guchar *t = tmp;
1224 for (gint x = 0; x < width; x++) {
1225 gint a = t[3];
1226 gint fc = (t[0] - buf[0]) * a;
1227 buf[0] = buf[0] + ((fc + (fc >> 8) + 0x80) >> 8);
1228 fc = (t[1] - buf[1]) * a;
1229 buf[1] = buf[1] + ((fc + (fc >> 8) + 0x80) >> 8);
1230 fc = (t[2] - buf[2]) * a;
1231 buf[2] = buf[2] + ((fc + (fc >> 8) + 0x80) >> 8);
1232 buf += 3;
1233 t += 4;
1234 }
1235 }
1236 } else {
1237 guchar *tmp = (guchar*)alloca(4 * height);
1238 sp_gradient_render_vector_line_rgba(gradient, tmp, height, pos, span);
1239 for (gint y = 0; y < height; y++) {
1240 guchar *t = tmp + 4 * y;
1241 for (gint x = 0; x < width; x++) {
1242 gint a = t[3];
1243 gint fc = (t[0] - buf[0]) * a;
1244 buf[0] = buf[0] + ((fc + (fc >> 8) + 0x80) >> 8);
1245 fc = (t[1] - buf[1]) * a;
1246 buf[1] = buf[1] + ((fc + (fc >> 8) + 0x80) >> 8);
1247 fc = (t[2] - buf[2]) * a;
1248 buf[2] = buf[2] + ((fc + (fc >> 8) + 0x80) >> 8);
1249 }
1250 }
1251 }
1252 }
1254 NR::Matrix
1255 sp_gradient_get_g2d_matrix(SPGradient const *gr, NR::Matrix const &ctm, NR::Rect const &bbox)
1256 {
1257 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1258 return ( NR::scale(bbox.dimensions())
1259 * NR::translate(bbox.min())
1260 * ctm );
1261 } else {
1262 return ctm;
1263 }
1264 }
1266 NR::Matrix
1267 sp_gradient_get_gs2d_matrix(SPGradient const *gr, NR::Matrix const &ctm, NR::Rect const &bbox)
1268 {
1269 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1270 return ( gr->gradientTransform
1271 * NR::scale(bbox.dimensions())
1272 * NR::translate(bbox.min())
1273 * ctm );
1274 } else {
1275 return gr->gradientTransform * ctm;
1276 }
1277 }
1279 void
1280 sp_gradient_set_gs2d_matrix(SPGradient *gr, NR::Matrix const &ctm,
1281 NR::Rect const &bbox, NR::Matrix const &gs2d)
1282 {
1283 gr->gradientTransform = gs2d / ctm;
1284 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX ) {
1285 gr->gradientTransform = ( gr->gradientTransform
1286 / NR::translate(bbox.min())
1287 / NR::scale(bbox.dimensions()) );
1288 }
1289 gr->gradientTransform_set = TRUE;
1291 SP_OBJECT(gr)->requestModified(SP_OBJECT_MODIFIED_FLAG);
1292 }
1294 /*
1295 * Linear Gradient
1296 */
1298 class SPLGPainter;
1300 /// A context with linear gradient, painter, and gradient renderer.
1301 struct SPLGPainter {
1302 SPPainter painter;
1303 SPLinearGradient *lg;
1305 NRLGradientRenderer lgr;
1306 };
1308 static void sp_lineargradient_class_init(SPLinearGradientClass *klass);
1309 static void sp_lineargradient_init(SPLinearGradient *lg);
1311 static void sp_lineargradient_build(SPObject *object,
1312 SPDocument *document,
1313 Inkscape::XML::Node *repr);
1314 static void sp_lineargradient_set(SPObject *object, unsigned key, gchar const *value);
1315 static Inkscape::XML::Node *sp_lineargradient_write(SPObject *object, Inkscape::XML::Node *repr,
1316 guint flags);
1318 static SPPainter *sp_lineargradient_painter_new(SPPaintServer *ps,
1319 NR::Matrix const &full_transform,
1320 NR::Matrix const &parent_transform,
1321 NRRect const *bbox);
1322 static void sp_lineargradient_painter_free(SPPaintServer *ps, SPPainter *painter);
1324 static void sp_lg_fill(SPPainter *painter, NRPixBlock *pb);
1326 static SPGradientClass *lg_parent_class;
1328 /**
1329 * Register SPLinearGradient class and return its type.
1330 */
1331 GType
1332 sp_lineargradient_get_type()
1333 {
1334 static GType type = 0;
1335 if (!type) {
1336 GTypeInfo info = {
1337 sizeof(SPLinearGradientClass),
1338 NULL, NULL,
1339 (GClassInitFunc) sp_lineargradient_class_init,
1340 NULL, NULL,
1341 sizeof(SPLinearGradient),
1342 16,
1343 (GInstanceInitFunc) sp_lineargradient_init,
1344 NULL, /* value_table */
1345 };
1346 type = g_type_register_static(SP_TYPE_GRADIENT, "SPLinearGradient", &info, (GTypeFlags)0);
1347 }
1348 return type;
1349 }
1351 /**
1352 * SPLinearGradient vtable initialization.
1353 */
1354 static void sp_lineargradient_class_init(SPLinearGradientClass *klass)
1355 {
1356 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
1357 SPPaintServerClass *ps_class = (SPPaintServerClass *) klass;
1359 lg_parent_class = (SPGradientClass*)g_type_class_ref(SP_TYPE_GRADIENT);
1361 sp_object_class->build = sp_lineargradient_build;
1362 sp_object_class->set = sp_lineargradient_set;
1363 sp_object_class->write = sp_lineargradient_write;
1365 ps_class->painter_new = sp_lineargradient_painter_new;
1366 ps_class->painter_free = sp_lineargradient_painter_free;
1367 }
1369 /**
1370 * Callback for SPLinearGradient object initialization.
1371 */
1372 static void sp_lineargradient_init(SPLinearGradient *lg)
1373 {
1374 lg->x1.unset(SVGLength::PERCENT, 0.0, 0.0);
1375 lg->y1.unset(SVGLength::PERCENT, 0.5, 0.5);
1376 lg->x2.unset(SVGLength::PERCENT, 1.0, 1.0);
1377 lg->y2.unset(SVGLength::PERCENT, 0.5, 0.5);
1378 }
1380 /**
1381 * Callback: set attributes from associated repr.
1382 */
1383 static void sp_lineargradient_build(SPObject *object,
1384 SPDocument *document,
1385 Inkscape::XML::Node *repr)
1386 {
1387 if (((SPObjectClass *) lg_parent_class)->build)
1388 (* ((SPObjectClass *) lg_parent_class)->build)(object, document, repr);
1390 sp_object_read_attr(object, "x1");
1391 sp_object_read_attr(object, "y1");
1392 sp_object_read_attr(object, "x2");
1393 sp_object_read_attr(object, "y2");
1394 }
1396 /**
1397 * Callback: set attribute.
1398 */
1399 static void
1400 sp_lineargradient_set(SPObject *object, unsigned key, gchar const *value)
1401 {
1402 SPLinearGradient *lg = SP_LINEARGRADIENT(object);
1404 switch (key) {
1405 case SP_ATTR_X1:
1406 lg->x1.readOrUnset(value, SVGLength::PERCENT, 0.0, 0.0);
1407 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1408 break;
1409 case SP_ATTR_Y1:
1410 lg->y1.readOrUnset(value, SVGLength::PERCENT, 0.5, 0.5);
1411 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1412 break;
1413 case SP_ATTR_X2:
1414 lg->x2.readOrUnset(value, SVGLength::PERCENT, 1.0, 1.0);
1415 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1416 break;
1417 case SP_ATTR_Y2:
1418 lg->y2.readOrUnset(value, SVGLength::PERCENT, 0.5, 0.5);
1419 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1420 break;
1421 default:
1422 if (((SPObjectClass *) lg_parent_class)->set)
1423 (* ((SPObjectClass *) lg_parent_class)->set)(object, key, value);
1424 break;
1425 }
1426 }
1428 /**
1429 * Callback: write attributes to associated repr.
1430 */
1431 static Inkscape::XML::Node *
1432 sp_lineargradient_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
1433 {
1434 SPLinearGradient *lg = SP_LINEARGRADIENT(object);
1436 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
1437 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_OBJECT_DOCUMENT(object));
1438 repr = xml_doc->createElement("svg:linearGradient");
1439 }
1441 if ((flags & SP_OBJECT_WRITE_ALL) || lg->x1._set)
1442 sp_repr_set_svg_double(repr, "x1", lg->x1.computed);
1443 if ((flags & SP_OBJECT_WRITE_ALL) || lg->y1._set)
1444 sp_repr_set_svg_double(repr, "y1", lg->y1.computed);
1445 if ((flags & SP_OBJECT_WRITE_ALL) || lg->x2._set)
1446 sp_repr_set_svg_double(repr, "x2", lg->x2.computed);
1447 if ((flags & SP_OBJECT_WRITE_ALL) || lg->y2._set)
1448 sp_repr_set_svg_double(repr, "y2", lg->y2.computed);
1450 if (((SPObjectClass *) lg_parent_class)->write)
1451 (* ((SPObjectClass *) lg_parent_class)->write)(object, repr, flags);
1453 return repr;
1454 }
1456 /**
1457 * Create linear gradient context.
1458 *
1459 * Basically we have to deal with transformations
1460 *
1461 * 1) color2norm - maps point in (0,NCOLORS) vector to (0,1) vector
1462 * 2) norm2pos - maps (0,1) vector to x1,y1 - x2,y2
1463 * 2) gradientTransform
1464 * 3) bbox2user
1465 * 4) ctm == userspace to pixel grid
1466 *
1467 * See also (*) in sp-pattern about why we may need parent_transform.
1468 *
1469 * \todo (point 1 above) fixme: I do not know how to deal with start > 0
1470 * and end < 1.
1471 */
1472 static SPPainter *
1473 sp_lineargradient_painter_new(SPPaintServer *ps,
1474 NR::Matrix const &full_transform,
1475 NR::Matrix const &parent_transform,
1476 NRRect const *bbox)
1477 {
1478 SPLinearGradient *lg = SP_LINEARGRADIENT(ps);
1479 SPGradient *gr = SP_GRADIENT(ps);
1481 if (!gr->color) sp_gradient_ensure_colors(gr);
1483 SPLGPainter *lgp = g_new(SPLGPainter, 1);
1485 lgp->painter.type = SP_PAINTER_IND;
1486 lgp->painter.fill = sp_lg_fill;
1488 lgp->lg = lg;
1490 /** \todo
1491 * Technically speaking, we map NCOLORS on line [start,end] onto line
1492 * [0,1]. I almost think we should fill color array start and end in
1493 * that case. The alternative would be to leave these just empty garbage
1494 * or something similar. Originally I had 1023.9999 here - not sure
1495 * whether we have really to cut out ceil int (Lauris).
1496 */
1497 NR::Matrix color2norm(NR::identity());
1498 NR::Matrix color2px;
1499 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1500 NR::Matrix norm2pos(NR::identity());
1502 /* BBox to user coordinate system */
1503 NR::Matrix bbox2user(bbox->x1 - bbox->x0, 0, 0, bbox->y1 - bbox->y0, bbox->x0, bbox->y0);
1505 NR::Matrix color2pos = color2norm * norm2pos;
1506 NR::Matrix color2tpos = color2pos * gr->gradientTransform;
1507 NR::Matrix color2user = color2tpos * bbox2user;
1508 color2px = color2user * full_transform;
1510 } else {
1511 /* Problem: What to do, if we have mixed lengths and percentages? */
1512 /* Currently we do ignore percentages at all, but that is not good (lauris) */
1514 NR::Matrix norm2pos(NR::identity());
1515 NR::Matrix color2pos = color2norm * norm2pos;
1516 NR::Matrix color2tpos = color2pos * gr->gradientTransform;
1517 color2px = color2tpos * full_transform;
1519 }
1521 NRMatrix v2px;
1522 color2px.copyto(&v2px);
1524 nr_lgradient_renderer_setup(&lgp->lgr, gr->color, sp_gradient_get_spread(gr), &v2px,
1525 lg->x1.computed, lg->y1.computed,
1526 lg->x2.computed, lg->y2.computed);
1528 return (SPPainter *) lgp;
1529 }
1531 static void
1532 sp_lineargradient_painter_free(SPPaintServer *ps, SPPainter *painter)
1533 {
1534 g_free(painter);
1535 }
1537 /**
1538 * Directly set properties of linear gradient and request modified.
1539 */
1540 void
1541 sp_lineargradient_set_position(SPLinearGradient *lg,
1542 gdouble x1, gdouble y1,
1543 gdouble x2, gdouble y2)
1544 {
1545 g_return_if_fail(lg != NULL);
1546 g_return_if_fail(SP_IS_LINEARGRADIENT(lg));
1548 /* fixme: units? (Lauris) */
1549 lg->x1.set(SVGLength::NONE, x1, x1);
1550 lg->y1.set(SVGLength::NONE, y1, y1);
1551 lg->x2.set(SVGLength::NONE, x2, x2);
1552 lg->y2.set(SVGLength::NONE, y2, y2);
1554 SP_OBJECT(lg)->requestModified(SP_OBJECT_MODIFIED_FLAG);
1555 }
1557 /**
1558 * Callback when linear gradient object is rendered.
1559 */
1560 static void
1561 sp_lg_fill(SPPainter *painter, NRPixBlock *pb)
1562 {
1563 SPLGPainter *lgp = (SPLGPainter *) painter;
1565 if (lgp->lg->color == NULL) {
1566 sp_gradient_ensure_colors (lgp->lg);
1567 lgp->lgr.vector = lgp->lg->color;
1568 }
1570 nr_render((NRRenderer *) &lgp->lgr, pb, NULL);
1571 }
1573 /*
1574 * Radial Gradient
1575 */
1577 class SPRGPainter;
1579 /// A context with radial gradient, painter, and gradient renderer.
1580 struct SPRGPainter {
1581 SPPainter painter;
1582 SPRadialGradient *rg;
1583 NRRGradientRenderer rgr;
1584 };
1586 static void sp_radialgradient_class_init(SPRadialGradientClass *klass);
1587 static void sp_radialgradient_init(SPRadialGradient *rg);
1589 static void sp_radialgradient_build(SPObject *object,
1590 SPDocument *document,
1591 Inkscape::XML::Node *repr);
1592 static void sp_radialgradient_set(SPObject *object, unsigned key, gchar const *value);
1593 static Inkscape::XML::Node *sp_radialgradient_write(SPObject *object, Inkscape::XML::Node *repr,
1594 guint flags);
1596 static SPPainter *sp_radialgradient_painter_new(SPPaintServer *ps,
1597 NR::Matrix const &full_transform,
1598 NR::Matrix const &parent_transform,
1599 NRRect const *bbox);
1600 static void sp_radialgradient_painter_free(SPPaintServer *ps, SPPainter *painter);
1602 static void sp_rg_fill(SPPainter *painter, NRPixBlock *pb);
1604 static SPGradientClass *rg_parent_class;
1606 /**
1607 * Register SPRadialGradient class and return its type.
1608 */
1609 GType
1610 sp_radialgradient_get_type()
1611 {
1612 static GType type = 0;
1613 if (!type) {
1614 GTypeInfo info = {
1615 sizeof(SPRadialGradientClass),
1616 NULL, NULL,
1617 (GClassInitFunc) sp_radialgradient_class_init,
1618 NULL, NULL,
1619 sizeof(SPRadialGradient),
1620 16,
1621 (GInstanceInitFunc) sp_radialgradient_init,
1622 NULL, /* value_table */
1623 };
1624 type = g_type_register_static(SP_TYPE_GRADIENT, "SPRadialGradient", &info, (GTypeFlags)0);
1625 }
1626 return type;
1627 }
1629 /**
1630 * SPRadialGradient vtable initialization.
1631 */
1632 static void sp_radialgradient_class_init(SPRadialGradientClass *klass)
1633 {
1634 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
1635 SPPaintServerClass *ps_class = (SPPaintServerClass *) klass;
1637 rg_parent_class = (SPGradientClass*)g_type_class_ref(SP_TYPE_GRADIENT);
1639 sp_object_class->build = sp_radialgradient_build;
1640 sp_object_class->set = sp_radialgradient_set;
1641 sp_object_class->write = sp_radialgradient_write;
1643 ps_class->painter_new = sp_radialgradient_painter_new;
1644 ps_class->painter_free = sp_radialgradient_painter_free;
1645 }
1647 /**
1648 * Callback for SPRadialGradient object initialization.
1649 */
1650 static void
1651 sp_radialgradient_init(SPRadialGradient *rg)
1652 {
1653 rg->cx.unset(SVGLength::PERCENT, 0.5, 0.5);
1654 rg->cy.unset(SVGLength::PERCENT, 0.5, 0.5);
1655 rg->r.unset(SVGLength::PERCENT, 0.5, 0.5);
1656 rg->fx.unset(SVGLength::PERCENT, 0.5, 0.5);
1657 rg->fy.unset(SVGLength::PERCENT, 0.5, 0.5);
1658 }
1660 /**
1661 * Set radial gradient attributes from associated repr.
1662 */
1663 static void
1664 sp_radialgradient_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
1665 {
1666 if (((SPObjectClass *) rg_parent_class)->build)
1667 (* ((SPObjectClass *) rg_parent_class)->build)(object, document, repr);
1669 sp_object_read_attr(object, "cx");
1670 sp_object_read_attr(object, "cy");
1671 sp_object_read_attr(object, "r");
1672 sp_object_read_attr(object, "fx");
1673 sp_object_read_attr(object, "fy");
1674 }
1676 /**
1677 * Set radial gradient attribute.
1678 */
1679 static void
1680 sp_radialgradient_set(SPObject *object, unsigned key, gchar const *value)
1681 {
1682 SPRadialGradient *rg = SP_RADIALGRADIENT(object);
1684 switch (key) {
1685 case SP_ATTR_CX:
1686 if (!rg->cx.read(value)) {
1687 rg->cx.unset(SVGLength::PERCENT, 0.5, 0.5);
1688 }
1689 if (!rg->fx._set) {
1690 rg->fx.value = rg->cx.value;
1691 rg->fx.computed = rg->cx.computed;
1692 }
1693 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1694 break;
1695 case SP_ATTR_CY:
1696 if (!rg->cy.read(value)) {
1697 rg->cy.unset(SVGLength::PERCENT, 0.5, 0.5);
1698 }
1699 if (!rg->fy._set) {
1700 rg->fy.value = rg->cy.value;
1701 rg->fy.computed = rg->cy.computed;
1702 }
1703 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1704 break;
1705 case SP_ATTR_R:
1706 if (!rg->r.read(value)) {
1707 rg->r.unset(SVGLength::PERCENT, 0.5, 0.5);
1708 }
1709 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1710 break;
1711 case SP_ATTR_FX:
1712 if (!rg->fx.read(value)) {
1713 rg->fx.unset(rg->cx.unit, rg->cx.value, rg->cx.computed);
1714 }
1715 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1716 break;
1717 case SP_ATTR_FY:
1718 if (!rg->fy.read(value)) {
1719 rg->fy.unset(rg->cy.unit, rg->cy.value, rg->cy.computed);
1720 }
1721 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1722 break;
1723 default:
1724 if (((SPObjectClass *) rg_parent_class)->set)
1725 ((SPObjectClass *) rg_parent_class)->set(object, key, value);
1726 break;
1727 }
1728 }
1730 /**
1731 * Write radial gradient attributes to associated repr.
1732 */
1733 static Inkscape::XML::Node *
1734 sp_radialgradient_write(SPObject *object, Inkscape::XML::Node *repr, guint flags)
1735 {
1736 SPRadialGradient *rg = SP_RADIALGRADIENT(object);
1738 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
1739 Inkscape::XML::Document *xml_doc = sp_document_repr_doc(SP_OBJECT_DOCUMENT(object));
1740 repr = xml_doc->createElement("svg:radialGradient");
1741 }
1743 if ((flags & SP_OBJECT_WRITE_ALL) || rg->cx._set) sp_repr_set_svg_double(repr, "cx", rg->cx.computed);
1744 if ((flags & SP_OBJECT_WRITE_ALL) || rg->cy._set) sp_repr_set_svg_double(repr, "cy", rg->cy.computed);
1745 if ((flags & SP_OBJECT_WRITE_ALL) || rg->r._set) sp_repr_set_svg_double(repr, "r", rg->r.computed);
1746 if ((flags & SP_OBJECT_WRITE_ALL) || rg->fx._set) sp_repr_set_svg_double(repr, "fx", rg->fx.computed);
1747 if ((flags & SP_OBJECT_WRITE_ALL) || rg->fy._set) sp_repr_set_svg_double(repr, "fy", rg->fy.computed);
1749 if (((SPObjectClass *) rg_parent_class)->write)
1750 (* ((SPObjectClass *) rg_parent_class)->write)(object, repr, flags);
1752 return repr;
1753 }
1755 /**
1756 * Create radial gradient context.
1757 */
1758 static SPPainter *
1759 sp_radialgradient_painter_new(SPPaintServer *ps,
1760 NR::Matrix const &full_transform,
1761 NR::Matrix const &parent_transform,
1762 NRRect const *bbox)
1763 {
1764 SPRadialGradient *rg = SP_RADIALGRADIENT(ps);
1765 SPGradient *gr = SP_GRADIENT(ps);
1767 if (!gr->color) sp_gradient_ensure_colors(gr);
1769 SPRGPainter *rgp = g_new(SPRGPainter, 1);
1771 rgp->painter.type = SP_PAINTER_IND;
1772 rgp->painter.fill = sp_rg_fill;
1774 rgp->rg = rg;
1776 NR::Matrix gs2px;
1778 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1779 /** \todo
1780 * fixme: We may try to normalize here too, look at
1781 * linearGradient (Lauris)
1782 */
1784 /* BBox to user coordinate system */
1785 NR::Matrix bbox2user(bbox->x1 - bbox->x0, 0, 0, bbox->y1 - bbox->y0, bbox->x0, bbox->y0);
1787 NR::Matrix gs2user = gr->gradientTransform * bbox2user;
1789 gs2px = gs2user * full_transform;
1790 } else {
1791 /** \todo
1792 * Problem: What to do, if we have mixed lengths and percentages?
1793 * Currently we do ignore percentages at all, but that is not
1794 * good (lauris)
1795 */
1797 gs2px = gr->gradientTransform * full_transform;
1798 }
1800 NRMatrix gs2px_nr;
1801 gs2px.copyto(&gs2px_nr);
1803 nr_rgradient_renderer_setup(&rgp->rgr, gr->color, sp_gradient_get_spread(gr),
1804 &gs2px_nr,
1805 rg->cx.computed, rg->cy.computed,
1806 rg->fx.computed, rg->fy.computed,
1807 rg->r.computed);
1809 return (SPPainter *) rgp;
1810 }
1812 static void
1813 sp_radialgradient_painter_free(SPPaintServer *ps, SPPainter *painter)
1814 {
1815 g_free(painter);
1816 }
1818 /**
1819 * Directly set properties of radial gradient and request modified.
1820 */
1821 void
1822 sp_radialgradient_set_position(SPRadialGradient *rg,
1823 gdouble cx, gdouble cy, gdouble fx, gdouble fy, gdouble r)
1824 {
1825 g_return_if_fail(rg != NULL);
1826 g_return_if_fail(SP_IS_RADIALGRADIENT(rg));
1828 /* fixme: units? (Lauris) */
1829 rg->cx.set(SVGLength::NONE, cx, cx);
1830 rg->cy.set(SVGLength::NONE, cy, cy);
1831 rg->fx.set(SVGLength::NONE, fx, fx);
1832 rg->fy.set(SVGLength::NONE, fy, fy);
1833 rg->r.set(SVGLength::NONE, r, r);
1835 SP_OBJECT(rg)->requestModified(SP_OBJECT_MODIFIED_FLAG);
1836 }
1838 /**
1839 * Callback when radial gradient object is rendered.
1840 */
1841 static void
1842 sp_rg_fill(SPPainter *painter, NRPixBlock *pb)
1843 {
1844 SPRGPainter *rgp = (SPRGPainter *) painter;
1846 if (rgp->rg->color == NULL) {
1847 sp_gradient_ensure_colors (rgp->rg);
1848 rgp->rgr.vector = rgp->rg->color;
1849 }
1851 nr_render((NRRenderer *) &rgp->rgr, pb, NULL);
1852 }
1854 /*
1855 Local Variables:
1856 mode:c++
1857 c-file-style:"stroustrup"
1858 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1859 indent-tabs-mode:nil
1860 fill-column:99
1861 End:
1862 */
1863 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :