src/live_effects/effect.h

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