src/gradient-chemistry.cpp

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