Code

4d5dad55a53b2289341c9457e7cf12549846a983
[inkscape.git] / src / snap.cpp
1 #define __SP_DESKTOP_SNAP_C__
3 /**
4  * \file snap.cpp
5  * \brief SnapManager class.
6  *
7  * Authors:
8  *   Lauris Kaplinski <lauris@kaplinski.com>
9  *   Frank Felfe <innerspace@iname.com>
10  *   Nathan Hurst <njh@njhurst.com>
11  *   Carl Hetherington <inkscape@carlh.net>
12  *   Diederik van Lierop <mail@diedenrezi.nl>
13  *
14  * Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
15  * Copyrigth (C) 2004      Nathan Hurst
16  * Copyright (C) 1999-2009 Authors
17  *
18  * Released under GNU GPL, read the file 'COPYING' for more information
19  */
21 #include <utility>
23 #include "sp-namedview.h"
24 #include "snap.h"
25 #include "snapped-line.h"
26 #include "snapped-curve.h"
28 #include "display/canvas-grid.h"
29 #include "display/snap-indicator.h"
31 #include "inkscape.h"
32 #include "desktop.h"
33 #include "sp-guide.h"
34 #include "preferences.h"
35 #include "event-context.h"
36 using std::vector;
38 /**
39  *  Construct a SnapManager for a SPNamedView.
40  *
41  *  \param v `Owning' SPNamedView.
42  */
44 SnapManager::SnapManager(SPNamedView const *v) :
45     guide(this, 0),
46     object(this, 0),
47     snapprefs(),
48     _named_view(v)
49 {
50 }
52 /**
53  *  \brief Return a list of snappers
54  *
55  *  Inkscape snaps to objects, grids, and guides. For each of these snap targets a
56  *  separate class is used, which has been derived from the base Snapper class. The
57  *  getSnappers() method returns a list of pointers to instances of this class. This
58  *  list contains exactly one instance of the guide snapper and of the object snapper
59  *  class, but any number of grid snappers (because each grid has its own snapper
60  *  instance)
61  *
62  *  \return List of snappers that we use.
63  */
64 SnapManager::SnapperList
65 SnapManager::getSnappers() const
66 {
67     SnapManager::SnapperList s;
68     s.push_back(&guide);
69     s.push_back(&object);
71     SnapManager::SnapperList gs = getGridSnappers();
72     s.splice(s.begin(), gs);
74     return s;
75 }
77 /**
78  *  \brief Return a list of gridsnappers
79  *
80  *  Each grid has its own instance of the snapper class. This way snapping can
81  *  be enabled per grid individually. A list will be returned containing the
82  *  pointers to these instances, but only for grids that are being displayed
83  *  and for which snapping is enabled.
84  *
85  *  \return List of gridsnappers that we use.
86  */
87 SnapManager::SnapperList
88 SnapManager::getGridSnappers() const
89 {
90     SnapperList s;
92     if (_desktop && _desktop->gridsEnabled() && snapprefs.getSnapToGrids()) {
93         for ( GSList const *l = _named_view->grids; l != NULL; l = l->next) {
94             Inkscape::CanvasGrid *grid = (Inkscape::CanvasGrid*) l->data;
95             s.push_back(grid->snapper);
96         }
97     }
99     return s;
102 /**
103  * \brief Return true if any snapping might occur, whether its to grids, guides or objects
104  *
105  * Each snapper instance handles its own snapping target, e.g. grids, guides or
106  * objects. This method iterates through all these snapper instances and returns
107  * true if any of the snappers might possible snap, considering only the relevant
108  * snapping preferences.
109  *
110  * \return true if one of the snappers will try to snap to something.
111  */
113 bool SnapManager::someSnapperMightSnap() const
115     if ( !snapprefs.getSnapEnabledGlobally() || snapprefs.getSnapPostponedGlobally() ) {
116         return false;
117     }
119     SnapperList const s = getSnappers();
120     SnapperList::const_iterator i = s.begin();
121     while (i != s.end() && (*i)->ThisSnapperMightSnap() == false) {
122         i++;
123     }
125     return (i != s.end());
128 /**
129  * \return true if one of the grids might be snapped to.
130  */
132 bool SnapManager::gridSnapperMightSnap() const
134     if ( !snapprefs.getSnapEnabledGlobally() || snapprefs.getSnapPostponedGlobally() ) {
135         return false;
136     }
138     SnapperList const s = getGridSnappers();
139     SnapperList::const_iterator i = s.begin();
140     while (i != s.end() && (*i)->ThisSnapperMightSnap() == false) {
141         i++;
142     }
144     return (i != s.end());
147 /**
148  *  \brief Try to snap a point to grids, guides or objects.
149  *
150  *  Try to snap a point to grids, guides or objects, in two degrees-of-freedom,
151  *  i.e. snap in any direction on the two dimensional canvas to the nearest
152  *  snap target. freeSnapReturnByRef() is equal in snapping behavior to
153  *  freeSnap(), but the former returns the snapped point trough the referenced
154  *  parameter p. This parameter p initially contains the position of the snap
155  *  source and will we overwritten by the target position if snapping has occurred.
156  *  This makes snapping transparent to the calling code. If this is not desired
157  *  because either the calling code must know whether snapping has occurred, or
158  *  because the original position should not be touched, then freeSnap() should be
159  *  called instead.
160  *
161  *  PS: SnapManager::setup() must have been called before calling this method,
162  *  but only once for a set of points
163  *
164  *  \param point_type Category of points to which the source point belongs: node, guide or bounding box
165  *  \param p Current position of the snap source; will be overwritten by the position of the snap target if snapping has occurred
166  *  \param source_type Detailed description of the source type, will be used by the snap indicator
167  *  \param first_point If true then this point is the first one from a set of points, all from the same selection and having the same transformation
168  *  \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
169  */
171 void SnapManager::freeSnapReturnByRef(Inkscape::SnapPreferences::PointType point_type,
172                                       Geom::Point &p,
173                                       Inkscape::SnapSourceType const source_type,
174                                       bool first_point,
175                                       Geom::OptRect const &bbox_to_snap) const
177     //TODO: PointType and source_type are somewhat redundant; can't we get rid of the point_type parameter?
178     Inkscape::SnappedPoint const s = freeSnap(point_type, p, source_type, first_point, bbox_to_snap);
179     s.getPoint(p);
183 /**
184  *  \brief Try to snap a point to grids, guides or objects.
185  *
186  *  Try to snap a point to grids, guides or objects, in two degrees-of-freedom,
187  *  i.e. snap in any direction on the two dimensional canvas to the nearest
188  *  snap target. freeSnap() is equal in snapping behavior to
189  *  freeSnapReturnByRef(). Please read the comments of the latter for more details
190  *
191  *  PS: SnapManager::setup() must have been called before calling this method,
192  *  but only once for a set of points
193  *
194  *  \param point_type Category of points to which the source point belongs: node, guide or bounding box
195  *  \param p Current position of the snap source
196  *  \param source_type Detailed description of the source type, will be used by the snap indicator
197  *  \param first_point If true then this point is the first one from a set of points, all from the same selection and having the same transformation
198  *  \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
199  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics
200  */
203 Inkscape::SnappedPoint SnapManager::freeSnap(Inkscape::SnapPreferences::PointType point_type,
204                                              Geom::Point const &p,
205                                              Inkscape::SnapSourceType const &source_type,
206                                              bool first_point,
207                                              Geom::OptRect const &bbox_to_snap) const
209         if (!someSnapperMightSnap()) {
210         return Inkscape::SnappedPoint(p, source_type, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
211     }
213     std::vector<SPItem const *> *items_to_ignore;
214     if (_item_to_ignore) { // If we have only a single item to ignore
215         // then build a list containing this single item;
216         // This single-item list will prevail over any other _items_to_ignore list, should that exist
217         items_to_ignore = new std::vector<SPItem const *>;
218         items_to_ignore->push_back(_item_to_ignore);
219     } else {
220         items_to_ignore = _items_to_ignore;
221     }
223     SnappedConstraints sc;
224     SnapperList const snappers = getSnappers();
226     for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
227         (*i)->freeSnap(sc, point_type, p, source_type, first_point, bbox_to_snap, items_to_ignore, _unselected_nodes);
228     }
230     if (_item_to_ignore) {
231         delete items_to_ignore;
232     }
234     return findBestSnap(p, source_type, sc, false);
237 /**
238  * \brief Snap to the closest multiple of a grid pitch
239  *
240  * When pasting, we would like to snap to the grid. Problem is that we don't know which
241  * nodes were aligned to the grid at the time of copying, so we don't know which nodes
242  * to snap. If we'd snap an unaligned node to the grid, previously aligned nodes would
243  * become unaligned. That's undesirable. Instead we will make sure that the offset
244  * between the source and its pasted copy is a multiple of the grid pitch. If the source
245  * was aligned, then the copy will therefore also be aligned.
246  *
247  * PS: Whether we really find a multiple also depends on the snapping range! Most users
248  * will have "always snap" enabled though, in which case a multiple will always be found.
249  * PS2: When multiple grids are present then the result will become ambiguous. There is no
250  * way to control to which grid this method will snap.
251  *
252  * \param t Vector that represents the offset of the pasted copy with respect to the original
253  * \return Offset vector after snapping to the closest multiple of a grid pitch
254  */
256 Geom::Point SnapManager::multipleOfGridPitch(Geom::Point const &t) const
258     if (!snapprefs.getSnapEnabledGlobally()) // No need to check for snapprefs.getSnapPostponedGlobally() here
259         return t;
261     if (_desktop && _desktop->gridsEnabled()) {
262         bool success = false;
263         Geom::Point nearest_multiple;
264         Geom::Coord nearest_distance = NR_HUGE;
266         // It will snap to the grid for which we find the closest snap. This might be a different
267         // grid than to which the objects were initially aligned. I don't see an easy way to fix
268         // this, so when using multiple grids one can get unexpected results
270         // Cannot use getGridSnappers() because we need both the grids AND their snappers
271         // Therefore we iterate through all grids manually
272         for (GSList const *l = _named_view->grids; l != NULL; l = l->next) {
273             Inkscape::CanvasGrid *grid = (Inkscape::CanvasGrid*) l->data;
274             const Inkscape::Snapper* snapper = grid->snapper;
275             if (snapper && snapper->ThisSnapperMightSnap()) {
276                 // To find the nearest multiple of the grid pitch for a given translation t, we
277                 // will use the grid snapper. Simply snapping the value t to the grid will do, but
278                 // only if the origin of the grid is at (0,0). If it's not then compensate for this
279                 // in the translation t
280                 Geom::Point const t_offset = t + grid->origin;
281                 SnappedConstraints sc;
282                 // Only the first three parameters are being used for grid snappers
283                 snapper->freeSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_NODE, t_offset, Inkscape::SNAPSOURCE_UNDEFINED, TRUE, Geom::OptRect(), NULL, NULL);
284                 // Find the best snap for this grid, including intersections of the grid-lines
285                 Inkscape::SnappedPoint s = findBestSnap(t_offset, Inkscape::SNAPSOURCE_UNDEFINED, sc, false);
286                 if (s.getSnapped() && (s.getSnapDistance() < nearest_distance)) {
287                     // use getSnapDistance() instead of getWeightedDistance() here because the pointer's position
288                     // doesn't tell us anything about which node to snap
289                     success = true;
290                     nearest_multiple = s.getPoint() - to_2geom(grid->origin);
291                     nearest_distance = s.getSnapDistance();
292                 }
293             }
294         }
296         if (success)
297             return nearest_multiple;
298     }
300     return t;
303 /**
304  *  \brief Try to snap a point along a constraint line to grids, guides or objects.
305  *
306  *  Try to snap a point to grids, guides or objects, in only one degree-of-freedom,
307  *  i.e. snap in a specific direction on the two dimensional canvas to the nearest
308  *  snap target.
309  *
310  *  constrainedSnapReturnByRef() is equal in snapping behavior to
311  *  constrainedSnap(), but the former returns the snapped point trough the referenced
312  *  parameter p. This parameter p initially contains the position of the snap
313  *  source and will we overwritten by the target position if snapping has occurred.
314  *  This makes snapping transparent to the calling code. If this is not desired
315  *  because either the calling code must know whether snapping has occurred, or
316  *  because the original position should not be touched, then constrainedSnap() should
317  *  be called instead.
318  *
319  *  PS: SnapManager::setup() must have been called before calling this method,
320  *  but only once for a set of points
321  *
322  *  \param point_type Category of points to which the source point belongs: node, guide or bounding box
323  *  \param p Current position of the snap source; will be overwritten by the position of the snap target if snapping has occurred
324  *  \param source_type Detailed description of the source type, will be used by the snap indicator
325  *  \param constraint The direction or line along which snapping must occur
326  *  \param first_point If true then this point is the first one from a set of points, all from the same selection and having the same transformation
327  *  \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
328  */
330 void SnapManager::constrainedSnapReturnByRef(Inkscape::SnapPreferences::PointType point_type,
331                                              Geom::Point &p,
332                                              Inkscape::SnapSourceType const source_type,
333                                              Inkscape::Snapper::ConstraintLine const &constraint,
334                                              bool first_point,
335                                              Geom::OptRect const &bbox_to_snap) const
337     Inkscape::SnappedPoint const s = constrainedSnap(point_type, p, source_type, constraint, first_point, bbox_to_snap);
338     s.getPoint(p);
341 /**
342  *  \brief Try to snap a point along a constraint line to grids, guides or objects.
343  *
344  *  Try to snap a point to grids, guides or objects, in only one degree-of-freedom,
345  *  i.e. snap in a specific direction on the two dimensional canvas to the nearest
346  *  snap target. constrainedSnap is equal in snapping behavior to
347  *  constrainedSnapReturnByRef(). Please read the comments of the latter for more details.
348  *
349  *  PS: SnapManager::setup() must have been called before calling this method,
350  *  but only once for a set of points
351  *
352  *  \param point_type Category of points to which the source point belongs: node, guide or bounding box
353  *  \param p Current position of the snap source
354  *  \param source_type Detailed description of the source type, will be used by the snap indicator
355  *  \param constraint The direction or line along which snapping must occur
356  *  \param first_point If true then this point is the first one from a set of points, all from the same selection and having the same transformation
357  *  \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
358  */
360 Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::SnapPreferences::PointType point_type,
361                                                     Geom::Point const &p,
362                                                     Inkscape::SnapSourceType const &source_type,
363                                                     Inkscape::Snapper::ConstraintLine const &constraint,
364                                                     bool first_point,
365                                                     Geom::OptRect const &bbox_to_snap) const
367     if (!someSnapperMightSnap()) {
368         return Inkscape::SnappedPoint(p, source_type, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
369     }
371     std::vector<SPItem const *> *items_to_ignore;
372     if (_item_to_ignore) { // If we have only a single item to ignore
373         // then build a list containing this single item;
374         // This single-item list will prevail over any other _items_to_ignore list, should that exist
375         items_to_ignore = new std::vector<SPItem const *>;
376         items_to_ignore->push_back(_item_to_ignore);
377     } else {
378         items_to_ignore = _items_to_ignore;
379     }
381     Geom::Point pp = constraint.projection(p);
383     SnappedConstraints sc;
384     SnapperList const snappers = getSnappers();
385     for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
386         (*i)->constrainedSnap(sc, point_type, pp, source_type, first_point, bbox_to_snap, constraint, items_to_ignore);
387     }
389     if (_item_to_ignore) {
390         delete items_to_ignore;
391     }
393     return findBestSnap(p, source_type, sc, true);
396 /**
397  *  \brief Try to snap a point of a guide to another guide or to a node
398  *
399  *  Try to snap a point of a guide to another guide or to a node in two degrees-
400  *  of-freedom, i.e. snap in any direction on the two dimensional canvas to the
401  *  nearest snap target. This method is used when dragging or rotating a guide
402  *
403  *  PS: SnapManager::setup() must have been called before calling this method,
404  *
405  *  \param p Current position of the point on the guide that is to be snapped; will be overwritten by the position of the snap target if snapping has occurred
406  *  \param guide_normal Vector normal to the guide line
407  */
408 void SnapManager::guideFreeSnap(Geom::Point &p, Geom::Point const &guide_normal) const
410     if (!snapprefs.getSnapEnabledGlobally() || snapprefs.getSnapPostponedGlobally()) {
411         return;
412     }
414     if (!(object.GuidesMightSnap() || snapprefs.getSnapToGuides())) {
415         return;
416     }
418     // Snap to nodes
419     SnappedConstraints sc;
420     if (object.GuidesMightSnap()) {
421         object.guideFreeSnap(sc, p, guide_normal);
422     }
424     // Snap to guides
425     if (snapprefs.getSnapToGuides()) {
426         guide.freeSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, Inkscape::SNAPSOURCE_GUIDE, true, Geom::OptRect(), NULL, NULL);
427     }
429     // We won't snap to grids, what's the use?
431     Inkscape::SnappedPoint const s = findBestSnap(p, Inkscape::SNAPSOURCE_GUIDE, sc, false);
432     s.getPoint(p);
435 /**
436  *  \brief Try to snap a point on a guide to the intersection with another guide or a path
437  *
438  *  Try to snap a point on a guide to the intersection of that guide with another
439  *  guide or with a path. The snapped point will lie somewhere on the guide-line,
440  *  making this is a constrained snap, i.e. in only one degree-of-freedom.
441  *  This method is used when dragging the origin of the guide along the guide itself.
442  *
443  *  PS: SnapManager::setup() must have been called before calling this method,
444  *
445  *  \param p Current position of the point on the guide that is to be snapped; will be overwritten by the position of the snap target if snapping has occurred
446  *  \param guide_normal Vector normal to the guide line
447  */
449 void SnapManager::guideConstrainedSnap(Geom::Point &p, SPGuide const &guideline) const
451         if (!snapprefs.getSnapEnabledGlobally() || snapprefs.getSnapPostponedGlobally()) {
452         return;
453     }
455     if (!(object.ThisSnapperMightSnap() || snapprefs.getSnapToGuides())) {
456         return;
457     }
459     // Snap to nodes or paths
460     SnappedConstraints sc;
461     Inkscape::Snapper::ConstraintLine cl(guideline.point_on_line, Geom::rot90(guideline.normal_to_line));
462     if (object.ThisSnapperMightSnap()) {
463         object.constrainedSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, Inkscape::SNAPSOURCE_GUIDE_ORIGIN, true, Geom::OptRect(), cl, NULL);
464     }
466     // Snap to guides
467     if (snapprefs.getSnapToGuides()) {
468         guide.constrainedSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, Inkscape::SNAPSOURCE_GUIDE_ORIGIN, true, Geom::OptRect(), cl, NULL);
469     }
471     // We won't snap to grids, what's the use?
473     Inkscape::SnappedPoint const s = findBestSnap(p, Inkscape::SNAPSOURCE_GUIDE, sc, false);
474     s.getPoint(p);
477 /**
478  *  \brief Method for snapping sets of points while they are being transformed
479  *
480  *  Method for snapping sets of points while they are being transformed, when using
481  *  for example the selector tool. This method is for internal use only, and should
482  *  not have to be called directly. Use freeSnapTransalation(), constrainedSnapScale(),
483  *  etc. instead.
484  *
485  *  This is what is being done in this method: transform each point, find out whether
486  *  a free snap or constrained snap is more appropriate, do the snapping, calculate
487  *  some metrics to quantify the snap "distance", and see if it's better than the
488  *  previous snap. Finally, the best ("nearest") snap from all these points is returned.
489  *
490  *  \param type Category of points to which the source point belongs: node or bounding box.
491  *  \param points Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
492  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
493  *  \param constrained true if the snap is constrained, e.g. for stretching or for purely horizontal translation.
494  *  \param constraint The direction or line along which snapping must occur, if 'constrained' is true; otherwise undefined.
495  *  \param transformation_type Type of transformation to apply to points before trying to snap them.
496  *  \param transformation Description of the transformation; details depend on the type.
497  *  \param origin Origin of the transformation, if applicable.
498  *  \param dim Dimension to which the transformation applies, if applicable.
499  *  \param uniform true if the transformation should be uniform; only applicable for stretching and scaling.
500  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
501  */
503 Inkscape::SnappedPoint SnapManager::_snapTransformed(
504     Inkscape::SnapPreferences::PointType type,
505     std::vector<std::pair<Geom::Point, int> > const &points,
506     Geom::Point const &pointer,
507     bool constrained,
508     Inkscape::Snapper::ConstraintLine const &constraint,
509     Transformation transformation_type,
510     Geom::Point const &transformation,
511     Geom::Point const &origin,
512     Geom::Dim2 dim,
513     bool uniform) const
515     /* We have a list of points, which we are proposing to transform in some way.  We need to see
516     ** if any of these points, when transformed, snap to anything.  If they do, we return the
517     ** appropriate transformation with `true'; otherwise we return the original scale with `false'.
518     */
520     /* Quick check to see if we have any snappers that are enabled
521     ** Also used to globally disable all snapping
522     */
523     if (someSnapperMightSnap() == false) {
524         return Inkscape::SnappedPoint();
525     }
527     std::vector<std::pair<Geom::Point, int> > transformed_points;
528     Geom::Rect bbox;
530     for (std::vector<std::pair<Geom::Point, int> >::const_iterator i = points.begin(); i != points.end(); i++) {
532         /* Work out the transformed version of this point */
533         Geom::Point transformed = _transformPoint(*i, transformation_type, transformation, origin, dim, uniform);
535         // add the current transformed point to the box hulling all transformed points
536         if (i == points.begin()) {
537             bbox = Geom::Rect(transformed, transformed);
538         } else {
539             bbox.expandTo(transformed);
540         }
542         transformed_points.push_back(std::make_pair(transformed, (*i).second));
543     }
545     /* The current best transformation */
546     Geom::Point best_transformation = transformation;
548     /* The current best metric for the best transformation; lower is better, NR_HUGE
549     ** means that we haven't snapped anything.
550     */
551     Geom::Point best_scale_metric(NR_HUGE, NR_HUGE);
552     Inkscape::SnappedPoint best_snapped_point;
553     g_assert(best_snapped_point.getAlwaysSnap() == false); // Check initialization of snapped point
554     g_assert(best_snapped_point.getAtIntersection() == false);
556     std::vector<std::pair<Geom::Point, int> >::const_iterator j = transformed_points.begin();
558     // std::cout << std::endl;
559     for (std::vector<std::pair<Geom::Point, int> >::const_iterator i = points.begin(); i != points.end(); i++) {
561         /* Snap it */
562         Inkscape::SnappedPoint snapped_point;
563         Inkscape::Snapper::ConstraintLine dedicated_constraint = constraint;
564         Geom::Point const b = ((*i).first - origin); // vector to original point
566         if (constrained) {
567             if ((transformation_type == SCALE || transformation_type == STRETCH) && uniform) {
568                 // When uniformly scaling, each point will have its own unique constraint line,
569                 // running from the scaling origin to the original untransformed point. We will
570                 // calculate that line here
571                 dedicated_constraint = Inkscape::Snapper::ConstraintLine(origin, b);
572             } else if (transformation_type == STRETCH) { // when non-uniform stretching {
573                 dedicated_constraint = Inkscape::Snapper::ConstraintLine((*i).first, component_vectors[dim]);
574             } else if (transformation_type == TRANSLATION) {
575                 // When doing a constrained translation, all points will move in the same direction, i.e.
576                 // either horizontally or vertically. The lines along which they move are therefore all
577                 // parallel, but might not be colinear. Therefore we will have to set the point through
578                 // which the constraint-line runs here, for each point individually.
579                 dedicated_constraint.setPoint((*i).first);
580             } // else: leave the original constraint, e.g. for skewing
581             if (transformation_type == SCALE && !uniform) {
582                 g_warning("Non-uniform constrained scaling is not supported!");
583             }
584             snapped_point = constrainedSnap(type, (*j).first, static_cast<Inkscape::SnapSourceType>((*j).second), dedicated_constraint, i == points.begin(), bbox);
585         } else {
586             bool const c1 = fabs(b[Geom::X]) < 1e-6;
587             bool const c2 = fabs(b[Geom::Y]) < 1e-6;
588             if (transformation_type == SCALE && (c1 || c2) && !(c1 && c2)) {
589                 // When scaling, a point aligned either horizontally or vertically with the origin can only
590                 // move in that specific direction; therefore it should only snap in that direction, otherwise
591                 // we will get snapped points with an invalid transformation
592                 dedicated_constraint = Inkscape::Snapper::ConstraintLine(origin, component_vectors[c1]);
593                 snapped_point = constrainedSnap(type, (*j).first, static_cast<Inkscape::SnapSourceType>((*j).second), dedicated_constraint, i == points.begin(), bbox);
594             } else {
595                 snapped_point = freeSnap(type, (*j).first, static_cast<Inkscape::SnapSourceType>((*j).second), i == points.begin(), bbox);
596             }
597         }
598         // std::cout << "dist = " << snapped_point.getSnapDistance() << std::endl;
599         snapped_point.setPointerDistance(Geom::L2(pointer - (*i).first));
601         Geom::Point result;
602         Geom::Point scale_metric(NR_HUGE, NR_HUGE);
604         if (snapped_point.getSnapped()) {
605             /* We snapped.  Find the transformation that describes where the snapped point has
606             ** ended up, and also the metric for this transformation.
607             */
608             Geom::Point const a = (snapped_point.getPoint() - origin); // vector to snapped point
609             //Geom::Point const b = (*i - origin); // vector to original point
611             switch (transformation_type) {
612                 case TRANSLATION:
613                     result = snapped_point.getPoint() - (*i).first;
614                     /* Consider the case in which a box is almost aligned with a grid in both
615                      * horizontal and vertical directions. The distance to the intersection of
616                      * the grid lines will always be larger then the distance to a single grid
617                      * line. If we prefer snapping to an intersection instead of to a single
618                      * grid line, then we cannot use "metric = Geom::L2(result)". Therefore the
619                      * snapped distance will be used as a metric. Please note that the snapped
620                      * distance is defined as the distance to the nearest line of the intersection,
621                      * and not to the intersection itself!
622                      */
623                     // Only for translations, the relevant metric will be the real snapped distance,
624                     // so we don't have to do anything special here
625                     break;
626                 case SCALE:
627                 {
628                     result = Geom::Point(NR_HUGE, NR_HUGE);
629                     // If this point *i is horizontally or vertically aligned with
630                     // the origin of the scaling, then it will scale purely in X or Y
631                     // We can therefore only calculate the scaling in this direction
632                     // and the scaling factor for the other direction should remain
633                     // untouched (unless scaling is uniform ofcourse)
634                     for (int index = 0; index < 2; index++) {
635                         if (fabs(b[index]) > 1e-6) { // if SCALING CAN occur in this direction
636                             if (fabs(fabs(a[index]/b[index]) - fabs(transformation[index])) > 1e-12) { // if SNAPPING DID occur in this direction
637                                 result[index] = a[index] / b[index]; // then calculate it!
638                             }
639                             // we might leave result[1-index] = NR_HUGE
640                             // if scaling didn't occur in the other direction
641                         }
642                     }
643                     // Compare the resulting scaling with the desired scaling
644                     scale_metric = result - transformation; // One or both of its components might be NR_HUGE
645                     break;
646                 }
647                 case STRETCH:
648                     result = Geom::Point(NR_HUGE, NR_HUGE);
649                     if (fabs(b[dim]) > 1e-6) { // if STRETCHING will occur for this point
650                         result[dim] = a[dim] / b[dim];
651                         result[1-dim] = uniform ? result[dim] : 1;
652                     } else { // STRETCHING might occur for this point, but only when the stretching is uniform
653                         if (uniform && fabs(b[1-dim]) > 1e-6) {
654                            result[1-dim] = a[1-dim] / b[1-dim];
655                            result[dim] = result[1-dim];
656                         }
657                     }
658                     // Store the metric for this transformation as a virtual distance
659                     snapped_point.setSnapDistance(std::abs(result[dim] - transformation[dim]));
660                     snapped_point.setSecondSnapDistance(NR_HUGE);
661                     break;
662                 case SKEW:
663                     result[0] = (snapped_point.getPoint()[dim] - ((*i).first)[dim]) / (((*i).first)[1 - dim] - origin[1 - dim]); // skew factor
664                     result[1] = transformation[1]; // scale factor
665                     // Store the metric for this transformation as a virtual distance
666                     snapped_point.setSnapDistance(std::abs(result[0] - transformation[0]));
667                     snapped_point.setSecondSnapDistance(NR_HUGE);
668                     break;
669                 default:
670                     g_assert_not_reached();
671             }
673             // When scaling, we're considering the best transformation in each direction separately. We will have a metric in each
674             // direction, whereas for all other transformation we only a single one-dimensional metric. That's why we need to handle
675             // the scaling metric differently
676             if (transformation_type == SCALE) {
677                 for (int index = 0; index < 2; index++) {
678                     if (fabs(scale_metric[index]) < fabs(best_scale_metric[index])) {
679                         best_transformation[index] = result[index];
680                         best_scale_metric[index] = fabs(scale_metric[index]);
681                         // When scaling, we're considering the best transformation in each direction separately
682                         // Therefore two different snapped points might together make a single best transformation
683                         // We will however return only a single snapped point (e.g. to display the snapping indicator)
684                         best_snapped_point = snapped_point;
685                         // std::cout << "SEL ";
686                     } // else { std::cout << "    ";}
687                 }
688                 if (uniform) {
689                     if (best_scale_metric[0] < best_scale_metric[1]) {
690                         best_transformation[1] = best_transformation[0];
691                         best_scale_metric[1] = best_scale_metric[0];
692                     } else {
693                         best_transformation[0] = best_transformation[1];
694                         best_scale_metric[0] = best_scale_metric[1];
695                     }
696                 }
697             } else { // For all transformations other than scaling
698                 if (best_snapped_point.isOtherSnapBetter(snapped_point, true)) {
699                     best_transformation = result;
700                     best_snapped_point = snapped_point;
701                 }
702             }
703         }
705         j++;
706     }
708     Geom::Coord best_metric;
709     if (transformation_type == SCALE) {
710         // When scaling, don't ever exit with one of scaling components set to NR_HUGE
711         for (int index = 0; index < 2; index++) {
712             if (best_transformation[index] == NR_HUGE) {
713                 if (uniform && best_transformation[1-index] < NR_HUGE) {
714                     best_transformation[index] = best_transformation[1-index];
715                 } else {
716                     best_transformation[index] = transformation[index];
717                 }
718             }
719         }
720         best_metric = std::min(best_scale_metric[0], best_scale_metric[1]);
721     } else { // For all transformations other than scaling
722         best_metric = best_snapped_point.getSnapDistance();
723     }
725     best_snapped_point.setTransformation(best_transformation);
726     // Using " < 1e6" instead of " < NR_HUGE" for catching some rounding errors
727     // These rounding errors might be caused by NRRects, see bug #1584301
728     best_snapped_point.setSnapDistance(best_metric < 1e6 ? best_metric : NR_HUGE);
729     return best_snapped_point;
733 /**
734  *  \brief Apply a translation to a set of points and try to snap freely in 2 degrees-of-freedom
735  *
736  *  \param point_type Category of points to which the source point belongs: node or bounding box.
737  *  \param p Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
738  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
739  *  \param tr Proposed translation; the final translation can only be calculated after snapping has occurred
740  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
741  */
743 Inkscape::SnappedPoint SnapManager::freeSnapTranslation(Inkscape::SnapPreferences::PointType point_type,
744                                                         std::vector<std::pair<Geom::Point, int> > const &p,
745                                                         Geom::Point const &pointer,
746                                                         Geom::Point const &tr) const
748     if (p.size() == 1) {
749         _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false), (p.at(0)).second));
750     }
752     return _snapTransformed(point_type, p, pointer, false, Geom::Point(0,0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
755 /**
756  *  \brief Apply a translation to a set of points and try to snap along a constraint
757  *
758  *  \param point_type Category of points to which the source point belongs: node or bounding box.
759  *  \param p Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
760  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
761  *  \param constraint The direction or line along which snapping must occur.
762  *  \param tr Proposed translation; the final translation can only be calculated after snapping has occurred.
763  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
764  */
766 Inkscape::SnappedPoint SnapManager::constrainedSnapTranslation(Inkscape::SnapPreferences::PointType point_type,
767                                                                std::vector<std::pair<Geom::Point, int> > const &p,
768                                                                Geom::Point const &pointer,
769                                                                Inkscape::Snapper::ConstraintLine const &constraint,
770                                                                Geom::Point const &tr) const
772     if (p.size() == 1) {
773         _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false), (p.at(0)).second));
774     }
776     return _snapTransformed(point_type, p, pointer, true, constraint, TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
780 /**
781  *  \brief Apply a scaling to a set of points and try to snap freely in 2 degrees-of-freedom
782  *
783  *  \param point_type Category of points to which the source point belongs: node or bounding box.
784  *  \param p Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
785  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
786  *  \param s Proposed scaling; the final scaling can only be calculated after snapping has occurred
787  *  \param o Origin of the scaling
788  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
789  */
791 Inkscape::SnappedPoint SnapManager::freeSnapScale(Inkscape::SnapPreferences::PointType point_type,
792                                                   std::vector<std::pair<Geom::Point, int> > const &p,
793                                                   Geom::Point const &pointer,
794                                                   Geom::Scale const &s,
795                                                   Geom::Point const &o) const
797     if (p.size() == 1) {
798         _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, false), (p.at(0)).second));
799     }
801     return _snapTransformed(point_type, p, pointer, false, Geom::Point(0,0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, false);
805 /**
806  *  \brief Apply a scaling to a set of points and snap such that the aspect ratio of the selection is preserved
807  *
808  *  \param point_type Category of points to which the source point belongs: node or bounding box.
809  *  \param p Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
810  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
811  *  \param s Proposed scaling; the final scaling can only be calculated after snapping has occurred
812  *  \param o Origin of the scaling
813  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
814  */
816 Inkscape::SnappedPoint SnapManager::constrainedSnapScale(Inkscape::SnapPreferences::PointType point_type,
817                                                          std::vector<std::pair<Geom::Point, int> > const &p,
818                                                          Geom::Point const &pointer,
819                                                          Geom::Scale const &s,
820                                                          Geom::Point const &o) const
822     // When constrained scaling, only uniform scaling is supported.
823     if (p.size() == 1) {
824         _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, true), (p.at(0)).second));
825     }
827     return _snapTransformed(point_type, p, pointer, true, Geom::Point(0,0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, true);
830 /**
831  *  \brief Apply a stretch to a set of points and snap such that the direction of the stretch is preserved
832  *
833  *  \param point_type Category of points to which the source point belongs: node or bounding box.
834  *  \param p Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
835  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
836  *  \param s Proposed stretch; the final stretch can only be calculated after snapping has occurred
837  *  \param o Origin of the stretching
838  *  \param d Dimension in which to apply proposed stretch.
839  *  \param u true if the stretch should be uniform (i.e. to be applied equally in both dimensions)
840  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
841  */
843 Inkscape::SnappedPoint SnapManager::constrainedSnapStretch(Inkscape::SnapPreferences::PointType point_type,
844                                                             std::vector<std::pair<Geom::Point, int> > const &p,
845                                                             Geom::Point const &pointer,
846                                                             Geom::Coord const &s,
847                                                             Geom::Point const &o,
848                                                             Geom::Dim2 d,
849                                                             bool u) const
851     if (p.size() == 1) {
852         _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), STRETCH, Geom::Point(s, s), o, d, u), (p.at(0)).second));
853     }
855     return _snapTransformed(point_type, p, pointer, true, Geom::Point(0,0), STRETCH, Geom::Point(s, s), o, d, u);
858 /**
859  *  \brief Apply a skew to a set of points and snap such that the direction of the skew is preserved
860  *
861  *  \param point_type Category of points to which the source point belongs: node or bounding box.
862  *  \param p Collection of points to snap (snap sources), at their untransformed position, all points undergoing the same transformation. Paired with an identifier of the type of the snap source.
863  *  \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
864  *  \param constraint The direction or line along which snapping must occur.
865  *  \param s Proposed skew; the final skew can only be calculated after snapping has occurred
866  *  \param o Origin of the proposed skew
867  *  \param d Dimension in which to apply proposed skew.
868  *  \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
869  */
871 Inkscape::SnappedPoint SnapManager::constrainedSnapSkew(Inkscape::SnapPreferences::PointType point_type,
872                                                  std::vector<std::pair<Geom::Point, int> > const &p,
873                                                  Geom::Point const &pointer,
874                                                  Inkscape::Snapper::ConstraintLine const &constraint,
875                                                  Geom::Point const &s,
876                                                  Geom::Point const &o,
877                                                  Geom::Dim2 d) const
879     // "s" contains skew factor in s[0], and scale factor in s[1]
881     // Snapping the nodes of the bounding box of a selection that is being transformed, will only work if
882     // the transformation of the bounding box is equal to the transformation of the individual nodes. This is
883     // NOT the case for example when rotating or skewing. The bounding box itself cannot possibly rotate or skew,
884     // so it's corners have a different transformation. The snappers cannot handle this, therefore snapping
885     // of bounding boxes is not allowed here.
886     g_assert(!(point_type & Inkscape::SnapPreferences::SNAPPOINT_BBOX));
888     if (p.size() == 1) {
889         _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), SKEW, s, o, d, false), (p.at(0)).second));
890     }
892     return _snapTransformed(point_type, p, pointer, true, constraint, SKEW, s, o, d, false);
895 /**
896  * \brief Given a set of possible snap targets, find the best target (which is not necessarily
897  * also the nearest target), and show the snap indicator if requested
898  *
899  * \param p Current position of the snap source
900  * \param source_type Detailed description of the source type, will be used by the snap indicator
901  * \param sc A structure holding all snap targets that have been found so far
902  * \param constrained True if the snap is constrained, e.g. for stretching or for purely horizontal translation.
903  * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics
904  */
906 Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p,
907                                                                                              Inkscape::SnapSourceType const source_type,
908                                                                                              SnappedConstraints &sc,
909                                                                                              bool constrained) const
912     /*
913     std::cout << "Type and number of snapped constraints: " << std::endl;
914     std::cout << "  Points      : " << sc.points.size() << std::endl;
915     std::cout << "  Lines       : " << sc.lines.size() << std::endl;
916     std::cout << "  Grid lines  : " << sc.grid_lines.size()<< std::endl;
917     std::cout << "  Guide lines : " << sc.guide_lines.size()<< std::endl;
918     std::cout << "  Curves      : " << sc.curves.size()<< std::endl;
919     */
921     // Store all snappoints
922     std::list<Inkscape::SnappedPoint> sp_list;
924     // search for the closest snapped point
925     Inkscape::SnappedPoint closestPoint;
926     if (getClosestSP(sc.points, closestPoint)) {
927         sp_list.push_back(closestPoint);
928     }
930     // search for the closest snapped curve
931     Inkscape::SnappedCurve closestCurve;
932     if (getClosestCurve(sc.curves, closestCurve)) {
933         sp_list.push_back(Inkscape::SnappedPoint(closestCurve));
934     }
936     if (snapprefs.getSnapIntersectionCS()) {
937         // search for the closest snapped intersection of curves
938         Inkscape::SnappedPoint closestCurvesIntersection;
939         if (getClosestIntersectionCS(sc.curves, p, closestCurvesIntersection, _desktop->dt2doc())) {
940             closestCurvesIntersection.setSource(source_type);
941             sp_list.push_back(closestCurvesIntersection);
942         }
943     }
945     // search for the closest snapped grid line
946     Inkscape::SnappedLine closestGridLine;
947     if (getClosestSL(sc.grid_lines, closestGridLine)) {
948         sp_list.push_back(Inkscape::SnappedPoint(closestGridLine));
949     }
951     // search for the closest snapped guide line
952     Inkscape::SnappedLine closestGuideLine;
953     if (getClosestSL(sc.guide_lines, closestGuideLine)) {
954         sp_list.push_back(Inkscape::SnappedPoint(closestGuideLine));
955     }
957     // When freely snapping to a grid/guide/path, only one degree of freedom is eliminated
958     // Therefore we will try get fully constrained by finding an intersection with another grid/guide/path
960     // When doing a constrained snap however, we're already at an intersection of the constrained line and
961     // the grid/guide/path we're snapping to. This snappoint is therefore fully constrained, so there's
962     // no need to look for additional intersections
963     if (!constrained) {
964         // search for the closest snapped intersection of grid lines
965         Inkscape::SnappedPoint closestGridPoint;
966         if (getClosestIntersectionSL(sc.grid_lines, closestGridPoint)) {
967             closestGridPoint.setSource(source_type);
968             closestGridPoint.setTarget(Inkscape::SNAPTARGET_GRID_INTERSECTION);
969             sp_list.push_back(closestGridPoint);
970         }
972         // search for the closest snapped intersection of guide lines
973         Inkscape::SnappedPoint closestGuidePoint;
974         if (getClosestIntersectionSL(sc.guide_lines, closestGuidePoint)) {
975             closestGuidePoint.setSource(source_type);
976             closestGuidePoint.setTarget(Inkscape::SNAPTARGET_GUIDE_INTERSECTION);
977             sp_list.push_back(closestGuidePoint);
978         }
980         // search for the closest snapped intersection of grid with guide lines
981         if (snapprefs.getSnapIntersectionGG()) {
982             Inkscape::SnappedPoint closestGridGuidePoint;
983             if (getClosestIntersectionSL(sc.grid_lines, sc.guide_lines, closestGridGuidePoint)) {
984                 closestGridGuidePoint.setSource(source_type);
985                 closestGridGuidePoint.setTarget(Inkscape::SNAPTARGET_GRID_GUIDE_INTERSECTION);
986                 sp_list.push_back(closestGridGuidePoint);
987             }
988         }
989     }
991     // now let's see which snapped point gets a thumbs up
992     Inkscape::SnappedPoint bestSnappedPoint = Inkscape::SnappedPoint(p, Inkscape::SNAPSOURCE_UNDEFINED, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
993     // std::cout << "Finding the best snap..." << std::endl;
994     for (std::list<Inkscape::SnappedPoint>::const_iterator i = sp_list.begin(); i != sp_list.end(); i++) {
995         // first find out if this snapped point is within snapping range
996         // std::cout << "sp = " << from_2geom((*i).getPoint());
997         if ((*i).getSnapDistance() <= (*i).getTolerance()) {
998             // if it's the first point, or if it is closer than the best snapped point so far
999             if (i == sp_list.begin() || bestSnappedPoint.isOtherSnapBetter(*i, false)) {
1000                 // then prefer this point over the previous one
1001                 bestSnappedPoint = *i;
1002             }
1003         }
1004         // std::cout << std::endl;
1005     }
1007     // Update the snap indicator, if requested
1008     if (_snapindicator) {
1009         if (bestSnappedPoint.getSnapped()) {
1010             _desktop->snapindicator->set_new_snaptarget(bestSnappedPoint);
1011         } else {
1012             _desktop->snapindicator->remove_snaptarget();
1013         }
1014     }
1016     // std::cout << "findBestSnap = " << bestSnappedPoint.getPoint() << " | dist = " << bestSnappedPoint.getSnapDistance() << std::endl;
1017     return bestSnappedPoint;
1020 /**
1021  * \brief Prepare the snap manager for the actual snapping, which includes building a list of snap targets
1022  * to ignore and toggling the snap indicator
1023  *
1024  * There are two overloaded setup() methods, of which this one only allows for a single item to be ignored
1025  * whereas the other one will take a list of items to ignore
1026  *
1027  * \param desktop Reference to the desktop to which this snap manager is attached
1028  * \param snapindicator If true then a snap indicator will be displayed automatically (when enabled in the preferences)
1029  * \param item_to_ignore This item will not be snapped to, e.g. the item that is currently being dragged. This avoids "self-snapping"
1030  * \param unselected_nodes Stationary nodes of the path that is currently being edited in the node tool and
1031  * that can be snapped too. Nodes not in this list will not be snapped to, to avoid "self-snapping". Of each
1032  * unselected node both the position (Geom::Point) and the type (Inkscape::SnapTargetType) will be stored
1033  * \param guide_to_ignore Guide that is currently being dragged and should not be snapped to
1034  */
1036 void SnapManager::setup(SPDesktop const *desktop,
1037                         bool snapindicator,
1038                         SPItem const *item_to_ignore,
1039                         std::vector<std::pair<Geom::Point, int> > *unselected_nodes,
1040                         SPGuide *guide_to_ignore)
1042     g_assert(desktop != NULL);
1043     _item_to_ignore = item_to_ignore;
1044     _items_to_ignore = NULL;
1045     _desktop = desktop;
1046     _snapindicator = snapindicator;
1047     _unselected_nodes = unselected_nodes;
1048     _guide_to_ignore = guide_to_ignore;
1051 /**
1052  * \brief Prepare the snap manager for the actual snapping, which includes building a list of snap targets
1053  * to ignore and toggling the snap indicator
1054  *
1055  * There are two overloaded setup() methods, of which the other one only allows for a single item to be ignored
1056  * whereas this one will take a list of items to ignore
1057  *
1058  * \param desktop Reference to the desktop to which this snap manager is attached
1059  * \param snapindicator If true then a snap indicator will be displayed automatically (when enabled in the preferences)
1060  * \param items_to_ignore These items will not be snapped to, e.g. the items that are currently being dragged. This avoids "self-snapping"
1061  * \param unselected_nodes Stationary nodes of the path that is currently being edited in the node tool and
1062  * that can be snapped too. Nodes not in this list will not be snapped to, to avoid "self-snapping". Of each
1063  * unselected node both the position (Geom::Point) and the type (Inkscape::SnapTargetType) will be stored
1064  * \param guide_to_ignore Guide that is currently being dragged and should not be snapped to
1065  */
1067 void SnapManager::setup(SPDesktop const *desktop,
1068                         bool snapindicator,
1069                         std::vector<SPItem const *> &items_to_ignore,
1070                         std::vector<std::pair<Geom::Point, int> > *unselected_nodes,
1071                         SPGuide *guide_to_ignore)
1073     g_assert(desktop != NULL);
1074     _item_to_ignore = NULL;
1075     _items_to_ignore = &items_to_ignore;
1076     _desktop = desktop;
1077     _snapindicator = snapindicator;
1078     _unselected_nodes = unselected_nodes;
1079     _guide_to_ignore = guide_to_ignore;
1082 SPDocument *SnapManager::getDocument() const
1084     return _named_view->document;
1087 /**
1088  * \brief Takes an untransformed point, applies the given transformation, and returns the transformed point. Eliminates lots of duplicated code
1089  *
1090  * \param p The untransformed position of the point, paired with an identifier of the type of the snap source.
1091  * \param transformation_type Type of transformation to apply.
1092  * \param transformation Mathematical description of the transformation; details depend on the type.
1093  * \param origin Origin of the transformation, if applicable.
1094  * \param dim Dimension to which the transformation applies, if applicable.
1095  * \param uniform true if the transformation should be uniform; only applicable for stretching and scaling.
1096  * \return The position of the point after transformation
1097  */
1099 Geom::Point SnapManager::_transformPoint(std::pair<Geom::Point, int> const &p,
1100                                         Transformation const transformation_type,
1101                                         Geom::Point const &transformation,
1102                                         Geom::Point const &origin,
1103                                         Geom::Dim2 const dim,
1104                                         bool const uniform) const
1106     /* Work out the transformed version of this point */
1107     Geom::Point transformed;
1108     switch (transformation_type) {
1109         case TRANSLATION:
1110             transformed = p.first + transformation;
1111             break;
1112         case SCALE:
1113             transformed = (p.first - origin) * Geom::Scale(transformation[Geom::X], transformation[Geom::Y]) + origin;
1114             break;
1115         case STRETCH:
1116         {
1117             Geom::Scale s(1, 1);
1118             if (uniform)
1119                 s[Geom::X] = s[Geom::Y] = transformation[dim];
1120             else {
1121                 s[dim] = transformation[dim];
1122                 s[1 - dim] = 1;
1123             }
1124             transformed = ((p.first - origin) * s) + origin;
1125             break;
1126         }
1127         case SKEW:
1128             // Apply the skew factor
1129             transformed[dim] = (p.first)[dim] + transformation[0] * ((p.first)[1 - dim] - origin[1 - dim]);
1130             // While skewing, mirroring and scaling (by integer multiples) in the opposite direction is also allowed.
1131             // Apply that scale factor here
1132             transformed[1-dim] = (p.first - origin)[1 - dim] * transformation[1] + origin[1 - dim];
1133             break;
1134         default:
1135             g_assert_not_reached();
1136     }
1138     return transformed;
1141 /**
1142  * \brief Mark the location of the snap source (not the snap target!) on the canvas by drawing a symbol
1143  *
1144  * \param point_type Category of points to which the source point belongs: node, guide or bounding box
1145  * \param p The transformed position of the source point, paired with an identifier of the type of the snap source.
1146  */
1148 void SnapManager::_displaySnapsource(Inkscape::SnapPreferences::PointType point_type, std::pair<Geom::Point, int> const &p) const {
1150     Inkscape::Preferences *prefs = Inkscape::Preferences::get();
1151     if (prefs->getBool("/options/snapclosestonly/value")) {
1152         bool p_is_a_node = point_type & Inkscape::SnapPreferences::SNAPPOINT_NODE;
1153         bool p_is_a_bbox = point_type & Inkscape::SnapPreferences::SNAPPOINT_BBOX;
1154         if (snapprefs.getSnapEnabledGlobally() && ((p_is_a_node && snapprefs.getSnapModeNode()) || (p_is_a_bbox && snapprefs.getSnapModeBBox()))) {
1155             _desktop->snapindicator->set_new_snapsource(p);
1156         } else {
1157             _desktop->snapindicator->remove_snapsource();
1158         }
1159     }
1162 /*
1163   Local Variables:
1164   mode:c++
1165   c-file-style:"stroustrup"
1166   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
1167   indent-tabs-mode:nil
1168   fill-column:99
1169   End:
1170 */
1171 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :