src/live_effects/lpe-bendpath.cpp

   1 #define INKSCAPE_LPE_BENDPATH_CPP
   2
   3 /*
   4  * Copyright (C) Johan Engelen 2007 <j.b.c.engelen@utwente.nl>
   5  * Copyright (C) Steren Giannini 2008 <steren.giannini@gmail.com>
   6  *
   7  * Released under GNU GPL, read the file 'COPYING' for more information
   8  */
   9
  10 #include "live_effects/lpe-bendpath.h"
  11 #include "sp-shape.h"
  12 #include "sp-item.h"
  13 #include "sp-path.h"
  14 #include "sp-item-group.h"
  15 #include "display/curve.h"
  16 #include <libnr/n-art-bpath.h>
  17 #include <libnr/nr-matrix-fns.h>
  18 #include "libnr/n-art-bpath-2geom.h"
  19 #include "svg/svg.h"
  20 #include "ui/widget/scalar.h"
  21
  22 #include <2geom/sbasis.h>
  23 #include <2geom/sbasis-geometric.h>
  24 #include <2geom/bezier-to-sbasis.h>
  25 #include <2geom/sbasis-to-bezier.h>
  26 #include <2geom/d2.h>
  27 #include <2geom/piecewise.h>
  28
  29 #include <algorithm>
  30 using std::vector;
  31
  32
  33 /* Theory in e-mail from J.F. Barraud
  34 Let B be the skeleton path, and P the pattern (the path to be deformed).
  35
  36 P is a map t --> P(t) = ( x(t), y(t) ).
  37 B is a map t --> B(t) = ( a(t), b(t) ).
  38
  39 The first step is to re-parametrize B by its arc length: this is the parametrization in which a point p on B is located by its distance s from start. One obtains a new map s --> U(s) = (a'(s),b'(s)), that still describes the same path B, but where the distance along B from start to
  40 U(s) is s itself.
  41
  42 We also need a unit normal to the path. This can be obtained by computing a unit tangent vector, and rotate it by 90°. Call this normal vector N(s).
  43
  44 The basic deformation associated to B is then given by:
  45
  46    (x,y) --> U(x)+y*N(x)
  47
  48 (i.e. we go for distance x along the path, and then for distance y along the normal)
  49
  50 Of course this formula needs some minor adaptations (as is it depends on the absolute position of P for instance, so a little translation is needed
  51 first) but I think we can first forget about them.
  52 */
  53
  54 namespace Inkscape {
  55 namespace LivePathEffect {
  56
  57 LPEBendPath::LPEBendPath(LivePathEffectObject *lpeobject) :
  58     Effect(lpeobject),
  59     bend_path(_("Bend path"), _("Path along which to bend the original path"), "bendpath", &wr, this, "M0,0 L1,0"),
  60     prop_scale(_("Width"), _("Width of the path"), "prop_scale", &wr, this, 1),
  61     scale_y_rel(_("Width in units of length"), _("Scale the width of the path in units of its length"), "scale_y_rel", &wr, this, false),
  62     vertical_pattern(_("Original path is vertical"), _("Rotates the original 90 degrees, before bending it along the bend path"), "vertical", &wr, this, false)
  63 {
  64     registerParameter( dynamic_cast<Parameter *>(&bend_path) );
  65     registerParameter( dynamic_cast<Parameter *>(&prop_scale) );
  66     registerParameter( dynamic_cast<Parameter *>(&scale_y_rel) );
  67     registerParameter( dynamic_cast<Parameter *>(&vertical_pattern) );
  68
  69     prop_scale.param_set_digits(3);
  70     prop_scale.param_set_increments(0.01, 0.10);
  71
  72     concatenate_before_pwd2 = true;
  73
  74     groupSpecialBehavior = false;
  75 }
  76
  77 LPEBendPath::~LPEBendPath()
  78 {
  79
  80 }
  81
  82 void
  83 LPEBendPath::doBeforeEffect (SPLPEItem *lpeitem)
  84 {
  85     if(SP_IS_GROUP(lpeitem))
  86     {
  87         groupSpecialBehavior = true;
  88
  89         using namespace Geom;
  90         Piecewise<D2<SBasis> > pwd2;
  91         std::vector<Geom::Path> temppath;
  92
  93         recursive_original_bbox(SP_GROUP(lpeitem), pwd2, temppath);
  94
  95         for (unsigned int i=0; i < temppath.size(); i++) {
  96             pwd2.concat( temppath[i].toPwSb() );
  97         }
  98
  99         D2<Piecewise<SBasis> > d2pw = make_cuts_independant(pwd2);
 100         boundingbox_X = bounds_exact(d2pw[0]);
 101         boundingbox_Y = bounds_exact(d2pw[1]);
 102     }
 103
 104 }
 105
 106 Geom::Piecewise<Geom::D2<Geom::SBasis> >
 107 LPEBendPath::doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in)
 108 {
 109     using namespace Geom;
 110
 111 /* Much credit should go to jfb and mgsloan of lib2geom development for the code below! */
 112
 113     Piecewise<D2<SBasis> > uskeleton = arc_length_parametrization(Piecewise<D2<SBasis> >(bend_path.get_pwd2()),2,.1);
 114     uskeleton = remove_short_cuts(uskeleton,.01);
 115     Piecewise<D2<SBasis> > n = rot90(derivative(uskeleton));
 116     n = force_continuity(remove_short_cuts(n,.1));
 117
 118     D2<Piecewise<SBasis> > patternd2 = make_cuts_independant(pwd2_in);
 119     Piecewise<SBasis> x = vertical_pattern.get_value() ? Piecewise<SBasis>(patternd2[1]) : Piecewise<SBasis>(patternd2[0]);
 120     Piecewise<SBasis> y = vertical_pattern.get_value() ? Piecewise<SBasis>(patternd2[0]) : Piecewise<SBasis>(patternd2[1]);
 121
 122 //We use the group bounding box size or the path bbox size to translate well x and y
 123     if(groupSpecialBehavior == false)
 124     {
 125         boundingbox_X = bounds_exact(x);
 126         boundingbox_Y = bounds_exact(y);
 127     }
 128     x-= boundingbox_X.min();
 129     y-= boundingbox_Y.middle();
 130
 131   double scaling = uskeleton.cuts.back()/boundingbox_X.extent();
 132
 133   if (scaling != 1.0) {
 134         x*=scaling;
 135     }
 136
 137     if ( scale_y_rel.get_value() ) {
 138         y*=(scaling*prop_scale);
 139     } else {
 140         if (prop_scale != 1.0) y *= prop_scale;
 141     }
 142
 143
 144     Piecewise<D2<SBasis> > output = compose(uskeleton,x) + y*compose(n,x);
 145     return output;
 146 }
 147
 148 void
 149 LPEBendPath::resetDefaults(SPItem * item)
 150 {
 151     if (SP_IS_PATH(item) || SP_IS_GROUP(item))
 152     {
 153         // set the bend path to run horizontally in the middle of the bounding box of the original path
 154         using namespace Geom;
 155         Piecewise<D2<SBasis> > pwd2;
 156         std::vector<Geom::Path> temppath;
 157
 158         if (SP_IS_PATH(item))
 159         {
 160             //TODO : this won't work well with LPE stacking
 161             temppath = SVGD_to_2GeomPath( SP_OBJECT_REPR(item)->attribute("inkscape:original-d"));
 162         }
 163         else if (SP_IS_GROUP(item))
 164         {
 165             recursive_original_bbox(SP_GROUP(item), pwd2, temppath);
 166         }
 167
 168     for (unsigned int i=0; i < temppath.size(); i++) {
 169         pwd2.concat( temppath[i].toPwSb() );
 170         }
 171
 172     D2<Piecewise<SBasis> > d2pw = make_cuts_independant(pwd2);
 173     boundingbox_X = bounds_exact(d2pw[0]);
 174     boundingbox_Y = bounds_exact(d2pw[1]);
 175
 176
 177     Point start(boundingbox_X.min(), (boundingbox_Y.max()+boundingbox_Y.min())/2);
 178     Point end(boundingbox_X.max(), (boundingbox_Y.max()+boundingbox_Y.min())/2);
 179
 180     if ( Geom::are_near(start,end) ) {
 181        end += Point(1.,0.);
 182        }
 183     Geom::Path path;
 184     path.start( start );
 185     path.appendNew<Geom::LineSegment>( end );
 186     bend_path.param_set_and_write_new_value( path.toPwSb() );
 187
 188
 189     }
 190 }
 191
 192 void
 193 LPEBendPath::transform_multiply(Geom::Matrix const& postmul, bool set)
 194 {
 195     // TODO: implement correct transformation instead of this default behavior
 196     Effect::transform_multiply(postmul, set);
 197 }
 198
 199
 200 } // namespace LivePathEffect
 201 } /* namespace Inkscape */
 202
 203 /*
 204   Local Variables:
 205   mode:c++
 206   c-file-style:"stroustrup"
 207   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 208   indent-tabs-mode:nil
 209   fill-column:99
 210   End:
 211 */
 212 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :