src/ui/tool/multi-path-manipulator.cpp

   1 /** @file
   2  * Multi path manipulator - implementation
   3  */
   4 /* Authors:
   5  *   Krzysztof Kosiński <tweenk.pl@gmail.com>
   6  *
   7  * Copyright (C) 2009 Authors
   8  * Released under GNU GPL, read the file 'COPYING' for more information
   9  */
  10
  11 #include <tr1/unordered_set>
  12 #include <boost/shared_ptr.hpp>
  13 #include <glib.h>
  14 #include <glibmm/i18n.h>
  15 #include "desktop.h"
  16 #include "desktop-handles.h"
  17 #include "document.h"
  18 #include "live_effects/lpeobject.h"
  19 #include "message-stack.h"
  20 #include "preferences.h"
  21 #include "sp-path.h"
  22 #include "ui/tool/control-point-selection.h"
  23 #include "ui/tool/event-utils.h"
  24 #include "ui/tool/node.h"
  25 #include "ui/tool/multi-path-manipulator.h"
  26 #include "ui/tool/path-manipulator.h"
  27
  28 namespace std { using namespace tr1; }
  29
  30 namespace Inkscape {
  31 namespace UI {
  32
  33 namespace {
  34 typedef std::pair<NodeList::iterator, NodeList::iterator> IterPair;
  35 typedef std::vector<IterPair> IterPairList;
  36 typedef std::unordered_set<NodeList::iterator> IterSet;
  37 typedef std::multimap<double, IterPair> DistanceMap;
  38 typedef std::pair<double, IterPair> DistanceMapItem;
  39
  40 /** Find pairs of selected endnodes suitable for joining. */
  41 void find_join_iterators(ControlPointSelection &sel, IterPairList &pairs)
  42 {
  43     IterSet join_iters;
  44     DistanceMap dists;
  45
  46     // find all endnodes in selection
  47     for (ControlPointSelection::iterator i = sel.begin(); i != sel.end(); ++i) {
  48         Node *node = dynamic_cast<Node*>(i->first);
  49         if (!node) continue;
  50         NodeList::iterator iter = NodeList::get_iterator(node);
  51         if (!iter.next() || !iter.prev()) join_iters.insert(iter);
  52     }
  53
  54     if (join_iters.size() < 2) return;
  55
  56     // Below we find the closest pairs. The algorithm is O(N^3).
  57     // We can go down to O(N^2 log N) by using O(N^2) memory, by putting all pairs
  58     // with their distances in a multimap (not worth it IMO).
  59     while (join_iters.size() >= 2) {
  60         double closest = DBL_MAX;
  61         IterPair closest_pair;
  62         for (IterSet::iterator i = join_iters.begin(); i != join_iters.end(); ++i) {
  63             for (IterSet::iterator j = join_iters.begin(); j != i; ++j) {
  64                 double dist = Geom::distance(**i, **j);
  65                 if (dist < closest) {
  66                     closest = dist;
  67                     closest_pair = std::make_pair(*i, *j);
  68                 }
  69             }
  70         }
  71         pairs.push_back(closest_pair);
  72         join_iters.erase(closest_pair.first);
  73         join_iters.erase(closest_pair.second);
  74     }
  75 }
  76
  77 /** After this function, first should be at the end of path and second at the beginnning.
  78  * @returns True if the nodes are in the same subpath */
  79 bool prepare_join(IterPair &join_iters)
  80 {
  81     if (&NodeList::get(join_iters.first) == &NodeList::get(join_iters.second)) {
  82         if (join_iters.first.next()) // if first is begin, swap the iterators
  83             std::swap(join_iters.first, join_iters.second);
  84         return true;
  85     }
  86
  87     NodeList &sp_first = NodeList::get(join_iters.first);
  88     NodeList &sp_second = NodeList::get(join_iters.second);
  89     if (join_iters.first.next()) { // first is begin
  90         if (join_iters.second.next()) { // second is begin
  91             sp_first.reverse();
  92         } else { // second is end
  93             std::swap(join_iters.first, join_iters.second);
  94         }
  95     } else { // first is end
  96         if (join_iters.second.next()) { // second is begin
  97             // do nothing
  98         } else { // second is end
  99             sp_second.reverse();
 100         }
 101     }
 102     return false;
 103 }
 104 } // anonymous namespace
 105
 106
 107 MultiPathManipulator::MultiPathManipulator(PathSharedData &data, sigc::connection &chg)
 108     : PointManipulator(data.node_data.desktop, *data.node_data.selection)
 109     , _path_data(data)
 110     , _changed(chg)
 111 {
 112     _selection.signal_commit.connect(
 113         sigc::mem_fun(*this, &MultiPathManipulator::_commit));
 114     _selection.signal_point_changed.connect(
 115         sigc::hide( sigc::hide(
 116             signal_coords_changed.make_slot())));
 117 }
 118
 119 MultiPathManipulator::~MultiPathManipulator()
 120 {
 121     _mmap.clear();
 122 }
 123
 124 /** Remove empty manipulators. */
 125 void MultiPathManipulator::cleanup()
 126 {
 127     for (MapType::iterator i = _mmap.begin(); i != _mmap.end(); ) {
 128         if (i->second->empty()) _mmap.erase(i++);
 129         else ++i;
 130     }
 131 }
 132
 133 /** @brief Change the set of items to edit.
 134  *
 135  * This method attempts to preserve as much of the state as possible. */
 136 void MultiPathManipulator::setItems(std::set<ShapeRecord> const &s)
 137 {
 138     std::set<ShapeRecord> shapes(s);
 139
 140     // iterate over currently edited items, modifying / removing them as necessary
 141     for (MapType::iterator i = _mmap.begin(); i != _mmap.end();) {
 142         std::set<ShapeRecord>::iterator si = shapes.find(i->first);
 143         if (si == shapes.end()) {
 144             // This item is no longer supposed to be edited - remove its manipulator
 145             _mmap.erase(i++);
 146         } else {
 147             ShapeRecord const &sr = i->first;
 148             ShapeRecord const &sr_new = *si;
 149             // if the shape record differs, replace the key only and modify other values
 150             if (sr.edit_transform != sr_new.edit_transform ||
 151                 sr.role != sr_new.role)
 152             {
 153                 boost::shared_ptr<PathManipulator> hold(i->second);
 154                 if (sr.edit_transform != sr_new.edit_transform)
 155                     hold->setControlsTransform(sr_new.edit_transform);
 156                 if (sr.role != sr_new.role) {
 157                     //hold->setOutlineColor(_getOutlineColor(sr_new.role));
 158                 }
 159                 _mmap.erase(sr);
 160                 _mmap.insert(std::make_pair(sr_new, hold));
 161             }
 162             shapes.erase(si); // remove the processed record
 163             ++i;
 164         }
 165     }
 166
 167     // add newly selected items
 168     for (std::set<ShapeRecord>::iterator i = shapes.begin(); i != shapes.end(); ++i) {
 169         ShapeRecord const &r = *i;
 170         if (!SP_IS_PATH(r.item) && !IS_LIVEPATHEFFECT(r.item)) continue;
 171         boost::shared_ptr<PathManipulator> newpm(new PathManipulator(*this, (SPPath*) r.item,
 172             r.edit_transform, _getOutlineColor(r.role), r.lpe_key));
 173         newpm->showHandles(_show_handles);
 174         // always show outlines for clips and masks
 175         newpm->showOutline(_show_outline || r.role != SHAPE_ROLE_NORMAL);
 176         newpm->showPathDirection(_show_path_direction);
 177         _mmap.insert(std::make_pair(r, newpm));
 178     }
 179 }
 180
 181 void MultiPathManipulator::selectSubpaths()
 182 {
 183     if (_selection.empty()) {
 184         _selection.selectAll();
 185     } else {
 186         invokeForAll(&PathManipulator::selectSubpaths);
 187     }
 188 }
 189
 190 void MultiPathManipulator::shiftSelection(int dir)
 191 {
 192     invokeForAll(&PathManipulator::shiftSelection, dir);
 193 }
 194
 195 void MultiPathManipulator::invertSelectionInSubpaths()
 196 {
 197     invokeForAll(&PathManipulator::invertSelectionInSubpaths);
 198 }
 199
 200 void MultiPathManipulator::setNodeType(NodeType type)
 201 {
 202     if (_selection.empty()) return;
 203     for (ControlPointSelection::iterator i = _selection.begin(); i != _selection.end(); ++i) {
 204         Node *node = dynamic_cast<Node*>(i->first);
 205         if (node) node->setType(type);
 206     }
 207     _done(_("Change node type"));
 208 }
 209
 210 void MultiPathManipulator::setSegmentType(SegmentType type)
 211 {
 212     if (_selection.empty()) return;
 213     invokeForAll(&PathManipulator::setSegmentType, type);
 214     if (type == SEGMENT_STRAIGHT) {
 215         _done(_("Straighten segments"));
 216     } else {
 217         _done(_("Make segments curves"));
 218     }
 219 }
 220
 221 void MultiPathManipulator::insertNodes()
 222 {
 223     invokeForAll(&PathManipulator::insertNodes);
 224     _done(_("Add nodes"));
 225 }
 226
 227 void MultiPathManipulator::joinNodes()
 228 {
 229     invokeForAll(&PathManipulator::hideDragPoint);
 230     // Node join has two parts. In the first one we join two subpaths by fusing endpoints
 231     // into one. In the second we fuse nodes in each subpath.
 232     IterPairList joins;
 233     NodeList::iterator preserve_pos;
 234     Node *mouseover_node = dynamic_cast<Node*>(ControlPoint::mouseovered_point);
 235     if (mouseover_node) {
 236         preserve_pos = NodeList::get_iterator(mouseover_node);
 237     }
 238     find_join_iterators(_selection, joins);
 239
 240     for (IterPairList::iterator i = joins.begin(); i != joins.end(); ++i) {
 241         bool same_path = prepare_join(*i);
 242         bool mouseover = true;
 243         NodeList &sp_first = NodeList::get(i->first);
 244         NodeList &sp_second = NodeList::get(i->second);
 245         i->first->setType(NODE_CUSP, false);
 246
 247         Geom::Point joined_pos, pos_front, pos_back;
 248         pos_front = *i->second->front();
 249         pos_back = *i->first->back();
 250         if (i->first == preserve_pos) {
 251             joined_pos = *i->first;
 252         } else if (i->second == preserve_pos) {
 253             joined_pos = *i->second;
 254         } else {
 255             joined_pos = Geom::middle_point(pos_back, pos_front);
 256             mouseover = false;
 257         }
 258
 259         // if the handles aren't degenerate, don't move them
 260         i->first->move(joined_pos);
 261         Node *joined_node = i->first.ptr();
 262         if (!i->second->front()->isDegenerate()) {
 263             joined_node->front()->setPosition(pos_front);
 264         }
 265         if (!i->first->back()->isDegenerate()) {
 266             joined_node->back()->setPosition(pos_back);
 267         }
 268         if (mouseover) {
 269             // Second node could be mouseovered, but it will be deleted, so we must change
 270             // the preserve_pos iterator to the first node.
 271             preserve_pos = i->first;
 272         }
 273         sp_second.erase(i->second);
 274
 275         if (same_path) {
 276             sp_first.setClosed(true);
 277         } else {
 278             sp_first.splice(sp_first.end(), sp_second);
 279             sp_second.kill();
 280         }
 281         _selection.insert(i->first.ptr());
 282     }
 283
 284     if (joins.empty()) {
 285         // Second part replaces contiguous selections of nodes with single nodes
 286         invokeForAll(&PathManipulator::weldNodes, preserve_pos);
 287     }
 288
 289     _doneWithCleanup(_("Join nodes"));
 290 }
 291
 292 void MultiPathManipulator::breakNodes()
 293 {
 294     if (_selection.empty()) return;
 295     invokeForAll(&PathManipulator::breakNodes);
 296     _done(_("Break nodes"));
 297 }
 298
 299 void MultiPathManipulator::deleteNodes(bool keep_shape)
 300 {
 301     if (_selection.empty()) return;
 302     invokeForAll(&PathManipulator::deleteNodes, keep_shape);
 303     _doneWithCleanup(_("Delete nodes"));
 304 }
 305
 306 /** Join selected endpoints to create segments. */
 307 void MultiPathManipulator::joinSegments()
 308 {
 309     IterPairList joins;
 310     find_join_iterators(_selection, joins);
 311
 312     for (IterPairList::iterator i = joins.begin(); i != joins.end(); ++i) {
 313         bool same_path = prepare_join(*i);
 314         NodeList &sp_first = NodeList::get(i->first);
 315         NodeList &sp_second = NodeList::get(i->second);
 316         i->first->setType(NODE_CUSP, false);
 317         i->second->setType(NODE_CUSP, false);
 318         if (same_path) {
 319             sp_first.setClosed(true);
 320         } else {
 321             sp_first.splice(sp_first.end(), sp_second);
 322             sp_second.kill();
 323         }
 324     }
 325
 326     if (joins.empty()) {
 327         invokeForAll(&PathManipulator::weldSegments);
 328     }
 329     _doneWithCleanup("Join segments");
 330 }
 331
 332 void MultiPathManipulator::deleteSegments()
 333 {
 334     if (_selection.empty()) return;
 335     invokeForAll(&PathManipulator::deleteSegments);
 336     _doneWithCleanup("Delete segments");
 337 }
 338
 339 void MultiPathManipulator::alignNodes(Geom::Dim2 d)
 340 {
 341     _selection.align(d);
 342     if (d == Geom::X) {
 343         _done("Align nodes to a horizontal line");
 344     } else {
 345         _done("Align nodes to a vertical line");
 346     }
 347 }
 348
 349 void MultiPathManipulator::distributeNodes(Geom::Dim2 d)
 350 {
 351     _selection.distribute(d);
 352     if (d == Geom::X) {
 353         _done("Distrubute nodes horizontally");
 354     } else {
 355         _done("Distribute nodes vertically");
 356     }
 357 }
 358
 359 void MultiPathManipulator::reverseSubpaths()
 360 {
 361     if (_selection.empty()) {
 362         invokeForAll(&PathManipulator::reverseSubpaths, false);
 363         _done("Reverse subpaths");
 364     } else {
 365         invokeForAll(&PathManipulator::reverseSubpaths, true);
 366         _done("Reverse selected subpaths");
 367     }
 368 }
 369
 370 void MultiPathManipulator::move(Geom::Point const &delta)
 371 {
 372     _selection.transform(Geom::Translate(delta));
 373     _done("Move nodes");
 374 }
 375
 376 void MultiPathManipulator::showOutline(bool show)
 377 {
 378     for (MapType::iterator i = _mmap.begin(); i != _mmap.end(); ++i) {
 379         // always show outlines for clipping paths and masks
 380         i->second->showOutline(show || i->first.role != SHAPE_ROLE_NORMAL);
 381     }
 382     _show_outline = show;
 383 }
 384
 385 void MultiPathManipulator::showHandles(bool show)
 386 {
 387     invokeForAll(&PathManipulator::showHandles, show);
 388     _show_handles = show;
 389 }
 390
 391 void MultiPathManipulator::showPathDirection(bool show)
 392 {
 393     invokeForAll(&PathManipulator::showPathDirection, show);
 394     _show_path_direction = show;
 395 }
 396
 397 void MultiPathManipulator::updateOutlineColors()
 398 {
 399     //for (MapType::iterator i = _mmap.begin(); i != _mmap.end(); ++i) {
 400     //    i->second->setOutlineColor(_getOutlineColor(i->first.role));
 401     //}
 402 }
 403
 404 bool MultiPathManipulator::event(GdkEvent *event)
 405 {
 406     switch (event->type) {
 407     case GDK_KEY_PRESS:
 408         switch (shortcut_key(event->key)) {
 409         case GDK_Insert:
 410         case GDK_KP_Insert:
 411             // Insert - insert nodes in the middle of selected segments
 412             insertNodes();
 413             return true;
 414         case GDK_i:
 415         case GDK_I:
 416             if (held_only_shift(event->key)) {
 417                 // Shift+I - insert nodes (alternate keybinding for Mac keyboards
 418                 //           that don't have the Insert key)
 419                 insertNodes();
 420                 return true;
 421             }
 422             break;
 423         case GDK_j:
 424         case GDK_J:
 425             if (held_only_shift(event->key)) {
 426                 // Shift+J - join nodes
 427                 joinNodes();
 428                 return true;
 429             }
 430             if (held_only_alt(event->key)) {
 431                 // Alt+J - join segments
 432                 joinSegments();
 433                 return true;
 434             }
 435             break;
 436         case GDK_b:
 437         case GDK_B:
 438             if (held_only_shift(event->key)) {
 439                 // Shift+B - break nodes
 440                 breakNodes();
 441                 return true;
 442             }
 443             break;
 444         case GDK_Delete:
 445         case GDK_KP_Delete:
 446         case GDK_BackSpace:
 447             if (held_shift(event->key)) break;
 448             if (held_alt(event->key)) {
 449                 // Alt+Delete - delete segments
 450                 deleteSegments();
 451             } else {
 452                 // Control+Delete - delete nodes
 453                 // Delete - delete nodes preserving shape
 454                 deleteNodes(!held_control(event->key));
 455             }
 456             return true;
 457         case GDK_c:
 458         case GDK_C:
 459             if (held_only_shift(event->key)) {
 460                 // Shift+C - make nodes cusp
 461                 setNodeType(NODE_CUSP);
 462                 return true;
 463             }
 464             break;
 465         case GDK_s:
 466         case GDK_S:
 467             if (held_only_shift(event->key)) {
 468                 // Shift+S - make nodes smooth
 469                 setNodeType(NODE_SMOOTH);
 470                 return true;
 471             }
 472             break;
 473         case GDK_a:
 474         case GDK_A:
 475             if (held_only_shift(event->key)) {
 476                 // Shift+A - make nodes auto-smooth
 477                 setNodeType(NODE_AUTO);
 478                 return true;
 479             }
 480             break;
 481         case GDK_y:
 482         case GDK_Y:
 483             if (held_only_shift(event->key)) {
 484                 // Shift+Y - make nodes symmetric
 485                 setNodeType(NODE_SYMMETRIC);
 486                 return true;
 487             }
 488             break;
 489         case GDK_r:
 490         case GDK_R:
 491             if (held_only_shift(event->key)) {
 492                 // Shift+R - reverse subpaths
 493                 reverseSubpaths();
 494             }
 495             break;
 496         default:
 497             break;
 498         }
 499         break;
 500     default: break;
 501     }
 502
 503     for (MapType::iterator i = _mmap.begin(); i != _mmap.end(); ++i) {
 504         if (i->second->event(event)) return true;
 505     }
 506     return false;
 507 }
 508
 509 /** Commit changes to XML and add undo stack entry based on the action that was done. Invoked
 510  * by sub-manipulators, for example TransformHandleSet and ControlPointSelection. */
 511 void MultiPathManipulator::_commit(CommitEvent cps)
 512 {
 513     gchar const *reason = NULL;
 514     gchar const *key = NULL;
 515     switch(cps) {
 516     case COMMIT_MOUSE_MOVE:
 517         reason = _("Move nodes");
 518         break;
 519     case COMMIT_KEYBOARD_MOVE_X:
 520         reason = _("Move nodes horizontally");
 521         key = "node:move:x";
 522         break;
 523     case COMMIT_KEYBOARD_MOVE_Y:
 524         reason = _("Move nodes vertically");
 525         key = "node:move:y";
 526         break;
 527     case COMMIT_MOUSE_ROTATE:
 528         reason = _("Rotate nodes");
 529         break;
 530     case COMMIT_KEYBOARD_ROTATE:
 531         reason = _("Rotate nodes");
 532         key = "node:rotate";
 533         break;
 534     case COMMIT_MOUSE_SCALE_UNIFORM:
 535         reason = _("Scale nodes uniformly");
 536         break;
 537     case COMMIT_MOUSE_SCALE:
 538         reason = _("Scale nodes");
 539         break;
 540     case COMMIT_KEYBOARD_SCALE_UNIFORM:
 541         reason = _("Scale nodes uniformly");
 542         key = "node:scale:uniform";
 543         break;
 544     case COMMIT_KEYBOARD_SCALE_X:
 545         reason = _("Scale nodes horizontally");
 546         key = "node:scale:x";
 547         break;
 548     case COMMIT_KEYBOARD_SCALE_Y:
 549         reason = _("Scale nodes vertically");
 550         key = "node:scale:y";
 551         break;
 552     case COMMIT_FLIP_X:
 553         reason = _("Flip nodes horizontally");
 554         break;
 555     case COMMIT_FLIP_Y:
 556         reason = _("Flip nodes vertically");
 557         break;
 558     default: return;
 559     }
 560
 561     _selection.signal_update.emit();
 562     invokeForAll(&PathManipulator::writeXML);
 563     if (key) {
 564         sp_document_maybe_done(sp_desktop_document(_desktop), key, SP_VERB_CONTEXT_NODE, reason);
 565     } else {
 566         sp_document_done(sp_desktop_document(_desktop), SP_VERB_CONTEXT_NODE, reason);
 567     }
 568     signal_coords_changed.emit();
 569 }
 570
 571 /** Commits changes to XML and adds undo stack entry. */
 572 void MultiPathManipulator::_done(gchar const *reason) {
 573     invokeForAll(&PathManipulator::update);
 574     invokeForAll(&PathManipulator::writeXML);
 575     sp_document_done(sp_desktop_document(_desktop), SP_VERB_CONTEXT_NODE, reason);
 576     signal_coords_changed.emit();
 577 }
 578
 579 /** Commits changes to XML, adds undo stack entry and removes empty manipulators. */
 580 void MultiPathManipulator::_doneWithCleanup(gchar const *reason) {
 581     _changed.block();
 582     _done(reason);
 583     cleanup();
 584     _changed.unblock();
 585 }
 586
 587 /** Get an outline color based on the shape's role (normal, mask, LPE parameter, etc.). */
 588 guint32 MultiPathManipulator::_getOutlineColor(ShapeRole role)
 589 {
 590     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 591     switch(role) {
 592     case SHAPE_ROLE_CLIPPING_PATH:
 593         return prefs->getColor("/tools/nodes/clipping_path_color", 0x00ff00ff);
 594     case SHAPE_ROLE_MASK:
 595         return prefs->getColor("/tools/nodes/mask_color", 0x0000ffff);
 596     case SHAPE_ROLE_LPE_PARAM:
 597         return prefs->getColor("/tools/nodes/lpe_param_color", 0x009000ff);
 598     case SHAPE_ROLE_NORMAL:
 599     default:
 600         return prefs->getColor("/tools/nodes/outline_color", 0xff0000ff);
 601     }
 602 }
 603
 604 } // namespace UI
 605 } // namespace Inkscape
 606
 607 /*
 608   Local Variables:
 609   mode:c++
 610   c-file-style:"stroustrup"
 611   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 612   indent-tabs-mode:nil
 613   fill-column:99
 614   End:
 615 */
 616 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :