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 "prefs-utils.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), _include_item_center(false)
  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::Snapper::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::Snapper::SNAPPOINT_NODE;
 179         bool p_is_a_bbox = t & Inkscape::Snapper::SNAPPOINT_BBOX;
 180         bool p_is_a_guide = t & Inkscape::Snapper::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             int prefs_bbox = prefs_get_int_attribute("tools", "bounding_box", 0);
 187             bbox_type = (prefs_bbox == 0)?
 188                 SPItem::APPROXIMATE_BBOX : SPItem::GEOMETRIC_BBOX;
 189         }
 190
 191         // Consider the page border for snapping
 192         if (_snap_to_page_border) {
 193             _getBorderNodes(_points_to_snap_to);
 194         }
 195
 196         for (std::vector<SnapCandidate>::const_iterator i = _candidates->begin(); i != _candidates->end(); i++) {
 197             //Geom::Matrix i2doc(Geom::identity());
 198             SPItem *root_item = (*i).item;
 199             if (SP_IS_USE((*i).item)) {
 200                 root_item = sp_use_root(SP_USE((*i).item));
 201             }
 202             g_return_if_fail(root_item);
 203
 204             //Collect all nodes so we can snap to them
 205             if (_snap_to_itemnode) {
 206                 if (!(_strict_snapping && !p_is_a_node) || p_is_a_guide) {
 207                     sp_item_snappoints(root_item, _include_item_center, SnapPointsIter(*_points_to_snap_to));
 208                 }
 209             }
 210
 211             //Collect the bounding box's corners so we can snap to them
 212             if (_snap_to_bboxnode) {
 213                 if (!(_strict_snapping && !p_is_a_bbox) || p_is_a_guide) {
 214                     // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
 215                     // of the item AND the bbox of the clipping path at the same time
 216                     if (!(*i).clip_or_mask) {
 217                         boost::optional<Geom::Rect> b = sp_item_bbox_desktop(root_item, bbox_type);
 218                         if (b) {
 219                             for ( unsigned k = 0 ; k < 4 ; k++ ) {
 220                                 _points_to_snap_to->push_back(b->corner(k));
 221                             }
 222                         }
 223                     }
 224                 }
 225             }
 226         }
 227     }
 228 }
 229
 230 void Inkscape::ObjectSnapper::_snapNodes(SnappedConstraints &sc,
 231                                          Inkscape::Snapper::PointType const &t,
 232                                          Geom::Point const &p,
 233                                          bool const &first_point,
 234                                          std::vector<Geom::Point> *unselected_nodes) const
 235 {
 236     // Iterate through all nodes, find out which one is the closest to p, and snap to it!
 237
 238     _collectNodes(t, first_point);
 239
 240     if (unselected_nodes != NULL) {
 241         _points_to_snap_to->insert(_points_to_snap_to->end(), unselected_nodes->begin(), unselected_nodes->end());
 242     }
 243
 244     SnappedPoint s;
 245     bool success = false;
 246
 247     for (std::vector<Geom::Point>::const_iterator k = _points_to_snap_to->begin(); k != _points_to_snap_to->end(); k++) {
 248         Geom::Coord dist = Geom::L2(*k - p);
 249         if (dist < getSnapperTolerance() && dist < s.getDistance()) {
 250             s = SnappedPoint(*k, SNAPTARGET_NODE, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
 251             success = true;
 252         }
 253     }
 254
 255     if (success) {
 256         sc.points.push_back(s);
 257     }
 258 }
 259
 260 void Inkscape::ObjectSnapper::_snapTranslatingGuideToNodes(SnappedConstraints &sc,
 261                                          Inkscape::Snapper::PointType const &t,
 262                                          Geom::Point const &p,
 263                                          Geom::Point const &guide_normal) const
 264 {
 265     // Iterate through all nodes, find out which one is the closest to this guide, and snap to it!
 266     _collectNodes(t, true);
 267
 268     SnappedPoint s;
 269     bool success = false;
 270
 271     Geom::Coord tol = getSnapperTolerance();
 272
 273     for (std::vector<Geom::Point>::const_iterator k = _points_to_snap_to->begin(); k != _points_to_snap_to->end(); k++) {
 274         // Project each node (*k) on the guide line (running through point p)
 275         Geom::Point p_proj = project_on_linesegment(*k, p, p + Geom::rot90(guide_normal));
 276         Geom::Coord dist = Geom::L2(*k - p_proj); // distance from node to the guide
 277         Geom::Coord dist2 = Geom::L2(p - p_proj); // distance from projection of node on the guide, to the mouse location
 278         if ((dist < tol && dist2 < tol || getSnapperAlwaysSnap()) && dist < s.getDistance()) {
 279             s = SnappedPoint(*k, SNAPTARGET_NODE, dist, tol, getSnapperAlwaysSnap(), true);
 280             success = true;
 281         }
 282     }
 283
 284     if (success) {
 285         sc.points.push_back(s);
 286     }
 287 }
 288
 289
 290 /**
 291  * Returns index of first NR_END bpath in array.
 292  */
 293
 294 void Inkscape::ObjectSnapper::_collectPaths(Inkscape::Snapper::PointType const &t,
 295                                          bool const &first_point) const
 296 {
 297     // Now, let's first collect all paths to snap to. If we have a whole bunch of points to snap,
 298     // e.g. when translating an item using the selector tool, then we will only do this for the
 299     // first point and store the collection for later use. This significantly improves the performance
 300     if (first_point) {
 301         _clear_paths();
 302
 303         // Determine the type of bounding box we should snap to
 304         SPItem::BBoxType bbox_type = SPItem::GEOMETRIC_BBOX;
 305
 306         bool p_is_a_node = t & Inkscape::Snapper::SNAPPOINT_NODE;
 307
 308         if (_snap_to_bboxpath) {
 309             int prefs_bbox = prefs_get_int_attribute("tools", "bounding_box", 0);
 310             bbox_type = (prefs_bbox ==0)?
 311                 SPItem::APPROXIMATE_BBOX : SPItem::GEOMETRIC_BBOX;
 312         }
 313
 314         // Consider the page border for snapping
 315         if (_snap_to_page_border) {
 316             Geom::PathVector *border_path = _getBorderPathv();
 317             if (border_path != NULL) {
 318                 _paths_to_snap_to->push_back(border_path);
 319             }
 320         }
 321
 322         for (std::vector<SnapCandidate>::const_iterator i = _candidates->begin(); i != _candidates->end(); i++) {
 323
 324             /* Transform the requested snap point to this item's coordinates */
 325             Geom::Matrix i2doc(Geom::identity());
 326             SPItem *root_item = NULL;
 327             /* We might have a clone at hand, so make sure we get the root item */
 328             if (SP_IS_USE((*i).item)) {
 329                 i2doc = sp_use_get_root_transform(SP_USE((*i).item));
 330                 root_item = sp_use_root(SP_USE((*i).item));
 331                 g_return_if_fail(root_item);
 332             } else {
 333                 i2doc = sp_item_i2doc_affine((*i).item);
 334                 root_item = (*i).item;
 335             }
 336
 337             //Build a list of all paths considered for snapping to
 338
 339             //Add the item's path to snap to
 340             if (_snap_to_itempath) {
 341                 if (!(_strict_snapping && !p_is_a_node)) {
 342                     // Snapping to the path of characters is very cool, but for a large
 343                     // chunk of text this will take ages! So limit snapping to text paths
 344                     // containing max. 240 characters. Snapping the bbox will not be affected
 345                     bool very_lenghty_prose = false;
 346                     if (SP_IS_TEXT(root_item) || SP_IS_FLOWTEXT(root_item)) {
 347                         very_lenghty_prose =  sp_text_get_length(SP_TEXT(root_item)) > 240;
 348                     }
 349                     // On my AMD 3000+, the snapping lag becomes annoying at approx. 240 chars
 350                     // which corresponds to a lag of 500 msec. This is for snapping a rect
 351                     // to a single line of text.
 352
 353                     // Snapping for example to a traced bitmap is also very stressing for
 354                     // the CPU, so we'll only snap to paths having no more than 500 nodes
 355                     // This also leads to a lag of approx. 500 msec (in my lousy test set-up).
 356                     bool very_complex_path = false;
 357                     if (SP_IS_PATH(root_item)) {
 358                         very_complex_path = sp_nodes_in_path(SP_PATH(root_item)) > 500;
 359                     }
 360
 361                     if (!very_lenghty_prose && !very_complex_path) {
 362                         SPCurve *curve = curve_for_item(root_item);
 363                         if (curve) {
 364                             // We will get our own copy of the path, which must be freed at some point
 365                             Geom::PathVector *borderpathv = pathvector_for_curve(root_item, curve, true, true, Geom::identity(), (*i).additional_affine);
 366                             _paths_to_snap_to->push_back(borderpathv); // Perhaps for speed, get a reference to the Geom::pathvector, and store the transformation besides it.
 367                             curve->unref();
 368                         }
 369                     }
 370                 }
 371             }
 372
 373             //Add the item's bounding box to snap to
 374             if (_snap_to_bboxpath) {
 375                 if (!(_strict_snapping && p_is_a_node)) {
 376                     // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
 377                     // of the item AND the bbox of the clipping path at the same time
 378                     if (!(*i).clip_or_mask) {
 379                         NRRect rect;
 380                         sp_item_invoke_bbox(root_item, &rect, i2doc, TRUE, bbox_type);
 381                         Geom::Rect const rect2 = to_2geom(*rect.upgrade());
 382                         Geom::PathVector *path = _getPathvFromRect(rect2);
 383                         _paths_to_snap_to->push_back(path);
 384                     }
 385                 }
 386             }
 387         }
 388     }
 389 }
 390
 391 void Inkscape::ObjectSnapper::_snapPaths(SnappedConstraints &sc,
 392                                      Inkscape::Snapper::PointType const &t,
 393                                      Geom::Point const &p,
 394                                      bool const &first_point,
 395                                      std::vector<Geom::Point> *unselected_nodes,
 396                                      SPPath const *selected_path) const
 397 {
 398     _collectPaths(t, first_point);
 399     // Now we can finally do the real snapping, using the paths collected above
 400
 401     g_assert(_snapmanager->getDesktop() != NULL);
 402     Geom::Point const p_doc = _snapmanager->getDesktop()->dt2doc(p);
 403
 404     bool const node_tool_active = _snap_to_itempath && selected_path != NULL;
 405
 406     if (first_point) {
 407         /* While editing a path in the node tool, findCandidates must ignore that path because
 408          * of the node snapping requirements (i.e. only unselected nodes must be snapable).
 409          * This path must not be ignored however when snapping to the paths, so we add it here
 410          * manually when applicable.
 411          *
 412          * Note that this path must be the last in line!
 413          * */
 414         if (node_tool_active) {
 415             SPCurve *curve = curve_for_item(SP_ITEM(selected_path));
 416             if (curve) {
 417                 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
 418                 _paths_to_snap_to->push_back(pathv);
 419                 curve->unref();
 420             }
 421         }
 422     }
 423
 424     for (std::vector<Geom::PathVector*>::const_iterator it_p = _paths_to_snap_to->begin(); it_p != _paths_to_snap_to->end(); it_p++) {
 425         bool const being_edited = (node_tool_active && (*it_p) == _paths_to_snap_to->back());
 426         //if true then this pathvector it_pv is currently being edited in the node tool
 427
 428         // char * svgd = sp_svg_write_path(**it_p);
 429         // std::cout << "Dumping the pathvector: " << svgd << std::endl;
 430
 431         for(Geom::PathVector::iterator it_pv = (*it_p)->begin(); it_pv != (*it_p)->end(); ++it_pv) {
 432             // Find a nearest point for each curve within this path
 433             // n curves will return n time values with 0 <= t <= 1
 434             std::vector<double> anp = (*it_pv).nearestPointPerCurve(p_doc);
 435
 436             std::vector<double>::const_iterator np = anp.begin();
 437             unsigned int index = 0;
 438             for (; np != anp.end(); np++, index++) {
 439                 Geom::Curve const *curve = &((*it_pv).at_index(index));
 440                 Geom::Point const sp_doc = curve->pointAt(*np);
 441
 442                 bool c1 = true;
 443                 bool c2 = true;
 444                 if (being_edited) {
 445                     /* If the path is being edited, then we should only snap though to stationary pieces of the path
 446                      * and not to the pieces that are being dragged around. This way we avoid
 447                      * self-snapping. For this we check whether the nodes at both ends of the current
 448                      * piece are unselected; if they are then this piece must be stationary
 449                      */
 450                     g_assert(unselected_nodes != NULL);
 451                     Geom::Point start_pt = _snapmanager->getDesktop()->doc2dt(curve->pointAt(0));
 452                     Geom::Point end_pt = _snapmanager->getDesktop()->doc2dt(curve->pointAt(1));
 453                     c1 = isUnselectedNode(start_pt, unselected_nodes);
 454                     c2 = isUnselectedNode(end_pt, unselected_nodes);
 455                 }
 456
 457                 Geom::Point const sp_dt = _snapmanager->getDesktop()->doc2dt(sp_doc);
 458                 if (!being_edited || (c1 && c2)) {
 459                     Geom::Coord const dist = Geom::distance(sp_doc, p_doc);
 460                     if (dist < getSnapperTolerance()) {
 461                         sc.curves.push_back(Inkscape::SnappedCurve(from_2geom(sp_dt), dist, getSnapperTolerance(), getSnapperAlwaysSnap(), false, curve));
 462                     }
 463                 }
 464             }
 465         } // End of: for (Geom::PathVector::iterator ....)
 466     }
 467 }
 468
 469 /* Returns true if point is coincident with one of the unselected nodes */
 470 bool Inkscape::ObjectSnapper::isUnselectedNode(Geom::Point const &point, std::vector<Geom::Point> const *unselected_nodes) const
 471 {
 472     if (unselected_nodes == NULL) {
 473         return false;
 474     }
 475
 476     if (unselected_nodes->size() == 0) {
 477         return false;
 478     }
 479
 480     for (std::vector<Geom::Point>::const_iterator i = unselected_nodes->begin(); i != unselected_nodes->end(); i++) {
 481         if (Geom::L2(point - *i) < 1e-4) {
 482             return true;
 483         }
 484     }
 485
 486     return false;
 487 }
 488
 489 void Inkscape::ObjectSnapper::_snapPathsConstrained(SnappedConstraints &sc,
 490                                      Inkscape::Snapper::PointType const &t,
 491                                      Geom::Point const &p,
 492                                      bool const &first_point,
 493                                      ConstraintLine const &c) const
 494 {
 495
 496     _collectPaths(t, first_point);
 497
 498     // Now we can finally do the real snapping, using the paths collected above
 499
 500     g_assert(_snapmanager->getDesktop() != NULL);
 501     Geom::Point const p_doc = _snapmanager->getDesktop()->dt2doc(p);
 502
 503     Geom::Point direction_vector = c.getDirection();
 504     if (!is_zero(direction_vector)) {
 505         direction_vector = Geom::unit_vector(direction_vector);
 506     }
 507
 508     Geom::Point const p1_on_cl = c.hasPoint() ? c.getPoint() : p;
 509     Geom::Point const p2_on_cl = p1_on_cl + direction_vector;
 510
 511     // The intersection point of the constraint line with any path,
 512     // must lie within two points on the constraintline: p_min_on_cl and p_max_on_cl
 513     // The distance between those points is twice the snapping tolerance
 514     Geom::Point const p_proj_on_cl = project_on_linesegment(p, p1_on_cl, p2_on_cl);
 515     Geom::Point const p_min_on_cl = _snapmanager->getDesktop()->dt2doc(p_proj_on_cl - getSnapperTolerance() * direction_vector);
 516     Geom::Point const p_max_on_cl = _snapmanager->getDesktop()->dt2doc(p_proj_on_cl + getSnapperTolerance() * direction_vector);
 517
 518     Geom::Path cl;
 519     std::vector<Geom::Path> clv;
 520     cl.start(p_min_on_cl);
 521     cl.appendNew<Geom::LineSegment>(p_max_on_cl);
 522     clv.push_back(cl);
 523
 524     for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
 525         if (*k) {
 526             Geom::CrossingSet cs = Geom::crossings(clv, *(*k));
 527             if (cs.size() > 0) {
 528                 // We need only the first element of cs, because cl is only a single straight linesegment
 529                 // This first element contains a vector filled with crossings of cl with *k
 530                 for (std::vector<Geom::Crossing>::const_iterator m = cs[0].begin(); m != cs[0].end(); m++) {
 531                     if ((*m).ta >= 0 && (*m).ta <= 1 ) {
 532                         // Reconstruct the point of intersection
 533                         Geom::Point p_inters = p_min_on_cl + ((*m).ta) * (p_max_on_cl - p_min_on_cl);
 534                         // When it's within snapping range, then return it
 535                         // (within snapping range == between p_min_on_cl and p_max_on_cl == 0 < ta < 1)
 536                         Geom::Coord dist = Geom::L2(_snapmanager->getDesktop()->dt2doc(p_proj_on_cl) - p_inters);
 537                         SnappedPoint s(_snapmanager->getDesktop()->doc2dt(p_inters), SNAPTARGET_PATH, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
 538                         sc.points.push_back(s);
 539                     }
 540                 }
 541             }
 542         }
 543     }
 544 }
 545
 546
 547 void Inkscape::ObjectSnapper::freeSnap(SnappedConstraints &sc,
 548                                             Inkscape::Snapper::PointType const &t,
 549                                             Geom::Point const &p,
 550                                             bool const &first_point,
 551                                             boost::optional<Geom::Rect> const &bbox_to_snap,
 552                                             std::vector<SPItem const *> const *it,
 553                                             std::vector<Geom::Point> *unselected_nodes) const
 554 {
 555     if (_snap_enabled == false || getSnapFrom(t) == false ) {
 556         return;
 557     }
 558
 559     /* Get a list of all the SPItems that we will try to snap to */
 560     if (first_point) {
 561         Geom::Rect const local_bbox_to_snap = bbox_to_snap ? *bbox_to_snap : Geom::Rect(p, p);
 562         _findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
 563     }
 564
 565     if (_snap_to_itemnode || _snap_to_bboxnode || _snap_to_page_border) {
 566         _snapNodes(sc, t, p, first_point, unselected_nodes);
 567     }
 568
 569     if (_snap_to_itempath || _snap_to_bboxpath || _snap_to_page_border) {
 570         unsigned n = (unselected_nodes == NULL) ? 0 : unselected_nodes->size();
 571         if (n > 0) {
 572             /* While editing a path in the node tool, findCandidates must ignore that path because
 573              * of the node snapping requirements (i.e. only unselected nodes must be snapable).
 574              * That path must not be ignored however when snapping to the paths, so we add it here
 575              * manually when applicable
 576              */
 577             SPPath *path = NULL;
 578             if (it != NULL) {
 579                 g_assert(SP_IS_PATH(*it->begin()));
 580                 g_assert(it->size() == 1);
 581                 path = SP_PATH(*it->begin());
 582             }
 583             _snapPaths(sc, t, p, first_point, unselected_nodes, path);
 584         } else {
 585             _snapPaths(sc, t, p, first_point, NULL, NULL);
 586         }
 587     }
 588 }
 589
 590 void Inkscape::ObjectSnapper::constrainedSnap( SnappedConstraints &sc,
 591                                                   Inkscape::Snapper::PointType const &t,
 592                                                   Geom::Point const &p,
 593                                                   bool const &first_point,
 594                                                   boost::optional<Geom::Rect> const &bbox_to_snap,
 595                                                   ConstraintLine const &c,
 596                                                   std::vector<SPItem const *> const *it) const
 597 {
 598     if (_snap_enabled == false || getSnapFrom(t) == false) {
 599         return;
 600     }
 601
 602     /* Get a list of all the SPItems that we will try to snap to */
 603     if (first_point) {
 604         Geom::Rect const local_bbox_to_snap = bbox_to_snap ? *bbox_to_snap : Geom::Rect(p, p);
 605         _findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
 606     }
 607
 608     // A constrained snap, is a snap in only one degree of freedom (specified by the constraint line).
 609     // This is usefull for example when scaling an object while maintaining a fixed aspect ratio. It's
 610     // nodes are only allowed to move in one direction (i.e. in one degree of freedom).
 611
 612     // When snapping to objects, we either snap to their nodes or their paths. It is however very
 613     // unlikely that any node will be exactly at the constrained line, so for a constrained snap
 614     // to objects we will only consider the object's paths. Beside, the nodes will be at these paths,
 615     // so we will more or less snap to them anyhow.
 616
 617     if (_snap_to_itempath || _snap_to_bboxpath || _snap_to_page_border) {
 618         _snapPathsConstrained(sc, t, p, first_point, c);
 619     }
 620 }
 621
 622
 623 // This method is used to snap a guide to nodes, while dragging the guide around
 624 void Inkscape::ObjectSnapper::guideSnap(SnappedConstraints &sc,
 625                                         Geom::Point const &p,
 626                                         Geom::Point const &guide_normal) const
 627 {
 628     /* Get a list of all the SPItems that we will try to snap to */
 629     std::vector<SPItem*> cand;
 630     std::vector<SPItem const *> const it; //just an empty list
 631
 632     DimensionToSnap snap_dim;
 633     if (guide_normal == to_2geom(component_vectors[Geom::Y])) {
 634         snap_dim = GUIDE_TRANSL_SNAP_Y;
 635     } else if (guide_normal == to_2geom(component_vectors[Geom::X])) {
 636         snap_dim = GUIDE_TRANSL_SNAP_X;
 637     } else {
 638         snap_dim = ANGLED_GUIDE_TRANSL_SNAP;
 639     }
 640
 641     // We don't support ANGLED_GUIDE_ROT_SNAP yet.
 642
 643     // It would be cool to allow the user to rotate a guide by dragging it, instead of
 644     // only translating it. (For example when CTRL is pressed). We will need an UI part
 645     // for that first; and some important usability choices need to be made:
 646     // E.g. which point should be used for pivoting? A previously snapped point,
 647     // or a transformation center (which can be moved after clicking for the
 648     // second time on an object; but should this point then be constrained to the
 649     // line, or can it be located anywhere?)
 650
 651     _findCandidates(sp_document_root(_snapmanager->getDocument()), &it, true, Geom::Rect(p, p), snap_dim, false, Geom::identity());
 652     _snapTranslatingGuideToNodes(sc, Inkscape::Snapper::SNAPPOINT_GUIDE, p, guide_normal);
 653     // _snapRotatingGuideToNodes has not been implemented yet.
 654 }
 655
 656 /**
 657  *  \return true if this Snapper will snap at least one kind of point.
 658  */
 659 bool Inkscape::ObjectSnapper::ThisSnapperMightSnap() const
 660 {
 661     bool snap_to_something = _snap_to_itempath || _snap_to_itemnode || _snap_to_bboxpath || _snap_to_bboxnode || _snap_to_page_border;
 662     return (_snap_enabled && _snap_from != 0 && snap_to_something);
 663 }
 664
 665 bool Inkscape::ObjectSnapper::GuidesMightSnap() const
 666 {
 667     bool snap_to_something = _snap_to_itemnode || _snap_to_bboxnode;
 668     return (_snap_enabled && (_snap_from & SNAPPOINT_GUIDE) && snap_to_something);
 669 }
 670
 671 void Inkscape::ObjectSnapper::_clear_paths() const
 672 {
 673     for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
 674         g_free(*k);
 675     }
 676     _paths_to_snap_to->clear();
 677 }
 678
 679 Geom::PathVector* Inkscape::ObjectSnapper::_getBorderPathv() const
 680 {
 681     Geom::Rect const border_rect = Geom::Rect(Geom::Point(0,0), Geom::Point(sp_document_width(_snapmanager->getDocument()),sp_document_height(_snapmanager->getDocument())));
 682     return _getPathvFromRect(border_rect);
 683 }
 684
 685 Geom::PathVector* Inkscape::ObjectSnapper::_getPathvFromRect(Geom::Rect const rect) const
 686 {
 687     SPCurve const *border_curve = SPCurve::new_from_rect(rect);
 688     if (border_curve) {
 689         Geom::PathVector *dummy = new Geom::PathVector(border_curve->get_pathvector());
 690         return dummy;
 691     } else {
 692         return NULL;
 693     }
 694 }
 695
 696 void Inkscape::ObjectSnapper::_getBorderNodes(std::vector<Geom::Point> *points) const
 697 {
 698     Geom::Coord w = sp_document_width(_snapmanager->getDocument());
 699     Geom::Coord h = sp_document_height(_snapmanager->getDocument());
 700     points->push_back(Geom::Point(0,0));
 701     points->push_back(Geom::Point(0,h));
 702     points->push_back(Geom::Point(w,h));
 703     points->push_back(Geom::Point(w,0));
 704 }
 705
 706 /*
 707   Local Variables:
 708   mode:c++
 709   c-file-style:"stroustrup"
 710   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 711   indent-tabs-mode:nil
 712   fill-column:99
 713   End:
 714 */
 715 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :