![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/snap.cpp b/src/snap.cpp
index aa0e4af5c511fa90c9fb2d735ceb651ff5ff6440..3cac53ebe6d74eeb90dac9b01ccb5d93f28c126c 100644 (file)
--- a/src/snap.cpp
+++ b/src/snap.cpp
*
* Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
* Copyrigth (C) 2004 Nathan Hurst
- * Copyright (C) 1999-2009 Authors
+ * Copyright (C) 1999-2010 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include "inkscape.h"
#include "desktop.h"
+#include "selection.h"
#include "sp-guide.h"
#include "preferences.h"
#include "event-context.h"
}
/**
+ * \brief Return a list of snappers
+ *
+ * Inkscape snaps to objects, grids, and guides. For each of these snap targets a
+ * separate class is used, which has been derived from the base Snapper class. The
+ * getSnappers() method returns a list of pointers to instances of this class. This
+ * list contains exactly one instance of the guide snapper and of the object snapper
+ * class, but any number of grid snappers (because each grid has its own snapper
+ * instance)
+ *
* \return List of snappers that we use.
*/
SnapManager::SnapperList
}
/**
+ * \brief Return a list of gridsnappers
+ *
+ * Each grid has its own instance of the snapper class. This way snapping can
+ * be enabled per grid individually. A list will be returned containing the
+ * pointers to these instances, but only for grids that are being displayed
+ * and for which snapping is enabled.
+ *
* \return List of gridsnappers that we use.
*/
SnapManager::SnapperList
{
SnapperList s;
- //FIXME: this code should actually do this: add new grid snappers that are active for this desktop. now it just adds all gridsnappers
if (_desktop && _desktop->gridsEnabled() && snapprefs.getSnapToGrids()) {
for ( GSList const *l = _named_view->grids; l != NULL; l = l->next) {
Inkscape::CanvasGrid *grid = (Inkscape::CanvasGrid*) l->data;
}
/**
- * \return true if one of the snappers will try to snap something.
+ * \brief Return true if any snapping might occur, whether its to grids, guides or objects
+ *
+ * Each snapper instance handles its own snapping target, e.g. grids, guides or
+ * objects. This method iterates through all these snapper instances and returns
+ * true if any of the snappers might possible snap, considering only the relevant
+ * snapping preferences.
+ *
+ * \return true if one of the snappers will try to snap to something.
*/
bool SnapManager::someSnapperMightSnap() const
}
/**
- * \return true if one of the snappers will try to snap something.
+ * \return true if one of the grids might be snapped to.
*/
bool SnapManager::gridSnapperMightSnap() const
}
/**
- * Try to snap a point to any of the specified snappers.
+ * \brief Try to snap a point to grids, guides or objects.
+ *
+ * Try to snap a point to grids, guides or objects, in two degrees-of-freedom,
+ * i.e. snap in any direction on the two dimensional canvas to the nearest
+ * snap target. freeSnapReturnByRef() is equal in snapping behavior to
+ * freeSnap(), but the former returns the snapped point trough the referenced
+ * parameter p. This parameter p initially contains the position of the snap
+ * source and will we overwritten by the target position if snapping has occurred.
+ * This makes snapping transparent to the calling code. If this is not desired
+ * because either the calling code must know whether snapping has occurred, or
+ * because the original position should not be touched, then freeSnap() should be
+ * called instead.
*
- * \param point_type Type of point.
- * \param p Point.
- * \param first_point If true then this point is the first one from a whole bunch of points
- * \param points_to_snap The whole bunch of points, all from the same selection and having the same transformation
- * \param snappers List of snappers to try to snap to
- * \return Snapped point.
+ * PS:
+ * 1) SnapManager::setup() must have been called before calling this method,
+ * but only once for a set of points
+ * 2) Only to be used when a single source point is to be snapped; it assumes
+ * that source_num = 0, which is inefficient when snapping sets our source points
+ *
+ * \param p Current position of the snap source; will be overwritten by the position of the snap target if snapping has occurred
+ * \param source_type Detailed description of the source type, will be used by the snap indicator
+ * \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
*/
-void SnapManager::freeSnapReturnByRef(Inkscape::SnapPreferences::PointType point_type,
- Geom::Point &p,
+void SnapManager::freeSnapReturnByRef(Geom::Point &p,
Inkscape::SnapSourceType const source_type,
- bool first_point,
Geom::OptRect const &bbox_to_snap) const
{
- Inkscape::SnappedPoint const s = freeSnap(point_type, p, source_type, first_point, bbox_to_snap);
+ //TODO: SnapCandidatePoint and point_type are somewhat redundant; can't we get rid of the point_type parameter?
+ Inkscape::SnappedPoint const s = freeSnap(Inkscape::SnapCandidatePoint(p, source_type), bbox_to_snap);
s.getPoint(p);
}
/**
- * Try to snap a point to any of the specified snappers.
+ * \brief Try to snap a point to grids, guides or objects.
+ *
+ * Try to snap a point to grids, guides or objects, in two degrees-of-freedom,
+ * i.e. snap in any direction on the two dimensional canvas to the nearest
+ * snap target. freeSnap() is equal in snapping behavior to
+ * freeSnapReturnByRef(). Please read the comments of the latter for more details
+ *
+ * PS: SnapManager::setup() must have been called before calling this method,
+ * but only once for a set of points
*
- * \param point_type Type of point.
- * \param p Point.
- * \param first_point If true then this point is the first one from a whole bunch of points
- * \param points_to_snap The whole bunch of points, all from the same selection and having the same transformation
- * \param snappers List of snappers to try to snap to
- * \return Snapped point.
+ * \param p Source point to be snapped
+ * \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics
*/
-Inkscape::SnappedPoint SnapManager::freeSnap(Inkscape::SnapPreferences::PointType point_type,
- Geom::Point const &p,
- Inkscape::SnapSourceType const &source_type,
- bool first_point,
+
+Inkscape::SnappedPoint SnapManager::freeSnap(Inkscape::SnapCandidatePoint const &p,
Geom::OptRect const &bbox_to_snap) const
{
- if (_desktop->event_context && _desktop->event_context->_snap_window_open == false) {
- g_warning("The current tool tries to snap, but it hasn't yet opened the snap window. Please report this!");
- // When the context goes into dragging-mode, then Inkscape should call this: sp_event_context_snap_window_open(event_context);
- }
-
- //std::cout << "SnapManager::freeSnap -> postponed: " << snapprefs.getSnapPostponedGlobally() << std::endl;
-
- if (!someSnapperMightSnap()) {
- return Inkscape::SnappedPoint(p, source_type, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
- }
-
- std::vector<SPItem const *> *items_to_ignore;
- if (_item_to_ignore) { // If we have only a single item to ignore
- // then build a list containing this single item;
- // This single-item list will prevail over any other _items_to_ignore list, should that exist
- items_to_ignore = new std::vector<SPItem const *>;
- items_to_ignore->push_back(_item_to_ignore);
- } else {
- items_to_ignore = _items_to_ignore;
+ if (!someSnapperMightSnap()) {
+ return Inkscape::SnappedPoint(p, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
}
SnappedConstraints sc;
SnapperList const snappers = getSnappers();
for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
- (*i)->freeSnap(sc, point_type, p, source_type, first_point, bbox_to_snap, items_to_ignore, _unselected_nodes);
+ (*i)->freeSnap(sc, p, bbox_to_snap, &_items_to_ignore, _unselected_nodes);
}
- if (_item_to_ignore) {
- delete items_to_ignore;
- }
+ return findBestSnap(p, sc, false);
+}
- return findBestSnap(p, source_type, sc, false);
+void SnapManager::preSnap(Inkscape::SnapCandidatePoint const &p)
+{
+ // setup() must have been called before calling this method!
+
+ if (_snapindicator) {
+ _snapindicator = false; // prevent other methods from drawing a snap indicator; we want to control this here
+ Inkscape::SnappedPoint s = freeSnap(p);
+ if (s.getSnapped()) {
+ _desktop->snapindicator->set_new_snaptarget(s, true);
+ } else {
+ _desktop->snapindicator->remove_snaptarget();
+ }
+ _snapindicator = true; // restore the original value
+ }
}
-// When pasting, we would like to snap to the grid. Problem is that we don't know which nodes were
-// aligned to the grid at the time of copying, so we don't know which nodes to snap. If we'd snap an
-// unaligned node to the grid, previously aligned nodes would become unaligned. That's undesirable.
-// Instead we will make sure that the offset between the source and the copy is a multiple of the grid
-// pitch. If the source was aligned, then the copy will therefore also be aligned
-// PS: Whether we really find a multiple also depends on the snapping range!
+/**
+ * \brief Snap to the closest multiple of a grid pitch
+ *
+ * When pasting, we would like to snap to the grid. Problem is that we don't know which
+ * nodes were aligned to the grid at the time of copying, so we don't know which nodes
+ * to snap. If we'd snap an unaligned node to the grid, previously aligned nodes would
+ * become unaligned. That's undesirable. Instead we will make sure that the offset
+ * between the source and its pasted copy is a multiple of the grid pitch. If the source
+ * was aligned, then the copy will therefore also be aligned.
+ *
+ * PS: Whether we really find a multiple also depends on the snapping range! Most users
+ * will have "always snap" enabled though, in which case a multiple will always be found.
+ * PS2: When multiple grids are present then the result will become ambiguous. There is no
+ * way to control to which grid this method will snap.
+ *
+ * \param t Vector that represents the offset of the pasted copy with respect to the original
+ * \return Offset vector after snapping to the closest multiple of a grid pitch
+ */
+
Geom::Point SnapManager::multipleOfGridPitch(Geom::Point const &t) const
{
if (!snapprefs.getSnapEnabledGlobally()) // No need to check for snapprefs.getSnapPostponedGlobally() here
return t;
- //FIXME: this code should actually do this: add new grid snappers that are active for this desktop. now it just adds all gridsnappers
-
if (_desktop && _desktop->gridsEnabled()) {
bool success = false;
Geom::Point nearest_multiple;
Geom::Point const t_offset = t + grid->origin;
SnappedConstraints sc;
// Only the first three parameters are being used for grid snappers
- snapper->freeSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_NODE, t_offset, Inkscape::SNAPSOURCE_UNDEFINED, TRUE, Geom::OptRect(), NULL, NULL);
+ snapper->freeSnap(sc, Inkscape::SnapCandidatePoint(t_offset, Inkscape::SNAPSOURCE_UNDEFINED),Geom::OptRect(), NULL, NULL);
// Find the best snap for this grid, including intersections of the grid-lines
- Inkscape::SnappedPoint s = findBestSnap(t_offset, Inkscape::SNAPSOURCE_UNDEFINED, sc, false);
+ Inkscape::SnappedPoint s = findBestSnap(Inkscape::SnapCandidatePoint(t_offset, Inkscape::SNAPSOURCE_UNDEFINED), sc, false);
if (s.getSnapped() && (s.getSnapDistance() < nearest_distance)) {
// use getSnapDistance() instead of getWeightedDistance() here because the pointer's position
// doesn't tell us anything about which node to snap
}
/**
- * Try to snap a point to any interested snappers. A snap will only occur along
- * a line described by a Inkscape::Snapper::ConstraintLine.
+ * \brief Try to snap a point along a constraint line to grids, guides or objects.
+ *
+ * Try to snap a point to grids, guides or objects, in only one degree-of-freedom,
+ * i.e. snap in a specific direction on the two dimensional canvas to the nearest
+ * snap target.
+ *
+ * constrainedSnapReturnByRef() is equal in snapping behavior to
+ * constrainedSnap(), but the former returns the snapped point trough the referenced
+ * parameter p. This parameter p initially contains the position of the snap
+ * source and will we overwritten by the target position if snapping has occurred.
+ * This makes snapping transparent to the calling code. If this is not desired
+ * because either the calling code must know whether snapping has occurred, or
+ * because the original position should not be touched, then constrainedSnap() should
+ * be called instead.
*
- * \param point_type Type of point.
- * \param p Point.
- * \param first_point If true then this point is the first one from a whole bunch of points
- * \param points_to_snap The whole bunch of points, all from the same selection and having the same transformation
- * \param constraint Constraint line.
- * \return Snapped point.
+ * PS:
+ * 1) SnapManager::setup() must have been called before calling this method,
+ * but only once for a set of points
+ * 2) Only to be used when a single source point is to be snapped; it assumes
+ * that source_num = 0, which is inefficient when snapping sets our source points
+
+ *
+ * \param p Current position of the snap source; will be overwritten by the position of the snap target if snapping has occurred
+ * \param source_type Detailed description of the source type, will be used by the snap indicator
+ * \param constraint The direction or line along which snapping must occur
+ * \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
*/
-void SnapManager::constrainedSnapReturnByRef(Inkscape::SnapPreferences::PointType point_type,
- Geom::Point &p,
+void SnapManager::constrainedSnapReturnByRef(Geom::Point &p,
Inkscape::SnapSourceType const source_type,
Inkscape::Snapper::ConstraintLine const &constraint,
- bool const snap_projection,
- bool first_point,
Geom::OptRect const &bbox_to_snap) const
{
- Inkscape::SnappedPoint const s = constrainedSnap(point_type, p, source_type, constraint, snap_projection, first_point, bbox_to_snap);
+ Inkscape::SnappedPoint const s = constrainedSnap(Inkscape::SnapCandidatePoint(p, source_type, 0), constraint, bbox_to_snap);
s.getPoint(p);
}
-
/**
- * Try to snap a point to any interested snappers. A snap will only occur along
- * a line described by a Inkscape::Snapper::ConstraintLine.
+ * \brief Try to snap a point along a constraint line to grids, guides or objects.
*
- * \param point_type Type of point.
- * \param p Point.
- * \param first_point If true then this point is the first one from a whole bunch of points
- * \param points_to_snap The whole bunch of points, all from the same selection and having the same transformation
- * \param constraint Constraint line.
- * \return Snapped point.
+ * Try to snap a point to grids, guides or objects, in only one degree-of-freedom,
+ * i.e. snap in a specific direction on the two dimensional canvas to the nearest
+ * snap target. constrainedSnap is equal in snapping behavior to
+ * constrainedSnapReturnByRef(). Please read the comments of the latter for more details.
+ *
+ * PS: SnapManager::setup() must have been called before calling this method,
+ * but only once for a set of points
+ *
+ * \param p Source point to be snapped
+ * \param constraint The direction or line along which snapping must occur
+ * \param bbox_to_snap Bounding box hulling the set of points, all from the same selection and having the same transformation
*/
-Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::SnapPreferences::PointType point_type,
- Geom::Point const &p,
- Inkscape::SnapSourceType const &source_type,
+Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::SnapCandidatePoint const &p,
Inkscape::Snapper::ConstraintLine const &constraint,
- bool /*snap_projection*/,
- bool first_point,
Geom::OptRect const &bbox_to_snap) const
{
- if (_desktop->event_context && _desktop->event_context->_snap_window_open == false) {
- g_warning("The current tool tries to snap, but it hasn't yet opened the snap window. Please report this!");
- // When the context goes into dragging-mode, then Inkscape should call this: sp_event_context_snap_window_open(event_context);
- }
-
- if (!someSnapperMightSnap()) {
- return Inkscape::SnappedPoint(p, source_type, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
- }
+ // First project the mouse pointer onto the constraint
+ Geom::Point pp = constraint.projection(p.getPoint());
- std::vector<SPItem const *> *items_to_ignore;
- if (_item_to_ignore) { // If we have only a single item to ignore
- // then build a list containing this single item;
- // This single-item list will prevail over any other _items_to_ignore list, should that exist
- items_to_ignore = new std::vector<SPItem const *>;
- items_to_ignore->push_back(_item_to_ignore);
- } else {
- items_to_ignore = _items_to_ignore;
+ if (!someSnapperMightSnap()) {
+ // The constraint should always be enforce, so we return pp here instead of p
+ return Inkscape::SnappedPoint(pp, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
}
- Geom::Point pp = constraint.projection(p);
+ // Then try to snap the projected point
+ Inkscape::SnapCandidatePoint candidate(pp, p.getSourceType(), p.getSourceNum(), Inkscape::SNAPTARGET_UNDEFINED, Geom::Rect());
SnappedConstraints sc;
SnapperList const snappers = getSnappers();
for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
- (*i)->constrainedSnap(sc, point_type, pp, source_type, first_point, bbox_to_snap, constraint, items_to_ignore);
- }
-
- if (_item_to_ignore) {
- delete items_to_ignore;
+ (*i)->constrainedSnap(sc, candidate, bbox_to_snap, constraint, &_items_to_ignore);
}
- return findBestSnap(p, source_type, sc, true);
+ return findBestSnap(candidate, sc, true);
}
-// guideFreeSnap is used when dragging or rotating the guide
-void SnapManager::guideFreeSnap(Geom::Point &p, Geom::Point const &guide_normal) const
+/**
+ * \brief Try to snap a point of a guide to another guide or to a node
+ *
+ * Try to snap a point of a guide to another guide or to a node in two degrees-
+ * of-freedom, i.e. snap in any direction on the two dimensional canvas to the
+ * nearest snap target. This method is used when dragging or rotating a guide
+ *
+ * PS: SnapManager::setup() must have been called before calling this method,
+ *
+ * \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
+ * \param guide_normal Vector normal to the guide line
+ */
+void SnapManager::guideFreeSnap(Geom::Point &p, Geom::Point const &guide_normal, SPGuideDragType drag_type) const
{
- // This method is used to snap a guide to nodes or to other guides, while dragging the guide around. Will not snap to grids!
-
- if (_desktop->event_context && _desktop->event_context->_snap_window_open == false) {
- g_warning("The current tool tries to snap, but it hasn't yet opened the snap window. Please report this!");
- // When the context goes into dragging-mode, then Inkscape should call this: sp_event_context_snap_window_open(event_context);
- }
-
if (!snapprefs.getSnapEnabledGlobally() || snapprefs.getSnapPostponedGlobally()) {
return;
}
@@ -348,33 +396,46 @@ void SnapManager::guideFreeSnap(Geom::Point &p, Geom::Point const &guide_normal)
return;
}
+ Inkscape::SnapCandidatePoint candidate(p, Inkscape::SNAPSOURCE_GUIDE_ORIGIN);
+ if (drag_type == SP_DRAG_ROTATE) {
+ candidate = Inkscape::SnapCandidatePoint(p, Inkscape::SNAPSOURCE_GUIDE);
+ }
+
// Snap to nodes
SnappedConstraints sc;
if (object.GuidesMightSnap()) {
object.guideFreeSnap(sc, p, guide_normal);
}
- // Snap to guides
- if (snapprefs.getSnapToGuides()) {
- guide.freeSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, Inkscape::SNAPSOURCE_GUIDE, true, Geom::OptRect(), NULL, NULL);
+ // Snap to guides & grid lines
+ SnapperList snappers = getGridSnappers();
+ snappers.push_back(&guide);
+ for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
+ (*i)->freeSnap(sc, candidate, Geom::OptRect(), NULL, NULL);
}
- // We won't snap to grids, what's the use?
+ // Snap to intersections of curves, but not to the curves themselves! (see _snapTranslatingGuideToNodes in object-snapper.cpp)
+ Inkscape::SnappedPoint const s = findBestSnap(candidate, sc, false, true);
- Inkscape::SnappedPoint const s = findBestSnap(p, Inkscape::SNAPSOURCE_GUIDE, sc, false);
s.getPoint(p);
}
-// guideConstrainedSnap is used when dragging the origin of the guide along the guide itself
+/**
+ * \brief Try to snap a point on a guide to the intersection with another guide or a path
+ *
+ * Try to snap a point on a guide to the intersection of that guide with another
+ * guide or with a path. The snapped point will lie somewhere on the guide-line,
+ * making this is a constrained snap, i.e. in only one degree-of-freedom.
+ * This method is used when dragging the origin of the guide along the guide itself.
+ *
+ * PS: SnapManager::setup() must have been called before calling this method,
+ *
+ * \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
+ * \param guide_normal Vector normal to the guide line
+ */
+
void SnapManager::guideConstrainedSnap(Geom::Point &p, SPGuide const &guideline) const
{
- // This method is used to snap a guide to paths or to other guides, while dragging the origin of the guide around. Will not snap to grids!
-
- if (_desktop->event_context && _desktop->event_context->_snap_window_open == false) {
- g_warning("The current tool tries to snap, but it hasn't yet opened the snap window. Please report this!");
- // When the context goes into dragging-mode, then Inkscape should call this: sp_event_context_snap_window_open(event_context);
- }
-
if (!snapprefs.getSnapEnabledGlobally() || snapprefs.getSnapPostponedGlobally()) {
return;
}
@@ -383,44 +444,53 @@ void SnapManager::guideConstrainedSnap(Geom::Point &p, SPGuide const &guideline)
return;
}
+ Inkscape::SnapCandidatePoint candidate(p, Inkscape::SNAPSOURCE_GUIDE_ORIGIN, Inkscape::SNAPTARGET_UNDEFINED);
+
// Snap to nodes or paths
SnappedConstraints sc;
Inkscape::Snapper::ConstraintLine cl(guideline.point_on_line, Geom::rot90(guideline.normal_to_line));
if (object.ThisSnapperMightSnap()) {
- object.constrainedSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, Inkscape::SNAPSOURCE_GUIDE_ORIGIN, true, Geom::OptRect(), cl, NULL);
+ object.constrainedSnap(sc, candidate, Geom::OptRect(), cl, NULL);
}
- // Snap to guides
- if (snapprefs.getSnapToGuides()) {
- guide.constrainedSnap(sc, Inkscape::SnapPreferences::SNAPPOINT_GUIDE, p, Inkscape::SNAPSOURCE_GUIDE_ORIGIN, true, Geom::OptRect(), cl, NULL);
+ // Snap to guides & grid lines
+ SnapperList snappers = getGridSnappers();
+ snappers.push_back(&guide);
+ for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
+ (*i)->constrainedSnap(sc, candidate, Geom::OptRect(), cl, NULL);
}
- // We won't snap to grids, what's the use?
-
- Inkscape::SnappedPoint const s = findBestSnap(p, Inkscape::SNAPSOURCE_GUIDE, sc, false);
+ Inkscape::SnappedPoint const s = findBestSnap(candidate, sc, false);
s.getPoint(p);
}
/**
- * Main internal snapping method, which is called by the other, friendlier, public
- * methods. It's a bit hairy as it has lots of parameters, but it saves on a lot
- * of duplicated code.
+ * \brief Method for snapping sets of points while they are being transformed
+ *
+ * Method for snapping sets of points while they are being transformed, when using
+ * for example the selector tool. This method is for internal use only, and should
+ * not have to be called directly. Use freeSnapTransalation(), constrainedSnapScale(),
+ * etc. instead.
+ *
+ * This is what is being done in this method: transform each point, find out whether
+ * a free snap or constrained snap is more appropriate, do the snapping, calculate
+ * some metrics to quantify the snap "distance", and see if it's better than the
+ * previous snap. Finally, the best ("nearest") snap from all these points is returned.
*
- * \param type Type of points being snapped.
- * \param points List of points to snap (i.e. untransformed).
- * \param pointer Location of the mouse pointer, at the time when dragging started (i.e. "untransformed")
- * \param constrained true if the snap is constrained.
- * \param constraint Constraint line to use, if `constrained' is true, otherwise undefined.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param constrained true if the snap is constrained, e.g. for stretching or for purely horizontal translation.
+ * \param constraint The direction or line along which snapping must occur, if 'constrained' is true; otherwise undefined.
* \param transformation_type Type of transformation to apply to points before trying to snap them.
* \param transformation Description of the transformation; details depend on the type.
* \param origin Origin of the transformation, if applicable.
- * \param dim Dimension of the transformation, if applicable.
+ * \param dim Dimension to which the transformation applies, if applicable.
* \param uniform true if the transformation should be uniform; only applicable for stretching and scaling.
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
Inkscape::SnappedPoint SnapManager::_snapTransformed(
- Inkscape::SnapPreferences::PointType type,
- std::vector<std::pair<Geom::Point, int> > const &points,
+ std::vector<Inkscape::SnapCandidatePoint> const &points,
Geom::Point const &pointer,
bool constrained,
Inkscape::Snapper::ConstraintLine const &constraint,
** Also used to globally disable all snapping
*/
if (someSnapperMightSnap() == false) {
- return Inkscape::SnappedPoint();
+ return Inkscape::SnappedPoint(pointer);
}
- std::vector<std::pair<Geom::Point, int> > transformed_points;
+ std::vector<Inkscape::SnapCandidatePoint> transformed_points;
Geom::Rect bbox;
- for (std::vector<std::pair<Geom::Point, int> >::const_iterator i = points.begin(); i != points.end(); i++) {
+ long source_num = 0;
+ for (std::vector<Inkscape::SnapCandidatePoint>::const_iterator i = points.begin(); i != points.end(); i++) {
/* Work out the transformed version of this point */
Geom::Point transformed = _transformPoint(*i, transformation_type, transformation, origin, dim, uniform);
bbox.expandTo(transformed);
}
- transformed_points.push_back(std::make_pair(transformed, (*i).second));
+ transformed_points.push_back(Inkscape::SnapCandidatePoint(transformed, (*i).getSourceType(), source_num));
+ source_num++;
}
/* The current best transformation */
g_assert(best_snapped_point.getAlwaysSnap() == false); // Check initialization of snapped point
g_assert(best_snapped_point.getAtIntersection() == false);
- std::vector<std::pair<Geom::Point, int> >::const_iterator j = transformed_points.begin();
+ std::vector<Inkscape::SnapCandidatePoint>::const_iterator j = transformed_points.begin();
+
// std::cout << std::endl;
- for (std::vector<std::pair<Geom::Point, int> >::const_iterator i = points.begin(); i != points.end(); i++) {
+ for (std::vector<Inkscape::SnapCandidatePoint>::const_iterator i = points.begin(); i != points.end(); i++) {
/* Snap it */
Inkscape::SnappedPoint snapped_point;
Inkscape::Snapper::ConstraintLine dedicated_constraint = constraint;
- Geom::Point const b = ((*i).first - origin); // vector to original point
+ Geom::Point const b = ((*i).getPoint() - origin); // vector to original point
if (constrained) {
if ((transformation_type == SCALE || transformation_type == STRETCH) && uniform) {
// calculate that line here
dedicated_constraint = Inkscape::Snapper::ConstraintLine(origin, b);
} else if (transformation_type == STRETCH) { // when non-uniform stretching {
- dedicated_constraint = Inkscape::Snapper::ConstraintLine((*i).first, component_vectors[dim]);
+ dedicated_constraint = Inkscape::Snapper::ConstraintLine((*i).getPoint(), component_vectors[dim]);
} else if (transformation_type == TRANSLATION) {
// When doing a constrained translation, all points will move in the same direction, i.e.
// either horizontally or vertically. The lines along which they move are therefore all
// parallel, but might not be colinear. Therefore we will have to set the point through
// which the constraint-line runs here, for each point individually.
- dedicated_constraint.setPoint((*i).first);
+ dedicated_constraint.setPoint((*i).getPoint());
} // else: leave the original constraint, e.g. for skewing
if (transformation_type == SCALE && !uniform) {
g_warning("Non-uniform constrained scaling is not supported!");
}
- snapped_point = constrainedSnap(type, (*j).first, static_cast<Inkscape::SnapSourceType>((*j).second), dedicated_constraint, false, i == points.begin(), bbox);
+ snapped_point = constrainedSnap(*j, dedicated_constraint, bbox);
} else {
bool const c1 = fabs(b[Geom::X]) < 1e-6;
bool const c2 = fabs(b[Geom::Y]) < 1e-6;
// move in that specific direction; therefore it should only snap in that direction, otherwise
// we will get snapped points with an invalid transformation
dedicated_constraint = Inkscape::Snapper::ConstraintLine(origin, component_vectors[c1]);
- snapped_point = constrainedSnap(type, (*j).first, static_cast<Inkscape::SnapSourceType>((*j).second), dedicated_constraint, false, i == points.begin(), bbox);
+ snapped_point = constrainedSnap(*j, dedicated_constraint, bbox);
} else {
- snapped_point = freeSnap(type, (*j).first, static_cast<Inkscape::SnapSourceType>((*j).second), i == points.begin(), bbox);
+ snapped_point = freeSnap(*j, bbox);
}
}
// std::cout << "dist = " << snapped_point.getSnapDistance() << std::endl;
- snapped_point.setPointerDistance(Geom::L2(pointer - (*i).first));
+ snapped_point.setPointerDistance(Geom::L2(pointer - (*i).getPoint()));
Geom::Point result;
- Geom::Point scale_metric(NR_HUGE, NR_HUGE);
if (snapped_point.getSnapped()) {
/* We snapped. Find the transformation that describes where the snapped point has
switch (transformation_type) {
case TRANSLATION:
- result = snapped_point.getPoint() - (*i).first;
+ result = snapped_point.getPoint() - (*i).getPoint();
/* Consider the case in which a box is almost aligned with a grid in both
* horizontal and vertical directions. The distance to the intersection of
* the grid lines will always be larger then the distance to a single grid
// if scaling didn't occur in the other direction
}
}
+ if (uniform) {
+ if (fabs(result[0]) < fabs(result[1])) {
+ result[1] = result[0];
+ } else {
+ result[0] = result[1];
+ }
+ }
// Compare the resulting scaling with the desired scaling
- scale_metric = result - transformation; // One or both of its components might be NR_HUGE
+ Geom::Point scale_metric = Geom::abs(result - transformation); // One or both of its components might be NR_HUGE
+ snapped_point.setSnapDistance(std::min(scale_metric[0], scale_metric[1]));
+ snapped_point.setSecondSnapDistance(std::max(scale_metric[0], scale_metric[1]));
break;
}
case STRETCH:
snapped_point.setSecondSnapDistance(NR_HUGE);
break;
case SKEW:
- result[0] = (snapped_point.getPoint()[dim] - ((*i).first)[dim]) / (((*i).first)[1 - dim] - origin[1 - dim]); // skew factor
+ result[0] = (snapped_point.getPoint()[dim] - ((*i).getPoint())[dim]) / (((*i).getPoint())[1 - dim] - origin[1 - dim]); // skew factor
result[1] = transformation[1]; // scale factor
// Store the metric for this transformation as a virtual distance
snapped_point.setSnapDistance(std::abs(result[0] - transformation[0]));
// When scaling, we're considering the best transformation in each direction separately. We will have a metric in each
// direction, whereas for all other transformation we only a single one-dimensional metric. That's why we need to handle
// the scaling metric differently
- if (transformation_type == SCALE) {
- for (int index = 0; index < 2; index++) {
- if (fabs(scale_metric[index]) < fabs(best_scale_metric[index])) {
- best_transformation[index] = result[index];
- best_scale_metric[index] = fabs(scale_metric[index]);
- // When scaling, we're considering the best transformation in each direction separately
- // Therefore two different snapped points might together make a single best transformation
- // We will however return only a single snapped point (e.g. to display the snapping indicator)
- best_snapped_point = snapped_point;
- // std::cout << "SEL ";
- } // else { std::cout << " ";}
- }
- if (uniform) {
- if (best_scale_metric[0] < best_scale_metric[1]) {
- best_transformation[1] = best_transformation[0];
- best_scale_metric[1] = best_scale_metric[0];
- } else {
- best_transformation[0] = best_transformation[1];
- best_scale_metric[0] = best_scale_metric[1];
- }
- }
- } else { // For all transformations other than scaling
- if (best_snapped_point.isOtherSnapBetter(snapped_point, true)) {
- best_transformation = result;
- best_snapped_point = snapped_point;
- }
+ if (best_snapped_point.isOtherSnapBetter(snapped_point, true)) {
+ best_transformation = result;
+ best_snapped_point = snapped_point;
}
}
}
}
}
- best_metric = std::min(best_scale_metric[0], best_scale_metric[1]);
- } else { // For all transformations other than scaling
- best_metric = best_snapped_point.getSnapDistance();
}
+ best_metric = best_snapped_point.getSnapDistance();
best_snapped_point.setTransformation(best_transformation);
// Using " < 1e6" instead of " < NR_HUGE" for catching some rounding errors
// These rounding errors might be caused by NRRects, see bug #1584301
/**
- * Try to snap a list of points to any interested snappers after they have undergone
- * a translation.
+ * \brief Apply a translation to a set of points and try to snap freely in 2 degrees-of-freedom
*
- * \param point_type Type of points.
- * \param p Points.
- * \param tr Proposed translation.
- * \return Snapped translation, if a snap occurred, and a flag indicating whether a snap occurred.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param tr Proposed translation; the final translation can only be calculated after snapping has occurred
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
-Inkscape::SnappedPoint SnapManager::freeSnapTranslation(Inkscape::SnapPreferences::PointType point_type,
- std::vector<std::pair<Geom::Point, int> > const &p,
+Inkscape::SnappedPoint SnapManager::freeSnapTranslation(std::vector<Inkscape::SnapCandidatePoint> const &p,
Geom::Point const &pointer,
Geom::Point const &tr) const
{
if (p.size() == 1) {
- _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false), (p.at(0)).second));
+ Geom::Point pt = _transformPoint(p.at(0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
+ _displaySnapsource(Inkscape::SnapCandidatePoint(pt, p.at(0).getSourceType()));
}
- return _snapTransformed(point_type, p, pointer, false, Geom::Point(0,0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
+ return _snapTransformed(p, pointer, false, Geom::Point(0,0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
}
-
/**
- * Try to snap a list of points to any interested snappers after they have undergone a
- * translation. A snap will only occur along a line described by a
- * Inkscape::Snapper::ConstraintLine.
+ * \brief Apply a translation to a set of points and try to snap along a constraint
*
- * \param point_type Type of points.
- * \param p Points.
- * \param constraint Constraint line.
- * \param tr Proposed translation.
- * \return Snapped translation, if a snap occurred, and a flag indicating whether a snap occurred.
+ * \param point_type Category of points to which the source point belongs: node or bounding box.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param constraint The direction or line along which snapping must occur.
+ * \param tr Proposed translation; the final translation can only be calculated after snapping has occurred.
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
-Inkscape::SnappedPoint SnapManager::constrainedSnapTranslation(Inkscape::SnapPreferences::PointType point_type,
- std::vector<std::pair<Geom::Point, int> > const &p,
+Inkscape::SnappedPoint SnapManager::constrainedSnapTranslation(std::vector<Inkscape::SnapCandidatePoint> const &p,
Geom::Point const &pointer,
Inkscape::Snapper::ConstraintLine const &constraint,
Geom::Point const &tr) const
{
if (p.size() == 1) {
- _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false), (p.at(0)).second));
+ Geom::Point pt = _transformPoint(p.at(0), TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
+ _displaySnapsource(Inkscape::SnapCandidatePoint(pt, p.at(0).getSourceType()));
}
- return _snapTransformed(point_type, p, pointer, true, constraint, TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
+ return _snapTransformed(p, pointer, true, constraint, TRANSLATION, tr, Geom::Point(0,0), Geom::X, false);
}
/**
- * Try to snap a list of points to any interested snappers after they have undergone
- * a scale.
+ * \brief Apply a scaling to a set of points and try to snap freely in 2 degrees-of-freedom
*
- * \param point_type Type of points.
- * \param p Points.
- * \param s Proposed scale.
- * \param o Origin of proposed scale.
- * \return Snapped scale, if a snap occurred, and a flag indicating whether a snap occurred.
+ * \param point_type Category of points to which the source point belongs: node or bounding box.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param s Proposed scaling; the final scaling can only be calculated after snapping has occurred
+ * \param o Origin of the scaling
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
-Inkscape::SnappedPoint SnapManager::freeSnapScale(Inkscape::SnapPreferences::PointType point_type,
- std::vector<std::pair<Geom::Point, int> > const &p,
+Inkscape::SnappedPoint SnapManager::freeSnapScale(std::vector<Inkscape::SnapCandidatePoint> const &p,
Geom::Point const &pointer,
Geom::Scale const &s,
Geom::Point const &o) const
{
if (p.size() == 1) {
- _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));
+ Geom::Point pt = _transformPoint(p.at(0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, false);
+ _displaySnapsource(Inkscape::SnapCandidatePoint(pt, p.at(0).getSourceType()));
}
- return _snapTransformed(point_type, p, pointer, false, Geom::Point(0,0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, false);
+ return _snapTransformed(p, pointer, false, Geom::Point(0,0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, false);
}
/**
- * Try to snap a list of points to any interested snappers after they have undergone
- * a scale. A snap will only occur along a line described by a
- * Inkscape::Snapper::ConstraintLine.
+ * \brief Apply a scaling to a set of points and snap such that the aspect ratio of the selection is preserved
*
- * \param point_type Type of points.
- * \param p Points.
- * \param s Proposed scale.
- * \param o Origin of proposed scale.
- * \return Snapped scale, if a snap occurred, and a flag indicating whether a snap occurred.
+ * \param point_type Category of points to which the source point belongs: node or bounding box.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param s Proposed scaling; the final scaling can only be calculated after snapping has occurred
+ * \param o Origin of the scaling
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
-Inkscape::SnappedPoint SnapManager::constrainedSnapScale(Inkscape::SnapPreferences::PointType point_type,
- std::vector<std::pair<Geom::Point, int> > const &p,
+Inkscape::SnappedPoint SnapManager::constrainedSnapScale(std::vector<Inkscape::SnapCandidatePoint> const &p,
Geom::Point const &pointer,
Geom::Scale const &s,
Geom::Point const &o) const
{
// When constrained scaling, only uniform scaling is supported.
if (p.size() == 1) {
- _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));
+ Geom::Point pt = _transformPoint(p.at(0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, true);
+ _displaySnapsource(Inkscape::SnapCandidatePoint(pt, p.at(0).getSourceType()));
}
- return _snapTransformed(point_type, p, pointer, true, Geom::Point(0,0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, true);
+ return _snapTransformed(p, pointer, true, Geom::Point(0,0), SCALE, Geom::Point(s[Geom::X], s[Geom::Y]), o, Geom::X, true);
}
-
/**
- * Try to snap a list of points to any interested snappers after they have undergone
- * a stretch.
+ * \brief Apply a stretch to a set of points and snap such that the direction of the stretch is preserved
*
- * \param point_type Type of points.
- * \param p Points.
- * \param s Proposed stretch.
- * \param o Origin of proposed stretch.
+ * \param point_type Category of points to which the source point belongs: node or bounding box.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param s Proposed stretch; the final stretch can only be calculated after snapping has occurred
+ * \param o Origin of the stretching
* \param d Dimension in which to apply proposed stretch.
- * \param u true if the stretch should be uniform (ie to be applied equally in both dimensions)
- * \return Snapped stretch, if a snap occurred, and a flag indicating whether a snap occurred.
+ * \param u true if the stretch should be uniform (i.e. to be applied equally in both dimensions)
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
-Inkscape::SnappedPoint SnapManager::constrainedSnapStretch(Inkscape::SnapPreferences::PointType point_type,
- std::vector<std::pair<Geom::Point, int> > const &p,
+Inkscape::SnappedPoint SnapManager::constrainedSnapStretch(std::vector<Inkscape::SnapCandidatePoint> const &p,
Geom::Point const &pointer,
Geom::Coord const &s,
Geom::Point const &o,
@@ -771,27 +821,27 @@ Inkscape::SnappedPoint SnapManager::constrainedSnapStretch(Inkscape::SnapPrefere
bool u) const
{
if (p.size() == 1) {
- _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), STRETCH, Geom::Point(s, s), o, d, u), (p.at(0)).second));
+ Geom::Point pt = _transformPoint(p.at(0), STRETCH, Geom::Point(s, s), o, d, u);
+ _displaySnapsource(Inkscape::SnapCandidatePoint(pt, p.at(0).getSourceType()));
}
- return _snapTransformed(point_type, p, pointer, true, Geom::Point(0,0), STRETCH, Geom::Point(s, s), o, d, u);
+ return _snapTransformed(p, pointer, true, Geom::Point(0,0), STRETCH, Geom::Point(s, s), o, d, u);
}
-
/**
- * Try to snap a list of points to any interested snappers after they have undergone
- * a skew.
+ * \brief Apply a skew to a set of points and snap such that the direction of the skew is preserved
*
- * \param point_type Type of points.
- * \param p Points.
- * \param s Proposed skew.
- * \param o Origin of proposed skew.
+ * \param point_type Category of points to which the source point belongs: node or bounding box.
+ * \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.
+ * \param pointer Location of the mouse pointer at the time dragging started (i.e. when the selection was still untransformed).
+ * \param constraint The direction or line along which snapping must occur.
+ * \param s Proposed skew; the final skew can only be calculated after snapping has occurred
+ * \param o Origin of the proposed skew
* \param d Dimension in which to apply proposed skew.
- * \return Snapped skew, if a snap occurred, and a flag indicating whether a snap occurred.
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics.
*/
-Inkscape::SnappedPoint SnapManager::constrainedSnapSkew(Inkscape::SnapPreferences::PointType point_type,
- std::vector<std::pair<Geom::Point, int> > const &p,
+Inkscape::SnappedPoint SnapManager::constrainedSnapSkew(std::vector<Inkscape::SnapCandidatePoint> const &p,
Geom::Point const &pointer,
Inkscape::Snapper::ConstraintLine const &constraint,
Geom::Point const &s,
@@ -800,21 +850,38 @@ Inkscape::SnappedPoint SnapManager::constrainedSnapSkew(Inkscape::SnapPreference
{
// "s" contains skew factor in s[0], and scale factor in s[1]
- // Snapping the nodes of the boundingbox of a selection that is being transformed, will only work if
+ // Snapping the nodes of the bounding box of a selection that is being transformed, will only work if
// the transformation of the bounding box is equal to the transformation of the individual nodes. This is
// NOT the case for example when rotating or skewing. The bounding box itself cannot possibly rotate or skew,
// so it's corners have a different transformation. The snappers cannot handle this, therefore snapping
// of bounding boxes is not allowed here.
- g_assert(!(point_type & Inkscape::SnapPreferences::SNAPPOINT_BBOX));
+ if (p.size() > 0) {
+ g_assert(!(p.at(0).getSourceType() & Inkscape::SNAPSOURCE_BBOX_CATEGORY));
+ }
if (p.size() == 1) {
- _displaySnapsource(point_type, std::make_pair(_transformPoint(p.at(0), SKEW, s, o, d, false), (p.at(0)).second));
+ Geom::Point pt = _transformPoint(p.at(0), SKEW, s, o, d, false);
+ _displaySnapsource(Inkscape::SnapCandidatePoint(pt, p.at(0).getSourceType()));
}
- return _snapTransformed(point_type, p, pointer, true, constraint, SKEW, s, o, d, false);
+ return _snapTransformed(p, pointer, true, constraint, SKEW, s, o, d, false);
}
-Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape::SnapSourceType const source_type, SnappedConstraints &sc, bool constrained) const
+/**
+ * \brief Given a set of possible snap targets, find the best target (which is not necessarily
+ * also the nearest target), and show the snap indicator if requested
+ *
+ * \param p Source point to be snapped
+ * \param sc A structure holding all snap targets that have been found so far
+ * \param constrained True if the snap is constrained, e.g. for stretching or for purely horizontal translation.
+ * \param noCurves If true, then do consider snapping to intersections of curves, but not to the curves themselves
+ * \return An instance of the SnappedPoint class, which holds data on the snap source, snap target, and various metrics
+ */
+
+Inkscape::SnappedPoint SnapManager::findBestSnap(Inkscape::SnapCandidatePoint const &p,
+ SnappedConstraints const &sc,
+ bool constrained,
+ bool noCurves) const
{
/*
@@ -836,16 +903,18 @@ Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape:
}
// search for the closest snapped curve
- Inkscape::SnappedCurve closestCurve;
- if (getClosestCurve(sc.curves, closestCurve)) {
- sp_list.push_back(Inkscape::SnappedPoint(closestCurve));
+ if (!noCurves) {
+ Inkscape::SnappedCurve closestCurve;
+ if (getClosestCurve(sc.curves, closestCurve)) {
+ sp_list.push_back(Inkscape::SnappedPoint(closestCurve));
+ }
}
if (snapprefs.getSnapIntersectionCS()) {
// search for the closest snapped intersection of curves
Inkscape::SnappedPoint closestCurvesIntersection;
- if (getClosestIntersectionCS(sc.curves, p, closestCurvesIntersection, _desktop->dt2doc())) {
- closestCurvesIntersection.setSource(source_type);
+ if (getClosestIntersectionCS(sc.curves, p.getPoint(), closestCurvesIntersection, _desktop->dt2doc())) {
+ closestCurvesIntersection.setSource(p.getSourceType());
sp_list.push_back(closestCurvesIntersection);
}
}
@@ -872,7 +941,7 @@ Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape:
// search for the closest snapped intersection of grid lines
Inkscape::SnappedPoint closestGridPoint;
if (getClosestIntersectionSL(sc.grid_lines, closestGridPoint)) {
- closestGridPoint.setSource(source_type);
+ closestGridPoint.setSource(p.getSourceType());
closestGridPoint.setTarget(Inkscape::SNAPTARGET_GRID_INTERSECTION);
sp_list.push_back(closestGridPoint);
}
@@ -880,7 +949,7 @@ Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape:
// search for the closest snapped intersection of guide lines
Inkscape::SnappedPoint closestGuidePoint;
if (getClosestIntersectionSL(sc.guide_lines, closestGuidePoint)) {
- closestGuidePoint.setSource(source_type);
+ closestGuidePoint.setSource(p.getSourceType());
closestGuidePoint.setTarget(Inkscape::SNAPTARGET_GUIDE_INTERSECTION);
sp_list.push_back(closestGuidePoint);
}
@@ -889,7 +958,7 @@ Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape:
if (snapprefs.getSnapIntersectionGG()) {
Inkscape::SnappedPoint closestGridGuidePoint;
if (getClosestIntersectionSL(sc.grid_lines, sc.guide_lines, closestGridGuidePoint)) {
- closestGridGuidePoint.setSource(source_type);
+ closestGridGuidePoint.setSource(p.getSourceType());
closestGridGuidePoint.setTarget(Inkscape::SNAPTARGET_GRID_GUIDE_INTERSECTION);
sp_list.push_back(closestGridGuidePoint);
}
@@ -897,11 +966,11 @@ Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape:
}
// now let's see which snapped point gets a thumbs up
- Inkscape::SnappedPoint bestSnappedPoint = Inkscape::SnappedPoint(p, Inkscape::SNAPSOURCE_UNDEFINED, Inkscape::SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false);
+ Inkscape::SnappedPoint bestSnappedPoint(p.getPoint());
// std::cout << "Finding the best snap..." << std::endl;
for (std::list<Inkscape::SnappedPoint>::const_iterator i = sp_list.begin(); i != sp_list.end(); i++) {
// first find out if this snapped point is within snapping range
- // std::cout << "sp = " << from_2geom((*i).getPoint());
+ // std::cout << "sp = " << (*i).getPoint() << " | source = " << (*i).getSource() << " | target = " << (*i).getTarget();
if ((*i).getSnapDistance() <= (*i).getTolerance()) {
// if it's the first point, or if it is closer than the best snapped point so far
if (i == sp_list.begin() || bestSnappedPoint.isOtherSnapBetter(*i, false)) {
@@ -925,34 +994,69 @@ Inkscape::SnappedPoint SnapManager::findBestSnap(Geom::Point const &p, Inkscape:
return bestSnappedPoint;
}
+/// Convenience shortcut when there is only one item to ignore
void SnapManager::setup(SPDesktop const *desktop,
bool snapindicator,
SPItem const *item_to_ignore,
- std::vector<std::pair<Geom::Point, int> > *unselected_nodes,
+ std::vector<Inkscape::SnapCandidatePoint> *unselected_nodes,
SPGuide *guide_to_ignore)
{
g_assert(desktop != NULL);
- _item_to_ignore = item_to_ignore;
- _items_to_ignore = NULL;
+ _items_to_ignore.clear();
+ _items_to_ignore.push_back(item_to_ignore);
_desktop = desktop;
_snapindicator = snapindicator;
_unselected_nodes = unselected_nodes;
_guide_to_ignore = guide_to_ignore;
}
+/**
+ * \brief Prepare the snap manager for the actual snapping, which includes building a list of snap targets
+ * to ignore and toggling the snap indicator
+ *
+ * There are two overloaded setup() methods, of which the other one only allows for a single item to be ignored
+ * whereas this one will take a list of items to ignore
+ *
+ * \param desktop Reference to the desktop to which this snap manager is attached
+ * \param snapindicator If true then a snap indicator will be displayed automatically (when enabled in the preferences)
+ * \param items_to_ignore These items will not be snapped to, e.g. the items that are currently being dragged. This avoids "self-snapping"
+ * \param unselected_nodes Stationary nodes of the path that is currently being edited in the node tool and
+ * that can be snapped too. Nodes not in this list will not be snapped to, to avoid "self-snapping". Of each
+ * unselected node both the position (Geom::Point) and the type (Inkscape::SnapTargetType) will be stored
+ * \param guide_to_ignore Guide that is currently being dragged and should not be snapped to
+ */
+
void SnapManager::setup(SPDesktop const *desktop,
bool snapindicator,
std::vector<SPItem const *> &items_to_ignore,
- std::vector<std::pair<Geom::Point, int> > *unselected_nodes,
+ std::vector<Inkscape::SnapCandidatePoint> *unselected_nodes,
SPGuide *guide_to_ignore)
{
g_assert(desktop != NULL);
- _item_to_ignore = NULL;
- _items_to_ignore = &items_to_ignore;
+ _items_to_ignore = items_to_ignore;
+ _desktop = desktop;
+ _snapindicator = snapindicator;
+ _unselected_nodes = unselected_nodes;
+ _guide_to_ignore = guide_to_ignore;
+}
+
+/// Setup, taking the list of items to ignore from the desktop's selection.
+void SnapManager::setupIgnoreSelection(SPDesktop const *desktop,
+ bool snapindicator,
+ std::vector<Inkscape::SnapCandidatePoint> *unselected_nodes,
+ SPGuide *guide_to_ignore)
+{
_desktop = desktop;
_snapindicator = snapindicator;
_unselected_nodes = unselected_nodes;
_guide_to_ignore = guide_to_ignore;
+ _items_to_ignore.clear();
+
+ Inkscape::Selection *sel = _desktop->selection;
+ GSList const *items = sel->itemList();
+ for (GSList *i = const_cast<GSList*>(items); i; i = i->next) {
+ _items_to_ignore.push_back(static_cast<SPItem const *>(i->data));
+ }
}
SPDocument *SnapManager::getDocument() const
return _named_view->document;
}
-Geom::Point SnapManager::_transformPoint(std::pair<Geom::Point, int> const &p,
+/**
+ * \brief Takes an untransformed point, applies the given transformation, and returns the transformed point. Eliminates lots of duplicated code
+ *
+ * \param p The untransformed position of the point, paired with an identifier of the type of the snap source.
+ * \param transformation_type Type of transformation to apply.
+ * \param transformation Mathematical description of the transformation; details depend on the type.
+ * \param origin Origin of the transformation, if applicable.
+ * \param dim Dimension to which the transformation applies, if applicable.
+ * \param uniform true if the transformation should be uniform; only applicable for stretching and scaling.
+ * \return The position of the point after transformation
+ */
+
+Geom::Point SnapManager::_transformPoint(Inkscape::SnapCandidatePoint const &p,
Transformation const transformation_type,
Geom::Point const &transformation,
Geom::Point const &origin,
@@ -971,10 +1087,10 @@ Geom::Point SnapManager::_transformPoint(std::pair<Geom::Point, int> const &p,
Geom::Point transformed;
switch (transformation_type) {
case TRANSLATION:
- transformed = p.first + transformation;
+ transformed = p.getPoint() + transformation;
break;
case SCALE:
- transformed = (p.first - origin) * Geom::Scale(transformation[Geom::X], transformation[Geom::Y]) + origin;
+ transformed = (p.getPoint() - origin) * Geom::Scale(transformation[Geom::X], transformation[Geom::Y]) + origin;
break;
case STRETCH:
{
@@ -985,15 +1101,15 @@ Geom::Point SnapManager::_transformPoint(std::pair<Geom::Point, int> const &p,
s[dim] = transformation[dim];
s[1 - dim] = 1;
}
- transformed = ((p.first - origin) * s) + origin;
+ transformed = ((p.getPoint() - origin) * s) + origin;
break;
}
case SKEW:
// Apply the skew factor
- transformed[dim] = (p.first)[dim] + transformation[0] * ((p.first)[1 - dim] - origin[1 - dim]);
+ transformed[dim] = (p.getPoint())[dim] + transformation[0] * ((p.getPoint())[1 - dim] - origin[1 - dim]);
// While skewing, mirroring and scaling (by integer multiples) in the opposite direction is also allowed.
// Apply that scale factor here
- transformed[1-dim] = (p.first - origin)[1 - dim] * transformation[1] + origin[1 - dim];
+ transformed[1-dim] = (p.getPoint() - origin)[1 - dim] * transformation[1] + origin[1 - dim];
break;
default:
g_assert_not_reached();
@@ -1002,12 +1118,20 @@ Geom::Point SnapManager::_transformPoint(std::pair<Geom::Point, int> const &p,
return transformed;
}
-void SnapManager::_displaySnapsource(Inkscape::SnapPreferences::PointType point_type, std::pair<Geom::Point, int> const &p) const {
+/**
+ * \brief Mark the location of the snap source (not the snap target!) on the canvas by drawing a symbol
+ *
+ * \param point_type Category of points to which the source point belongs: node, guide or bounding box
+ * \param p The transformed position of the source point, paired with an identifier of the type of the snap source.
+ */
+
+void SnapManager::_displaySnapsource(Inkscape::SnapCandidatePoint const &p) const {
Inkscape::Preferences *prefs = Inkscape::Preferences::get();
if (prefs->getBool("/options/snapclosestonly/value")) {
- bool p_is_a_node = point_type & Inkscape::SnapPreferences::SNAPPOINT_NODE;
- bool p_is_a_bbox = point_type & Inkscape::SnapPreferences::SNAPPOINT_BBOX;
+ bool p_is_a_node = p.getSourceType() & Inkscape::SNAPSOURCE_NODE_CATEGORY;
+ bool p_is_a_bbox = p.getSourceType() & Inkscape::SNAPSOURCE_BBOX_CATEGORY;
+
if (snapprefs.getSnapEnabledGlobally() && ((p_is_a_node && snapprefs.getSnapModeNode()) || (p_is_a_bbox && snapprefs.getSnapModeBBox()))) {
_desktop->snapindicator->set_new_snapsource(p);
} else {