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 <libnr/n-art-bpath.h>
  16 #include "libnr/n-art-bpath-2geom.h"
  17 #include "svg/svg.h"
  18 #include "ui/widget/scalar.h"
  19
  20 #include <2geom/sbasis.h>
  21 #include <2geom/sbasis-geometric.h>
  22 #include <2geom/bezier-to-sbasis.h>
  23 #include <2geom/sbasis-to-bezier.h>
  24 #include <2geom/d2.h>
  25 #include <2geom/piecewise.h>
  26
  27 #include <algorithm>
  28 using std::vector;
  29
  30
  31 /* Theory in e-mail from J.F. Barraud
  32 Let B be the skeleton path, and P the pattern (the path to be deformed).
  33
  34 P is a map t --> P(t) = ( x(t), y(t) ).
  35 B is a map t --> B(t) = ( a(t), b(t) ).
  36
  37 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
  38 U(s) is s itself.
  39
  40 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).
  41
  42 The basic deformation associated to B is then given by:
  43
  44    (x,y) --> U(x)+y*N(x)
  45
  46 (i.e. we go for distance x along the path, and then for distance y along the normal)
  47
  48 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
  49 first) but I think we can first forget about them.
  50 */
  51
  52 namespace Inkscape {
  53 namespace LivePathEffect {
  54
  55 LPEBendPath::LPEBendPath(LivePathEffectObject *lpeobject) :
  56     Effect(lpeobject),
  57     bend_path(_("Bend path"), _("Path along which to bend the original path"), "bendpath", &wr, this, "M0,0 L1,0"),
  58     prop_scale(_("Width"), _("Width of the path"), "prop_scale", &wr, this, 1),
  59     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),
  60     vertical_pattern(_("Original path is vertical"), _("Rotates the original 90 degrees, before bending it along the bend path"), "vertical", &wr, this, false)
  61 {
  62     registerParameter( dynamic_cast<Parameter *>(&bend_path) );
  63     registerParameter( dynamic_cast<Parameter *>(&prop_scale) );
  64     registerParameter( dynamic_cast<Parameter *>(&scale_y_rel) );
  65     registerParameter( dynamic_cast<Parameter *>(&vertical_pattern) );
  66
  67     prop_scale.param_set_digits(3);
  68     prop_scale.param_set_increments(0.01, 0.10);
  69
  70     concatenate_before_pwd2 = true;
  71 }
  72
  73 LPEBendPath::~LPEBendPath()
  74 {
  75
  76 }
  77
  78 void
  79 LPEBendPath::doBeforeEffect (SPLPEItem *lpeitem)
  80 {
  81     // get the item bounding box
  82     original_bbox(lpeitem);
  83 }
  84
  85 Geom::Piecewise<Geom::D2<Geom::SBasis> >
  86 LPEBendPath::doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in)
  87 {
  88     using namespace Geom;
  89
  90 /* Much credit should go to jfb and mgsloan of lib2geom development for the code below! */
  91
  92     Piecewise<D2<SBasis> > uskeleton = arc_length_parametrization(Piecewise<D2<SBasis> >(bend_path.get_pwd2()),2,.1);
  93     uskeleton = remove_short_cuts(uskeleton,.01);
  94     Piecewise<D2<SBasis> > n = rot90(derivative(uskeleton));
  95     n = force_continuity(remove_short_cuts(n,.1));
  96
  97     D2<Piecewise<SBasis> > patternd2 = make_cuts_independant(pwd2_in);
  98     Piecewise<SBasis> x = vertical_pattern.get_value() ? Piecewise<SBasis>(patternd2[1]) : Piecewise<SBasis>(patternd2[0]);
  99     Piecewise<SBasis> y = vertical_pattern.get_value() ? Piecewise<SBasis>(patternd2[0]) : Piecewise<SBasis>(patternd2[1]);
 100
 101 //We use the group bounding box size or the path bbox size to translate well x and y
 102     x-= vertical_pattern.get_value() ? boundingbox_Y.min() : boundingbox_X.min();
 103     y-= vertical_pattern.get_value() ? boundingbox_X.middle() : boundingbox_Y.middle();
 104
 105   double scaling = uskeleton.cuts.back()/boundingbox_X.extent();
 106
 107   if (scaling != 1.0) {
 108         x*=scaling;
 109     }
 110
 111     if ( scale_y_rel.get_value() ) {
 112         y*=(scaling*prop_scale);
 113     } else {
 114         if (prop_scale != 1.0) y *= prop_scale;
 115     }
 116
 117
 118     Piecewise<D2<SBasis> > output = compose(uskeleton,x) + y*compose(n,x);
 119     return output;
 120 }
 121
 122 void
 123 LPEBendPath::resetDefaults(SPItem * item)
 124 {
 125     original_bbox(SP_LPE_ITEM(item));
 126
 127     Geom::Point start(boundingbox_X.min(), (boundingbox_Y.max()+boundingbox_Y.min())/2);
 128     Geom::Point end(boundingbox_X.max(), (boundingbox_Y.max()+boundingbox_Y.min())/2);
 129
 130     if ( Geom::are_near(start,end) ) {
 131         end += Geom::Point(1.,0.);
 132     }
 133
 134     Geom::Path path;
 135     path.start( start );
 136     path.appendNew<Geom::LineSegment>( end );
 137     bend_path.param_set_and_write_new_value( path.toPwSb() );
 138 }
 139
 140 void
 141 LPEBendPath::transform_multiply(Geom::Matrix const& postmul, bool set)
 142 {
 143     // TODO: implement correct transformation instead of this default behavior
 144     Effect::transform_multiply(postmul, set);
 145 }
 146
 147
 148 } // namespace LivePathEffect
 149 } /* namespace Inkscape */
 150
 151 /*
 152   Local Variables:
 153   mode:c++
 154   c-file-style:"stroustrup"
 155   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 156   indent-tabs-mode:nil
 157   fill-column:99
 158   End:
 159 */
 160 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :