/* * Copyright (C) Johan Engelen 2007 * Abhishek Sharma * * Released under GNU GPL, read the file 'COPYING' for more information */ //#define LPE_ENABLE_TEST_EFFECTS #include "live_effects/effect.h" #ifdef HAVE_CONFIG_H # include "config.h" #endif // include effects: #include "live_effects/lpe-patternalongpath.h" #include "live_effects/lpe-bendpath.h" #include "live_effects/lpe-sketch.h" #include "live_effects/lpe-vonkoch.h" #include "live_effects/lpe-knot.h" #include "live_effects/lpe-rough-hatches.h" #include "live_effects/lpe-dynastroke.h" #include "live_effects/lpe-test-doEffect-stack.h" #include "live_effects/lpe-gears.h" #include "live_effects/lpe-curvestitch.h" #include "live_effects/lpe-circle_with_radius.h" #include "live_effects/lpe-perspective_path.h" #include "live_effects/lpe-spiro.h" #include "live_effects/lpe-lattice.h" #include "live_effects/lpe-envelope.h" #include "live_effects/lpe-constructgrid.h" #include "live_effects/lpe-perp_bisector.h" #include "live_effects/lpe-tangent_to_curve.h" #include "live_effects/lpe-mirror_symmetry.h" #include "live_effects/lpe-circle_3pts.h" #include "live_effects/lpe-angle_bisector.h" #include "live_effects/lpe-parallel.h" #include "live_effects/lpe-copy_rotate.h" #include "live_effects/lpe-offset.h" #include "live_effects/lpe-ruler.h" #include "live_effects/lpe-boolops.h" #include "live_effects/lpe-interpolate.h" #include "live_effects/lpe-text_label.h" #include "live_effects/lpe-path_length.h" #include "live_effects/lpe-line_segment.h" #include "live_effects/lpe-recursiveskeleton.h" #include "live_effects/lpe-extrude.h" #include "live_effects/lpe-powerstroke.h" #include "live_effects/lpe-clone-original.h" #include "xml/node-event-vector.h" #include "sp-object.h" #include "attributes.h" #include "message-stack.h" #include "desktop.h" #include "inkscape.h" #include "document.h" #include "document-private.h" #include "xml/document.h" #include #include "pen-context.h" #include "tools-switch.h" #include "message-stack.h" #include "desktop.h" #include "knotholder.h" #include "sp-lpe-item.h" #include "live_effects/lpeobject.h" #include "live_effects/parameter/parameter.h" #include #include "display/curve.h" #include #include <2geom/sbasis-to-bezier.h> #include <2geom/affine.h> #include <2geom/pathvector.h> namespace Inkscape { namespace LivePathEffect { const Util::EnumData LPETypeData[] = { // {constant defined in effect-enum.h, N_("name of your effect"), "name of your effect in SVG"} #ifdef LPE_ENABLE_TEST_EFFECTS {DOEFFECTSTACK_TEST, N_("doEffect stack test"), "doeffectstacktest"}, {ANGLE_BISECTOR, N_("Angle bisector"), "angle_bisector"}, // TRANSLATORS: boolean operations {BOOLOPS, N_("Boolops"), "boolops"}, {CIRCLE_WITH_RADIUS, N_("Circle (by center and radius)"), "circle_with_radius"}, {CIRCLE_3PTS, N_("Circle by 3 points"), "circle_3pts"}, {DYNASTROKE, N_("Dynamic stroke"), "dynastroke"}, {EXTRUDE, N_("Extrude"), "extrude"}, {LATTICE, N_("Lattice Deformation"), "lattice"}, {LINE_SEGMENT, N_("Line Segment"), "line_segment"}, {MIRROR_SYMMETRY, N_("Mirror symmetry"), "mirror_symmetry"}, {OFFSET, N_("Offset"), "offset"}, {PARALLEL, N_("Parallel"), "parallel"}, {PATH_LENGTH, N_("Path length"), "path_length"}, {PERP_BISECTOR, N_("Perpendicular bisector"), "perp_bisector"}, {PERSPECTIVE_PATH, N_("Perspective path"), "perspective_path"}, {COPY_ROTATE, N_("Rotate copies"), "copy_rotate"}, {RECURSIVE_SKELETON, N_("Recursive skeleton"), "recursive_skeleton"}, {TANGENT_TO_CURVE, N_("Tangent to curve"), "tangent_to_curve"}, {TEXT_LABEL, N_("Text label"), "text_label"}, #endif /* 0.46 */ {BEND_PATH, N_("Bend"), "bend_path"}, {GEARS, N_("Gears"), "gears"}, {PATTERN_ALONG_PATH, N_("Pattern Along Path"), "skeletal"}, // for historic reasons, this effect is called skeletal(strokes) in Inkscape:SVG {CURVE_STITCH, N_("Stitch Sub-Paths"), "curvestitching"}, /* 0.47 */ {VONKOCH, N_("VonKoch"), "vonkoch"}, {KNOT, N_("Knot"), "knot"}, {CONSTRUCT_GRID, N_("Construct grid"), "construct_grid"}, {SPIRO, N_("Spiro spline"), "spiro"}, {ENVELOPE, N_("Envelope Deformation"), "envelope"}, {INTERPOLATE, N_("Interpolate Sub-Paths"), "interpolate"}, {ROUGH_HATCHES, N_("Hatches (rough)"), "rough_hatches"}, {SKETCH, N_("Sketch"), "sketch"}, {RULER, N_("Ruler"), "ruler"}, /* 0.49 */ {POWERSTROKE, N_("Power stroke"), "powerstroke"}, {CLONE_ORIGINAL, N_("Clone original path"), "clone_original"}, }; const Util::EnumDataConverter LPETypeConverter(LPETypeData, sizeof(LPETypeData)/sizeof(*LPETypeData)); int Effect::acceptsNumClicks(EffectType type) { switch (type) { case INVALID_LPE: return -1; // in case we want to distinguish between invalid LPE and valid ones that expect zero clicks case ANGLE_BISECTOR: return 3; case CIRCLE_3PTS: return 3; case CIRCLE_WITH_RADIUS: return 2; case LINE_SEGMENT: return 2; case PERP_BISECTOR: return 2; default: return 0; } } Effect* Effect::New(EffectType lpenr, LivePathEffectObject *lpeobj) { Effect* neweffect = NULL; switch (lpenr) { case PATTERN_ALONG_PATH: neweffect = static_cast ( new LPEPatternAlongPath(lpeobj) ); break; case BEND_PATH: neweffect = static_cast ( new LPEBendPath(lpeobj) ); break; case SKETCH: neweffect = static_cast ( new LPESketch(lpeobj) ); break; case ROUGH_HATCHES: neweffect = static_cast ( new LPERoughHatches(lpeobj) ); break; case VONKOCH: neweffect = static_cast ( new LPEVonKoch(lpeobj) ); break; case KNOT: neweffect = static_cast ( new LPEKnot(lpeobj) ); break; case GEARS: neweffect = static_cast ( new LPEGears(lpeobj) ); break; case CURVE_STITCH: neweffect = static_cast ( new LPECurveStitch(lpeobj) ); break; case LATTICE: neweffect = static_cast ( new LPELattice(lpeobj) ); break; case ENVELOPE: neweffect = static_cast ( new LPEEnvelope(lpeobj) ); break; case CIRCLE_WITH_RADIUS: neweffect = static_cast ( new LPECircleWithRadius(lpeobj) ); break; case PERSPECTIVE_PATH: neweffect = static_cast ( new LPEPerspectivePath(lpeobj) ); break; case SPIRO: neweffect = static_cast ( new LPESpiro(lpeobj) ); break; case CONSTRUCT_GRID: neweffect = static_cast ( new LPEConstructGrid(lpeobj) ); break; case PERP_BISECTOR: neweffect = static_cast ( new LPEPerpBisector(lpeobj) ); break; case TANGENT_TO_CURVE: neweffect = static_cast ( new LPETangentToCurve(lpeobj) ); break; case MIRROR_SYMMETRY: neweffect = static_cast ( new LPEMirrorSymmetry(lpeobj) ); break; case CIRCLE_3PTS: neweffect = static_cast ( new LPECircle3Pts(lpeobj) ); break; case ANGLE_BISECTOR: neweffect = static_cast ( new LPEAngleBisector(lpeobj) ); break; case PARALLEL: neweffect = static_cast ( new LPEParallel(lpeobj) ); break; case COPY_ROTATE: neweffect = static_cast ( new LPECopyRotate(lpeobj) ); break; case OFFSET: neweffect = static_cast ( new LPEOffset(lpeobj) ); break; case RULER: neweffect = static_cast ( new LPERuler(lpeobj) ); break; case BOOLOPS: neweffect = static_cast ( new LPEBoolops(lpeobj) ); break; case INTERPOLATE: neweffect = static_cast ( new LPEInterpolate(lpeobj) ); break; case TEXT_LABEL: neweffect = static_cast ( new LPETextLabel(lpeobj) ); break; case PATH_LENGTH: neweffect = static_cast ( new LPEPathLength(lpeobj) ); break; case LINE_SEGMENT: neweffect = static_cast ( new LPELineSegment(lpeobj) ); break; case DOEFFECTSTACK_TEST: neweffect = static_cast ( new LPEdoEffectStackTest(lpeobj) ); break; case DYNASTROKE: neweffect = static_cast ( new LPEDynastroke(lpeobj) ); break; case RECURSIVE_SKELETON: neweffect = static_cast ( new LPERecursiveSkeleton(lpeobj) ); break; case EXTRUDE: neweffect = static_cast ( new LPEExtrude(lpeobj) ); break; case POWERSTROKE: neweffect = static_cast ( new LPEPowerStroke(lpeobj) ); break; case CLONE_ORIGINAL: neweffect = static_cast ( new LPECloneOriginal(lpeobj) ); break; default: g_warning("LivePathEffect::Effect::New called with invalid patheffect type (%d)", lpenr); neweffect = NULL; break; } if (neweffect) { neweffect->readallParameters(lpeobj->getRepr()); } return neweffect; } void Effect::createAndApply(const char* name, SPDocument *doc, SPItem *item) { // Path effect definition Inkscape::XML::Document *xml_doc = doc->getReprDoc(); Inkscape::XML::Node *repr = xml_doc->createElement("inkscape:path-effect"); repr->setAttribute("effect", name); doc->getDefs()->getRepr()->addChild(repr, NULL); // adds to and assigns the 'id' attribute const gchar * repr_id = repr->attribute("id"); Inkscape::GC::release(repr); gchar *href = g_strdup_printf("#%s", repr_id); sp_lpe_item_add_path_effect(SP_LPE_ITEM(item), href, true); g_free(href); } void Effect::createAndApply(EffectType type, SPDocument *doc, SPItem *item) { createAndApply(LPETypeConverter.get_key(type).c_str(), doc, item); } Effect::Effect(LivePathEffectObject *lpeobject) : _provides_knotholder_entities(false), oncanvasedit_it(0), is_visible(_("Is visible?"), _("If unchecked, the effect remains applied to the object but is temporarily disabled on canvas"), "is_visible", &wr, this, true), show_orig_path(false), lpeobj(lpeobject), concatenate_before_pwd2(false), provides_own_flash_paths(true), // is automatically set to false if providesOwnFlashPaths() is not overridden is_ready(false) // is automatically set to false if providesOwnFlashPaths() is not overridden { registerParameter( dynamic_cast(&is_visible) ); is_visible.widget_is_visible = false; } Effect::~Effect() { } Glib::ustring Effect::getName() { if (lpeobj->effecttype_set && LPETypeConverter.is_valid_id(lpeobj->effecttype) ) return Glib::ustring( _(LPETypeConverter.get_label(lpeobj->effecttype).c_str()) ); else return Glib::ustring( _("No effect") ); } EffectType Effect::effectType() const { return lpeobj->effecttype; } /** * Is performed a single time when the effect is freshly applied to a path */ void Effect::doOnApply (SPLPEItem const*/*lpeitem*/) { } /** * Is performed each time before the effect is updated. */ void Effect::doBeforeEffect (SPLPEItem */*lpeitem*/) { //Do nothing for simple effects } /** * Effects can have a parameter path set before they are applied by accepting a nonzero number of * mouse clicks. This method activates the pen context, which waits for the specified number of * clicks. Override Effect::acceptsNumClicks() to return the number of expected mouse clicks. */ void Effect::doAcceptPathPreparations(SPLPEItem *lpeitem) { // switch to pen context SPDesktop *desktop = inkscape_active_desktop(); // TODO: Is there a better method to find the item's desktop? if (!tools_isactive(desktop, TOOLS_FREEHAND_PEN)) { tools_switch(desktop, TOOLS_FREEHAND_PEN); } SPEventContext *ec = desktop->event_context; SPPenContext *pc = SP_PEN_CONTEXT(ec); pc->expecting_clicks_for_LPE = this->acceptsNumClicks(); pc->waiting_LPE = this; pc->waiting_item = lpeitem; pc->polylines_only = true; ec->desktop->messageStack()->flash(Inkscape::INFORMATION_MESSAGE, g_strdup_printf(_("Please specify a parameter path for the LPE '%s' with %d mouse clicks"), getName().c_str(), acceptsNumClicks())); } void Effect::writeParamsToSVG() { std::vector::iterator p; for (p = param_vector.begin(); p != param_vector.end(); ++p) { (*p)->write_to_SVG(); } } /** * If the effect expects a path parameter (specified by a number of mouse clicks) before it is * applied, this is the method that processes the resulting path. Override it to customize it for * your LPE. But don't forget to call the parent method so that is_ready is set to true! */ void Effect::acceptParamPath (SPPath */*param_path*/) { setReady(); } /* * Here be the doEffect function chain: */ void Effect::doEffect (SPCurve * curve) { std::vector orig_pathv = curve->get_pathvector(); std::vector result_pathv = doEffect_path(orig_pathv); curve->set_pathvector(result_pathv); } std::vector Effect::doEffect_path (std::vector const & path_in) { std::vector path_out; if ( !concatenate_before_pwd2 ) { // default behavior for (unsigned int i=0; i < path_in.size(); i++) { Geom::Piecewise > pwd2_in = path_in[i].toPwSb(); Geom::Piecewise > pwd2_out = doEffect_pwd2(pwd2_in); std::vector path = Geom::path_from_piecewise( pwd2_out, LPE_CONVERSION_TOLERANCE); // add the output path vector to the already accumulated vector: for (unsigned int j=0; j < path.size(); j++) { path_out.push_back(path[j]); } } } else { // concatenate the path into possibly discontinuous pwd2 Geom::Piecewise > pwd2_in; for (unsigned int i=0; i < path_in.size(); i++) { pwd2_in.concat( path_in[i].toPwSb() ); } Geom::Piecewise > pwd2_out = doEffect_pwd2(pwd2_in); path_out = Geom::path_from_piecewise( pwd2_out, LPE_CONVERSION_TOLERANCE); } return path_out; } Geom::Piecewise > Effect::doEffect_pwd2 (Geom::Piecewise > const & pwd2_in) { g_warning("Effect has no doEffect implementation"); return pwd2_in; } void Effect::readallParameters(Inkscape::XML::Node * repr) { std::vector::iterator it = param_vector.begin(); while (it != param_vector.end()) { Parameter * param = *it; const gchar * key = param->param_key.c_str(); const gchar * value = repr->attribute(key); if (value) { bool accepted = param->param_readSVGValue(value); if (!accepted) { g_warning("Effect::readallParameters - '%s' not accepted for %s", value, key); } } else { // set default value param->param_set_default(); } ++it; } } /* This function does not and SHOULD NOT write to XML */ void Effect::setParameter(const gchar * key, const gchar * new_value) { Parameter * param = getParameter(key); if (param) { if (new_value) { bool accepted = param->param_readSVGValue(new_value); if (!accepted) { g_warning("Effect::setParameter - '%s' not accepted for %s", new_value, key); } } else { // set default value param->param_set_default(); } } } void Effect::registerParameter(Parameter * param) { param_vector.push_back(param); } /** * Add all registered LPE knotholder handles to the knotholder */ void Effect::addHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item) { using namespace Inkscape::LivePathEffect; // add handles provided by the effect itself addKnotHolderEntities(knotholder, desktop, item); // add handles provided by the effect's parameters (if any) for (std::vector::iterator p = param_vector.begin(); p != param_vector.end(); ++p) { (*p)->addKnotHolderEntities(knotholder, desktop, item); } } /** * Return a vector of PathVectors which contain all helperpaths that should be drawn by the effect. * This is the function called by external code like SPLPEItem. */ std::vector Effect::getHelperPaths(SPLPEItem *lpeitem) { std::vector hp_vec; if (!SP_IS_SHAPE(lpeitem)) { // g_print ("How to handle helperpaths for non-shapes?\n"); // non-shapes are for example SPGroups. return hp_vec; } // TODO: we can probably optimize this by using a lot more references // rather than copying PathVectors all over the place if (show_orig_path) { // add original path to helperpaths SPCurve* curve = SP_SHAPE(lpeitem)->getCurve (); hp_vec.push_back(curve->get_pathvector()); } // add other helperpaths provided by the effect itself addCanvasIndicators(lpeitem, hp_vec); // add helperpaths provided by the effect's parameters for (std::vector::iterator p = param_vector.begin(); p != param_vector.end(); ++p) { (*p)->addCanvasIndicators(lpeitem, hp_vec); } return hp_vec; } /** * Add possible canvas indicators (i.e., helperpaths other than the original path) to \a hp_vec * This function should be overwritten by derived effects if they want to provide their own helperpaths. */ void Effect::addCanvasIndicators(SPLPEItem */*lpeitem*/, std::vector &/*hp_vec*/) { } /** * This *creates* a new widget, management of deletion should be done by the caller */ Gtk::Widget * Effect::newWidget() { // use manage here, because after deletion of Effect object, others might still be pointing to this widget. Gtk::VBox * vbox = Gtk::manage( new Gtk::VBox() ); vbox->set_border_width(5); std::vector::iterator it = param_vector.begin(); while (it != param_vector.end()) { if ((*it)->widget_is_visible) { Parameter * param = *it; Gtk::Widget * widg = param->param_newWidget(); Glib::ustring * tip = param->param_getTooltip(); if (widg) { vbox->pack_start(*widg, true, true, 2); if (tip) { widg->set_tooltip_text(*tip); } else { widg->set_tooltip_text(""); widg->set_has_tooltip(false); } } } ++it; } return dynamic_cast(vbox); } Inkscape::XML::Node *Effect::getRepr() { return lpeobj->getRepr(); } SPDocument *Effect::getSPDoc() { if (lpeobj->document == NULL) { g_message("Effect::getSPDoc() returns NULL"); } return lpeobj->document; } Parameter * Effect::getParameter(const char * key) { Glib::ustring stringkey(key); std::vector::iterator it = param_vector.begin(); while (it != param_vector.end()) { Parameter * param = *it; if ( param->param_key == key) { return param; } ++it; } return NULL; } Parameter * Effect::getNextOncanvasEditableParam() { if (param_vector.size() == 0) // no parameters return NULL; oncanvasedit_it++; if (oncanvasedit_it >= static_cast(param_vector.size())) { oncanvasedit_it = 0; } int old_it = oncanvasedit_it; do { Parameter * param = param_vector[oncanvasedit_it]; if(param && param->oncanvas_editable) { return param; } else { oncanvasedit_it++; if (oncanvasedit_it == static_cast(param_vector.size())) { // loop round the map oncanvasedit_it = 0; } } } while (oncanvasedit_it != old_it); // iterate until complete loop through map has been made return NULL; } void Effect::editNextParamOncanvas(SPItem * item, SPDesktop * desktop) { if (!desktop) return; Parameter * param = getNextOncanvasEditableParam(); if (param) { param->param_editOncanvas(item, desktop); gchar *message = g_strdup_printf(_("Editing parameter %s."), param->param_label.c_str()); desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, message); g_free(message); } else { desktop->messageStack()->flash( Inkscape::WARNING_MESSAGE, _("None of the applied path effect's parameters can be edited on-canvas.") ); } } /* This function should reset the defaults and is used for example to initialize an effect right after it has been applied to a path * The nice thing about this is that this function can use knowledge of the original path and set things accordingly for example to the size or origin of the original path! */ void Effect::resetDefaults(SPItem const* /*item*/) { std::vector::iterator p; for (p = param_vector.begin(); p != param_vector.end(); ++p) { (*p)->param_set_default(); (*p)->write_to_SVG(); } } void Effect::transform_multiply(Geom::Affine const& postmul, bool set) { // cycle through all parameters. Most parameters will not need transformation, but path and point params do. for (std::vector::iterator it = param_vector.begin(); it != param_vector.end(); ++it) { Parameter * param = *it; param->param_transform_multiply(postmul, set); } } bool Effect::providesKnotholder() const { // does the effect actively provide any knotholder entities of its own? if (_provides_knotholder_entities) { return true; } // otherwise: are there any parameters that have knotholderentities? for (std::vector::const_iterator p = param_vector.begin(); p != param_vector.end(); ++p) { if ((*p)->providesKnotHolderEntities()) { return true; } } return false; } } /* namespace LivePathEffect */ } /* namespace Inkscape */ /* 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 :