![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/snap.cpp b/src/snap.cpp
index 3d4a48005d5deb0229326ca60d1d22515cff5692..3dda92ecbcd73504c982a36737f9205cdc57a693 100644 (file)
--- a/src/snap.cpp
+++ b/src/snap.cpp
/**
* \file snap.cpp
- *
- * \brief Various snapping methods
+ * \brief SnapManager class.
*
* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Frank Felfe <innerspace@iname.com>
* Carl Hetherington <inkscape@carlh.net>
*
+ * Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
* Copyright (C) 1999-2002 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
#include <libnr/nr-scale-ops.h>
#include <libnr/nr-values.h>
-SnapManager::SnapManager(SPNamedView const *v) : grid(v, 0), guide(v, 0), object(v, 0)
+#include "display/canvas-grid.h"
+
+#include "inkscape.h"
+#include "desktop.h"
+
+/**
+ * Construct a SnapManager for a SPNamedView.
+ *
+ * \param v `Owning' SPNamedView.
+ */
+
+SnapManager::SnapManager(SPNamedView const *v) :
+ guide(v, 0),
+ object(v, 0),
+ _named_view(v)
{
}
-SnapManager::SnapperList SnapManager::getSnappers() const
+
+/**
+ * \return List of snappers that we use.
+ */
+SnapManager::SnapperList
+SnapManager::getSnappers() const
{
SnapManager::SnapperList s;
- s.push_back(&grid);
s.push_back(&guide);
s.push_back(&object);
+
+ SnapManager::SnapperList gs = getGridSnappers();
+ s.splice(s.begin(), gs);
+
+ return s;
+}
+
+/**
+ * \return List of gridsnappers that we use.
+ */
+SnapManager::SnapperList
+SnapManager::getGridSnappers() const
+{
+ 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
+ SPDesktop* desktop = SP_ACTIVE_DESKTOP;
+ if (desktop && desktop->gridsEnabled()) {
+ for ( GSList const *l = _named_view->grids; l != NULL; l = l->next) {
+ Inkscape::CanvasGrid *grid = (Inkscape::CanvasGrid*) l->data;
+ s.push_back(grid->snapper);
+ }
+ }
+
return s;
}
/**
* \return true if one of the snappers will try to snap something.
*/
-bool SnapManager::willSnapSomething() const
+
+bool SnapManager::SomeSnapperMightSnap() const
{
SnapperList const s = getSnappers();
SnapperList::const_iterator i = s.begin();
- while (i != s.end() && (*i)->willSnapSomething() == false) {
+ while (i != s.end() && (*i)->ThisSnapperMightSnap() == false) {
i++;
}
+
return (i != s.end());
}
+
+/**
+ * Try to snap a point to any interested snappers.
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param it Item to ignore when snapping.
+ * \return Snapped point.
+ */
+
Inkscape::SnappedPoint SnapManager::freeSnap(Inkscape::Snapper::PointType t,
NR::Point const &p,
SPItem const *it) const
}
+/**
+ * Try to snap a point to any interested snappers.
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param it List of items to ignore when snapping.
+ * \return Snapped point.
+ */
+
Inkscape::SnappedPoint SnapManager::freeSnap(Inkscape::Snapper::PointType t,
NR::Point const &p,
std::list<SPItem const *> const &it) const
+{
+ SnapperList const snappers = getSnappers();
+
+ return freeSnap(t, p, it, snappers);
+}
+
+/**
+ * Try to snap a point to any of the specified snappers.
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param it List of items to ignore when snapping.
+ * \param snappers List of snappers to try to snap to
+ * \return Snapped point.
+ */
+
+Inkscape::SnappedPoint SnapManager::freeSnap(Inkscape::Snapper::PointType t,
+ NR::Point const &p,
+ std::list<SPItem const *> const &it,
+ SnapperList const &snappers) const
{
Inkscape::SnappedPoint r(p, NR_HUGE);
- SnapperList const snappers = getSnappers();
for (SnapperList::const_iterator i = snappers.begin(); i != snappers.end(); i++) {
Inkscape::SnappedPoint const s = (*i)->freeSnap(t, p, it);
if (s.getDistance() < r.getDistance()) {
return r;
}
+/**
+ * Try to snap a point to any of the specified snappers. Snap always, ignoring the snap-distance
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param it Item to ignore when snapping.
+ * \param snappers List of snappers to try to snap to
+ * \return Snapped point.
+ */
+
+Inkscape::SnappedPoint
+SnapManager::freeSnapAlways( Inkscape::Snapper::PointType t,
+ NR::Point const &p,
+ SPItem const *it,
+ SnapperList &snappers )
+{
+ std::list<SPItem const *> lit;
+ lit.push_back(it);
+ return freeSnapAlways(t, p, lit, snappers);
+}
+
+/**
+ * Try to snap a point to any of the specified snappers. Snap always, ignoring the snap-distance
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param it List of items to ignore when snapping.
+ * \param snappers List of snappers to try to snap to
+ * \return Snapped point.
+ */
+
+Inkscape::SnappedPoint
+SnapManager::freeSnapAlways( Inkscape::Snapper::PointType t,
+ NR::Point const &p,
+ std::list<SPItem const *> const &it,
+ SnapperList &snappers )
+{
+ Inkscape::SnappedPoint r(p, NR_HUGE);
+
+ for (SnapperList::iterator i = snappers.begin(); i != snappers.end(); i++) {
+ gdouble const curr_gridsnap = (*i)->getDistance();
+ const_cast<Inkscape::Snapper*> (*i)->setDistance(NR_HUGE);
+ Inkscape::SnappedPoint const s = (*i)->freeSnap(t, p, it);
+ const_cast<Inkscape::Snapper*> (*i)->setDistance(curr_gridsnap);
+
+ if (s.getDistance() < r.getDistance()) {
+ r = s;
+ }
+ }
+
+ return r;
+}
+
+
+
+/**
+ * Try to snap a point to any interested snappers. A snap will only occur along
+ * a line described by a Inkscape::Snapper::ConstraintLine.
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param c Constraint line.
+ * \param it Item to ignore when snapping.
+ * \return Snapped point.
+ */
Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::Snapper::PointType t,
NR::Point const &p,
@@ -89,6 +236,18 @@ Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::Snapper::PointType
}
+
+/**
+ * Try to snap a point to any interested snappers. A snap will only occur along
+ * a line described by a Inkscape::Snapper::ConstraintLine.
+ *
+ * \param t Type of point.
+ * \param p Point.
+ * \param c Constraint line.
+ * \param it List of items to ignore when snapping.
+ * \return Snapped point.
+ */
+
Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::Snapper::PointType t,
NR::Point const &p,
Inkscape::Snapper::ConstraintLine const &c,
@@ -108,6 +267,24 @@ Inkscape::SnappedPoint SnapManager::constrainedSnap(Inkscape::Snapper::PointType
}
+
+/**
+ * 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.
+ *
+ * \param type Type of points being snapped.
+ * \param points List of points to snap.
+ * \param ignore List of items to ignore while snapping.
+ * \param constrained true if the snap is constrained.
+ * \param constraint Constraint line to use, 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 uniform true if the transformation should be uniform, if applicable.
+ */
+
std::pair<NR::Point, bool> SnapManager::_snapTransformed(
Inkscape::Snapper::PointType type,
std::vector<NR::Point> const &points,
*/
/* Quick check to see if we have any snappers that are enabled */
- if (willSnapSomething() == false) {
+ if (SomeSnapperMightSnap() == false) {
return std::make_pair(transformation, false);
}
/* The current best transformation */
NR::Point best_transformation = transformation;
-
+
/* The current best metric for the best transformation; lower is better, NR_HUGE
** means that we haven't snapped anything.
*/
default:
g_assert_not_reached();
}
-
+
/* Snap it */
Inkscape::SnappedPoint const snapped = constrained ?
constrainedSnap(type, transformed, constraint, ignore) : freeSnap(type, transformed, ignore);
}
}
}
-
- return std::make_pair(best_transformation, best_metric < NR_HUGE);
+
+ // Using " < 1e6" instead of " < NR::HUGE" for catching some rounding errors
+ // These rounding errors might be caused by NRRects, see bug #1584301
+ return std::make_pair(best_transformation, best_metric < 1e6);
}
+/**
+ * Try to snap a list of points to any interested snappers after they have undergone
+ * a translation.
+ *
+ * \param t Type of points.
+ * \param p Points.
+ * \param it List of items to ignore when snapping.
+ * \param tr Proposed translation.
+ * \return Snapped translation, if a snap occurred, and a flag indicating whether a snap occurred.
+ */
+
std::pair<NR::Point, bool> SnapManager::freeSnapTranslation(Inkscape::Snapper::PointType t,
std::vector<NR::Point> const &p,
std::list<SPItem const *> const &it,
@@ -235,6 +425,18 @@ std::pair<NR::Point, bool> SnapManager::freeSnapTranslation(Inkscape::Snapper::P
}
+/**
+ * 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.
+ *
+ * \param t Type of points.
+ * \param p Points.
+ * \param it List of items to ignore when snapping.
+ * \param c Constraint line.
+ * \param tr Proposed translation.
+ * \return Snapped translation, if a snap occurred, and a flag indicating whether a snap occurred.
+ */
std::pair<NR::Point, bool> SnapManager::constrainedSnapTranslation(Inkscape::Snapper::PointType t,
std::vector<NR::Point> const &p,
@@ -247,6 +449,19 @@ std::pair<NR::Point, bool> SnapManager::constrainedSnapTranslation(Inkscape::Sna
);
}
+
+/**
+ * Try to snap a list of points to any interested snappers after they have undergone
+ * a scale.
+ *
+ * \param t Type of points.
+ * \param p Points.
+ * \param it List of items to ignore when snapping.
+ * \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.
+ */
+
std::pair<NR::scale, bool> SnapManager::freeSnapScale(Inkscape::Snapper::PointType t,
std::vector<NR::Point> const &p,
std::list<SPItem const *> const &it,
@@ -259,6 +474,19 @@ std::pair<NR::scale, bool> SnapManager::freeSnapScale(Inkscape::Snapper::PointTy
}
+/**
+ * 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.
+ *
+ * \param t Type of points.
+ * \param p Points.
+ * \param it List of items to ignore when snapping.
+ * \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.
+ */
+
std::pair<NR::scale, bool> SnapManager::constrainedSnapScale(Inkscape::Snapper::PointType t,
std::vector<NR::Point> const &p,
std::list<SPItem const *> const &it,
@@ -272,6 +500,20 @@ std::pair<NR::scale, bool> SnapManager::constrainedSnapScale(Inkscape::Snapper::
}
+/**
+ * Try to snap a list of points to any interested snappers after they have undergone
+ * a stretch.
+ *
+ * \param t Type of points.
+ * \param p Points.
+ * \param it List of items to ignore when snapping.
+ * \param s Proposed stretch.
+ * \param o Origin of proposed stretch.
+ * \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.
+ */
+
std::pair<NR::Coord, bool> SnapManager::freeSnapStretch(Inkscape::Snapper::PointType t,
std::vector<NR::Point> const &p,
std::list<SPItem const *> const &it,
@@ -288,6 +530,19 @@ std::pair<NR::Coord, bool> SnapManager::freeSnapStretch(Inkscape::Snapper::Point
}
+/**
+ * Try to snap a list of points to any interested snappers after they have undergone
+ * a skew.
+ *
+ * \param t Type of points.
+ * \param p Points.
+ * \param it List of items to ignore when snapping.
+ * \param s Proposed skew.
+ * \param o Origin of 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.
+ */
+
std::pair<NR::Coord, bool> SnapManager::freeSnapSkew(Inkscape::Snapper::PointType t,
std::vector<NR::Point> const &p,
std::list<SPItem const *> const &it,