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 namespace Inkscape {
  23 namespace LivePathEffect {
  24
  25 static const Util::EnumData<MarkDirType> MarkDirData[] = {
  26     {MARKDIR_LEFT   , N_("Left"),  "left"},
  27     {MARKDIR_RIGHT  , N_("Right"), "right"},
  28     {MARKDIR_BOTH   , N_("Both"),  "both"},
  29 };
  30 static const Util::EnumDataConverter<MarkDirType> MarkDirTypeConverter(MarkDirData, sizeof(MarkDirData)/sizeof(*MarkDirData));
  31
  32 static const Util::EnumData<BorderMarkType> BorderMarkData[] = {
  33     {BORDERMARK_NONE    , N_("None"),  "none"},
  34     {BORDERMARK_START   , N_("Start"), "start"},
  35     {BORDERMARK_END     , N_("End"),   "end"},
  36     {BORDERMARK_BOTH    , N_("Both"),  "both"},
  37 };
  38 static const Util::EnumDataConverter<BorderMarkType> BorderMarkTypeConverter(BorderMarkData, sizeof(BorderMarkData)/sizeof(*BorderMarkData));
  39
  40 LPERuler::LPERuler(LivePathEffectObject *lpeobject) :
  41     Effect(lpeobject),
  42     mark_distance(_("Mark distance"), _("Distance between successive ruler marks"), "mark_distance", &wr, this, 20.0),
  43     mark_length(_("Major length"), _("Length of major ruler marks"), "mark_length", &wr, this, 14.0),
  44     minor_mark_length(_("Minor length"), _("Length of minor ruler marks"), "minor_mark_length", &wr, this, 7.0),
  45     major_mark_steps(_("Major steps"), _("Draw a major mark every ... steps"), "major_mark_steps", &wr, this, 5),
  46     shift(_("Shift marks by"), _("Shift marks by this many steps"), "shift", &wr, this, 0),
  47     mark_dir(_("Mark direction"), _("Direction of marks (when viewing along the path from start to end)"), "mark_dir", MarkDirTypeConverter, &wr, this, MARKDIR_LEFT),
  48     offset(_("Offset"), _("Offset of first mark"), "offset", &wr, this, 0.0),
  49     border_marks(_("Border marks"), _("Choose whether to draw marks at the beginning and end of the path"), "border_marks", BorderMarkTypeConverter, &wr, this, BORDERMARK_BOTH)
  50 {
  51     registerParameter(dynamic_cast<Parameter *>(&mark_distance));
  52     registerParameter(dynamic_cast<Parameter *>(&mark_length));
  53     registerParameter(dynamic_cast<Parameter *>(&minor_mark_length));
  54     registerParameter(dynamic_cast<Parameter *>(&major_mark_steps));
  55     registerParameter(dynamic_cast<Parameter *>(&shift));
  56     registerParameter(dynamic_cast<Parameter *>(&offset));
  57     registerParameter(dynamic_cast<Parameter *>(&mark_dir));
  58     registerParameter(dynamic_cast<Parameter *>(&border_marks));
  59
  60     major_mark_steps.param_make_integer();
  61     major_mark_steps.param_set_range(1, 1000);
  62     shift.param_make_integer();
  63
  64     mark_length.param_set_increments(1.0, 10.0);
  65     minor_mark_length.param_set_increments(1.0, 10.0);
  66     offset.param_set_increments(1.0, 10.0);
  67 }
  68
  69 LPERuler::~LPERuler()
  70 {
  71
  72 }
  73
  74 Geom::Point LPERuler::n_major;
  75 Geom::Point LPERuler::n_minor;
  76
  77 Geom::Piecewise<Geom::D2<Geom::SBasis> >
  78 LPERuler::ruler_mark(Geom::Point const &A, Geom::Point const &n, MarkType const &marktype)
  79 {
  80     using namespace Geom;
  81
  82     n_major = mark_length * n;
  83     n_minor = minor_mark_length * n;
  84
  85     Point C, D;
  86     switch (marktype) {
  87         case MARK_MAJOR:
  88             C = A;
  89             D = A + n_major;
  90             if (mark_dir == MARKDIR_BOTH)
  91                 C -= n_major;
  92             break;
  93         case MARK_MINOR:
  94             C = A;
  95             D = A + n_minor;
  96             if (mark_dir == MARKDIR_BOTH)
  97                 C -= n_minor;
  98             break;
  99         default:
 100             // do nothing
 101             break;
 102     }
 103
 104     Piecewise<D2<SBasis> > seg(D2<SBasis>(Linear(C[X], D[X]), Linear(C[Y], D[Y])));
 105     return seg;
 106 }
 107
 108 Geom::Piecewise<Geom::D2<Geom::SBasis> >
 109 LPERuler::doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in)
 110 {
 111     using namespace Geom;
 112
 113     Piecewise<D2<SBasis> > pwd2_arclength = arc_length_parametrization(pwd2_in);
 114     Point A(pwd2_arclength.firstValue());
 115     Point B(pwd2_arclength.lastValue());
 116     double path_length = Geom::length(pwd2_arclength);
 117
 118     Piecewise<D2<SBasis> > n = -rot90(unitVector(derivative(pwd2_arclength)));
 119     Piecewise<D2<SBasis> >output(pwd2_arclength);
 120
 121     if (mark_dir == MARKDIR_RIGHT) {
 122         n *= -1.0;
 123     }
 124
 125     int j = 0;
 126     const int mminterval = static_cast<int>(major_mark_steps);
 127     const int j_shift = static_cast<int>(shift) % mminterval;
 128
 129     /* draw the ruler */
 130     if ((border_marks == BORDERMARK_START || border_marks == BORDERMARK_BOTH) && (offset != 0.0 || j_shift != 0))
 131         output.concat (ruler_mark(A, n.firstValue(), MARK_MAJOR));
 132     for (double t = offset; t < path_length; t += mark_distance, ++j) {
 133         if ((j % mminterval) == j_shift) {
 134             output.concat (ruler_mark(pwd2_arclength(t), n(t), MARK_MAJOR));
 135         } else {
 136             output.concat (ruler_mark(pwd2_arclength(t), n(t), MARK_MINOR));
 137         }
 138     }
 139     if (border_marks == BORDERMARK_END || border_marks == BORDERMARK_BOTH)
 140         output.concat (ruler_mark(B, n.lastValue(), MARK_MAJOR));
 141
 142     return output;
 143 }
 144
 145 } //namespace LivePathEffect
 146 } /* namespace Inkscape */
 147
 148 /*
 149   Local Variables:
 150   mode:c++
 151   c-file-style:"stroustrup"
 152   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 153   indent-tabs-mode:nil
 154   fill-column:99
 155   End:
 156 */
 157 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :