Merge from fe-moved

[inkscape.git] / src / live_effects / lpe-skeleton.h

diff --git a/src/live_effects/lpe-skeleton.h b/src/live_effects/lpe-skeleton.h
index 290b8a724a7854a22d9eddeefaed27ac3e1fd24c..fd9dc0abaecd2cf8b75e700d89049d953748da6a 100644 (file)
--- a/src/live_effects/lpe-skeleton.h
+++ b/src/live_effects/lpe-skeleton.h
@@ -1,26 +1,32 @@
-#ifndef INKSCAPE_LPE_SKELETON_H
-#define INKSCAPE_LPE_SKELETON_H
-
-/** \file
- * LPE <skeleton> implementation, see lpe-skeleton.cpp.
+/** @file
+ * @brief Minimal LPE effect, see lpe-skeleton.cpp.
  */
-
-/*
- * Authors:
- *   Johan Engelen
-*
-* Copyright (C) Johan Engelen 2007 <j.b.c.engelen@utwente.nl>
+/* Authors:
+ *   Johan Engelen <j.b.c.engelen@utwente.nl>
+ *
+ * Copyright (C) 2007 Authors
  *
  * Released under GNU GPL, read the file 'COPYING' for more information
  */
 
+#ifndef INKSCAPE_LPE_SKELETON_H
+#define INKSCAPE_LPE_SKELETON_H
+
 #include "live_effects/effect.h"
 #include "live_effects/parameter/parameter.h"
-#include "live_effects/parameter/point.h"
 
 namespace Inkscape {
 namespace LivePathEffect {
 
+// each knotholder handle for your LPE requires a separate class derived from KnotHolderEntity;
+// define it in lpe-skeleton.cpp and register it in the effect's constructor
+/**
+namespace Skeleton {
+  // we need a separate namespace to avoid clashes with other LPEs
+  class KnotHolderEntityMyHandle;
+}
+**/
+
 class LPESkeleton : public Effect {
 public:
     LPESkeleton(LivePathEffectObject *lpeobject);
@@ -28,10 +34,12 @@ public:
 
 //  Choose to implement one of the doEffect functions. You can delete or comment out the others.
 //    virtual void doEffect (SPCurve * curve);
-//    virtual NArtBpath * doEffect_nartbpath (NArtBpath * path_in);
-//    virtual std::vector<Geom::Path> doEffect_path (std::vector<Geom::Path> & path_in);
+//    virtual std::vector<Geom::Path> doEffect_path (std::vector<Geom::Path> const & path_in);
     virtual Geom::Piecewise<Geom::D2<Geom::SBasis> > doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in);
 
+    /* the knotholder entity classes (if any) must be declared friends */
+    //friend class Skeleton::KnotHolderEntityMyHandle;
+
 private:
     // add the parameters for your effect here:
     ScalarParam number;
@@ -45,3 +53,14 @@ private:
 } //namespace Inkscape
 
 #endif
+
+/*
+  Local Variables:
+  mode:c++
+  c-file-style:"stroustrup"
+  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
+  indent-tabs-mode:nil
+  fill-column:99
+  End:
+*/
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :