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     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     INTERPOLATE,
  82     INVALID_LPE // This must be last
  83 };
  84
  85 extern const Util::EnumData<EffectType> LPETypeData[];
  86 extern const Util::EnumDataConverter<EffectType> LPETypeConverter;
  87
  88 enum LPEPathFlashType {
  89     SUPPRESS_FLASH,
  90 //    PERMANENT_FLASH,
  91     DEFAULT
  92 };
  93
  94 class Effect {
  95 public:
  96     static Effect* New(EffectType lpenr, LivePathEffectObject *lpeobj);
  97     static void createAndApply(const char* name, SPDocument *doc, SPItem *item);
  98     static void createAndApply(EffectType type, SPDocument *doc, SPItem *item);
  99
 100     virtual ~Effect();
 101
 102     EffectType effectType ();
 103
 104     virtual void doOnApply (SPLPEItem *lpeitem);
 105     virtual void doBeforeEffect (SPLPEItem *lpeitem);
 106
 107     void writeParamsToSVG();
 108
 109     virtual void acceptParamPath (SPPath *param_path);
 110     virtual int acceptsNumParams() { return 0; }
 111     void doAcceptPathPreparations(SPLPEItem *lpeitem);
 112
 113     inline bool pathParamAccepted() { return done_pathparam_set; }
 114
 115     virtual void doEffect (SPCurve * curve);
 116
 117     virtual Gtk::Widget * newWidget(Gtk::Tooltips * tooltips);
 118
 119     virtual void resetDefaults(SPItem * item);
 120
 121     virtual void setup_nodepath(Inkscape::NodePath::Path *np);
 122
 123     virtual void transform_multiply(Geom::Matrix const& postmul, bool set);
 124
 125     // TODO: providesKnotholder() is currently used as an indicator of whether a nodepath is
 126     // created for an item or not. When we allow both at the same time, this needs rethinking!
 127     bool providesKnotholder();
 128     // TODO: in view of providesOwnFlashPaths() below, this is somewhat redundant
 129     //       (but spiro lpe still needs it!)
 130     virtual LPEPathFlashType pathFlashType() { return DEFAULT; }
 131     void addHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
 132     void addPointParamHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item);
 133
 134     void addHelperPaths(SPLPEItem *lpeitem, SPDesktop *desktop);
 135     inline bool providesOwnFlashPaths() {
 136         return provides_own_flash_paths || show_orig_path;
 137     }
 138     inline bool showOrigPath() { return show_orig_path; }
 139
 140     Glib::ustring          getName();
 141     Inkscape::XML::Node *  getRepr();
 142     SPDocument *           getSPDoc();
 143     LivePathEffectObject * getLPEObj() {return lpeobj;};
 144     Parameter *            getParameter(const char * key);
 145
 146     void readallParameters(Inkscape::XML::Node * repr);
 147     void setParameter(const gchar * key, const gchar * new_value);
 148
 149     inline bool isVisible() { return is_visible; }
 150
 151     void editNextParamOncanvas(SPItem * item, SPDesktop * desktop);
 152
 153 protected:
 154     Effect(LivePathEffectObject *lpeobject);
 155
 156     // provide a set of doEffect functions so the developer has a choice
 157     // of what kind of input/output parameters he desires.
 158     // the order in which they appear is the order in which they are
 159     // called by this base class. (i.e. doEffect(SPCurve * curve) defaults to calling
 160     // doEffect(std::vector<Geom::Path> )
 161     virtual std::vector<Geom::Path>
 162             doEffect_path (std::vector<Geom::Path> const & path_in);
 163     virtual Geom::Piecewise<Geom::D2<Geom::SBasis> >
 164             doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
 165
 166     void registerParameter(Parameter * param);
 167     void registerKnotHolderHandle(KnotHolderEntity* entity, const char* descr);
 168     Parameter * getNextOncanvasEditableParam();
 169
 170     virtual void addHelperPathsImpl(SPLPEItem *lpeitem, SPDesktop *desktop);
 171
 172     std::vector<Parameter *> param_vector;
 173     std::vector<std::pair<KnotHolderEntity*, const char*> > kh_entity_vector;
 174     int oncanvasedit_it;
 175     BoolParam is_visible;
 176     bool done_pathparam_set;
 177
 178     bool show_orig_path; // set this to true in derived effects to automatically have the original
 179                          // path displayed as helperpath
 180
 181     Inkscape::UI::Widget::Registry wr;
 182
 183     LivePathEffectObject *lpeobj;
 184
 185     // this boolean defaults to false, it concatenates the input path to one pwd2,
 186     // instead of normally 'splitting' the path into continuous pwd2 paths.
 187     bool concatenate_before_pwd2;
 188
 189 private:
 190     bool provides_own_flash_paths; // if true, the standard flash path is suppressed
 191
 192     Effect(const Effect&);
 193     Effect& operator=(const Effect&);
 194 };
 195
 196
 197 } //namespace LivePathEffect
 198 } //namespace Inkscape
 199
 200 #endif
 201
 202 /*
 203   Local Variables:
 204   mode:c++
 205   c-file-style:"stroustrup"
 206   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 207   indent-tabs-mode:nil
 208   fill-column:99
 209   End:
 210 */
 211 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :