1 #ifndef INKSCAPE_LIVEPATHEFFECT_H
2 #define INKSCAPE_LIVEPATHEFFECT_H
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 */
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 #include "knotholder.h"
21 #include "parameter/bool.h"
23 #define LPE_CONVERSION_TOLERANCE 0.01 // FIXME: find good solution for this.
25 #define LPE_ENABLE_TEST_EFFECTS
27 struct SPDocument;
28 struct SPDesktop;
29 struct SPItem;
30 class NArtBpath;
31 struct LivePathEffectObject;
33 namespace Gtk {
34 class Widget;
35 class VBox;
36 class Tooltips;
37 }
39 namespace Geom {
40 class Matrix;
41 }
43 namespace Inkscape {
45 namespace XML {
46 class Node;
47 }
49 namespace NodePath {
50 class Path ;
51 }
53 namespace LivePathEffect {
55 enum EffectType {
56 BEND_PATH = 0,
57 PATTERN_ALONG_PATH,
58 SKETCH,
59 VONKOCH,
60 KNOT,
61 #ifdef LPE_ENABLE_TEST_EFFECTS
62 DOEFFECTSTACK_TEST,
63 #endif
64 GEARS,
65 CURVE_STITCH,
66 CIRCLE_WITH_RADIUS,
67 PERSPECTIVE_PATH,
68 SPIRO,
69 LATTICE,
70 ENVELOPE,
71 CONSTRUCT_GRID,
72 PERP_BISECTOR,
73 TANGENT_TO_CURVE,
74 INVALID_LPE // This must be last
75 };
77 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
78 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
80 class Effect {
81 public:
82 static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
83 static void createAndApply(const char* name, SPDocument *doc, SPItem *item);
84 static void createAndApply(EffectType type, SPDocument *doc, SPItem *item);
86 virtual ~Effect();
88 EffectType effectType ();
90 virtual void doOnApply (SPLPEItem *lpeitem);
92 virtual void doBeforeEffect (SPLPEItem *lpeitem);
94 virtual void doEffect (SPCurve * curve);
96 virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
98 virtual void resetDefaults(SPItem * item);
100 virtual void setup_nodepath(Inkscape::NodePath::Path *np);
102 virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
104 virtual bool providesKnotholder() { return false; }
105 void addPointParamHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
106 virtual void addKnotHolderHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
108 Glib::ustring getName();
109 Inkscape::XML::Node * getRepr();
110 SPDocument * getSPDoc();
111 LivePathEffectObject * getLPEObj() {return lpeobj;};
112 Parameter * getParameter(const char * key);
114 void readallParameters(Inkscape::XML::Node * repr);
115 void setParameter(const gchar * key, const gchar * new_value);
117 inline bool isVisible() { return is_visible; }
119 void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
121 protected:
122 Effect(LivePathEffectObject *lpeobject);
124 // provide a set of doEffect functions so the developer has a choice
125 // of what kind of input/output parameters he desires.
126 // the order in which they appear is the order in which they are
127 // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
128 // doEffect(std::vector<Geom::Path> )
129 virtual std::vector<Geom::Path>
130 doEffect_path (std::vector<Geom::Path> const & path_in);
131 virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
132 doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
134 void registerParameter(Parameter * param);
135 void registerKnotHolderHandle(SPKnotHolderSetFunc set_func, SPKnotHolderGetFunc get_func);
136 Parameter * getNextOncanvasEditableParam();
138 std::vector<Parameter *> param_vector;
139 int oncanvasedit_it;
140 BoolParam is_visible;
142 Inkscape::UI::Widget::Registry wr;
144 LivePathEffectObject *lpeobj;
146 // this boolean defaults to false, it concatenates the input path to one pwd2,
147 // instead of normally 'splitting' the path into continuous pwd2 paths.
148 bool concatenate_before_pwd2;
150 private:
151 Effect(const Effect&);
152 Effect& operator=(const Effect&);
153 };
156 } //namespace LivePathEffect
157 } //namespace Inkscape
159 #endif