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 CONSTRUCT_GRID,
70 ENVELOPE,
71 PERP_BISECTOR,
72 TANGENT_TO_CURVE,
73 INVALID_LPE // This must be last
74 };
76 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
77 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
79 class Effect {
80 public:
81 static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
83 virtual ~Effect();
85 EffectType effectType ();
87 virtual void doOnApply (SPLPEItem *lpeitem);
89 virtual void doBeforeEffect (SPLPEItem *lpeitem);
91 virtual void doEffect (SPCurve * curve);
93 virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
95 virtual void resetDefaults(SPItem * item);
97 virtual void setup_nodepath(Inkscape::NodePath::Path *np);
99 virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
101 bool providesKnotholder() { return knotholder_func_vector.size() > 0; }
102 void addHandles(SPKnotHolder *knotholder);
104 Glib::ustring getName();
105 Inkscape::XML::Node * getRepr();
106 SPDocument * getSPDoc();
107 LivePathEffectObject * getLPEObj() {return lpeobj;};
108 Parameter * getParameter(const char * key);
110 void readallParameters(Inkscape::XML::Node * repr);
111 void setParameter(const gchar * key, const gchar * new_value);
113 inline bool isVisible() { return is_visible; }
115 void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
117 protected:
118 Effect(LivePathEffectObject *lpeobject);
120 // provide a set of doEffect functions so the developer has a choice
121 // of what kind of input/output parameters he desires.
122 // the order in which they appear is the order in which they are
123 // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
124 // doEffect(std::vector<Geom::Path> )
125 virtual NArtBpath *
126 doEffect_nartbpath (NArtBpath const * path_in) __attribute__ ((deprecated));
127 virtual std::vector<Geom::Path>
128 doEffect_path (std::vector<Geom::Path> const & path_in);
129 virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
130 doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
132 void registerParameter(Parameter * param);
133 void registerKnotHolderHandle(SPKnotHolderSetFunc set_func, SPKnotHolderGetFunc get_func);
134 Parameter * getNextOncanvasEditableParam();
136 std::vector<Parameter *> param_vector;
137 std::vector<std::pair<SPKnotHolderSetFunc, SPKnotHolderGetFunc> > knotholder_func_vector;
138 int oncanvasedit_it;
139 BoolParam is_visible;
141 Inkscape::UI::Widget::Registry wr;
143 LivePathEffectObject *lpeobj;
145 // this boolean defaults to false, it concatenates the input path to one pwd2,
146 // instead of normally 'splitting' the path into continuous pwd2 paths.
147 bool concatenate_before_pwd2;
149 private:
150 Effect(const Effect&);
151 Effect& operator=(const Effect&);
152 };
155 } //namespace LivePathEffect
156 } //namespace Inkscape
158 #endif