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
21 #include <cstring>
22 #include <string>
24 #include <libnr/nr-matrix-fns.h>
25 #include <libnr/nr-matrix-ops.h>
26 #include <libnr/nr-matrix-scale-ops.h>
27 #include <libnr/nr-matrix-translate-ops.h>
28 #include "libnr/nr-scale-translate-ops.h"
30 #include <sigc++/functors/ptr_fun.h>
31 #include <sigc++/adaptors/bind.h>
33 #include "libnr/nr-gradient.h"
34 #include "svg/svg.h"
35 #include "svg/svg-color.h"
36 #include "svg/css-ostringstream.h"
37 #include "attributes.h"
38 #include "document-private.h"
39 #include "gradient-chemistry.h"
40 #include "sp-gradient-reference.h"
41 #include "sp-linear-gradient.h"
42 #include "sp-radial-gradient.h"
43 #include "sp-stop.h"
44 #include "streq.h"
45 #include "uri.h"
46 #include "xml/repr.h"
48 #define SP_MACROS_SILENT
49 #include "macros.h"
51 /// Has to be power of 2
52 #define NCOLORS NR_GRADIENT_VECTOR_LENGTH
54 static void sp_stop_class_init(SPStopClass *klass);
55 static void sp_stop_init(SPStop *stop);
57 static void sp_stop_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr);
58 static void sp_stop_set(SPObject *object, unsigned key, gchar const *value);
59 static Inkscape::XML::Node *sp_stop_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr, guint flags);
61 static SPObjectClass *stop_parent_class;
63 /**
64 * Registers SPStop class and returns its type.
65 */
66 GType
67 sp_stop_get_type()
68 {
69 static GType type = 0;
70 if (!type) {
71 GTypeInfo info = {
72 sizeof(SPStopClass),
73 NULL, NULL,
74 (GClassInitFunc) sp_stop_class_init,
75 NULL, NULL,
76 sizeof(SPStop),
77 16,
78 (GInstanceInitFunc) sp_stop_init,
79 NULL, /* value_table */
80 };
81 type = g_type_register_static(SP_TYPE_OBJECT, "SPStop", &info, (GTypeFlags)0);
82 }
83 return type;
84 }
86 /**
87 * Callback to initialize SPStop vtable.
88 */
89 static void sp_stop_class_init(SPStopClass *klass)
90 {
91 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
93 stop_parent_class = (SPObjectClass *) g_type_class_ref(SP_TYPE_OBJECT);
95 sp_object_class->build = sp_stop_build;
96 sp_object_class->set = sp_stop_set;
97 sp_object_class->write = sp_stop_write;
98 }
100 /**
101 * Callback to initialize SPStop object.
102 */
103 static void
104 sp_stop_init(SPStop *stop)
105 {
106 stop->offset = 0.0;
107 stop->currentColor = false;
108 stop->specified_color.set( 0x000000ff );
109 stop->opacity = 1.0;
110 }
112 /**
113 * Virtual build: set stop attributes from its associated XML node.
114 */
115 static void sp_stop_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
116 {
117 if (((SPObjectClass *) stop_parent_class)->build)
118 (* ((SPObjectClass *) stop_parent_class)->build)(object, document, repr);
120 sp_object_read_attr(object, "offset");
121 sp_object_read_attr(object, "stop-color");
122 sp_object_read_attr(object, "stop-opacity");
123 sp_object_read_attr(object, "style");
124 }
126 /**
127 * Virtual set: set attribute to value.
128 */
129 static void
130 sp_stop_set(SPObject *object, unsigned key, gchar const *value)
131 {
132 SPStop *stop = SP_STOP(object);
134 switch (key) {
135 case SP_ATTR_STYLE: {
136 /** \todo
137 * fixme: We are reading simple values 3 times during build (Lauris).
138 * \par
139 * We need presentation attributes etc.
140 * \par
141 * remove the hackish "style reading" from here: see comments in
142 * sp_object_get_style_property about the bugs in our current
143 * approach. However, note that SPStyle doesn't currently have
144 * stop-color and stop-opacity properties.
145 */
146 {
147 gchar const *p = sp_object_get_style_property(object, "stop-color", "black");
148 if (streq(p, "currentColor")) {
149 stop->currentColor = true;
150 } else {
151 guint32 const color = sp_svg_read_color(p, 0);
152 stop->specified_color.set( color );
153 }
154 }
155 {
156 gchar const *p = sp_object_get_style_property(object, "stop-opacity", "1");
157 gdouble opacity = sp_svg_read_percentage(p, stop->opacity);
158 stop->opacity = opacity;
159 }
160 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
161 break;
162 }
163 case SP_PROP_STOP_COLOR: {
164 {
165 gchar const *p = sp_object_get_style_property(object, "stop-color", "black");
166 if (streq(p, "currentColor")) {
167 stop->currentColor = true;
168 } else {
169 stop->currentColor = false;
170 guint32 const color = sp_svg_read_color(p, 0);
171 stop->specified_color.set( color );
172 }
173 }
174 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
175 break;
176 }
177 case SP_PROP_STOP_OPACITY: {
178 {
179 gchar const *p = sp_object_get_style_property(object, "stop-opacity", "1");
180 gdouble opacity = sp_svg_read_percentage(p, stop->opacity);
181 stop->opacity = opacity;
182 }
183 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
184 break;
185 }
186 case SP_ATTR_OFFSET: {
187 stop->offset = sp_svg_read_percentage(value, 0.0);
188 object->requestModified(SP_OBJECT_MODIFIED_FLAG | SP_OBJECT_STYLE_MODIFIED_FLAG);
189 break;
190 }
191 default: {
192 if (((SPObjectClass *) stop_parent_class)->set)
193 (* ((SPObjectClass *) stop_parent_class)->set)(object, key, value);
194 break;
195 }
196 }
197 }
199 /**
200 * Virtual write: write object attributes to repr.
201 */
202 static Inkscape::XML::Node *
203 sp_stop_write(SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
204 {
205 SPStop *stop = SP_STOP(object);
207 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
208 repr = xml_doc->createElement("svg:stop");
209 }
211 guint32 specifiedcolor = stop->specified_color.toRGBA32( 255 );
212 gfloat opacity = stop->opacity;
214 if (((SPObjectClass *) stop_parent_class)->write)
215 (* ((SPObjectClass *) stop_parent_class)->write)(object, xml_doc, repr, flags);
217 // Since we do a hackish style setting here (because SPStyle does not support stop-color and
218 // stop-opacity), we must do it AFTER calling the parent write method; otherwise
219 // sp_object_write would clear our style= attribute (bug 1695287)
221 Inkscape::CSSOStringStream os;
222 os << "stop-color:";
223 if (stop->currentColor) {
224 os << "currentColor";
225 } else {
226 gchar c[64];
227 sp_svg_write_color(c, sizeof(c), specifiedcolor);
228 os << c;
229 }
230 os << ";stop-opacity:" << opacity;
231 repr->setAttribute("style", os.str().c_str());
232 repr->setAttribute("stop-color", NULL);
233 repr->setAttribute("stop-opacity", NULL);
234 sp_repr_set_css_double(repr, "offset", stop->offset);
235 /* strictly speaking, offset an SVG <number> rather than a CSS one, but exponents make no sense
236 * for offset proportions. */
238 return repr;
239 }
241 /**
242 * Return stop's color as 32bit value.
243 */
244 guint32
245 sp_stop_get_rgba32(SPStop const *const stop)
246 {
247 guint32 rgb0 = 0;
248 /* Default value: arbitrarily black. (SVG1.1 and CSS2 both say that the initial
249 * value depends on user agent, and don't give any further restrictions that I can
250 * see.) */
251 if (stop->currentColor) {
252 char const *str = sp_object_get_style_property(stop, "color", NULL);
253 if (str) {
254 rgb0 = sp_svg_read_color(str, rgb0);
255 }
256 unsigned const alpha = static_cast<unsigned>(stop->opacity * 0xff + 0.5);
257 g_return_val_if_fail((alpha & ~0xff) == 0,
258 rgb0 | 0xff);
259 return rgb0 | alpha;
260 } else {
261 return stop->specified_color.toRGBA32( stop->opacity );
262 }
263 }
265 /**
266 * Return stop's color as SPColor.
267 */
268 static SPColor
269 sp_stop_get_color(SPStop const *const stop)
270 {
271 if (stop->currentColor) {
272 char const *str = sp_object_get_style_property(stop, "color", NULL);
273 guint32 const dfl = 0;
274 /* Default value: arbitrarily black. (SVG1.1 and CSS2 both say that the initial
275 * value depends on user agent, and don't give any further restrictions that I can
276 * see.) */
277 guint32 color = dfl;
278 if (str) {
279 color = sp_svg_read_color(str, dfl);
280 }
281 SPColor 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::Document *doc, 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::Document *xml_doc, 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, xml_doc, 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(xml_doc, 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, sizeof(c), gr->vector.stops[i].color.toRGBA32( 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 gstop.color.set( 0x00000000 );
1037 gstop.opacity = 0.0;
1038 gr->vector.stops.push_back(gstop);
1039 }
1040 {
1041 SPGradientStop gstop;
1042 gstop.offset = 1.0;
1043 gstop.color.set( 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 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 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 = gr->vector.stops[i].color.toRGBA32( gr->vector.stops[i].opacity );
1090 gint r0 = (color >> 24) & 0xff;
1091 gint g0 = (color >> 16) & 0xff;
1092 gint b0 = (color >> 8) & 0xff;
1093 gint a0 = color & 0xff;
1094 color = gr->vector.stops[i + 1].color.toRGBA32( gr->vector.stops[i + 1].opacity );
1095 gint r1 = (color >> 24) & 0xff;
1096 gint g1 = (color >> 16) & 0xff;
1097 gint b1 = (color >> 8) & 0xff;
1098 gint a1 = color & 0xff;
1099 gint o0 = (gint) floor(gr->vector.stops[i].offset * (NCOLORS - 0.001));
1100 gint o1 = (gint) floor(gr->vector.stops[i + 1].offset * (NCOLORS - 0.001));
1101 if (o1 > o0) {
1102 gint dr = ((r1 - r0) << 16) / (o1 - o0);
1103 gint dg = ((g1 - g0) << 16) / (o1 - o0);
1104 gint db = ((b1 - b0) << 16) / (o1 - o0);
1105 gint da = ((a1 - a0) << 16) / (o1 - o0);
1106 gint r = r0 << 16;
1107 gint g = g0 << 16;
1108 gint b = b0 << 16;
1109 gint a = a0 << 16;
1110 for (int j = o0; j < o1 + 1; j++) {
1111 gr->color[4 * j] = r >> 16;
1112 gr->color[4 * j + 1] = g >> 16;
1113 gr->color[4 * j + 2] = b >> 16;
1114 gr->color[4 * j + 3] = a >> 16;
1115 r += dr;
1116 g += dg;
1117 b += db;
1118 a += da;
1119 }
1120 }
1121 }
1122 }
1124 /**
1125 * Renders gradient vector to buffer as line.
1126 *
1127 * RGB buffer background should be set up beforehand.
1128 *
1129 * @param len,width,height,rowstride Buffer parameters (1 or 2 dimensional).
1130 * @param span Full integer width of requested gradient.
1131 * @param pos Buffer starting position in span.
1132 */
1133 static void
1134 sp_gradient_render_vector_line_rgba(SPGradient *const gradient, guchar *buf,
1135 gint const len, gint const pos, gint const span)
1136 {
1137 g_return_if_fail(gradient != NULL);
1138 g_return_if_fail(SP_IS_GRADIENT(gradient));
1139 g_return_if_fail(buf != NULL);
1140 g_return_if_fail(len > 0);
1141 g_return_if_fail(pos >= 0);
1142 g_return_if_fail(pos + len <= span);
1143 g_return_if_fail(span > 0);
1145 if (!gradient->color) {
1146 sp_gradient_ensure_colors(gradient);
1147 }
1149 gint idx = (pos * 1024 << 8) / span;
1150 gint didx = (1024 << 8) / span;
1152 for (gint x = 0; x < len; x++) {
1153 /// \todo Can this be done with 4 byte copies?
1154 *buf++ = gradient->color[4 * (idx >> 8)];
1155 *buf++ = gradient->color[4 * (idx >> 8) + 1];
1156 *buf++ = gradient->color[4 * (idx >> 8) + 2];
1157 *buf++ = gradient->color[4 * (idx >> 8) + 3];
1158 idx += didx;
1159 }
1160 }
1162 /**
1163 * Render rectangular RGBA area from gradient vector.
1164 */
1165 void
1166 sp_gradient_render_vector_block_rgba(SPGradient *const gradient, guchar *buf,
1167 gint const width, gint const height, gint const rowstride,
1168 gint const pos, gint const span, bool const horizontal)
1169 {
1170 g_return_if_fail(gradient != NULL);
1171 g_return_if_fail(SP_IS_GRADIENT(gradient));
1172 g_return_if_fail(buf != NULL);
1173 g_return_if_fail(width > 0);
1174 g_return_if_fail(height > 0);
1175 g_return_if_fail(pos >= 0);
1176 g_return_if_fail((horizontal && (pos + width <= span)) || (!horizontal && (pos + height <= span)));
1177 g_return_if_fail(span > 0);
1179 if (horizontal) {
1180 sp_gradient_render_vector_line_rgba(gradient, buf, width, pos, span);
1181 for (gint y = 1; y < height; y++) {
1182 memcpy(buf + y * rowstride, buf, 4 * width);
1183 }
1184 } else {
1185 guchar *tmp = (guchar *)alloca(4 * height);
1186 sp_gradient_render_vector_line_rgba(gradient, tmp, height, pos, span);
1187 for (gint y = 0; y < height; y++) {
1188 guchar *b = buf + y * rowstride;
1189 for (gint x = 0; x < width; x++) {
1190 *b++ = tmp[0];
1191 *b++ = tmp[1];
1192 *b++ = tmp[2];
1193 *b++ = tmp[3];
1194 }
1195 tmp += 4;
1196 }
1197 }
1198 }
1200 /**
1201 * Render rectangular RGB area from gradient vector.
1202 */
1203 void
1204 sp_gradient_render_vector_block_rgb(SPGradient *gradient, guchar *buf,
1205 gint const width, gint const height, gint const /*rowstride*/,
1206 gint const pos, gint const span, bool const horizontal)
1207 {
1208 g_return_if_fail(gradient != NULL);
1209 g_return_if_fail(SP_IS_GRADIENT(gradient));
1210 g_return_if_fail(buf != NULL);
1211 g_return_if_fail(width > 0);
1212 g_return_if_fail(height > 0);
1213 g_return_if_fail(pos >= 0);
1214 g_return_if_fail((horizontal && (pos + width <= span)) || (!horizontal && (pos + height <= span)));
1215 g_return_if_fail(span > 0);
1217 if (horizontal) {
1218 guchar *tmp = (guchar*)alloca(4 * width);
1219 sp_gradient_render_vector_line_rgba(gradient, tmp, width, pos, span);
1220 for (gint y = 0; y < height; y++) {
1221 guchar *t = tmp;
1222 for (gint x = 0; x < width; x++) {
1223 gint a = t[3];
1224 gint fc = (t[0] - buf[0]) * a;
1225 buf[0] = buf[0] + ((fc + (fc >> 8) + 0x80) >> 8);
1226 fc = (t[1] - buf[1]) * a;
1227 buf[1] = buf[1] + ((fc + (fc >> 8) + 0x80) >> 8);
1228 fc = (t[2] - buf[2]) * a;
1229 buf[2] = buf[2] + ((fc + (fc >> 8) + 0x80) >> 8);
1230 buf += 3;
1231 t += 4;
1232 }
1233 }
1234 } else {
1235 guchar *tmp = (guchar*)alloca(4 * height);
1236 sp_gradient_render_vector_line_rgba(gradient, tmp, height, pos, span);
1237 for (gint y = 0; y < height; y++) {
1238 guchar *t = tmp + 4 * y;
1239 for (gint x = 0; x < width; x++) {
1240 gint a = t[3];
1241 gint fc = (t[0] - buf[0]) * a;
1242 buf[0] = buf[0] + ((fc + (fc >> 8) + 0x80) >> 8);
1243 fc = (t[1] - buf[1]) * a;
1244 buf[1] = buf[1] + ((fc + (fc >> 8) + 0x80) >> 8);
1245 fc = (t[2] - buf[2]) * a;
1246 buf[2] = buf[2] + ((fc + (fc >> 8) + 0x80) >> 8);
1247 }
1248 }
1249 }
1250 }
1252 NR::Matrix
1253 sp_gradient_get_g2d_matrix(SPGradient const *gr, NR::Matrix const &ctm, NR::Rect const &bbox)
1254 {
1255 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1256 return ( NR::scale(bbox.dimensions())
1257 * NR::translate(bbox.min())
1258 * ctm );
1259 } else {
1260 return ctm;
1261 }
1262 }
1264 NR::Matrix
1265 sp_gradient_get_gs2d_matrix(SPGradient const *gr, NR::Matrix const &ctm, NR::Rect const &bbox)
1266 {
1267 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1268 return ( gr->gradientTransform
1269 * NR::scale(bbox.dimensions())
1270 * NR::translate(bbox.min())
1271 * ctm );
1272 } else {
1273 return gr->gradientTransform * ctm;
1274 }
1275 }
1277 void
1278 sp_gradient_set_gs2d_matrix(SPGradient *gr, NR::Matrix const &ctm,
1279 NR::Rect const &bbox, NR::Matrix const &gs2d)
1280 {
1281 gr->gradientTransform = gs2d * ctm.inverse();
1282 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX ) {
1283 gr->gradientTransform = ( gr->gradientTransform
1284 / NR::translate(bbox.min())
1285 / NR::scale(bbox.dimensions()) );
1286 }
1287 gr->gradientTransform_set = TRUE;
1289 SP_OBJECT(gr)->requestModified(SP_OBJECT_MODIFIED_FLAG);
1290 }
1292 /*
1293 * Linear Gradient
1294 */
1296 class SPLGPainter;
1298 /// A context with linear gradient, painter, and gradient renderer.
1299 struct SPLGPainter {
1300 SPPainter painter;
1301 SPLinearGradient *lg;
1303 NRLGradientRenderer lgr;
1304 };
1306 static void sp_lineargradient_class_init(SPLinearGradientClass *klass);
1307 static void sp_lineargradient_init(SPLinearGradient *lg);
1309 static void sp_lineargradient_build(SPObject *object,
1310 SPDocument *document,
1311 Inkscape::XML::Node *repr);
1312 static void sp_lineargradient_set(SPObject *object, unsigned key, gchar const *value);
1313 static Inkscape::XML::Node *sp_lineargradient_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr,
1314 guint flags);
1316 static SPPainter *sp_lineargradient_painter_new(SPPaintServer *ps,
1317 NR::Matrix const &full_transform,
1318 NR::Matrix const &parent_transform,
1319 NRRect const *bbox);
1320 static void sp_lineargradient_painter_free(SPPaintServer *ps, SPPainter *painter);
1322 static void sp_lg_fill(SPPainter *painter, NRPixBlock *pb);
1324 static SPGradientClass *lg_parent_class;
1326 /**
1327 * Register SPLinearGradient class and return its type.
1328 */
1329 GType
1330 sp_lineargradient_get_type()
1331 {
1332 static GType type = 0;
1333 if (!type) {
1334 GTypeInfo info = {
1335 sizeof(SPLinearGradientClass),
1336 NULL, NULL,
1337 (GClassInitFunc) sp_lineargradient_class_init,
1338 NULL, NULL,
1339 sizeof(SPLinearGradient),
1340 16,
1341 (GInstanceInitFunc) sp_lineargradient_init,
1342 NULL, /* value_table */
1343 };
1344 type = g_type_register_static(SP_TYPE_GRADIENT, "SPLinearGradient", &info, (GTypeFlags)0);
1345 }
1346 return type;
1347 }
1349 /**
1350 * SPLinearGradient vtable initialization.
1351 */
1352 static void sp_lineargradient_class_init(SPLinearGradientClass *klass)
1353 {
1354 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
1355 SPPaintServerClass *ps_class = (SPPaintServerClass *) klass;
1357 lg_parent_class = (SPGradientClass*)g_type_class_ref(SP_TYPE_GRADIENT);
1359 sp_object_class->build = sp_lineargradient_build;
1360 sp_object_class->set = sp_lineargradient_set;
1361 sp_object_class->write = sp_lineargradient_write;
1363 ps_class->painter_new = sp_lineargradient_painter_new;
1364 ps_class->painter_free = sp_lineargradient_painter_free;
1365 }
1367 /**
1368 * Callback for SPLinearGradient object initialization.
1369 */
1370 static void sp_lineargradient_init(SPLinearGradient *lg)
1371 {
1372 lg->x1.unset(SVGLength::PERCENT, 0.0, 0.0);
1373 lg->y1.unset(SVGLength::PERCENT, 0.5, 0.5);
1374 lg->x2.unset(SVGLength::PERCENT, 1.0, 1.0);
1375 lg->y2.unset(SVGLength::PERCENT, 0.5, 0.5);
1376 }
1378 /**
1379 * Callback: set attributes from associated repr.
1380 */
1381 static void sp_lineargradient_build(SPObject *object,
1382 SPDocument *document,
1383 Inkscape::XML::Node *repr)
1384 {
1385 if (((SPObjectClass *) lg_parent_class)->build)
1386 (* ((SPObjectClass *) lg_parent_class)->build)(object, document, repr);
1388 sp_object_read_attr(object, "x1");
1389 sp_object_read_attr(object, "y1");
1390 sp_object_read_attr(object, "x2");
1391 sp_object_read_attr(object, "y2");
1392 }
1394 /**
1395 * Callback: set attribute.
1396 */
1397 static void
1398 sp_lineargradient_set(SPObject *object, unsigned key, gchar const *value)
1399 {
1400 SPLinearGradient *lg = SP_LINEARGRADIENT(object);
1402 switch (key) {
1403 case SP_ATTR_X1:
1404 lg->x1.readOrUnset(value, SVGLength::PERCENT, 0.0, 0.0);
1405 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1406 break;
1407 case SP_ATTR_Y1:
1408 lg->y1.readOrUnset(value, SVGLength::PERCENT, 0.5, 0.5);
1409 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1410 break;
1411 case SP_ATTR_X2:
1412 lg->x2.readOrUnset(value, SVGLength::PERCENT, 1.0, 1.0);
1413 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1414 break;
1415 case SP_ATTR_Y2:
1416 lg->y2.readOrUnset(value, SVGLength::PERCENT, 0.5, 0.5);
1417 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1418 break;
1419 default:
1420 if (((SPObjectClass *) lg_parent_class)->set)
1421 (* ((SPObjectClass *) lg_parent_class)->set)(object, key, value);
1422 break;
1423 }
1424 }
1426 /**
1427 * Callback: write attributes to associated repr.
1428 */
1429 static Inkscape::XML::Node *
1430 sp_lineargradient_write(SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
1431 {
1432 SPLinearGradient *lg = SP_LINEARGRADIENT(object);
1434 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
1435 repr = xml_doc->createElement("svg:linearGradient");
1436 }
1438 if ((flags & SP_OBJECT_WRITE_ALL) || lg->x1._set)
1439 sp_repr_set_svg_double(repr, "x1", lg->x1.computed);
1440 if ((flags & SP_OBJECT_WRITE_ALL) || lg->y1._set)
1441 sp_repr_set_svg_double(repr, "y1", lg->y1.computed);
1442 if ((flags & SP_OBJECT_WRITE_ALL) || lg->x2._set)
1443 sp_repr_set_svg_double(repr, "x2", lg->x2.computed);
1444 if ((flags & SP_OBJECT_WRITE_ALL) || lg->y2._set)
1445 sp_repr_set_svg_double(repr, "y2", lg->y2.computed);
1447 if (((SPObjectClass *) lg_parent_class)->write)
1448 (* ((SPObjectClass *) lg_parent_class)->write)(object, xml_doc, repr, flags);
1450 return repr;
1451 }
1453 /**
1454 * Create linear gradient context.
1455 *
1456 * Basically we have to deal with transformations
1457 *
1458 * 1) color2norm - maps point in (0,NCOLORS) vector to (0,1) vector
1459 * 2) norm2pos - maps (0,1) vector to x1,y1 - x2,y2
1460 * 2) gradientTransform
1461 * 3) bbox2user
1462 * 4) ctm == userspace to pixel grid
1463 *
1464 * See also (*) in sp-pattern about why we may need parent_transform.
1465 *
1466 * \todo (point 1 above) fixme: I do not know how to deal with start > 0
1467 * and end < 1.
1468 */
1469 static SPPainter *
1470 sp_lineargradient_painter_new(SPPaintServer *ps,
1471 NR::Matrix const &full_transform,
1472 NR::Matrix const &/*parent_transform*/,
1473 NRRect const *bbox)
1474 {
1475 SPLinearGradient *lg = SP_LINEARGRADIENT(ps);
1476 SPGradient *gr = SP_GRADIENT(ps);
1478 if (!gr->color) sp_gradient_ensure_colors(gr);
1480 SPLGPainter *lgp = g_new(SPLGPainter, 1);
1482 lgp->painter.type = SP_PAINTER_IND;
1483 lgp->painter.fill = sp_lg_fill;
1485 lgp->lg = lg;
1487 /** \todo
1488 * Technically speaking, we map NCOLORS on line [start,end] onto line
1489 * [0,1]. I almost think we should fill color array start and end in
1490 * that case. The alternative would be to leave these just empty garbage
1491 * or something similar. Originally I had 1023.9999 here - not sure
1492 * whether we have really to cut out ceil int (Lauris).
1493 */
1494 NR::Matrix color2norm(NR::identity());
1495 NR::Matrix color2px;
1496 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1497 NR::Matrix norm2pos(NR::identity());
1499 /* BBox to user coordinate system */
1500 NR::Matrix bbox2user(bbox->x1 - bbox->x0, 0, 0, bbox->y1 - bbox->y0, bbox->x0, bbox->y0);
1502 NR::Matrix color2pos = color2norm * norm2pos;
1503 NR::Matrix color2tpos = color2pos * gr->gradientTransform;
1504 NR::Matrix color2user = color2tpos * bbox2user;
1505 color2px = color2user * full_transform;
1507 } else {
1508 /* Problem: What to do, if we have mixed lengths and percentages? */
1509 /* Currently we do ignore percentages at all, but that is not good (lauris) */
1511 NR::Matrix norm2pos(NR::identity());
1512 NR::Matrix color2pos = color2norm * norm2pos;
1513 NR::Matrix color2tpos = color2pos * gr->gradientTransform;
1514 color2px = color2tpos * full_transform;
1516 }
1518 nr_lgradient_renderer_setup(&lgp->lgr, gr->color, sp_gradient_get_spread(gr), &color2px,
1519 lg->x1.computed, lg->y1.computed,
1520 lg->x2.computed, lg->y2.computed);
1522 return (SPPainter *) lgp;
1523 }
1525 static void
1526 sp_lineargradient_painter_free(SPPaintServer */*ps*/, SPPainter *painter)
1527 {
1528 g_free(painter);
1529 }
1531 /**
1532 * Directly set properties of linear gradient and request modified.
1533 */
1534 void
1535 sp_lineargradient_set_position(SPLinearGradient *lg,
1536 gdouble x1, gdouble y1,
1537 gdouble x2, gdouble y2)
1538 {
1539 g_return_if_fail(lg != NULL);
1540 g_return_if_fail(SP_IS_LINEARGRADIENT(lg));
1542 /* fixme: units? (Lauris) */
1543 lg->x1.set(SVGLength::NONE, x1, x1);
1544 lg->y1.set(SVGLength::NONE, y1, y1);
1545 lg->x2.set(SVGLength::NONE, x2, x2);
1546 lg->y2.set(SVGLength::NONE, y2, y2);
1548 SP_OBJECT(lg)->requestModified(SP_OBJECT_MODIFIED_FLAG);
1549 }
1551 /**
1552 * Callback when linear gradient object is rendered.
1553 */
1554 static void
1555 sp_lg_fill(SPPainter *painter, NRPixBlock *pb)
1556 {
1557 SPLGPainter *lgp = (SPLGPainter *) painter;
1559 if (lgp->lg->color == NULL) {
1560 sp_gradient_ensure_colors (lgp->lg);
1561 lgp->lgr.vector = lgp->lg->color;
1562 }
1564 nr_render((NRRenderer *) &lgp->lgr, pb, NULL);
1565 }
1567 /*
1568 * Radial Gradient
1569 */
1571 class SPRGPainter;
1573 /// A context with radial gradient, painter, and gradient renderer.
1574 struct SPRGPainter {
1575 SPPainter painter;
1576 SPRadialGradient *rg;
1577 NRRGradientRenderer rgr;
1578 };
1580 static void sp_radialgradient_class_init(SPRadialGradientClass *klass);
1581 static void sp_radialgradient_init(SPRadialGradient *rg);
1583 static void sp_radialgradient_build(SPObject *object,
1584 SPDocument *document,
1585 Inkscape::XML::Node *repr);
1586 static void sp_radialgradient_set(SPObject *object, unsigned key, gchar const *value);
1587 static Inkscape::XML::Node *sp_radialgradient_write(SPObject *object, Inkscape::XML::Document *doc, Inkscape::XML::Node *repr,
1588 guint flags);
1590 static SPPainter *sp_radialgradient_painter_new(SPPaintServer *ps,
1591 NR::Matrix const &full_transform,
1592 NR::Matrix const &parent_transform,
1593 NRRect const *bbox);
1594 static void sp_radialgradient_painter_free(SPPaintServer *ps, SPPainter *painter);
1596 static void sp_rg_fill(SPPainter *painter, NRPixBlock *pb);
1598 static SPGradientClass *rg_parent_class;
1600 /**
1601 * Register SPRadialGradient class and return its type.
1602 */
1603 GType
1604 sp_radialgradient_get_type()
1605 {
1606 static GType type = 0;
1607 if (!type) {
1608 GTypeInfo info = {
1609 sizeof(SPRadialGradientClass),
1610 NULL, NULL,
1611 (GClassInitFunc) sp_radialgradient_class_init,
1612 NULL, NULL,
1613 sizeof(SPRadialGradient),
1614 16,
1615 (GInstanceInitFunc) sp_radialgradient_init,
1616 NULL, /* value_table */
1617 };
1618 type = g_type_register_static(SP_TYPE_GRADIENT, "SPRadialGradient", &info, (GTypeFlags)0);
1619 }
1620 return type;
1621 }
1623 /**
1624 * SPRadialGradient vtable initialization.
1625 */
1626 static void sp_radialgradient_class_init(SPRadialGradientClass *klass)
1627 {
1628 SPObjectClass *sp_object_class = (SPObjectClass *) klass;
1629 SPPaintServerClass *ps_class = (SPPaintServerClass *) klass;
1631 rg_parent_class = (SPGradientClass*)g_type_class_ref(SP_TYPE_GRADIENT);
1633 sp_object_class->build = sp_radialgradient_build;
1634 sp_object_class->set = sp_radialgradient_set;
1635 sp_object_class->write = sp_radialgradient_write;
1637 ps_class->painter_new = sp_radialgradient_painter_new;
1638 ps_class->painter_free = sp_radialgradient_painter_free;
1639 }
1641 /**
1642 * Callback for SPRadialGradient object initialization.
1643 */
1644 static void
1645 sp_radialgradient_init(SPRadialGradient *rg)
1646 {
1647 rg->cx.unset(SVGLength::PERCENT, 0.5, 0.5);
1648 rg->cy.unset(SVGLength::PERCENT, 0.5, 0.5);
1649 rg->r.unset(SVGLength::PERCENT, 0.5, 0.5);
1650 rg->fx.unset(SVGLength::PERCENT, 0.5, 0.5);
1651 rg->fy.unset(SVGLength::PERCENT, 0.5, 0.5);
1652 }
1654 /**
1655 * Set radial gradient attributes from associated repr.
1656 */
1657 static void
1658 sp_radialgradient_build(SPObject *object, SPDocument *document, Inkscape::XML::Node *repr)
1659 {
1660 if (((SPObjectClass *) rg_parent_class)->build)
1661 (* ((SPObjectClass *) rg_parent_class)->build)(object, document, repr);
1663 sp_object_read_attr(object, "cx");
1664 sp_object_read_attr(object, "cy");
1665 sp_object_read_attr(object, "r");
1666 sp_object_read_attr(object, "fx");
1667 sp_object_read_attr(object, "fy");
1668 }
1670 /**
1671 * Set radial gradient attribute.
1672 */
1673 static void
1674 sp_radialgradient_set(SPObject *object, unsigned key, gchar const *value)
1675 {
1676 SPRadialGradient *rg = SP_RADIALGRADIENT(object);
1678 switch (key) {
1679 case SP_ATTR_CX:
1680 if (!rg->cx.read(value)) {
1681 rg->cx.unset(SVGLength::PERCENT, 0.5, 0.5);
1682 }
1683 if (!rg->fx._set) {
1684 rg->fx.value = rg->cx.value;
1685 rg->fx.computed = rg->cx.computed;
1686 }
1687 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1688 break;
1689 case SP_ATTR_CY:
1690 if (!rg->cy.read(value)) {
1691 rg->cy.unset(SVGLength::PERCENT, 0.5, 0.5);
1692 }
1693 if (!rg->fy._set) {
1694 rg->fy.value = rg->cy.value;
1695 rg->fy.computed = rg->cy.computed;
1696 }
1697 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1698 break;
1699 case SP_ATTR_R:
1700 if (!rg->r.read(value)) {
1701 rg->r.unset(SVGLength::PERCENT, 0.5, 0.5);
1702 }
1703 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1704 break;
1705 case SP_ATTR_FX:
1706 if (!rg->fx.read(value)) {
1707 rg->fx.unset(rg->cx.unit, rg->cx.value, rg->cx.computed);
1708 }
1709 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1710 break;
1711 case SP_ATTR_FY:
1712 if (!rg->fy.read(value)) {
1713 rg->fy.unset(rg->cy.unit, rg->cy.value, rg->cy.computed);
1714 }
1715 object->requestModified(SP_OBJECT_MODIFIED_FLAG);
1716 break;
1717 default:
1718 if (((SPObjectClass *) rg_parent_class)->set)
1719 ((SPObjectClass *) rg_parent_class)->set(object, key, value);
1720 break;
1721 }
1722 }
1724 /**
1725 * Write radial gradient attributes to associated repr.
1726 */
1727 static Inkscape::XML::Node *
1728 sp_radialgradient_write(SPObject *object, Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
1729 {
1730 SPRadialGradient *rg = SP_RADIALGRADIENT(object);
1732 if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
1733 repr = xml_doc->createElement("svg:radialGradient");
1734 }
1736 if ((flags & SP_OBJECT_WRITE_ALL) || rg->cx._set) sp_repr_set_svg_double(repr, "cx", rg->cx.computed);
1737 if ((flags & SP_OBJECT_WRITE_ALL) || rg->cy._set) sp_repr_set_svg_double(repr, "cy", rg->cy.computed);
1738 if ((flags & SP_OBJECT_WRITE_ALL) || rg->r._set) sp_repr_set_svg_double(repr, "r", rg->r.computed);
1739 if ((flags & SP_OBJECT_WRITE_ALL) || rg->fx._set) sp_repr_set_svg_double(repr, "fx", rg->fx.computed);
1740 if ((flags & SP_OBJECT_WRITE_ALL) || rg->fy._set) sp_repr_set_svg_double(repr, "fy", rg->fy.computed);
1742 if (((SPObjectClass *) rg_parent_class)->write)
1743 (* ((SPObjectClass *) rg_parent_class)->write)(object, xml_doc, repr, flags);
1745 return repr;
1746 }
1748 /**
1749 * Create radial gradient context.
1750 */
1751 static SPPainter *
1752 sp_radialgradient_painter_new(SPPaintServer *ps,
1753 NR::Matrix const &full_transform,
1754 NR::Matrix const &/*parent_transform*/,
1755 NRRect const *bbox)
1756 {
1757 SPRadialGradient *rg = SP_RADIALGRADIENT(ps);
1758 SPGradient *gr = SP_GRADIENT(ps);
1760 if (!gr->color) sp_gradient_ensure_colors(gr);
1762 SPRGPainter *rgp = g_new(SPRGPainter, 1);
1764 rgp->painter.type = SP_PAINTER_IND;
1765 rgp->painter.fill = sp_rg_fill;
1767 rgp->rg = rg;
1769 NR::Matrix gs2px;
1771 if (gr->units == SP_GRADIENT_UNITS_OBJECTBOUNDINGBOX) {
1772 /** \todo
1773 * fixme: We may try to normalize here too, look at
1774 * linearGradient (Lauris)
1775 */
1777 /* BBox to user coordinate system */
1778 NR::Matrix bbox2user(bbox->x1 - bbox->x0, 0, 0, bbox->y1 - bbox->y0, bbox->x0, bbox->y0);
1780 NR::Matrix gs2user = gr->gradientTransform * bbox2user;
1782 gs2px = gs2user * full_transform;
1783 } else {
1784 /** \todo
1785 * Problem: What to do, if we have mixed lengths and percentages?
1786 * Currently we do ignore percentages at all, but that is not
1787 * good (lauris)
1788 */
1790 gs2px = gr->gradientTransform * full_transform;
1791 }
1793 nr_rgradient_renderer_setup(&rgp->rgr, gr->color, sp_gradient_get_spread(gr),
1794 &gs2px,
1795 rg->cx.computed, rg->cy.computed,
1796 rg->fx.computed, rg->fy.computed,
1797 rg->r.computed);
1799 return (SPPainter *) rgp;
1800 }
1802 static void
1803 sp_radialgradient_painter_free(SPPaintServer */*ps*/, SPPainter *painter)
1804 {
1805 g_free(painter);
1806 }
1808 /**
1809 * Directly set properties of radial gradient and request modified.
1810 */
1811 void
1812 sp_radialgradient_set_position(SPRadialGradient *rg,
1813 gdouble cx, gdouble cy, gdouble fx, gdouble fy, gdouble r)
1814 {
1815 g_return_if_fail(rg != NULL);
1816 g_return_if_fail(SP_IS_RADIALGRADIENT(rg));
1818 /* fixme: units? (Lauris) */
1819 rg->cx.set(SVGLength::NONE, cx, cx);
1820 rg->cy.set(SVGLength::NONE, cy, cy);
1821 rg->fx.set(SVGLength::NONE, fx, fx);
1822 rg->fy.set(SVGLength::NONE, fy, fy);
1823 rg->r.set(SVGLength::NONE, r, r);
1825 SP_OBJECT(rg)->requestModified(SP_OBJECT_MODIFIED_FLAG);
1826 }
1828 /**
1829 * Callback when radial gradient object is rendered.
1830 */
1831 static void
1832 sp_rg_fill(SPPainter *painter, NRPixBlock *pb)
1833 {
1834 SPRGPainter *rgp = (SPRGPainter *) painter;
1836 if (rgp->rg->color == NULL) {
1837 sp_gradient_ensure_colors (rgp->rg);
1838 rgp->rgr.vector = rgp->rg->color;
1839 }
1841 nr_render((NRRenderer *) &rgp->rgr, pb, NULL);
1842 }
1844 /*
1845 Local Variables:
1846 mode:c++
1847 c-file-style:"stroustrup"
1848 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1849 indent-tabs-mode:nil
1850 fill-column:99
1851 End:
1852 */
1853 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :