src/object-snapper.cpp

   1 /**
   2  *  \file object-snapper.cpp
   3  *  \brief Snapping things to objects.
   4  *
   5  * Authors:
   6  *   Carl Hetherington <inkscape@carlh.net>
   7  *   Diederik van Lierop <mail@diedenrezi.nl>
   8  *
   9  * Copyright (C) 2005 - 2008 Authors
  10  *
  11  * Released under GNU GPL, read the file 'COPYING' for more information
  12  */
  13
  14 #include "svg/svg.h"
  15 #include "libnr/nr-rect-ops.h"
  16 #include "libnr/nr-point-fns.h"
  17 #include <2geom/path-intersection.h>
  18 #include <2geom/point.h>
  19 #include <2geom/rect.h>
  20 #include "document.h"
  21 #include "sp-namedview.h"
  22 #include "sp-image.h"
  23 #include "sp-item-group.h"
  24 #include "sp-item.h"
  25 #include "sp-use.h"
  26 #include "display/curve.h"
  27 #include "inkscape.h"
  28 #include "preferences.h"
  29 #include "sp-text.h"
  30 #include "sp-flowtext.h"
  31 #include "text-editing.h"
  32 #include "sp-clippath.h"
  33 #include "sp-mask.h"
  34 #include "helper/geom-curves.h"
  35 #include "desktop.h"
  36
  37 Inkscape::SnapCandidate::SnapCandidate(SPItem* item, bool clip_or_mask, Geom::Matrix additional_affine)
  38     : item(item), clip_or_mask(clip_or_mask), additional_affine(additional_affine)
  39 {
  40 }
  41
  42 Inkscape::SnapCandidate::~SnapCandidate()
  43 {
  44 }
  45
  46 Inkscape::ObjectSnapper::ObjectSnapper(SnapManager const *sm, Geom::Coord const d)
  47     : Snapper(sm, d), _snap_to_itemnode(true), _snap_to_itempath(true),
  48       _snap_to_bboxnode(true), _snap_to_bboxpath(true), _snap_to_page_border(false),
  49       _strict_snapping(true)
  50 {
  51     _candidates = new std::vector<SnapCandidate>;
  52     _points_to_snap_to = new std::vector<Geom::Point>;
  53     _paths_to_snap_to = new std::vector<Geom::PathVector*>;
  54 }
  55
  56 Inkscape::ObjectSnapper::~ObjectSnapper()
  57 {
  58     _candidates->clear();
  59     delete _candidates;
  60
  61     _points_to_snap_to->clear();
  62     delete _points_to_snap_to;
  63
  64     _clear_paths();
  65     delete _paths_to_snap_to;
  66 }
  67
  68 /**
  69  *  Find all items within snapping range.
  70  *  \param parent Pointer to the document's root, or to a clipped path or mask object
  71  *  \param it List of items to ignore
  72  *  \param first_point If true then this point is the first one from a whole bunch of points
  73  *  \param bbox_to_snap Bounding box hulling the whole bunch of points, all from the same selection and having the same transformation
  74  *  \param DimensionToSnap Snap in X, Y, or both directions.
  75  */
  76
  77 void Inkscape::ObjectSnapper::_findCandidates(SPObject* parent,
  78                                               std::vector<SPItem const *> const *it,
  79                                               bool const &first_point,
  80                                               Geom::Rect const &bbox_to_snap,
  81                                               DimensionToSnap const snap_dim,
  82                                               bool const clip_or_mask,
  83                                               Geom::Matrix const additional_affine) const // transformation of the item being clipped / masked
  84 {
  85     bool const c1 = (snap_dim == TRANSL_SNAP_XY) && ThisSnapperMightSnap();
  86     bool const c2 = (snap_dim != TRANSL_SNAP_XY) && GuidesMightSnap();
  87
  88     if (!(c1 || c2)) {
  89         return;
  90     }
  91
  92     if (first_point) {
  93         _candidates->clear();
  94     }
  95
  96     Geom::Rect bbox_to_snap_incl = bbox_to_snap; // _incl means: will include the snapper tolerance
  97     bbox_to_snap_incl.expandBy(getSnapperTolerance()); // see?
  98
  99     for (SPObject* o = sp_object_first_child(parent); o != NULL; o = SP_OBJECT_NEXT(o)) {
 100         g_assert(_snapmanager->getDesktop() != NULL);
 101         if (SP_IS_ITEM(o) && !SP_ITEM(o)->isLocked() && !(_snapmanager->getDesktop()->itemIsHidden(SP_ITEM(o)) && !clip_or_mask)) {
 102             // Don't snap to locked items, and
 103             // don't snap to hidden objects, unless they're a clipped path or a mask
 104             /* See if this item is on the ignore list */
 105             std::vector<SPItem const *>::const_iterator i;
 106             if (it != NULL) {
 107                 i = it->begin();
 108                 while (i != it->end() && *i != o) {
 109                     i++;
 110                 }
 111             }
 112
 113             if (it == NULL || i == it->end()) {
 114                 SPItem *item = SP_ITEM(o);
 115                 Geom::Matrix transform = Geom::identity();
 116                 if (item) {
 117                     SPObject *obj = NULL;
 118                     if (clip_or_mask) { // If the current item is a clipping path or a mask
 119                         // then store the transformation of the clipped path or mask itself
 120                         // but also take into account the additional affine of the object
 121                         // being clipped / masked
 122                         transform = to_2geom(item->transform) * additional_affine;
 123                     } else { // cannot clip or mask more than once
 124                         // The current item is not a clipping path or a mask, but might
 125                         // still be the subject of clipping or masking itself ; if so, then
 126                         // we should also consider that path or mask for snapping to
 127                         obj = SP_OBJECT(item->clip_ref->getObject());
 128                         if (obj) {
 129                             _findCandidates(obj, it, false, bbox_to_snap, snap_dim, true, item->transform);
 130                         }
 131                         obj = SP_OBJECT(item->mask_ref->getObject());
 132                         if (obj) {
 133                             _findCandidates(obj, it, false, bbox_to_snap, snap_dim, true, item->transform);
 134                         }
 135                     }
 136                 }
 137
 138                 if (SP_IS_GROUP(o)) {
 139                     _findCandidates(o, it, false, bbox_to_snap, snap_dim, false, Geom::identity());
 140                 } else {
 141                     boost::optional<Geom::Rect> bbox_of_item = Geom::Rect();
 142                     if (clip_or_mask) {
 143                         // Oh oh, this will get ugly. We cannot use sp_item_i2d_affine directly because we need to
 144                         // insert an additional transformation in document coordinates (code copied from sp_item_i2d_affine)
 145                         sp_item_invoke_bbox(item,
 146                             bbox_of_item,
 147                             sp_item_i2doc_affine(item) * matrix_to_desktop(additional_affine, item),
 148                             true);
 149                     } else {
 150                         sp_item_invoke_bbox(item, bbox_of_item, sp_item_i2d_affine(item), true);
 151                     }
 152                     if (bbox_of_item) {
 153                         // See if the item is within range
 154                         if (bbox_to_snap_incl.intersects(*bbox_of_item)) {
 155                             // This item is within snapping range, so record it as a candidate
 156                             _candidates->push_back(SnapCandidate(item, clip_or_mask, additional_affine));
 157                         }
 158                     }
 159                 }
 160             }
 161         }
 162     }
 163 }
 164
 165
 166 void Inkscape::ObjectSnapper::_collectNodes(Inkscape::SnapPreferences::PointType const &t,
 167                                          bool const &first_point) const
 168 {
 169     // Now, let's first collect all points to snap to. If we have a whole bunch of points to snap,
 170     // e.g. when translating an item using the selector tool, then we will only do this for the
 171     // first point and store the collection for later use. This significantly improves the performance
 172     if (first_point) {
 173         _points_to_snap_to->clear();
 174
 175          // Determine the type of bounding box we should snap to
 176         SPItem::BBoxType bbox_type = SPItem::GEOMETRIC_BBOX;
 177
 178         bool p_is_a_node = t & Inkscape::SnapPreferences::SNAPPOINT_NODE;
 179         bool p_is_a_bbox = t & Inkscape::SnapPreferences::SNAPPOINT_BBOX;
 180         bool p_is_a_guide = t & Inkscape::SnapPreferences::SNAPPOINT_GUIDE;
 181
 182         // A point considered for snapping should be either a node, a bbox corner or a guide. Pick only ONE!
 183         g_assert(!((p_is_a_node && p_is_a_bbox) || (p_is_a_bbox && p_is_a_guide) || (p_is_a_node && p_is_a_guide)));
 184
 185         if (_snap_to_bboxnode) {
 186             Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 187             bool prefs_bbox = prefs->getBool("/tools/bounding_box");
 188             bbox_type = !prefs_bbox ?
 189                 SPItem::APPROXIMATE_BBOX : SPItem::GEOMETRIC_BBOX;
 190         }
 191
 192         // Consider the page border for snapping
 193         if (_snap_to_page_border) {
 194             _getBorderNodes(_points_to_snap_to);
 195         }
 196
 197         for (std::vector<SnapCandidate>::const_iterator i = _candidates->begin(); i != _candidates->end(); i++) {
 198             //Geom::Matrix i2doc(Geom::identity());
 199             SPItem *root_item = (*i).item;
 200             if (SP_IS_USE((*i).item)) {
 201                 root_item = sp_use_root(SP_USE((*i).item));
 202             }
 203             g_return_if_fail(root_item);
 204
 205             //Collect all nodes so we can snap to them
 206             if (_snap_to_itemnode) {
 207                 if (!(_strict_snapping && !p_is_a_node) || p_is_a_guide) {
 208                     sp_item_snappoints(root_item, SnapPointsIter(*_points_to_snap_to), &_snapmanager->snapprefs);
 209                 }
 210             }
 211
 212             //Collect the bounding box's corners so we can snap to them
 213             if (_snap_to_bboxnode) {
 214                 if (!(_strict_snapping && !p_is_a_bbox) || p_is_a_guide) {
 215                     // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
 216                     // of the item AND the bbox of the clipping path at the same time
 217                     if (!(*i).clip_or_mask) {
 218                         boost::optional<Geom::Rect> b = sp_item_bbox_desktop(root_item, bbox_type);
 219                         if (b) {
 220                             for ( unsigned k = 0 ; k < 4 ; k++ ) {
 221                                 _points_to_snap_to->push_back(b->corner(k));
 222                             }
 223                         }
 224                     }
 225                 }
 226             }
 227         }
 228     }
 229 }
 230
 231 void Inkscape::ObjectSnapper::_snapNodes(SnappedConstraints &sc,
 232                                          Inkscape::SnapPreferences::PointType const &t,
 233                                          Geom::Point const &p,
 234                                          bool const &first_point,
 235                                          std::vector<Geom::Point> *unselected_nodes) const
 236 {
 237     // Iterate through all nodes, find out which one is the closest to p, and snap to it!
 238
 239     _collectNodes(t, first_point);
 240
 241     if (unselected_nodes != NULL) {
 242         _points_to_snap_to->insert(_points_to_snap_to->end(), unselected_nodes->begin(), unselected_nodes->end());
 243     }
 244
 245     SnappedPoint s;
 246     bool success = false;
 247
 248     for (std::vector<Geom::Point>::const_iterator k = _points_to_snap_to->begin(); k != _points_to_snap_to->end(); k++) {
 249         Geom::Coord dist = Geom::L2(*k - p);
 250         if (dist < getSnapperTolerance() && dist < s.getDistance()) {
 251             s = SnappedPoint(*k, SNAPTARGET_NODE, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
 252             success = true;
 253         }
 254     }
 255
 256     if (success) {
 257         sc.points.push_back(s);
 258     }
 259 }
 260
 261 void Inkscape::ObjectSnapper::_snapTranslatingGuideToNodes(SnappedConstraints &sc,
 262                                          Inkscape::SnapPreferences::PointType const &t,
 263                                          Geom::Point const &p,
 264                                          Geom::Point const &guide_normal) const
 265 {
 266     // Iterate through all nodes, find out which one is the closest to this guide, and snap to it!
 267     _collectNodes(t, true);
 268
 269     SnappedPoint s;
 270     bool success = false;
 271
 272     Geom::Coord tol = getSnapperTolerance();
 273
 274     for (std::vector<Geom::Point>::const_iterator k = _points_to_snap_to->begin(); k != _points_to_snap_to->end(); k++) {
 275         // Project each node (*k) on the guide line (running through point p)
 276         Geom::Point p_proj = project_on_linesegment(*k, p, p + Geom::rot90(guide_normal));
 277         Geom::Coord dist = Geom::L2(*k - p_proj); // distance from node to the guide
 278         Geom::Coord dist2 = Geom::L2(p - p_proj); // distance from projection of node on the guide, to the mouse location
 279         if ((dist < tol && dist2 < tol) || (getSnapperAlwaysSnap() && dist < s.getDistance())) {
 280             s = SnappedPoint(*k, SNAPTARGET_NODE, dist, tol, getSnapperAlwaysSnap(), true);
 281             success = true;
 282         }
 283     }
 284
 285     if (success) {
 286         sc.points.push_back(s);
 287     }
 288 }
 289
 290
 291 /**
 292  * Returns index of first NR_END bpath in array.
 293  */
 294
 295 void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType const &t,
 296                                          bool const &first_point) const
 297 {
 298     // Now, let's first collect all paths to snap to. If we have a whole bunch of points to snap,
 299     // e.g. when translating an item using the selector tool, then we will only do this for the
 300     // first point and store the collection for later use. This significantly improves the performance
 301     if (first_point) {
 302         _clear_paths();
 303
 304         // Determine the type of bounding box we should snap to
 305         SPItem::BBoxType bbox_type = SPItem::GEOMETRIC_BBOX;
 306
 307         bool p_is_a_node = t & Inkscape::SnapPreferences::SNAPPOINT_NODE;
 308
 309         if (_snap_to_bboxpath) {
 310             Inkscape::Preferences *prefs = Inkscape::Preferences::get();
 311             int prefs_bbox = prefs->getBool("/tools/bounding_box", 0);
 312             bbox_type = !prefs_bbox ?
 313                 SPItem::APPROXIMATE_BBOX : SPItem::GEOMETRIC_BBOX;
 314         }
 315
 316         // Consider the page border for snapping
 317         if (_snap_to_page_border) {
 318             Geom::PathVector *border_path = _getBorderPathv();
 319             if (border_path != NULL) {
 320                 _paths_to_snap_to->push_back(border_path);
 321             }
 322         }
 323
 324         for (std::vector<SnapCandidate>::const_iterator i = _candidates->begin(); i != _candidates->end(); i++) {
 325
 326             /* Transform the requested snap point to this item's coordinates */
 327             Geom::Matrix i2doc(Geom::identity());
 328             SPItem *root_item = NULL;
 329             /* We might have a clone at hand, so make sure we get the root item */
 330             if (SP_IS_USE((*i).item)) {
 331                 i2doc = sp_use_get_root_transform(SP_USE((*i).item));
 332                 root_item = sp_use_root(SP_USE((*i).item));
 333                 g_return_if_fail(root_item);
 334             } else {
 335                 i2doc = sp_item_i2doc_affine((*i).item);
 336                 root_item = (*i).item;
 337             }
 338
 339             //Build a list of all paths considered for snapping to
 340
 341             //Add the item's path to snap to
 342             if (_snap_to_itempath) {
 343                 if (!(_strict_snapping && !p_is_a_node)) {
 344                     // Snapping to the path of characters is very cool, but for a large
 345                     // chunk of text this will take ages! So limit snapping to text paths
 346                     // containing max. 240 characters. Snapping the bbox will not be affected
 347                     bool very_lenghty_prose = false;
 348                     if (SP_IS_TEXT(root_item) || SP_IS_FLOWTEXT(root_item)) {
 349                         very_lenghty_prose =  sp_text_get_length(SP_TEXT(root_item)) > 240;
 350                     }
 351                     // On my AMD 3000+, the snapping lag becomes annoying at approx. 240 chars
 352                     // which corresponds to a lag of 500 msec. This is for snapping a rect
 353                     // to a single line of text.
 354
 355                     // Snapping for example to a traced bitmap is also very stressing for
 356                     // the CPU, so we'll only snap to paths having no more than 500 nodes
 357                     // This also leads to a lag of approx. 500 msec (in my lousy test set-up).
 358                     bool very_complex_path = false;
 359                     if (SP_IS_PATH(root_item)) {
 360                         very_complex_path = sp_nodes_in_path(SP_PATH(root_item)) > 500;
 361                     }
 362
 363                     if (!very_lenghty_prose && !very_complex_path) {
 364                         SPCurve *curve = curve_for_item(root_item);
 365                         if (curve) {
 366                             // We will get our own copy of the path, which must be freed at some point
 367                             Geom::PathVector *borderpathv = pathvector_for_curve(root_item, curve, true, true, Geom::identity(), (*i).additional_affine);
 368                             _paths_to_snap_to->push_back(borderpathv); // Perhaps for speed, get a reference to the Geom::pathvector, and store the transformation besides it.
 369                             curve->unref();
 370                         }
 371                     }
 372                 }
 373             }
 374
 375             //Add the item's bounding box to snap to
 376             if (_snap_to_bboxpath) {
 377                 if (!(_strict_snapping && p_is_a_node)) {
 378                     // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
 379                     // of the item AND the bbox of the clipping path at the same time
 380                     if (!(*i).clip_or_mask) {
 381                         NRRect rect;
 382                         sp_item_invoke_bbox(root_item, &rect, i2doc, TRUE, bbox_type);
 383                         Geom::Rect const rect2 = to_2geom(*rect.upgrade());
 384                         Geom::PathVector *path = _getPathvFromRect(rect2);
 385                         _paths_to_snap_to->push_back(path);
 386                     }
 387                 }
 388             }
 389         }
 390     }
 391 }
 392
 393 void Inkscape::ObjectSnapper::_snapPaths(SnappedConstraints &sc,
 394                                      Inkscape::SnapPreferences::PointType const &t,
 395                                      Geom::Point const &p,
 396                                      bool const &first_point,
 397                                      std::vector<Geom::Point> *unselected_nodes,
 398                                      SPPath const *selected_path) const
 399 {
 400     _collectPaths(t, first_point);
 401     // Now we can finally do the real snapping, using the paths collected above
 402
 403     g_assert(_snapmanager->getDesktop() != NULL);
 404     Geom::Point const p_doc = _snapmanager->getDesktop()->dt2doc(p);
 405
 406     bool const node_tool_active = _snap_to_itempath && selected_path != NULL;
 407
 408     if (first_point) {
 409         /* While editing a path in the node tool, findCandidates must ignore that path because
 410          * of the node snapping requirements (i.e. only unselected nodes must be snapable).
 411          * This path must not be ignored however when snapping to the paths, so we add it here
 412          * manually when applicable.
 413          *
 414          * Note that this path must be the last in line!
 415          * */
 416         if (node_tool_active) {
 417             SPCurve *curve = curve_for_item(SP_ITEM(selected_path));
 418             if (curve) {
 419                 Geom::PathVector *pathv = pathvector_for_curve(SP_ITEM(selected_path), curve, true, true, Geom::identity(), Geom::identity()); // We will get our own copy of the path, which must be freed at some point
 420                 _paths_to_snap_to->push_back(pathv);
 421                 curve->unref();
 422             }
 423         }
 424     }
 425
 426     for (std::vector<Geom::PathVector*>::const_iterator it_p = _paths_to_snap_to->begin(); it_p != _paths_to_snap_to->end(); it_p++) {
 427         bool const being_edited = (node_tool_active && (*it_p) == _paths_to_snap_to->back());
 428         //if true then this pathvector it_pv is currently being edited in the node tool
 429
 430         // char * svgd = sp_svg_write_path(**it_p);
 431         // std::cout << "Dumping the pathvector: " << svgd << std::endl;
 432
 433         for(Geom::PathVector::iterator it_pv = (*it_p)->begin(); it_pv != (*it_p)->end(); ++it_pv) {
 434             // Find a nearest point for each curve within this path
 435             // n curves will return n time values with 0 <= t <= 1
 436             std::vector<double> anp = (*it_pv).nearestPointPerCurve(p_doc);
 437
 438             std::vector<double>::const_iterator np = anp.begin();
 439             unsigned int index = 0;
 440             for (; np != anp.end(); np++, index++) {
 441                 Geom::Curve const *curve = &((*it_pv).at_index(index));
 442                 Geom::Point const sp_doc = curve->pointAt(*np);
 443
 444                 bool c1 = true;
 445                 bool c2 = true;
 446                 if (being_edited) {
 447                     /* If the path is being edited, then we should only snap though to stationary pieces of the path
 448                      * and not to the pieces that are being dragged around. This way we avoid
 449                      * self-snapping. For this we check whether the nodes at both ends of the current
 450                      * piece are unselected; if they are then this piece must be stationary
 451                      */
 452                     g_assert(unselected_nodes != NULL);
 453                     Geom::Point start_pt = _snapmanager->getDesktop()->doc2dt(curve->pointAt(0));
 454                     Geom::Point end_pt = _snapmanager->getDesktop()->doc2dt(curve->pointAt(1));
 455                     c1 = isUnselectedNode(start_pt, unselected_nodes);
 456                     c2 = isUnselectedNode(end_pt, unselected_nodes);
 457                 }
 458
 459                 Geom::Point const sp_dt = _snapmanager->getDesktop()->doc2dt(sp_doc);
 460                 if (!being_edited || (c1 && c2)) {
 461                     Geom::Coord const dist = Geom::distance(sp_doc, p_doc);
 462                     if (dist < getSnapperTolerance()) {
 463                         sc.curves.push_back(Inkscape::SnappedCurve(from_2geom(sp_dt), dist, getSnapperTolerance(), getSnapperAlwaysSnap(), false, curve));
 464                     }
 465                 }
 466             }
 467         } // End of: for (Geom::PathVector::iterator ....)
 468     }
 469 }
 470
 471 /* Returns true if point is coincident with one of the unselected nodes */
 472 bool Inkscape::ObjectSnapper::isUnselectedNode(Geom::Point const &point, std::vector<Geom::Point> const *unselected_nodes) const
 473 {
 474     if (unselected_nodes == NULL) {
 475         return false;
 476     }
 477
 478     if (unselected_nodes->size() == 0) {
 479         return false;
 480     }
 481
 482     for (std::vector<Geom::Point>::const_iterator i = unselected_nodes->begin(); i != unselected_nodes->end(); i++) {
 483         if (Geom::L2(point - *i) < 1e-4) {
 484             return true;
 485         }
 486     }
 487
 488     return false;
 489 }
 490
 491 void Inkscape::ObjectSnapper::_snapPathsConstrained(SnappedConstraints &sc,
 492                                      Inkscape::SnapPreferences::PointType const &t,
 493                                      Geom::Point const &p,
 494                                      bool const &first_point,
 495                                      ConstraintLine const &c) const
 496 {
 497
 498     _collectPaths(t, first_point);
 499
 500     // Now we can finally do the real snapping, using the paths collected above
 501
 502     g_assert(_snapmanager->getDesktop() != NULL);
 503     Geom::Point const p_doc = _snapmanager->getDesktop()->dt2doc(p);
 504
 505     Geom::Point direction_vector = c.getDirection();
 506     if (!is_zero(direction_vector)) {
 507         direction_vector = Geom::unit_vector(direction_vector);
 508     }
 509
 510     Geom::Point const p1_on_cl = c.hasPoint() ? c.getPoint() : p;
 511     Geom::Point const p2_on_cl = p1_on_cl + direction_vector;
 512
 513     // The intersection point of the constraint line with any path,
 514     // must lie within two points on the constraintline: p_min_on_cl and p_max_on_cl
 515     // The distance between those points is twice the snapping tolerance
 516     Geom::Point const p_proj_on_cl = project_on_linesegment(p, p1_on_cl, p2_on_cl);
 517     Geom::Point const p_min_on_cl = _snapmanager->getDesktop()->dt2doc(p_proj_on_cl - getSnapperTolerance() * direction_vector);
 518     Geom::Point const p_max_on_cl = _snapmanager->getDesktop()->dt2doc(p_proj_on_cl + getSnapperTolerance() * direction_vector);
 519
 520     Geom::Path cl;
 521     std::vector<Geom::Path> clv;
 522     cl.start(p_min_on_cl);
 523     cl.appendNew<Geom::LineSegment>(p_max_on_cl);
 524     clv.push_back(cl);
 525
 526     for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
 527         if (*k) {
 528             Geom::CrossingSet cs = Geom::crossings(clv, *(*k));
 529             if (cs.size() > 0) {
 530                 // We need only the first element of cs, because cl is only a single straight linesegment
 531                 // This first element contains a vector filled with crossings of cl with *k
 532                 for (std::vector<Geom::Crossing>::const_iterator m = cs[0].begin(); m != cs[0].end(); m++) {
 533                     if ((*m).ta >= 0 && (*m).ta <= 1 ) {
 534                         // Reconstruct the point of intersection
 535                         Geom::Point p_inters = p_min_on_cl + ((*m).ta) * (p_max_on_cl - p_min_on_cl);
 536                         // When it's within snapping range, then return it
 537                         // (within snapping range == between p_min_on_cl and p_max_on_cl == 0 < ta < 1)
 538                         Geom::Coord dist = Geom::L2(_snapmanager->getDesktop()->dt2doc(p_proj_on_cl) - p_inters);
 539                         SnappedPoint s(_snapmanager->getDesktop()->doc2dt(p_inters), SNAPTARGET_PATH, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
 540                         sc.points.push_back(s);
 541                     }
 542                 }
 543             }
 544         }
 545     }
 546 }
 547
 548
 549 void Inkscape::ObjectSnapper::freeSnap(SnappedConstraints &sc,
 550                                             Inkscape::SnapPreferences::PointType const &t,
 551                                             Geom::Point const &p,
 552                                             bool const &first_point,
 553                                             boost::optional<Geom::Rect> const &bbox_to_snap,
 554                                             std::vector<SPItem const *> const *it,
 555                                             std::vector<Geom::Point> *unselected_nodes) const
 556 {
 557         if (_snap_enabled == false || _snapmanager->snapprefs.getSnapFrom(t) == false ) {
 558         return;
 559     }
 560
 561     /* Get a list of all the SPItems that we will try to snap to */
 562     if (first_point) {
 563         Geom::Rect const local_bbox_to_snap = bbox_to_snap ? *bbox_to_snap : Geom::Rect(p, p);
 564         _findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
 565     }
 566
 567     if (_snap_to_itemnode || _snap_to_bboxnode || _snap_to_page_border) {
 568         _snapNodes(sc, t, p, first_point, unselected_nodes);
 569     }
 570
 571     if (_snap_to_itempath || _snap_to_bboxpath || _snap_to_page_border) {
 572         unsigned n = (unselected_nodes == NULL) ? 0 : unselected_nodes->size();
 573         if (n > 0) {
 574             /* While editing a path in the node tool, findCandidates must ignore that path because
 575              * of the node snapping requirements (i.e. only unselected nodes must be snapable).
 576              * That path must not be ignored however when snapping to the paths, so we add it here
 577              * manually when applicable
 578              */
 579             SPPath *path = NULL;
 580             if (it != NULL) {
 581                 g_assert(SP_IS_PATH(*it->begin()));
 582                 g_assert(it->size() == 1);
 583                 path = SP_PATH(*it->begin());
 584             }
 585             _snapPaths(sc, t, p, first_point, unselected_nodes, path);
 586         } else {
 587             _snapPaths(sc, t, p, first_point, NULL, NULL);
 588         }
 589     }
 590 }
 591
 592 void Inkscape::ObjectSnapper::constrainedSnap( SnappedConstraints &sc,
 593                                                   Inkscape::SnapPreferences::PointType const &t,
 594                                                   Geom::Point const &p,
 595                                                   bool const &first_point,
 596                                                   boost::optional<Geom::Rect> const &bbox_to_snap,
 597                                                   ConstraintLine const &c,
 598                                                   std::vector<SPItem const *> const *it) const
 599 {
 600     if (_snap_enabled == false || _snapmanager->snapprefs.getSnapFrom(t) == false) {
 601         return;
 602     }
 603
 604     /* Get a list of all the SPItems that we will try to snap to */
 605     if (first_point) {
 606         Geom::Rect const local_bbox_to_snap = bbox_to_snap ? *bbox_to_snap : Geom::Rect(p, p);
 607         _findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
 608     }
 609
 610     // A constrained snap, is a snap in only one degree of freedom (specified by the constraint line).
 611     // This is usefull for example when scaling an object while maintaining a fixed aspect ratio. It's
 612     // nodes are only allowed to move in one direction (i.e. in one degree of freedom).
 613
 614     // When snapping to objects, we either snap to their nodes or their paths. It is however very
 615     // unlikely that any node will be exactly at the constrained line, so for a constrained snap
 616     // to objects we will only consider the object's paths. Beside, the nodes will be at these paths,
 617     // so we will more or less snap to them anyhow.
 618
 619     if (_snap_to_itempath || _snap_to_bboxpath || _snap_to_page_border) {
 620         _snapPathsConstrained(sc, t, p, first_point, c);
 621     }
 622 }
 623
 624
 625 // This method is used to snap a guide to nodes, while dragging the guide around
 626 void Inkscape::ObjectSnapper::guideSnap(SnappedConstraints &sc,
 627                                         Geom::Point const &p,
 628                                         Geom::Point const &guide_normal) const
 629 {
 630     /* Get a list of all the SPItems that we will try to snap to */
 631     std::vector<SPItem*> cand;
 632     std::vector<SPItem const *> const it; //just an empty list
 633
 634     DimensionToSnap snap_dim;
 635     if (guide_normal == to_2geom(component_vectors[Geom::Y])) {
 636         snap_dim = GUIDE_TRANSL_SNAP_Y;
 637     } else if (guide_normal == to_2geom(component_vectors[Geom::X])) {
 638         snap_dim = GUIDE_TRANSL_SNAP_X;
 639     } else {
 640         snap_dim = ANGLED_GUIDE_TRANSL_SNAP;
 641     }
 642
 643     // We don't support ANGLED_GUIDE_ROT_SNAP yet.
 644
 645     // It would be cool to allow the user to rotate a guide by dragging it, instead of
 646     // only translating it. (For example when CTRL is pressed). We will need an UI part
 647     // for that first; and some important usability choices need to be made:
 648     // E.g. which point should be used for pivoting? A previously snapped point,
 649     // or a transformation center (which can be moved after clicking for the
 650     // second time on an object; but should this point then be constrained to the
 651     // line, or can it be located anywhere?)
 652
 653     _findCandidates(sp_document_root(_snapmanager->getDocument()), &it, true, Geom::Rect(p, p), snap_dim, false, Geom::identity());
 654     _snapTranslatingGuideToNodes(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, guide_normal);
 655     // _snapRotatingGuideToNodes has not been implemented yet.
 656 }
 657
 658 /**
 659  *  \return true if this Snapper will snap at least one kind of point.
 660  */
 661 bool Inkscape::ObjectSnapper::ThisSnapperMightSnap() const
 662 {
 663     bool snap_to_something = _snap_to_itempath || _snap_to_itemnode || _snap_to_bboxpath || _snap_to_bboxnode || _snap_to_page_border;
 664     return (_snap_enabled && _snapmanager->snapprefs.getSnapModeBBoxOrNodes() && snap_to_something);
 665 }
 666
 667 bool Inkscape::ObjectSnapper::GuidesMightSnap() const
 668 {
 669     bool snap_to_something = _snap_to_itemnode || _snap_to_bboxnode;
 670     return (_snap_enabled && _snapmanager->snapprefs.getSnapModeGuide() && snap_to_something);
 671 }
 672
 673 void Inkscape::ObjectSnapper::_clear_paths() const
 674 {
 675     for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
 676         g_free(*k);
 677     }
 678     _paths_to_snap_to->clear();
 679 }
 680
 681 Geom::PathVector* Inkscape::ObjectSnapper::_getBorderPathv() const
 682 {
 683     Geom::Rect const border_rect = Geom::Rect(Geom::Point(0,0), Geom::Point(sp_document_width(_snapmanager->getDocument()),sp_document_height(_snapmanager->getDocument())));
 684     return _getPathvFromRect(border_rect);
 685 }
 686
 687 Geom::PathVector* Inkscape::ObjectSnapper::_getPathvFromRect(Geom::Rect const rect) const
 688 {
 689     SPCurve const *border_curve = SPCurve::new_from_rect(rect);
 690     if (border_curve) {
 691         Geom::PathVector *dummy = new Geom::PathVector(border_curve->get_pathvector());
 692         return dummy;
 693     } else {
 694         return NULL;
 695     }
 696 }
 697
 698 void Inkscape::ObjectSnapper::_getBorderNodes(std::vector<Geom::Point> *points) const
 699 {
 700     Geom::Coord w = sp_document_width(_snapmanager->getDocument());
 701     Geom::Coord h = sp_document_height(_snapmanager->getDocument());
 702     points->push_back(Geom::Point(0,0));
 703     points->push_back(Geom::Point(0,h));
 704     points->push_back(Geom::Point(w,h));
 705     points->push_back(Geom::Point(w,0));
 706 }
 707
 708 /*
 709   Local Variables:
 710   mode:c++
 711   c-file-style:"stroustrup"
 712   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 713   indent-tabs-mode:nil
 714   fill-column:99
 715   End:
 716 */
 717 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :