summaryrefslogtreecommitdiffstats
path: root/src/snap.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2006-05-08 17:11:12 +0000
committercth103 <cth103@users.sourceforge.net>2006-05-08 17:11:12 +0000
commitf3d93d01bec00dcaedb33506dfc7d5e101ac0a17 (patch)
tree515d8a9129411df7e907bc82082ab1079bc93ac8 /src/snap.h
parentstandardize indents on 4 spaces (diff)
downloadinkscape-f3d93d01bec00dcaedb33506dfc7d5e101ac0a17.tar.gz
inkscape-f3d93d01bec00dcaedb33506dfc7d5e101ac0a17.zip
Added some comments.
(bzr r771)
Diffstat (limited to 'src/snap.h')
-rw-r--r--src/snap.h14
1 files changed, 11 insertions, 3 deletions
diff --git a/src/snap.h b/src/snap.h
index 12996f04d..8345da40d 100644
--- a/src/snap.h
+++ b/src/snap.h
@@ -27,6 +27,14 @@
class SPNamedView;
+/// Class to coordinate snapping operations
+
+/**
+ * Each SPNamedView has one of these. It offers methods to snap points to whatever
+ * snappers are defined (e.g. grid, guides etc.). It also allows callers to snap
+ * points which have undergone some transformation (e.g. translation, scaling etc.)
+ */
+
class SnapManager
{
public:
@@ -91,9 +99,9 @@ public:
NR::Point const &o,
NR::Dim2 d) const;
- Inkscape::GridSnapper grid;
- Inkscape::GuideSnapper guide;
- Inkscape::ObjectSnapper object;
+ Inkscape::GridSnapper grid; ///< grid snapper
+ Inkscape::GuideSnapper guide; ///< guide snapper
+ Inkscape::ObjectSnapper object; ///< snapper to other objects
typedef std::list<const Inkscape::Snapper*> SnapperList;
SnapperList getSnappers() const;