// SPDX-License-Identifier: GPL-2.0-or-later /* * Connector creation tool * * Authors: * Michael Wybrow * Abhishek Sharma * Jon A. Cruz * Martin Owens * * Copyright (C) 2005-2008 Michael Wybrow * Copyright (C) 2009 Monash University * Copyright (C) 2012 Authors * * Released under GNU GPL v2+, read the file 'COPYING' for more information. * * TODO: * o Show a visual indicator for objects with the 'avoid' property set. * o Allow user to change a object between a path and connector through * the interface. * o Create an interface for setting markers (arrow heads). * o Better distinguish between paths and connectors to prevent problems * in the node tool and paths accidentally being turned into connectors * in the connector tool. Perhaps have a way to convert between. * o Only call libavoid's updateEndPoint as required. Currently we do it * for both endpoints, even if only one is moving. * o Deal sanely with connectors with both endpoints attached to the * same connection point, and drawing of connectors attaching * overlapping shapes (currently tries to adjust connector to be * outside both bounding boxes). * o Fix many special cases related to connectors updating, * e.g., copying a couple of shapes and a connector that are * attached to each other. * e.g., detach connector when it is moved or transformed in * one of the other contexts. * o Cope with shapes whose ids change when they have attached * connectors. * o During dragging motion, gobble up to and use the final motion event. * Gobbling away all duplicates after the current can occasionally result * in the path lagging behind the mouse cursor if it is no longer being * dragged. * o Fix up libavoid's representation after undo actions. It doesn't see * any transform signals and hence doesn't know shapes have moved back to * there earlier positions. * * ---------------------------------------------------------------------------- * * Notes: * * Much of the way connectors work for user-defined points has been * changed so that it no longer defines special attributes to record * the points. Instead it uses single node paths to define points * who are then separate objects that can be fixed on the canvas, * grouped into objects and take full advantage of all transform, snap * and align functionality of all other objects. * * I think that the style change between polyline and orthogonal * would be much clearer with two buttons (radio behaviour -- just * one is true). * * The other tools show a label change from "New:" to "Change:" * depending on whether an object is selected. We could consider * this but there may not be space. * * Likewise for the avoid/ignore shapes buttons. These should be * inactive when a shape is not selected in the connector context. * */ #include "connector-tool.h" #include #include #include #include #include #include "context-fns.h" #include "desktop-style.h" #include "desktop.h" #include "document-undo.h" #include "document.h" #include "inkscape.h" #include "message-context.h" #include "message-stack.h" #include "selection.h" #include "snap.h" #include "display/control/canvas-item-bpath.h" #include "display/control/canvas-item-ctrl.h" #include "display/curve.h" #include "3rdparty/adaptagrams/libavoid/router.h" #include "object/sp-conn-end.h" #include "object/sp-flowtext.h" #include "object/sp-namedview.h" #include "object/sp-path.h" #include "object/sp-text.h" #include "object/sp-use.h" #include "object/sp-symbol.h" #include "ui/icon-names.h" #include "ui/knot/knot.h" #include "ui/widget/canvas.h" // Enter events #include "svg/svg.h" #include "xml/node-event-vector.h" using Inkscape::DocumentUndo; namespace Inkscape { namespace UI { namespace Tools { static void cc_clear_active_knots(SPKnotList k); static void shape_event_attr_deleted(Inkscape::XML::Node *repr, Inkscape::XML::Node *child, Inkscape::XML::Node *ref, gpointer data); static void shape_event_attr_changed(Inkscape::XML::Node *repr, gchar const *name, gchar const *old_value, gchar const *new_value, bool is_interactive, gpointer data); static void cc_select_handle(SPKnot* knot); static void cc_deselect_handle(SPKnot* knot); static bool cc_item_is_shape(SPItem *item); /*static Geom::Point connector_drag_origin_w(0, 0); static bool connector_within_tolerance = false;*/ static Inkscape::XML::NodeEventVector shape_repr_events = { nullptr, /* child_added */ nullptr, /* child_added */ shape_event_attr_changed, nullptr, /* content_changed */ nullptr /* order_changed */ }; static Inkscape::XML::NodeEventVector layer_repr_events = { nullptr, /* child_added */ shape_event_attr_deleted, nullptr, /* child_added */ nullptr, /* content_changed */ nullptr /* order_changed */ }; ConnectorTool::ConnectorTool(SPDesktop *desktop) : ToolBase(desktop, "/tools/connector", "connector.svg") , selection(nullptr) , npoints(0) , state(SP_CONNECTOR_CONTEXT_IDLE) , red_bpath(nullptr) , red_curve(nullptr) , red_color(0xff00007f) , green_curve(nullptr) , newconn(nullptr) , newConnRef(nullptr) , curvature(0.0) , isOrthogonal(false) , active_shape(nullptr) , active_shape_repr(nullptr) , active_shape_layer_repr(nullptr) , active_conn(nullptr) , active_conn_repr(nullptr) , active_handle(nullptr) , selected_handle(nullptr) , clickeditem(nullptr) , clickedhandle(nullptr) , shref(nullptr) , sub_shref(nullptr) , ehref(nullptr) , sub_ehref(nullptr) { this->selection = desktop->getSelection(); this->sel_changed_connection.disconnect(); this->sel_changed_connection = this->selection->connectChanged( sigc::mem_fun(this, &ConnectorTool::_selectionChanged) ); /* Create red bpath */ red_bpath = new Inkscape::CanvasItemBpath(desktop->getCanvasSketch()); red_bpath->set_stroke(red_color); red_bpath->set_fill(0x0, SP_WIND_RULE_NONZERO); /* Create red curve */ this->red_curve = std::make_unique(); /* Create green curve */ green_curve = std::make_unique(); // Notice the initial selection. //cc_selection_changed(this->selection, (gpointer) this); this->_selectionChanged(this->selection); this->within_tolerance = false; sp_event_context_read(this, "curvature"); sp_event_context_read(this, "orthogonal"); Inkscape::Preferences *prefs = Inkscape::Preferences::get(); if (prefs->getBool("/tools/connector/selcue", false)) { this->enableSelectionCue(); } // Make sure we see all enter events for canvas items, // even if a mouse button is depressed. desktop->getCanvas()->set_all_enter_events(true); } ConnectorTool::~ConnectorTool() { this->_finish(); this->state = SP_CONNECTOR_CONTEXT_IDLE; if (this->selection) { this->selection = nullptr; } this->cc_clear_active_shape(); this->cc_clear_active_conn(); // Restore the default event generating behaviour. _desktop->getCanvas()->set_all_enter_events(false); this->sel_changed_connection.disconnect(); for (auto &i : this->endpt_handle) { if (i) { knot_unref(i); i = nullptr; } } if (this->shref) { g_free(this->shref); this->shref = nullptr; } if (this->ehref) { g_free(this->shref); this->shref = nullptr; } g_assert(this->newConnRef == nullptr); } void ConnectorTool::set(const Inkscape::Preferences::Entry &val) { /* fixme: Proper error handling for non-numeric data. Use a locale-independent function like * g_ascii_strtod (or a thin wrapper that does the right thing for invalid values inf/nan). */ Glib::ustring name = val.getEntryName(); if (name == "curvature") { this->curvature = val.getDoubleLimited(); // prevents NaN and +/-Inf from messing up } else if (name == "orthogonal") { this->isOrthogonal = val.getBool(); } } //----------------------------------------------------------------------------- void ConnectorTool::cc_clear_active_shape() { if (this->active_shape == nullptr) { return; } g_assert( this->active_shape_repr ); g_assert( this->active_shape_layer_repr ); this->active_shape = nullptr; if (this->active_shape_repr) { sp_repr_remove_listener_by_data(this->active_shape_repr, this); Inkscape::GC::release(this->active_shape_repr); this->active_shape_repr = nullptr; sp_repr_remove_listener_by_data(this->active_shape_layer_repr, this); Inkscape::GC::release(this->active_shape_layer_repr); this->active_shape_layer_repr = nullptr; } cc_clear_active_knots(this->knots); } static void cc_clear_active_knots(SPKnotList k) { // Hide the connection points if they exist. if (k.size()) { for (auto & it : k) { it.first->hide(); } } } void ConnectorTool::cc_clear_active_conn() { if (this->active_conn == nullptr) { return; } g_assert( this->active_conn_repr ); this->active_conn = nullptr; if (this->active_conn_repr) { sp_repr_remove_listener_by_data(this->active_conn_repr, this); Inkscape::GC::release(this->active_conn_repr); this->active_conn_repr = nullptr; } // Hide the endpoint handles. for (auto & i : this->endpt_handle) { if (i) { i->hide(); } } } bool ConnectorTool::_ptHandleTest(Geom::Point& p, gchar **href, gchar **subhref) { if (this->active_handle && (this->knots.find(this->active_handle) != this->knots.end())) { p = this->active_handle->pos; *href = g_strdup_printf("#%s", this->active_handle->owner->getId()); if(this->active_handle->sub_owner) { auto id = this->active_handle->sub_owner->getAttribute("id"); if(id) { *subhref = g_strdup_printf("#%s", id); } } else { *subhref = nullptr; } return true; } *href = nullptr; *subhref = nullptr; return false; } static void cc_select_handle(SPKnot* knot) { knot->setShape(Inkscape::CANVAS_ITEM_CTRL_SHAPE_SQUARE); knot->setSize(11); // Should be odd. knot->setAnchor(SP_ANCHOR_CENTER); knot->setFill(0x0000ffff, 0x0000ffff, 0x0000ffff, 0x0000ffff); knot->updateCtrl(); } static void cc_deselect_handle(SPKnot* knot) { knot->setShape(Inkscape::CANVAS_ITEM_CTRL_SHAPE_SQUARE); knot->setSize(9); // Should be odd. knot->setAnchor(SP_ANCHOR_CENTER); knot->setFill(0xffffff00, 0xff0000ff, 0xff0000ff, 0xff0000ff); knot->updateCtrl(); } bool ConnectorTool::item_handler(SPItem* item, GdkEvent* event) { bool ret = false; Geom::Point p(event->button.x, event->button.y); switch (event->type) { case GDK_BUTTON_RELEASE: if (event->button.button == 1) { if ((this->state == SP_CONNECTOR_CONTEXT_DRAGGING) && this->within_tolerance) { this->_resetColors(); this->state = SP_CONNECTOR_CONTEXT_IDLE; } if (this->state != SP_CONNECTOR_CONTEXT_IDLE) { // Doing something else like rerouting. break; } // find out clicked item, honoring Alt SPItem *item = sp_event_context_find_item(_desktop, p, event->button.state & GDK_MOD1_MASK, FALSE); if (event->button.state & GDK_SHIFT_MASK) { this->selection->toggle(item); } else { this->selection->set(item); /* When selecting a new item, do not allow showing connection points on connectors. (yet?) */ if (item != this->active_shape && !cc_item_is_connector(item)) { this->_setActiveShape(item); } } ret = true; } break; case GDK_MOTION_NOTIFY: { auto last_pos = Geom::Point(event->motion.x, event->motion.y); SPItem *item = _desktop->getItemAtPoint(last_pos, false); if (cc_item_is_shape(item)) { this->_setActiveShape(item); } ret = false; break; } default: break; } return ret; } bool ConnectorTool::root_handler(GdkEvent* event) { bool ret = false; switch (event->type) { case GDK_BUTTON_PRESS: ret = this->_handleButtonPress(event->button); break; case GDK_MOTION_NOTIFY: ret = this->_handleMotionNotify(event->motion); break; case GDK_BUTTON_RELEASE: ret = this->_handleButtonRelease(event->button); break; case GDK_KEY_PRESS: ret = this->_handleKeyPress(get_latin_keyval (&event->key)); break; default: break; } if (!ret) { ret = ToolBase::root_handler(event); } return ret; } bool ConnectorTool::_handleButtonPress(GdkEventButton const &bevent) { Geom::Point const event_w(bevent.x, bevent.y); /* Find desktop coordinates */ Geom::Point p = _desktop->w2d(event_w); bool ret = false; if ( bevent.button == 1 ) { if (Inkscape::have_viable_layer(_desktop, defaultMessageContext()) == false) { return true; } Geom::Point const event_w(bevent.x, bevent.y); this->xp = bevent.x; this->yp = bevent.y; this->within_tolerance = true; Geom::Point const event_dt = _desktop->w2d(event_w); SnapManager &m = _desktop->namedview->snap_manager; switch (this->state) { case SP_CONNECTOR_CONTEXT_STOP: /* This is allowed, if we just canceled curve */ case SP_CONNECTOR_CONTEXT_IDLE: { if ( this->npoints == 0 ) { this->cc_clear_active_conn(); _desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Creating new connector")); /* Set start anchor */ /* Create green anchor */ Geom::Point p = event_dt; // Test whether we clicked on a connection point bool found = this->_ptHandleTest(p, &this->shref, &this->sub_shref); if (!found) { // This is the first point, so just snap it to the grid // as there's no other points to go off. m.setup(_desktop); m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_OTHER_HANDLE); m.unSetup(); } this->_setInitialPoint(p); } this->state = SP_CONNECTOR_CONTEXT_DRAGGING; ret = true; break; } case SP_CONNECTOR_CONTEXT_DRAGGING: { // This is the second click of a connector creation. m.setup(_desktop); m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_OTHER_HANDLE); m.unSetup(); this->_setSubsequentPoint(p); this->_finishSegment(p); this->_ptHandleTest(p, &this->ehref, &this->sub_ehref); if (this->npoints != 0) { this->_finish(); } this->cc_set_active_conn(this->newconn); this->state = SP_CONNECTOR_CONTEXT_IDLE; ret = true; break; } case SP_CONNECTOR_CONTEXT_CLOSE: { g_warning("Button down in CLOSE state"); break; } default: break; } } else if (bevent.button == 3) { if (this->state == SP_CONNECTOR_CONTEXT_REROUTING) { // A context menu is going to be triggered here, // so end the rerouting operation. this->_reroutingFinish(&p); this->state = SP_CONNECTOR_CONTEXT_IDLE; // Don't set ret to TRUE, so we drop through to the // parent handler which will open the context menu. } else if (this->npoints != 0) { this->_finish(); this->state = SP_CONNECTOR_CONTEXT_IDLE; ret = true; } } return ret; } bool ConnectorTool::_handleMotionNotify(GdkEventMotion const &mevent) { bool ret = false; Inkscape::Preferences *prefs = Inkscape::Preferences::get(); if (mevent.state & GDK_BUTTON2_MASK || mevent.state & GDK_BUTTON3_MASK) { // allow middle-button scrolling return false; } Geom::Point const event_w(mevent.x, mevent.y); if (this->within_tolerance) { this->tolerance = prefs->getIntLimited("/options/dragtolerance/value", 0, 0, 100); if ( ( abs( (gint) mevent.x - this->xp ) < this->tolerance ) && ( abs( (gint) mevent.y - this->yp ) < this->tolerance ) ) { return false; // Do not drag if we're within tolerance from origin. } } // Once the user has moved farther than tolerance from the original location // (indicating they intend to move the object, not click), then always process // the motion notify coordinates as given (no snapping back to origin) this->within_tolerance = false; /* Find desktop coordinates */ Geom::Point p = _desktop->w2d(event_w); SnapManager &m = _desktop->namedview->snap_manager; switch (this->state) { case SP_CONNECTOR_CONTEXT_DRAGGING: { gobble_motion_events(mevent.state); // This is movement during a connector creation. if ( this->npoints > 0 ) { m.setup(_desktop); m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_OTHER_HANDLE); m.unSetup(); this->selection->clear(); this->_setSubsequentPoint(p); ret = true; } break; } case SP_CONNECTOR_CONTEXT_REROUTING: { gobble_motion_events(GDK_BUTTON1_MASK); g_assert( SP_IS_PATH(this->clickeditem)); m.setup(_desktop); m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_OTHER_HANDLE); m.unSetup(); // Update the hidden path Geom::Affine i2d ( (this->clickeditem)->i2dt_affine() ); Geom::Affine d2i = i2d.inverse(); SPPath *path = SP_PATH(this->clickeditem); SPCurve *curve = path->curve(); if (this->clickedhandle == this->endpt_handle[0]) { Geom::Point o = this->endpt_handle[1]->pos; curve->stretch_endpoints(p * d2i, o * d2i); } else { Geom::Point o = this->endpt_handle[0]->pos; curve->stretch_endpoints(o * d2i, p * d2i); } sp_conn_reroute_path_immediate(path); // Copy this to the temporary visible path this->red_curve = SPCurve::copy(path->curveForEdit()); this->red_curve->transform(i2d); red_bpath->set_bpath(red_curve.get()); ret = true; break; } case SP_CONNECTOR_CONTEXT_STOP: /* This is perfectly valid */ break; default: if (!this->sp_event_context_knot_mouseover()) { m.setup(_desktop); m.preSnap(Inkscape::SnapCandidatePoint(p, Inkscape::SNAPSOURCE_OTHER_HANDLE)); m.unSetup(); } break; } return ret; } bool ConnectorTool::_handleButtonRelease(GdkEventButton const &revent) { bool ret = false; if ( revent.button == 1 ) { SPDocument *doc = _desktop->getDocument(); SnapManager &m = _desktop->namedview->snap_manager; Geom::Point const event_w(revent.x, revent.y); /* Find desktop coordinates */ Geom::Point p = _desktop->w2d(event_w); switch (this->state) { //case SP_CONNECTOR_CONTEXT_POINT: case SP_CONNECTOR_CONTEXT_DRAGGING: { m.setup(_desktop); m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_OTHER_HANDLE); m.unSetup(); if (this->within_tolerance) { this->_finishSegment(p); return true; } // Connector has been created via a drag, end it now. this->_setSubsequentPoint(p); this->_finishSegment(p); // Test whether we clicked on a connection point this->_ptHandleTest(p, &this->ehref, &this->sub_ehref); if (this->npoints != 0) { this->_finish(); } this->cc_set_active_conn(this->newconn); this->state = SP_CONNECTOR_CONTEXT_IDLE; break; } case SP_CONNECTOR_CONTEXT_REROUTING: { m.setup(_desktop); m.freeSnapReturnByRef(p, Inkscape::SNAPSOURCE_OTHER_HANDLE); m.unSetup(); this->_reroutingFinish(&p); doc->ensureUpToDate(); this->state = SP_CONNECTOR_CONTEXT_IDLE; return true; break; } case SP_CONNECTOR_CONTEXT_STOP: /* This is allowed, if we just cancelled curve */ break; default: break; } ret = true; } return ret; } bool ConnectorTool::_handleKeyPress(guint const keyval) { bool ret = false; switch (keyval) { case GDK_KEY_Return: case GDK_KEY_KP_Enter: if (this->npoints != 0) { this->_finish(); this->state = SP_CONNECTOR_CONTEXT_IDLE; ret = true; } break; case GDK_KEY_Escape: if (this->state == SP_CONNECTOR_CONTEXT_REROUTING) { SPDocument *doc = _desktop->getDocument(); this->_reroutingFinish(nullptr); DocumentUndo::undo(doc); this->state = SP_CONNECTOR_CONTEXT_IDLE; _desktop->messageStack()->flash( Inkscape::NORMAL_MESSAGE, _("Connector endpoint drag cancelled.")); ret = true; } else if (this->npoints != 0) { // if drawing, cancel, otherwise pass it up for deselecting this->state = SP_CONNECTOR_CONTEXT_STOP; this->_resetColors(); ret = true; } break; default: break; } return ret; } void ConnectorTool::_reroutingFinish(Geom::Point *const p) { SPDocument *doc = _desktop->getDocument(); // Clear the temporary path: this->red_curve->reset(); red_bpath->set_bpath(nullptr); if (p != nullptr) { // Test whether we clicked on a connection point gchar *shape_label; gchar *sub_label; bool found = this->_ptHandleTest(*p, &shape_label, &sub_label); if (found) { if (this->clickedhandle == this->endpt_handle[0]) { this->clickeditem->setAttribute("inkscape:connection-start", shape_label); this->clickeditem->setAttribute("inkscape:connection-start-point", sub_label); } else { this->clickeditem->setAttribute("inkscape:connection-end", shape_label); this->clickeditem->setAttribute("inkscape:connection-end-point", sub_label); } g_free(shape_label); if(sub_label) { g_free(sub_label); } } } this->clickeditem->setHidden(false); sp_conn_reroute_path_immediate(SP_PATH(this->clickeditem)); this->clickeditem->updateRepr(); DocumentUndo::done(doc, _("Reroute connector"), INKSCAPE_ICON("draw-connector")); this->cc_set_active_conn(this->clickeditem); } void ConnectorTool::_resetColors() { /* Red */ this->red_curve->reset(); red_bpath->set_bpath(nullptr); this->green_curve->reset(); this->npoints = 0; } void ConnectorTool::_setInitialPoint(Geom::Point const p) { g_assert( this->npoints == 0 ); this->p[0] = p; this->p[1] = p; this->npoints = 2; red_bpath->set_bpath(nullptr); } void ConnectorTool::_setSubsequentPoint(Geom::Point const p) { g_assert( this->npoints != 0 ); Geom::Point o = _desktop->dt2doc(this->p[0]); Geom::Point d = _desktop->dt2doc(p); Avoid::Point src(o[Geom::X], o[Geom::Y]); Avoid::Point dst(d[Geom::X], d[Geom::Y]); if (!this->newConnRef) { Avoid::Router *router = _desktop->getDocument()->getRouter(); this->newConnRef = new Avoid::ConnRef(router); this->newConnRef->setEndpoint(Avoid::VertID::src, src); if (this->isOrthogonal) { this->newConnRef->setRoutingType(Avoid::ConnType_Orthogonal); } else { this->newConnRef->setRoutingType(Avoid::ConnType_PolyLine); } } // Set new endpoint. this->newConnRef->setEndpoint(Avoid::VertID::tar, dst); // Immediately generate new routes for connector. this->newConnRef->makePathInvalid(); this->newConnRef->router()->processTransaction(); // Recreate curve from libavoid route. recreateCurve(red_curve.get(), this->newConnRef, this->curvature); this->red_curve->transform(_desktop->doc2dt()); red_bpath->set_bpath(red_curve.get(), true); } /** * Concats red, blue and green. * If any anchors are defined, process these, optionally removing curves from white list * Invoke _flush_white to write result back to object. */ void ConnectorTool::_concatColorsAndFlush() { auto c = std::make_unique(); std::swap(c, green_curve); this->red_curve->reset(); red_bpath->set_bpath(nullptr); if (c->is_empty()) { return; } this->_flushWhite(c.get()); } /* * Flushes white curve(s) and additional curve into object * * No cleaning of colored curves - this has to be done by caller * No rereading of white data, so if you cannot rely on ::modified, do it in caller * */ void ConnectorTool::_flushWhite(SPCurve *c) { /* Now we have to go back to item coordinates at last */ c->transform(_desktop->dt2doc()); SPDocument *doc = _desktop->getDocument(); Inkscape::XML::Document *xml_doc = doc->getReprDoc(); if ( c && !c->is_empty() ) { /* We actually have something to write */ Inkscape::XML::Node *repr = xml_doc->createElement("svg:path"); /* Set style */ sp_desktop_apply_style_tool(_desktop, repr, "/tools/connector", false); repr->setAttribute("d", sp_svg_write_path(c->get_pathvector())); /* Attach repr */ auto layer = currentLayer(); this->newconn = SP_ITEM(layer->appendChildRepr(repr)); this->newconn->transform = layer->i2doc_affine().inverse(); bool connection = false; this->newconn->setAttribute( "inkscape:connector-type", this->isOrthogonal ? "orthogonal" : "polyline"); this->newconn->setAttribute( "inkscape:connector-curvature", Glib::Ascii::dtostr(this->curvature).c_str()); if (this->shref) { connection = true; this->newconn->setAttribute( "inkscape:connection-start", this->shref); if(this->sub_shref) { this->newconn->setAttribute( "inkscape:connection-start-point", this->sub_shref); } } if (this->ehref) { connection = true; this->newconn->setAttribute( "inkscape:connection-end", this->ehref); if(this->sub_ehref) { this->newconn->setAttribute( "inkscape:connection-end-point", this->sub_ehref); } } // Process pending updates. this->newconn->updateRepr(); doc->ensureUpToDate(); if (connection) { // Adjust endpoints to shape edge. sp_conn_reroute_path_immediate(SP_PATH(this->newconn)); this->newconn->updateRepr(); } this->newconn->doWriteTransform(this->newconn->transform, nullptr, true); // Only set the selection after we are finished with creating the attributes of // the connector. Otherwise, the selection change may alter the defaults for // values like curvature in the connector context, preventing subsequent lookup // of their original values. this->selection->set(repr); Inkscape::GC::release(repr); } DocumentUndo::done(doc, _("Create connector"), INKSCAPE_ICON("draw-connector")); } void ConnectorTool::_finishSegment(Geom::Point const /*p*/) { if (!this->red_curve->is_empty()) { green_curve->append_continuous(*red_curve); this->p[0] = this->p[3]; this->p[1] = this->p[4]; this->npoints = 2; this->red_curve->reset(); } } void ConnectorTool::_finish() { _desktop->messageStack()->flash(Inkscape::NORMAL_MESSAGE, _("Finishing connector")); this->red_curve->reset(); this->_concatColorsAndFlush(); this->npoints = 0; if (this->newConnRef) { this->newConnRef->router()->deleteConnector(this->newConnRef); this->newConnRef = nullptr; } } static bool cc_generic_knot_handler(GdkEvent *event, SPKnot *knot) { g_assert (knot != nullptr); //g_object_ref(knot); knot_ref(knot); ConnectorTool *cc = SP_CONNECTOR_CONTEXT( knot->desktop->event_context); bool consumed = false; gchar const *knot_tip = _("Click to join at this point"); switch (event->type) { case GDK_ENTER_NOTIFY: knot->setFlag(SP_KNOT_MOUSEOVER, TRUE); cc->active_handle = knot; if (knot_tip) { knot->desktop->event_context->defaultMessageContext()->set( Inkscape::NORMAL_MESSAGE, knot_tip); } consumed = true; break; case GDK_LEAVE_NOTIFY: knot->setFlag(SP_KNOT_MOUSEOVER, FALSE); /* FIXME: the following test is a workaround for LP Bug #1273510. * It seems that a signal is not correctly disconnected, maybe * something missing in cc_clear_active_conn()? */ if (cc) { cc->active_handle = nullptr; } if (knot_tip) { knot->desktop->event_context->defaultMessageContext()->clear(); } consumed = true; break; default: break; } knot_unref(knot); return consumed; } static bool endpt_handler(GdkEvent *event, ConnectorTool *cc) { //g_assert( SP_IS_CONNECTOR_CONTEXT(cc) ); gboolean consumed = FALSE; switch (event->type) { case GDK_BUTTON_PRESS: g_assert( (cc->active_handle == cc->endpt_handle[0]) || (cc->active_handle == cc->endpt_handle[1]) ); if (cc->state == SP_CONNECTOR_CONTEXT_IDLE) { cc->clickeditem = cc->active_conn; cc->clickedhandle = cc->active_handle; cc->cc_clear_active_conn(); cc->state = SP_CONNECTOR_CONTEXT_REROUTING; // Disconnect from attached shape unsigned ind = (cc->active_handle == cc->endpt_handle[0]) ? 0 : 1; sp_conn_end_detach(cc->clickeditem, ind); Geom::Point origin; if (cc->clickedhandle == cc->endpt_handle[0]) { origin = cc->endpt_handle[1]->pos; } else { origin = cc->endpt_handle[0]->pos; } // Show the red path for dragging. auto path = static_cast(cc->clickeditem); cc->red_curve = SPCurve::copy(path->curveForEdit()); Geom::Affine i2d = (cc->clickeditem)->i2dt_affine(); cc->red_curve->transform(i2d); cc->red_bpath->set_bpath(cc->red_curve.get(), true); cc->clickeditem->setHidden(true); // The rest of the interaction rerouting the connector is // handled by the context root handler. consumed = TRUE; } break; default: break; } return consumed; } void ConnectorTool::_activeShapeAddKnot(SPItem* item, SPItem* subitem) { SPKnot *knot = new SPKnot(_desktop, "", Inkscape::CANVAS_ITEM_CTRL_TYPE_SHAPER, "CanvasItemCtrl:ConnectorTool:Shape"); knot->owner = item; if (subitem) { SPUse *use = dynamic_cast(item); g_assert(use != nullptr); knot->sub_owner = subitem; knot->setShape(Inkscape::CANVAS_ITEM_CTRL_SHAPE_SQUARE); knot->setSize(11); // Must be odd knot->setAnchor(SP_ANCHOR_CENTER); knot->setFill(0xffffff00, 0xff0000ff, 0xff0000ff, 0xff0000ff); // Set the point to the middle of the sub item knot->setPosition(subitem->getAvoidRef().getConnectionPointPos() * _desktop->doc2dt(), 0); } else { knot->setShape(Inkscape::CANVAS_ITEM_CTRL_SHAPE_SQUARE); knot->setSize(9); // Must be odd knot->setAnchor(SP_ANCHOR_CENTER); knot->setFill(0xffffff00, 0xff0000ff, 0xff0000ff, 0xff0000ff); // Set the point to the middle of the object knot->setPosition(item->getAvoidRef().getConnectionPointPos() * _desktop->doc2dt(), 0); } knot->updateCtrl(); // We don't want to use the standard knot handler. knot->_event_connection.disconnect(); knot->_event_connection = knot->ctrl->connect_event(sigc::bind(sigc::ptr_fun(cc_generic_knot_handler), knot)); knot->show(); this->knots[knot] = 1; } void ConnectorTool::_setActiveShape(SPItem *item) { g_assert(item != nullptr ); if (this->active_shape != item) { // The active shape has changed // Rebuild everything this->active_shape = item; // Remove existing active shape listeners if (this->active_shape_repr) { sp_repr_remove_listener_by_data(this->active_shape_repr, this); Inkscape::GC::release(this->active_shape_repr); sp_repr_remove_listener_by_data(this->active_shape_layer_repr, this); Inkscape::GC::release(this->active_shape_layer_repr); } // Listen in case the active shape changes this->active_shape_repr = item->getRepr(); if (this->active_shape_repr) { Inkscape::GC::anchor(this->active_shape_repr); sp_repr_add_listener(this->active_shape_repr, &shape_repr_events, this); this->active_shape_layer_repr = this->active_shape_repr->parent(); Inkscape::GC::anchor(this->active_shape_layer_repr); sp_repr_add_listener(this->active_shape_layer_repr, &layer_repr_events, this); } cc_clear_active_knots(this->knots); // The idea here is to try and add a group's children to solidify // connection handling. We react to path objects with only one node. for (auto& child: item->children) { if(child.getAttribute("inkscape:connector")) { this->_activeShapeAddKnot((SPItem *) &child, nullptr); } } // Special connector points in a symbol SPUse *use = dynamic_cast(item); if(use) { SPItem *orig = use->root(); //SPItem *orig = use->get_original(); for (auto& child: orig->children) { if(child.getAttribute("inkscape:connector")) { this->_activeShapeAddKnot(item, (SPItem *) &child); } } } // Center point to any object this->_activeShapeAddKnot(item, nullptr); } else { // Ensure the item's connection_points map // has been updated item->document->ensureUpToDate(); } } void ConnectorTool::cc_set_active_conn(SPItem *item) { g_assert( SP_IS_PATH(item) ); const SPCurve *curve = SP_PATH(item)->curveForEdit(); Geom::Affine i2dt = item->i2dt_affine(); if (this->active_conn == item) { if (curve->is_empty()) { // Connector is invisible because it is clipped to the boundary of // two overlapping shapes. this->endpt_handle[0]->hide(); this->endpt_handle[1]->hide(); } else { // Just adjust handle positions. Geom::Point startpt = *(curve->first_point()) * i2dt; this->endpt_handle[0]->setPosition(startpt, 0); Geom::Point endpt = *(curve->last_point()) * i2dt; this->endpt_handle[1]->setPosition(endpt, 0); } return; } this->active_conn = item; // Remove existing active conn listeners if (this->active_conn_repr) { sp_repr_remove_listener_by_data(this->active_conn_repr, this); Inkscape::GC::release(this->active_conn_repr); this->active_conn_repr = nullptr; } // Listen in case the active conn changes this->active_conn_repr = item->getRepr(); if (this->active_conn_repr) { Inkscape::GC::anchor(this->active_conn_repr); sp_repr_add_listener(this->active_conn_repr, &shape_repr_events, this); } for (int i = 0; i < 2; ++i) { // Create the handle if it doesn't exist if ( this->endpt_handle[i] == nullptr ) { SPKnot *knot = new SPKnot(_desktop, _("Connector endpoint: drag to reroute or connect to new shapes"), Inkscape::CANVAS_ITEM_CTRL_TYPE_SHAPER, "CanvasItemCtrl:ConnectorTool:Endpoint"); knot->setShape(Inkscape::CANVAS_ITEM_CTRL_SHAPE_SQUARE); knot->setSize(7); knot->setAnchor(SP_ANCHOR_CENTER); knot->setFill(0xffffff00, 0xff0000ff, 0xff0000ff, 0xff0000ff); knot->setStroke(0x000000ff, 0x000000ff, 0x000000ff, 0x000000ff); knot->updateCtrl(); // We don't want to use the standard knot handler, // since we don't want this knot to be draggable. knot->_event_connection.disconnect(); knot->_event_connection = knot->ctrl->connect_event(sigc::bind(sigc::ptr_fun(cc_generic_knot_handler), knot)); this->endpt_handle[i] = knot; } // Remove any existing handlers this->endpt_handler_connection[i].disconnect(); this->endpt_handler_connection[i] = this->endpt_handle[i]->ctrl->connect_event(sigc::bind(sigc::ptr_fun(endpt_handler), this)); } if (curve->is_empty()) { // Connector is invisible because it is clipped to the boundary // of two overlpapping shapes. So, it doesn't need endpoints. return; } Geom::Point startpt = *(curve->first_point()) * i2dt; this->endpt_handle[0]->setPosition(startpt, 0); Geom::Point endpt = *(curve->last_point()) * i2dt; this->endpt_handle[1]->setPosition(endpt, 0); this->endpt_handle[0]->show(); this->endpt_handle[1]->show(); } void cc_create_connection_point(ConnectorTool* cc) { if (cc->active_shape && cc->state == SP_CONNECTOR_CONTEXT_IDLE) { if (cc->selected_handle) { cc_deselect_handle( cc->selected_handle ); } SPKnot *knot = new SPKnot(cc->getDesktop(), "", Inkscape::CANVAS_ITEM_CTRL_TYPE_SHAPER, "CanvasItemCtrl::ConnectorTool:ConnectionPoint"); // We do not process events on this knot. knot->_event_connection.disconnect(); cc_select_handle( knot ); cc->selected_handle = knot; cc->selected_handle->show(); cc->state = SP_CONNECTOR_CONTEXT_NEWCONNPOINT; } } static bool cc_item_is_shape(SPItem *item) { if (auto path = dynamic_cast(item)) { SPCurve const *curve = path->curve(); if ( curve && !(curve->is_closed()) ) { // Open paths are connectors. return false; } } else if (SP_IS_TEXT(item) || SP_IS_FLOWTEXT(item)) { Inkscape::Preferences *prefs = Inkscape::Preferences::get(); if (prefs->getBool("/tools/connector/ignoretext", true)) { // Don't count text as a shape we can connect connector to. return false; } } return true; } bool cc_item_is_connector(SPItem *item) { if (SP_IS_PATH(item)) { bool closed = SP_PATH(item)->curveForEdit()->is_closed(); if (SP_PATH(item)->connEndPair.isAutoRoutingConn() && !closed) { // To be considered a connector, an object must be a non-closed // path that is marked with a "inkscape:connector-type" attribute. return true; } } return false; } void cc_selection_set_avoid(SPDesktop *desktop, bool const set_avoid) { if (desktop == nullptr) { return; } SPDocument *document = desktop->getDocument(); Inkscape::Selection *selection = desktop->getSelection(); int changes = 0; for (SPItem *item: selection->items()) { char const *value = (set_avoid) ? "true" : nullptr; if (cc_item_is_shape(item)) { item->setAttribute("inkscape:connector-avoid", value); item->getAvoidRef().handleSettingChange(); changes++; } } if (changes == 0) { desktop->messageStack()->flash(Inkscape::WARNING_MESSAGE, _("Select at least one non-connector object.")); return; } char *event_desc = (set_avoid) ? _("Make connectors avoid selected objects") : _("Make connectors ignore selected objects"); DocumentUndo::done(document, event_desc, INKSCAPE_ICON("draw-connector")); } void ConnectorTool::_selectionChanged(Inkscape::Selection *selection) { SPItem *item = selection->singleItem(); if (this->active_conn == item) { // Nothing to change. return; } if (item == nullptr) { this->cc_clear_active_conn(); return; } if (cc_item_is_connector(item)) { this->cc_set_active_conn(item); } } static void shape_event_attr_deleted(Inkscape::XML::Node */*repr*/, Inkscape::XML::Node *child, Inkscape::XML::Node */*ref*/, gpointer data) { g_assert(data); ConnectorTool *cc = SP_CONNECTOR_CONTEXT(data); if (child == cc->active_shape_repr) { // The active shape has been deleted. Clear active shape. cc->cc_clear_active_shape(); } } static void shape_event_attr_changed(Inkscape::XML::Node *repr, gchar const *name, gchar const */*old_value*/, gchar const */*new_value*/, bool /*is_interactive*/, gpointer data) { g_assert(data); ConnectorTool *cc = SP_CONNECTOR_CONTEXT(data); // Look for changes that result in onscreen movement. if (!strcmp(name, "d") || !strcmp(name, "x") || !strcmp(name, "y") || !strcmp(name, "width") || !strcmp(name, "height") || !strcmp(name, "transform")) { if (repr == cc->active_shape_repr) { // Active shape has moved. Clear active shape. cc->cc_clear_active_shape(); } else if (repr == cc->active_conn_repr) { // The active conn has been moved. // Set it again, which just sets new handle positions. cc->cc_set_active_conn(cc->active_conn); } } } } } } /* 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:fileencoding=utf-8:textwidth=99 :