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 <2geom/forward.h>
18 #include "ui/widget/registry.h"
19 #include "util/enums.h"
20 #include "sp-lpe-item.h"
21 #include "knotholder.h"
22 #include "parameter/bool.h"
24 #define LPE_CONVERSION_TOLERANCE 0.01 // FIXME: find good solution for this.
26 #define LPE_ENABLE_TEST_EFFECTS
28 struct SPDocument;
29 struct SPDesktop;
30 struct SPItem;
31 class SPNodeContext;
32 class NArtBpath;
33 struct LivePathEffectObject;
35 namespace Gtk {
36 class Widget;
37 class VBox;
38 class Tooltips;
39 }
41 namespace Inkscape {
43 namespace XML {
44 class Node;
45 }
47 namespace NodePath {
48 class Path ;
49 }
51 namespace LivePathEffect {
53 enum EffectType {
54 BEND_PATH = 0,
55 PATTERN_ALONG_PATH,
56 FREEHAND_SHAPE,
57 SKETCH,
58 VONKOCH,
59 KNOT,
60 #ifdef LPE_ENABLE_TEST_EFFECTS
61 DOEFFECTSTACK_TEST,
62 #endif
63 GEARS,
64 CURVE_STITCH,
65 CIRCLE_WITH_RADIUS,
66 PERSPECTIVE_PATH,
67 SPIRO,
68 LATTICE,
69 ENVELOPE,
70 CONSTRUCT_GRID,
71 PERP_BISECTOR,
72 TANGENT_TO_CURVE,
73 MIRROR_SYMMETRY,
74 CIRCLE_3PTS,
75 ANGLE_BISECTOR,
76 PARALLEL,
77 COPY_ROTATE,
78 OFFSET,
79 RULER,
80 BOOLOPS,
81 INVALID_LPE // This must be last
82 };
84 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
85 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
87 enum LPEPathFlashType {
88 SUPPRESS_FLASH,
89 // PERMANENT_FLASH,
90 DEFAULT
91 };
93 class Effect {
94 public:
95 static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
96 static void createAndApply(const char* name, SPDocument *doc, SPItem *item);
97 static void createAndApply(EffectType type, SPDocument *doc, SPItem *item);
99 virtual ~Effect();
101 EffectType effectType ();
103 virtual void doOnApply (SPLPEItem *lpeitem);
104 virtual void doBeforeEffect (SPLPEItem *lpeitem);
106 void writeParamsToSVG();
108 virtual void acceptParamPath (SPPath *param_path);
109 virtual int acceptsNumParams() { return 0; }
110 void doAcceptPathPreparations(SPLPEItem *lpeitem);
112 inline bool pathParamAccepted() { return done_pathparam_set; }
114 virtual void doEffect (SPCurve * curve);
116 virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
118 virtual void resetDefaults(SPItem * item);
120 virtual void setup_nodepath(Inkscape::NodePath::Path *np);
122 virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
124 // TODO: providesKnotholder() is currently used as an indicator of whether a nodepath is
125 // created for an item or not. When we allow both at the same time, this needs rethinking!
126 bool providesKnotholder();
127 // TODO: in view of providesOwnFlashPaths() below, this is somewhat redundant
128 // (but spiro lpe still needs it!)
129 virtual LPEPathFlashType pathFlashType() { return DEFAULT; }
130 void addHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
131 void addPointParamHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
133 void addHelperPaths(SPLPEItem *lpeitem, SPDesktop *desktop);
134 inline bool providesOwnFlashPaths() {
135 return provides_own_flash_paths || show_orig_path;
136 }
137 inline bool showOrigPath() { return show_orig_path; }
139 Glib::ustring getName();
140 Inkscape::XML::Node * getRepr();
141 SPDocument * getSPDoc();
142 LivePathEffectObject * getLPEObj() {return lpeobj;};
143 Parameter * getParameter(const char * key);
145 void readallParameters(Inkscape::XML::Node * repr);
146 void setParameter(const gchar * key, const gchar * new_value);
148 inline bool isVisible() { return is_visible; }
150 void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
152 protected:
153 Effect(LivePathEffectObject *lpeobject);
155 // provide a set of doEffect functions so the developer has a choice
156 // of what kind of input/output parameters he desires.
157 // the order in which they appear is the order in which they are
158 // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
159 // doEffect(std::vector<Geom::Path> )
160 virtual std::vector<Geom::Path>
161 doEffect_path (std::vector<Geom::Path> const & path_in);
162 virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
163 doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
165 void registerParameter(Parameter * param);
166 void registerKnotHolderHandle(KnotHolderEntity* entity, const char* descr);
167 Parameter * getNextOncanvasEditableParam();
169 virtual void addHelperPathsImpl(SPLPEItem *lpeitem, SPDesktop *desktop);
171 std::vector<Parameter *> param_vector;
172 std::vector<std::pair<KnotHolderEntity*, const char*> > kh_entity_vector;
173 int oncanvasedit_it;
174 BoolParam is_visible;
175 bool done_pathparam_set;
177 bool show_orig_path; // set this to true in derived effects to automatically have the original
178 // path displayed as helperpath
180 Inkscape::UI::Widget::Registry wr;
182 LivePathEffectObject *lpeobj;
184 // this boolean defaults to false, it concatenates the input path to one pwd2,
185 // instead of normally 'splitting' the path into continuous pwd2 paths.
186 bool concatenate_before_pwd2;
188 private:
189 bool provides_own_flash_paths; // if true, the standard flash path is suppressed
191 Effect(const Effect&);
192 Effect& operator=(const Effect&);
193 };
196 } //namespace LivePathEffect
197 } //namespace Inkscape
199 #endif
201 /*
202 Local Variables:
203 mode:c++
204 c-file-style:"stroustrup"
205 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
206 indent-tabs-mode:nil
207 fill-column:99
208 End:
209 */
210 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :