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 SPNodeContext;
31 class NArtBpath;
32 struct LivePathEffectObject;
34 namespace Gtk {
35 class Widget;
36 class VBox;
37 class Tooltips;
38 }
40 namespace Geom {
41 class Matrix;
42 }
44 namespace Inkscape {
46 namespace XML {
47 class Node;
48 }
50 namespace NodePath {
51 class Path ;
52 }
54 namespace LivePathEffect {
56 enum EffectType {
57 BEND_PATH = 0,
58 PATTERN_ALONG_PATH,
59 SKETCH,
60 VONKOCH,
61 KNOT,
62 #ifdef LPE_ENABLE_TEST_EFFECTS
63 DOEFFECTSTACK_TEST,
64 #endif
65 GEARS,
66 CURVE_STITCH,
67 CIRCLE_WITH_RADIUS,
68 PERSPECTIVE_PATH,
69 SPIRO,
70 LATTICE,
71 ENVELOPE,
72 CONSTRUCT_GRID,
73 PERP_BISECTOR,
74 TANGENT_TO_CURVE,
75 MIRROR_REFLECT,
76 INVALID_LPE // This must be last
77 };
79 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
80 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
82 enum LPEPathFlashType {
83 SUPPRESS_FLASH,
84 PERMANENT_FLASH,
85 DEFAULT
86 };
88 class Effect {
89 public:
90 static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
91 static void createAndApply(const char* name, SPDocument *doc, SPItem *item);
92 static void createAndApply(EffectType type, SPDocument *doc, SPItem *item);
94 virtual ~Effect();
96 EffectType effectType ();
98 virtual void doOnApply (SPLPEItem *lpeitem);
99 virtual void doBeforeEffect (SPLPEItem *lpeitem);
101 void writeParamsToSVG();
103 virtual void acceptParamPath (SPPath *param_path);
104 virtual int acceptsNumParams() { return 0; }
105 void doAcceptPathPreparations(SPLPEItem *lpeitem);
107 inline bool pathParamAccepted() { return done_pathparam_set; }
109 virtual void doEffect (SPCurve * curve);
111 virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
113 virtual void resetDefaults(SPItem * item);
115 virtual void setup_nodepath(Inkscape::NodePath::Path *np);
117 virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
119 bool providesKnotholder() { return (kh_entity_vector.size() > 0); }
120 virtual LPEPathFlashType pathFlashType() { return DEFAULT; }
121 void addHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
123 void addHelperPaths(SPLPEItem *lpeitem, SPDesktop *desktop);
124 inline bool providesOwnFlashPaths() {
125 return provides_own_flash_paths || show_orig_path;
126 }
128 Glib::ustring getName();
129 Inkscape::XML::Node * getRepr();
130 SPDocument * getSPDoc();
131 LivePathEffectObject * getLPEObj() {return lpeobj;};
132 Parameter * getParameter(const char * key);
134 void readallParameters(Inkscape::XML::Node * repr);
135 void setParameter(const gchar * key, const gchar * new_value);
137 inline bool isVisible() { return is_visible; }
139 void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
141 protected:
142 Effect(LivePathEffectObject *lpeobject);
144 // provide a set of doEffect functions so the developer has a choice
145 // of what kind of input/output parameters he desires.
146 // the order in which they appear is the order in which they are
147 // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
148 // doEffect(std::vector<Geom::Path> )
149 virtual std::vector<Geom::Path>
150 doEffect_path (std::vector<Geom::Path> const & path_in);
151 virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
152 doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
154 void registerParameter(Parameter * param);
155 void registerKnotHolderHandle(KnotHolderEntity* entity, const char* descr);
156 void addPointParamHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
157 Parameter * getNextOncanvasEditableParam();
159 virtual void addHelperPathsImpl(SPLPEItem *lpeitem, SPDesktop *desktop);
161 std::vector<Parameter *> param_vector;
162 std::vector<std::pair<KnotHolderEntity*, const char*> > kh_entity_vector;
163 int oncanvasedit_it;
164 BoolParam is_visible;
165 bool done_pathparam_set;
167 bool show_orig_path; // set this to true in derived effects to automatically have the original
168 // path displayed as helperpath
170 Inkscape::UI::Widget::Registry wr;
172 LivePathEffectObject *lpeobj;
174 // this boolean defaults to false, it concatenates the input path to one pwd2,
175 // instead of normally 'splitting' the path into continuous pwd2 paths.
176 bool concatenate_before_pwd2;
178 private:
179 bool provides_own_flash_paths; // if true, the standard flash path is suppressed
181 Effect(const Effect&);
182 Effect& operator=(const Effect&);
183 };
186 } //namespace LivePathEffect
187 } //namespace Inkscape
189 #endif
191 /*
192 Local Variables:
193 mode:c++
194 c-file-style:"stroustrup"
195 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
196 indent-tabs-mode:nil
197 fill-column:99
198 End:
199 */
200 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :