src/live_effects/effect.h

   1 #ifndef INKSCAPE_LIVEPATHEFFECT_H
   2 #define INKSCAPE_LIVEPATHEFFECT_H
   3
   4 /*
   5  * Inkscape::LivePathEffect
   6  *
   7 * Copyright (C) Johan Engelen 2007-2008 <j.b.c.engelen@utwente.nl>
   8  *
   9  * Released under GNU GPL, read the file 'COPYING' for more information
  10  */
  11
  12
  13 #include "display/display-forward.h"
  14 #include <map>
  15 #include <glibmm/ustring.h>
  16 #include <2geom/path.h>
  17 #include "ui/widget/registry.h"
  18 #include "util/enums.h"
  19 #include "sp-lpe-item.h"
  20
  21 #define  LPE_CONVERSION_TOLERANCE 0.01    // FIXME: find good solution for this.
  22
  23 #define LPE_ENABLE_TEST_EFFECTS
  24
  25 struct SPDocument;
  26 struct SPDesktop;
  27 struct SPItem;
  28 class NArtBpath;
  29 struct LivePathEffectObject;
  30
  31 namespace Gtk {
  32     class Widget;
  33     class VBox;
  34     class Tooltips;
  35 }
  36
  37 namespace Geom {
  38     class Matrix;
  39 }
  40
  41 namespace Inkscape {
  42
  43 namespace XML {
  44     class Node;
  45 }
  46
  47 namespace NodePath {
  48     class Path ;
  49 }
  50
  51 namespace LivePathEffect {
  52
  53 enum EffectType {
  54     BEND_PATH = 0,
  55     PATTERN_ALONG_PATH,
  56     SKETCH,
  57     VONKOCH,
  58     KNOT,
  59 #ifdef LPE_ENABLE_TEST_EFFECTS
  60     SLANT,
  61     DOEFFECTSTACK_TEST,
  62 #endif
  63     GEARS,
  64     CURVE_STITCH,
  65     CIRCLE_WITH_RADIUS,
  66     PERSPECTIVE_PATH,
  67     SPIRO,
  68     INVALID_LPE // This must be last
  69 };
  70
  71 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
  72 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
  73
  74 class Parameter;
  75
  76 class Effect {
  77 public:
  78     static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
  79
  80     virtual ~Effect();
  81
  82     virtual void doBeforeEffect (SPLPEItem *lpeitem);
  83
  84     virtual void doEffect (SPCurve * curve);
  85
  86     virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
  87
  88     virtual void resetDefaults(SPItem * item);
  89
  90     virtual void setup_nodepath(Inkscape::NodePath::Path *np);
  91
  92     virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
  93
  94     Glib::ustring          getName();
  95     Inkscape::XML::Node *  getRepr();
  96     SPDocument *           getSPDoc();
  97     LivePathEffectObject * getLPEObj() {return lpeobj;};
  98     Parameter *            getParameter(const char * key);
  99
 100     void readallParameters(Inkscape::XML::Node * repr);
 101     void setParameter(const gchar * key, const gchar * new_value);
 102
 103     void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
 104
 105 protected:
 106     Effect(LivePathEffectObject *lpeobject);
 107
 108     // provide a set of doEffect functions so the developer has a choice
 109     // of what kind of input/output parameters he desires.
 110     // the order in which they appear is the order in which they are
 111     // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
 112     // doEffect(std::vector<Geom::Path> )
 113     virtual NArtBpath *
 114             doEffect_nartbpath (NArtBpath * path_in);
 115     virtual std::vector<Geom::Path>
 116             doEffect_path (std::vector<Geom::Path> const & path_in);
 117     virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
 118             doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
 119
 120     void registerParameter(Parameter * param);
 121     Parameter * getNextOncanvasEditableParam();
 122
 123     std::vector<Parameter *> param_vector;
 124     int oncanvasedit_it;
 125     Inkscape::UI::Widget::Registry wr;
 126
 127     LivePathEffectObject *lpeobj;
 128
 129     // this boolean defaults to false, it concatenates the input path to one pwd2,
 130     // instead of normally 'splitting' the path into continuous pwd2 paths.
 131     bool concatenate_before_pwd2;
 132
 133 private:
 134     Effect(const Effect&);
 135     Effect& operator=(const Effect&);
 136 };
 137
 138
 139 } //namespace LivePathEffect
 140 } //namespace Inkscape
 141
 142 #endif