more string cleanup

[inkscape.git] / src / snap.h

diff --git a/src/snap.h b/src/snap.h
index ad5c6885755015c5a2fafbcd7c1c2c42ce081bea..ea833b0ecc64ee6f25beba6b468bda559d533f5f 100644 (file)
--- a/src/snap.h
+++ b/src/snap.h
@@ -3,7 +3,7 @@
 
 /**
  * \file snap.h
- * \brief Various snapping methods.
+ * \brief SnapManager class.
  *
  * Authors:
  *   Lauris Kaplinski <lauris@kaplinski.com>
@@ -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:
@@ -84,9 +92,16 @@ public:
                                                NR::Dim2 d,
                                                bool uniform) const;
 
-    Inkscape::GridSnapper grid;
-    Inkscape::GuideSnapper guide;
-    Inkscape::ObjectSnapper object;
+    std::pair<NR::Coord, bool> freeSnapSkew(Inkscape::Snapper::PointType t,
+                                            std::vector<NR::Point> const &p,
+                                            std::list<SPItem const *> const &it,
+                                            NR::Coord const &s,
+                                            NR::Point const &o,
+                                            NR::Dim2 d) const;
+
+    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;
@@ -96,7 +111,8 @@ private:
     enum Transformation {
         TRANSLATION,
         SCALE,
-        STRETCH
+        STRETCH,
+        SKEW
     };
     
     std::pair<NR::Point, bool> _snapTransformed(Inkscape::Snapper::PointType type,
@@ -111,24 +127,6 @@ private:
                                                 bool uniform) const;
 };
 
-
-/* Single point methods */
-NR::Coord namedview_vector_snap(SPNamedView const *nv, Inkscape::Snapper::PointType t, NR::Point &req,
-                                NR::Point const &d, std::list<SPItem const *> const &it);
-NR::Coord namedview_vector_snap(SPNamedView const *nv, Inkscape::Snapper::PointType t, NR::Point &req,
-                                NR::Point const &d, SPItem const *it);
-NR::Coord namedview_dim_snap(SPNamedView const *nv, Inkscape::Snapper::PointType t, NR::Point& req,
-                             NR::Dim2 const dim, SPItem const *it);
-NR::Coord namedview_dim_snap(SPNamedView const *nv, Inkscape::Snapper::PointType t, NR::Point& req,
-                             NR::Dim2 const dim, std::list<SPItem const *> const &it);
-
-/* List of points methods */
-
-NR::Coord namedview_dim_snap_list_skew(SPNamedView const *nv, Inkscape::Snapper::PointType t,
-                                       const std::vector<NR::Point> &p,
-                                       NR::Point const &norm, double const sx, NR::Dim2 const dim);
-
-
 #endif /* !SEEN_SNAP_H */
 
 /*