Code

change doEffect functions to use const& parameters
[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"
21 #define  LPE_CONVERSION_TOLERANCE 0.01    // FIXME: find good solution for this.
23 #define LPE_ENABLE_TEST_EFFECTS
25 struct SPDocument;
26 struct SPDesktop;
27 struct SPItem;
28 class NArtBpath;
29 struct LivePathEffectObject;
31 namespace Gtk {
32     class Widget;
33     class VBox;
34     class Tooltips;
35 }
37 namespace Geom {
38     class Matrix;
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     SKETCH,
57     VONKOCH,
58     KNOT,
59 #ifdef LPE_ENABLE_TEST_EFFECTS
60     SLANT,
61     DOEFFECTSTACK_TEST,
62 #endif
63     GEARS,
64     CURVE_STITCH,
65     CIRCLE_WITH_RADIUS,
66     PERSPECTIVE_PATH,
67     INVALID_LPE // This must be last
68 };
70 extern const Util::EnumData<EffectType> LPETypeData[INVALID_LPE];
71 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
73 class Parameter;
75 class Effect {
76 public:
77     static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
79     virtual ~Effect();
81     virtual void doBeforeEffect (SPLPEItem *lpeitem);
83     virtual void doEffect (SPCurve * curve);
85     virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
87     virtual void resetDefaults(SPItem * item);
89     virtual void setup_nodepath(Inkscape::NodePath::Path *np);
91     virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
93     Glib::ustring          getName();
94     Inkscape::XML::Node *  getRepr();
95     SPDocument *           getSPDoc();
96     LivePathEffectObject * getLPEObj() {return lpeobj;};
97     Parameter *            getParameter(const char * key);
99     void readallParameters(Inkscape::XML::Node * repr);
100     void setParameter(const gchar * key, const gchar * new_value);
102     void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
104 protected:
105     Effect(LivePathEffectObject *lpeobject);
107     // provide a set of doEffect functions so the developer has a choice
108     // of what kind of input/output parameters he desires.
109     // the order in which they appear is the order in which they are
110     // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
111     // doEffect(std::vector<Geom::Path> )
112     virtual NArtBpath *
113             doEffect_nartbpath (NArtBpath * path_in);
114     virtual std::vector<Geom::Path>
115             doEffect_path (std::vector<Geom::Path> const & path_in);
116     virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
117             doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
119     void registerParameter(Parameter * param);
120     Parameter * getNextOncanvasEditableParam();
122     std::vector<Parameter *> param_vector;
123     int oncanvasedit_it;
124     Inkscape::UI::Widget::Registry wr;
126     LivePathEffectObject *lpeobj;
128     // this boolean defaults to false, it concatenates the input path to one pwd2,
129     // instead of normally 'splitting' the path into continuous pwd2 paths.
130     bool concatenate_before_pwd2;
132 private:
133     Effect(const Effect&);
134     Effect& operator=(const Effect&);
135 };
138 } //namespace LivePathEffect
139 } //namespace Inkscape
141 #endif