Code

799c4cf755260ba09a9f91b510e2ab886354d190
[inkscape.git] / src / live_effects / effect.h
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     // TODO: providesKnotholder() is currently used as an indicator of whether a nodepath is
120     // created for an item or not. When we allow both at the same time, this needs rethinking!
121     bool providesKnotholder() { return (kh_entity_vector.size() > 0); }
122     // TODO: in view of providesOwnFlashPaths() below, this is somewhat redundant
123     //       (but spiro lpe still needs it!)
124     virtual LPEPathFlashType pathFlashType() { return DEFAULT; }
125     void addHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
127     void addHelperPaths(SPLPEItem *lpeitem, SPDesktop *desktop);
128     inline bool providesOwnFlashPaths() {
129         return provides_own_flash_paths || show_orig_path;
130     }
131     inline bool showOrigPath() { return show_orig_path; }
133     Glib::ustring          getName();
134     Inkscape::XML::Node *  getRepr();
135     SPDocument *           getSPDoc();
136     LivePathEffectObject * getLPEObj() {return lpeobj;};
137     Parameter *            getParameter(const char * key);
139     void readallParameters(Inkscape::XML::Node * repr);
140     void setParameter(const gchar * key, const gchar * new_value);
142     inline bool isVisible() { return is_visible; }
144     void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
146 protected:
147     Effect(LivePathEffectObject *lpeobject);
149     // provide a set of doEffect functions so the developer has a choice
150     // of what kind of input/output parameters he desires.
151     // the order in which they appear is the order in which they are
152     // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
153     // doEffect(std::vector<Geom::Path> )
154     virtual std::vector<Geom::Path>
155             doEffect_path (std::vector<Geom::Path> const & path_in);
156     virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
157             doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
159     void registerParameter(Parameter * param);
160     void registerKnotHolderHandle(KnotHolderEntity* entity, const char* descr);
161     void addPointParamHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
162     Parameter * getNextOncanvasEditableParam();
164     virtual void addHelperPathsImpl(SPLPEItem *lpeitem, SPDesktop *desktop);
166     std::vector<Parameter *> param_vector;
167     std::vector<std::pair<KnotHolderEntity*, const char*> > kh_entity_vector;
168     int oncanvasedit_it;
169     BoolParam is_visible;
170     bool done_pathparam_set;
172     bool show_orig_path; // set this to true in derived effects to automatically have the original
173                          // path displayed as helperpath
175     Inkscape::UI::Widget::Registry wr;
177     LivePathEffectObject *lpeobj;
179     // this boolean defaults to false, it concatenates the input path to one pwd2,
180     // instead of normally 'splitting' the path into continuous pwd2 paths.
181     bool concatenate_before_pwd2;
183 private:
184     bool provides_own_flash_paths; // if true, the standard flash path is suppressed
186     Effect(const Effect&);
187     Effect& operator=(const Effect&);
188 };
191 } //namespace LivePathEffect
192 } //namespace Inkscape
194 #endif
196 /*
197   Local Variables:
198   mode:c++
199   c-file-style:"stroustrup"
200   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
201   indent-tabs-mode:nil
202   fill-column:99
203   End:
204 */
205 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :