#define INKSCAPE_LIVEPATHEFFECT_CPP

#include "live_effects/effect.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 <glibmm/i18n.h>

#include "pen-context.h"

#include "tools-switch.h"

#include "message-stack.h"

#include "desktop.h"

#include "nodepath.h"

#include "live_effects/lpeobject.h"

#include "live_effects/parameter/parameter.h"

#include <glibmm/ustring.h>

#include "display/curve.h"

#include <gtkmm.h>

#include <exception>

#include <2geom/sbasis-to-bezier.h>

#include <2geom/matrix.h>

#include <2geom/pathvector.h>

#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"

namespace Inkscape {

namespace LivePathEffect {

const Util::EnumData<EffectType> 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"},

{DYNASTROKE, N_("Dynamic stroke"), "dynastroke"},

#endif

{ANGLE_BISECTOR, N_("Angle bisector"), "angle_bisector"},

{BEND_PATH, N_("Bend"), "bend_path"},

{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"},

{CONSTRUCT_GRID, N_("Construct grid"), "construct_grid"},

{ENVELOPE, N_("Envelope Deformation"), "envelope"},

{FREEHAND_SHAPE, N_("Freehand Shape"), "freehand_shape"}, // this is actually a special type of PatternAlongPath, used to paste shapes in pen/pencil tool

{GEARS, N_("Gears"), "gears"},

{ROUGH_HATCHES, N_("Hatches (rough)"), "rough_hatches"},

{INTERPOLATE, N_("Interpolate Sub-Paths"), "interpolate"},

{KNOT, N_("Knot"), "knot"},

{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"},

{PATTERN_ALONG_PATH, N_("Pattern Along Path"), "skeletal"}, // for historic reasons, this effect is called skeletal(strokes) in Inkscape:SVG

{PERP_BISECTOR, N_("Perpendicular bisector"), "perp_bisector"},

{PERSPECTIVE_PATH, N_("Perspective path"), "perspective_path"},

{COPY_ROTATE, N_("Rotate copies"), "copy_rotate"},

{RULER, N_("Ruler"), "ruler"},

{SKETCH, N_("Sketch"), "sketch"},

{SPIRO, N_("Spiro spline"), "spiro"},

{CURVE_STITCH, N_("Stitch Sub-Paths"), "curvestitching"},

{TANGENT_TO_CURVE, N_("Tangent to curve"), "tangent_to_curve"},

{TEXT_LABEL, N_("Text label"), "text_label"},

{VONKOCH, N_("VonKoch"), "vonkoch"},

};

const Util::EnumDataConverter<EffectType> LPETypeConverter(LPETypeData, sizeof(LPETypeData)/sizeof(*LPETypeData));

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<Effect*> ( new LPEPatternAlongPath(lpeobj) );

break;

case FREEHAND_SHAPE:

neweffect = static_cast<Effect*> ( new LPEFreehandShape(lpeobj) );

break;

case BEND_PATH:

neweffect = static_cast<Effect*> ( new LPEBendPath(lpeobj) );

break;

case SKETCH:

neweffect = static_cast<Effect*> ( new LPESketch(lpeobj) );

break;

case ROUGH_HATCHES:

neweffect = static_cast<Effect*> ( new LPERoughHatches(lpeobj) );

break;

case VONKOCH:

neweffect = static_cast<Effect*> ( new LPEVonKoch(lpeobj) );

break;

case KNOT:

neweffect = static_cast<Effect*> ( new LPEKnot(lpeobj) );

break;

case GEARS:

neweffect = static_cast<Effect*> ( new LPEGears(lpeobj) );

break;

case CURVE_STITCH:

neweffect = static_cast<Effect*> ( new LPECurveStitch(lpeobj) );

break;

case LATTICE:

neweffect = static_cast<Effect*> ( new LPELattice(lpeobj) );

break;

case ENVELOPE:

neweffect = static_cast<Effect*> ( new LPEEnvelope(lpeobj) );

break;

case CIRCLE_WITH_RADIUS:

neweffect = static_cast<Effect*> ( new LPECircleWithRadius(lpeobj) );

break;

case PERSPECTIVE_PATH:

neweffect = static_cast<Effect*> ( new LPEPerspectivePath(lpeobj) );

break;

case SPIRO:

neweffect = static_cast<Effect*> ( new LPESpiro(lpeobj) );

break;

case CONSTRUCT_GRID:

neweffect = static_cast<Effect*> ( new LPEConstructGrid(lpeobj) );

break;

case PERP_BISECTOR:

neweffect = static_cast<Effect*> ( new LPEPerpBisector(lpeobj) );

break;

case TANGENT_TO_CURVE:

neweffect = static_cast<Effect*> ( new LPETangentToCurve(lpeobj) );

break;

case MIRROR_SYMMETRY:

neweffect = static_cast<Effect*> ( new LPEMirrorSymmetry(lpeobj) );

break;

case CIRCLE_3PTS:

neweffect = static_cast<Effect*> ( new LPECircle3Pts(lpeobj) );

break;

case ANGLE_BISECTOR:

neweffect = static_cast<Effect*> ( new LPEAngleBisector(lpeobj) );

break;

case PARALLEL:

neweffect = static_cast<Effect*> ( new LPEParallel(lpeobj) );

break;

case COPY_ROTATE:

neweffect = static_cast<Effect*> ( new LPECopyRotate(lpeobj) );

break;

case OFFSET:

neweffect = static_cast<Effect*> ( new LPEOffset(lpeobj) );

break;

case RULER:

neweffect = static_cast<Effect*> ( new LPERuler(lpeobj) );

break;

case BOOLOPS:

neweffect = static_cast<Effect*> ( new LPEBoolops(lpeobj) );

break;

case INTERPOLATE:

neweffect = static_cast<Effect*> ( new LPEInterpolate(lpeobj) );

break;

case TEXT_LABEL:

neweffect = static_cast<Effect*> ( new LPETextLabel(lpeobj) );

break;

case PATH_LENGTH:

neweffect = static_cast<Effect*> ( new LPEPathLength(lpeobj) );

break;

case LINE_SEGMENT:

neweffect = static_cast<Effect*> ( new LPELineSegment(lpeobj) );

break;

#ifdef LPE_ENABLE_TEST_EFFECTS

case DOEFFECTSTACK_TEST:

neweffect = static_cast<Effect*> ( new LPEdoEffectStackTest(lpeobj) );

break;

case DYNASTROKE:

neweffect = static_cast<Effect*> ( new LPEDynastroke(lpeobj) );

break;

#endif

default:

g_warning("LivePathEffect::Effect::New called with invalid patheffect type (%d)", lpenr);

neweffect = NULL;

break;

}

if (neweffect) {

neweffect->readallParameters(SP_OBJECT_REPR(lpeobj));

}

return neweffect;

}

Effect::createAndApply(const char* name, SPDocument *doc, SPItem *item)

{

// Path effect definition

Inkscape::XML::Document *xml_doc = sp_document_repr_doc(doc);

Inkscape::XML::Node *repr = xml_doc->createElement("inkscape:path-effect");

repr->setAttribute("effect", name);

SP_OBJECT_REPR(SP_DOCUMENT_DEFS(doc))->addChild(repr, NULL); // adds to <defs> 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);

}

Effect::createAndApply(EffectType type, SPDocument *doc, SPItem *item)

{

createAndApply(LPETypeConverter.get_key(type).c_str(), doc, item);

}

Effect::Effect(LivePathEffectObject *lpeobject)

: 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),

deactivate_knotholder(_("Deactivate knotholder?"), _("Check this to deactivate knotholder handles (useful if they interfere with node handles during editing)"), "deactivate_knotholder", &wr, this, false),

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<Parameter *>(&is_visible) );

registerParameter( dynamic_cast<Parameter *>(&deactivate_knotholder) );

}

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") );

}

Effect::effectType() {

return lpeobj->effecttype;

}

Effect::doOnApply (SPLPEItem */*lpeitem*/)

{

}

Effect::doBeforeEffect (SPLPEItem */*lpeitem*/)

{

//Do nothing for simple effects

}

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()));

}

Effect::writeParamsToSVG() {

std::vector<Inkscape::LivePathEffect::Parameter *>::iterator p;

for (p = param_vector.begin(); p != param_vector.end(); ++p) {

(*p)->write_to_SVG();

}

}

Effect::acceptParamPath (SPPath */*param_path*/) {

setReady();

}

Effect::doEffect (SPCurve * curve)

{

std::vector<Geom::Path> orig_pathv = curve->get_pathvector();

std::vector<Geom::Path> result_pathv = doEffect_path(orig_pathv);

curve->set_pathvector(result_pathv);

}

std::vector<Geom::Path>

Effect::doEffect_path (std::vector<Geom::Path> const & path_in)

{

std::vector<Geom::Path> path_out;

if ( !concatenate_before_pwd2 ) {

// default behavior

for (unsigned int i=0; i < path_in.size(); i++) {

Geom::Piecewise<Geom::D2<Geom::SBasis> > pwd2_in = path_in[i].toPwSb();

Geom::Piecewise<Geom::D2<Geom::SBasis> > pwd2_out = doEffect_pwd2(pwd2_in);

std::vector<Geom::Path> 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<Geom::D2<Geom::SBasis> > pwd2_in;

for (unsigned int i=0; i < path_in.size(); i++) {

pwd2_in.concat( path_in[i].toPwSb() );

}

Geom::Piecewise<Geom::D2<Geom::SBasis> > pwd2_out = doEffect_pwd2(pwd2_in);

path_out = Geom::path_from_piecewise( pwd2_out, LPE_CONVERSION_TOLERANCE);

}

return path_out;

}

Geom::Piecewise<Geom::D2<Geom::SBasis> >

Effect::doEffect_pwd2 (Geom::Piecewise<Geom::D2<Geom::SBasis> > const & pwd2_in)

{

g_warning("Effect has no doEffect implementation");

return pwd2_in;

}

Effect::readallParameters(Inkscape::XML::Node * repr)

{

std::vector<Parameter *>::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++;

}

}

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();

}

}

}

Effect::registerParameter(Parameter * param)

{

param_vector.push_back(param);

}

Effect::registerKnotHolderHandle(KnotHolderEntity* entity, const char* descr)

{

kh_entity_vector.push_back(std::make_pair(entity, descr));

}

Effect::addHandles(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item) {

using namespace Inkscape::LivePathEffect;

if (deactivate_knotholder)

return;

// add handles provided by the effect itself

addKnotHolderEntities(knotholder, desktop, item);

// add handles provided by the effect's parameters (if any)

for (std::vector<Parameter *>::iterator p = param_vector.begin(); p != param_vector.end(); ++p) {

(*p)->addKnotHolderEntities(knotholder, desktop, item);

}

}

Effect::addKnotHolderEntities(KnotHolder *knotholder, SPDesktop *desktop, SPItem *item) {

// TODO: The entities in kh_entity_vector are already instantiated during the call

// to registerKnotHolderHandle(), but they are recreated here. Also, we must not

// delete them when the knotholder is destroyed, whence the clumsy function

// isDeletable(). If we could create entities of different classes dynamically,

// this would be much nicer. How to do this?

std::vector<std::pair<KnotHolderEntity*, const char*> >::iterator i;

for (i = kh_entity_vector.begin(); i != kh_entity_vector.end(); ++i) {

KnotHolderEntity *entity = i->first;

const char *descr = i->second;

entity->create(desktop, item, knotholder, descr);

knotholder->add(entity);

}

}

std::vector<Geom::PathVector>

Effect::getHelperPaths(SPLPEItem *lpeitem)

{

std::vector<Geom::PathVector> 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_get_curve (SP_SHAPE(lpeitem));

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<Parameter *>::iterator p = param_vector.begin(); p != param_vector.end(); ++p) {

(*p)->addCanvasIndicators(lpeitem, hp_vec);

}

return hp_vec;

}

Effect::addCanvasIndicators(SPLPEItem */*lpeitem*/, std::vector<Geom::PathVector> &/*hp_vec*/)

{

}

Gtk::Widget *

Effect::newWidget(Gtk::Tooltips * tooltips)

{

// 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<Parameter *>::iterator it = param_vector.begin();

while (it != param_vector.end()) {

Parameter * param = *it;

Gtk::Widget * widg = param->param_newWidget(tooltips);

Glib::ustring * tip = param->param_getTooltip();

if (widg) {

vbox->pack_start(*widg, true, true, 2);

if (tip != NULL) {

tooltips->set_tip(*widg, *tip);

}

}

it++;

}

return dynamic_cast<Gtk::Widget *>(vbox);

}

Inkscape::XML::Node *

Effect::getRepr()

{

return SP_OBJECT_REPR(lpeobj);

}

SPDocument *

Effect::getSPDoc()

{

if (SP_OBJECT_DOCUMENT(lpeobj) == NULL) g_message("Effect::getSPDoc() returns NULL");

return SP_OBJECT_DOCUMENT(lpeobj);

}

Parameter *

Effect::getParameter(const char * key)

{

Glib::ustring stringkey(key);

std::vector<Parameter *>::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<int>(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<int>(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;

}

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 <b>%s</b>."), 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.") );

}

}

Effect::resetDefaults(SPItem * /*item*/)

{

// do nothing for simple effects

}

Effect::setup_nodepath(Inkscape::NodePath::Path *np)

{

np->helperpath_rgba = 0xff0000ff;

np->helperpath_width = 1.0;

}

Effect::transform_multiply(Geom::Matrix const& postmul, bool set)

{

// cycle through all parameters. Most parameters will not need transformation, but path and point params do.

for (std::vector<Parameter *>::iterator it = param_vector.begin(); it != param_vector.end(); it++) {

Parameter * param = *it;

param->param_transform_multiply(postmul, set);

}

}

Effect::providesKnotholder()

{

// does the effect actively provide any knotholder entities of its own?

if (kh_entity_vector.size() > 0)

return true;

// otherwise: are there any parameters that have knotholderentities?

for (std::vector<Parameter *>::iterator p = param_vector.begin(); p != param_vector.end(); ++p) {

if ((*p)->providesKnotHolderEntities()) {

return true;

}

}

return false;

}

} /* namespace LivePathEffect */

} /* namespace Inkscape */