src/live_effects/lpe-ruler.cpp

   1 #define INKSCAPE_LPE_RULER_CPP
   2
   3 /** \file
   4  * LPE <ruler> implementation, see lpe-ruler.cpp.
   5  */
   6
   7 /*
   8  * Authors:
   9  *   Maximilian Albert
  10  *
  11  * Copyright (C) Maximilian Albert 2008 <maximilian.albert@gmail.com>
  12  *
  13  * Released under GNU GPL, read the file 'COPYING' for more information
  14  */
  15
  16 #include "live_effects/lpe-ruler.h"
  17 #include <2geom/piecewise.h>
  18 #include <2geom/sbasis-geometric.h>
  19 #include "inkscape.h"
  20 #include "desktop.h"
  21
  22
  23 namespace Inkscape {
  24 namespace LivePathEffect {
  25
  26 static const Util::EnumData<MarkDirType> MarkDirData[] = {
  27     {MARKDIR_LEFT   , N_("Left"),  "left"},
  28     {MARKDIR_RIGHT  , N_("Right"), "right"},
  29     {MARKDIR_BOTH   , N_("Both"),  "both"},
  30 };
  31 static const Util::EnumDataConverter<MarkDirType> MarkDirTypeConverter(MarkDirData, sizeof(MarkDirData)/sizeof(*MarkDirData));
  32
  33 static const Util::EnumData<BorderMarkType> BorderMarkData[] = {
  34     {BORDERMARK_NONE    , N_("None"),  "none"},
  35     {BORDERMARK_START   , N_("Start"), "start"},
  36     {BORDERMARK_END     , N_("End"),   "end"},
  37     {BORDERMARK_BOTH    , N_("Both"),  "both"},
  38 };
  39 static const Util::EnumDataConverter<BorderMarkType> BorderMarkTypeConverter(BorderMarkData, sizeof(BorderMarkData)/sizeof(*BorderMarkData));
  40
  41 LPERuler::LPERuler(LivePathEffectObject *lpeobject) :
  42     Effect(lpeobject),
  43     mark_distance(_("Mark distance"), _("Distance between successive ruler marks"), "mark_distance", &wr, this, 20.0),
  44     mark_length(_("Major length"), _("Length of major ruler marks"), "mark_length", &wr, this, 14.0),
  45     minor_mark_length(_("Minor length"), _("Length of minor ruler marks"), "minor_mark_length", &wr, this, 7.0),
  46     major_mark_steps(_("Major steps"), _("Draw a major mark every ... steps"), "major_mark_steps", &wr, this, 5),
  47     shift(_("Shift marks by"), _("Shift marks by this many steps"), "shift", &wr, this, 0),
  48     mark_dir(_("Mark direction"), _("Direction of marks (when viewing along the path from start to end)"), "mark_dir", MarkDirTypeConverter, &wr, this, MARKDIR_LEFT),
  49     offset(_("Offset"), _("Offset of first mark"), "offset", &wr, this, 0.0),
  50     border_marks(_("Border marks"), _("Choose whether to draw marks at the beginning and end of the path"), "border_marks", BorderMarkTypeConverter, &wr, this, BORDERMARK_BOTH)
  51 {
  52     registerParameter(dynamic_cast<Parameter *>(&mark_distance));
  53     registerParameter(dynamic_cast<Parameter *>(&mark_length));
  54     registerParameter(dynamic_cast<Parameter *>(&minor_mark_length));
  55     registerParameter(dynamic_cast<Parameter *>(&major_mark_steps));
  56     registerParameter(dynamic_cast<Parameter *>(&shift));
  57     registerParameter(dynamic_cast<Parameter *>(&offset));
  58     registerParameter(dynamic_cast<Parameter *>(&mark_dir));
  59     registerParameter(dynamic_cast<Parameter *>(&border_marks));
  60
  61     major_mark_steps.param_make_integer();
  62     major_mark_steps.param_set_range(1, 1000);
  63     shift.param_make_integer();
  64
  65     mark_length.param_set_increments(1.0, 10.0);
  66     minor_mark_length.param_set_increments(1.0, 10.0);
  67     offset.param_set_increments(1.0, 10.0);
  68 }
  69
  70 LPERuler::~LPERuler()
  71 {
  72
  73 }
  74
  75 Geom::Point LPERuler::n_major;
  76 Geom::Point LPERuler::n_minor;
  77
  78 Geom::Piecewise<Geom::D2<Geom::SBasis> >
  79 LPERuler::ruler_mark(Geom::Point const &A, Geom::Point const &n, MarkType const &marktype)
  80 {
  81     using namespace Geom;
  82
  83     n_major = mark_length * n;
  84     n_minor = minor_mark_length * n;
  85
  86     Point C, D;
  87     switch (marktype) {
  88         case MARK_MAJOR:
  89             C = A;
  90             D = A + n_major;
  91             if (mark_dir == MARKDIR_BOTH)
  92                 C -= n_major;
  93             break;
  94         case MARK_MINOR:
  95             C = A;
  96             D = A + n_minor;
  97             if (mark_dir == MARKDIR_BOTH)
  98                 C -= n_minor;
  99             break;
 100         default:
 101             // do nothing
 102             break;
 103     }
 104
 105     Piecewise<D2<SBasis> > seg(D2<SBasis>(Linear(C[X], D[X]), Linear(C[Y], D[Y])));
 106     return seg;
 107 }
 108
 109 Geom::Piecewise<Geom::D2<Geom::SBasis> >
 110 LPERuler::doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in)
 111 {
 112     using namespace Geom;
 113
 114     const int mminterval = static_cast<int>(major_mark_steps);
 115     const int i_shift = static_cast<int>(shift) % mminterval;
 116     int sign = (mark_dir == MARKDIR_RIGHT ? 1 : -1 );
 117
 118     Piecewise<D2<SBasis> >output(pwd2_in);
 119     Piecewise<D2<SBasis> >speed = derivative(pwd2_in);
 120     Piecewise<SBasis> arclength = arcLengthSb(pwd2_in);
 121     double totlength = arclength.lastValue();
 122
 123     //find at which times to draw a mark:
 124     std::vector<double> s_cuts;
 125     for (double s = offset; s<totlength; s+=mark_distance){
 126         s_cuts.push_back(s);
 127     }
 128     std::vector<std::vector<double> > roots = multi_roots(arclength, s_cuts);
 129     std::vector<double> t_cuts;
 130     g_warning("times:");
 131     for (unsigned v=0; v<roots.size();v++){
 132         //FIXME: 2geom multi_roots solver seem to sometimes "repeat" solutions.
 133         //Here, we are supposed to have one and only one solution for each s.
 134         if(roots[v].size()>0)
 135             t_cuts.push_back(roots[v][0]);
 136     }
 137     //draw the marks
 138     for (unsigned i=0; i<t_cuts.size(); i++){
 139         Point A = pwd2_in(t_cuts[i]);
 140         Point n = rot90(unit_vector(speed(t_cuts[i])))*sign;
 141         if ((i % mminterval) == i_shift) {
 142             output.concat (ruler_mark(A, n, MARK_MAJOR));
 143         } else {
 144             output.concat (ruler_mark(A, n, MARK_MINOR));
 145         }
 146     }
 147     //eventually draw a mark at start
 148     if ((border_marks == BORDERMARK_START || border_marks == BORDERMARK_BOTH) && (offset != 0.0 || i_shift != 0)){
 149         Point A = pwd2_in.firstValue();
 150         Point n = rot90(unit_vector(speed.firstValue()))*sign;
 151         output.concat (ruler_mark(A, n, MARK_MAJOR));
 152     }
 153     //eventually draw a mark at end
 154     if (border_marks == BORDERMARK_END || border_marks == BORDERMARK_BOTH){
 155         Point A = pwd2_in.lastValue();
 156         Point n = rot90(unit_vector(speed.lastValue()))*sign;
 157         output.concat (ruler_mark(A, n, MARK_MAJOR));
 158     }
 159
 160     return output;
 161 }
 162
 163 } //namespace LivePathEffect
 164 } /* namespace Inkscape */
 165
 166 /*
 167   Local Variables:
 168   mode:c++
 169   c-file-style:"stroustrup"
 170   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 171   indent-tabs-mode:nil
 172   fill-column:99
 173   End:
 174 */
 175 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :