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     DOEFFECTSTACK_TEST,
  61 #endif
  62     GEARS,
  63     CURVE_STITCH,
  64     CIRCLE_WITH_RADIUS,
  65     PERSPECTIVE_PATH,
  66     SPIRO,
  67     CONSTRUCT_GRID,
  68     ENVELOPE,
  69     PERP_BISECTOR,
  70     INVALID_LPE // This must be last
  71 };
  72
  73 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
  74 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
  75
  76 class Parameter;
  77
  78 class Effect {
  79 public:
  80     static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
  81
  82     virtual ~Effect();
  83
  84     EffectType effectType ();
  85
  86     virtual void doBeforeEffect (SPLPEItem *lpeitem);
  87
  88     virtual void doEffect (SPCurve * curve);
  89
  90     virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
  91
  92     virtual void resetDefaults(SPItem * item);
  93
  94     virtual void setup_nodepath(Inkscape::NodePath::Path *np);
  95
  96     virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
  97
  98     Glib::ustring          getName();
  99     Inkscape::XML::Node *  getRepr();
 100     SPDocument *           getSPDoc();
 101     LivePathEffectObject * getLPEObj() {return lpeobj;};
 102     Parameter *            getParameter(const char * key);
 103
 104     void readallParameters(Inkscape::XML::Node * repr);
 105     void setParameter(const gchar * key, const gchar * new_value);
 106
 107     void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
 108
 109 protected:
 110     Effect(LivePathEffectObject *lpeobject);
 111
 112     // provide a set of doEffect functions so the developer has a choice
 113     // of what kind of input/output parameters he desires.
 114     // the order in which they appear is the order in which they are
 115     // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
 116     // doEffect(std::vector<Geom::Path> )
 117     virtual NArtBpath *
 118             doEffect_nartbpath (NArtBpath const * path_in) __attribute__ ((deprecated));
 119     virtual std::vector<Geom::Path>
 120             doEffect_path (std::vector<Geom::Path> const & path_in);
 121     virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
 122             doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
 123
 124     void registerParameter(Parameter * param);
 125     Parameter * getNextOncanvasEditableParam();
 126
 127     std::vector<Parameter *> param_vector;
 128     int oncanvasedit_it;
 129     Inkscape::UI::Widget::Registry wr;
 130
 131     LivePathEffectObject *lpeobj;
 132
 133     // this boolean defaults to false, it concatenates the input path to one pwd2,
 134     // instead of normally 'splitting' the path into continuous pwd2 paths.
 135     bool concatenate_before_pwd2;
 136
 137 private:
 138     Effect(const Effect&);
 139     Effect& operator=(const Effect&);
 140 };
 141
 142
 143 } //namespace LivePathEffect
 144 } //namespace Inkscape
 145
 146 #endif