Refactoring the snapping API (making it easier to maintain and understand for the devs)

(bzr r8960)

1 files changed, 15 insertions, 41 deletions

diff --git a/src/object-snapper.h b/src/object-snapper.h
index 2fcafb79a..556ff86de 100644
--- a/src/object-snapper.h
+++ b/src/object-snapper.h
@@ -17,6 +17,7 @@
 #include "snapper.h"
 #include "sp-path.h"
 #include "splivarot.h"
+#include "snap-candidate.h"
 
 struct SPNamedView;
 struct SPItem;
@@ -25,23 +26,6 @@ struct SPObject;
 namespace Inkscape
 {
 
-class SnapCandidate
-
-{
-public:
-    SnapCandidate(SPItem* item, bool clip_or_mask, Geom::Matrix _additional_affine);
-    ~SnapCandidate();
-
-    SPItem* item;        // An item that is to be considered for snapping to
-    bool clip_or_mask;    // If true, then item refers to a clipping path or a mask
-
-    /* To find out the absolute position of a clipping path or mask, we not only need to know
-     * the transformation of the clipping path or mask itself, but also the transformation of
-     * the object to which the clip or mask is being applied; that transformation is stored here
-     */
-    Geom::Matrix additional_affine;
-};
-
 class ObjectSnapper : public Snapper
 {
 
@@ -72,27 +56,23 @@ public:
 
     void freeSnap(SnappedConstraints &sc,
                   Inkscape::SnapPreferences::PointType const &t,
-                  Geom::Point const &p,
-                  SnapSourceType const &source_type,
-                  long source_num,
+                  Inkscape::SnapCandidatePoint const &p,
                   Geom::OptRect const &bbox_to_snap,
                   std::vector<SPItem const *> const *it,
-                  std::vector<std::pair<Geom::Point, int> > *unselected_nodes) const;
+                  std::vector<SnapCandidatePoint> *unselected_nodes) const;
 
     void constrainedSnap(SnappedConstraints &sc,
                   Inkscape::SnapPreferences::PointType const &t,
-                  Geom::Point const &p,
-                  SnapSourceType const &source_type,
-                  long source_num,
+                  Inkscape::SnapCandidatePoint const &p,
                   Geom::OptRect const &bbox_to_snap,
                   ConstraintLine const &c,
                   std::vector<SPItem const *> const *it) const;
 
 private:
     //store some lists of candidates, points and paths, so we don't have to rebuild them for each point we want to snap
-    std::vector<SnapCandidate> *_candidates;
-    std::vector<std::pair<Geom::Point, int> > *_points_to_snap_to;
-    std::vector<std::pair<Geom::PathVector*, SnapTargetType> > *_paths_to_snap_to;
+    std::vector<SnapCandidateItem> *_candidates;
+    std::vector<SnapCandidatePoint> *_points_to_snap_to;
+    std::vector<SnapCandidatePath > *_paths_to_snap_to;
 
     void _findCandidates(SPObject* parent,
                        std::vector<SPItem const *> const *it,
@@ -104,10 +84,8 @@ private:
 
     void _snapNodes(SnappedConstraints &sc,
                       Inkscape::SnapPreferences::PointType const &t,
-                      Geom::Point const &p, // in desktop coordinates
-                      SnapSourceType const &source_type,
-                      long source_num,
-                      std::vector<std::pair<Geom::Point, int> > *unselected_nodes) const; // in desktop coordinates
+                      Inkscape::SnapCandidatePoint const &p,
+                      std::vector<SnapCandidatePoint> *unselected_nodes) const; // in desktop coordinates
 
     void _snapTranslatingGuideToNodes(SnappedConstraints &sc,
                      Inkscape::SnapPreferences::PointType const &t,
@@ -119,20 +97,16 @@ private:
 
     void _snapPaths(SnappedConstraints &sc,
                       Inkscape::SnapPreferences::PointType const &t,
-                      Geom::Point const &p,    // in desktop coordinates
-                      SnapSourceType const &source_type,
-                      long source_num,
-                      std::vector<std::pair<Geom::Point, int> > *unselected_nodes, // in desktop coordinates
+                      Inkscape::SnapCandidatePoint const &p, // in desktop coordinates
+                      std::vector<Inkscape::SnapCandidatePoint> *unselected_nodes, // in desktop coordinates
                       SPPath const *selected_path) const;
 
     void _snapPathsConstrained(SnappedConstraints &sc,
                  Inkscape::SnapPreferences::PointType const &t,
-                 Geom::Point const &p, // in desktop coordinates
-                 SnapSourceType const source_type,
-                 long source_num,
+                 Inkscape::SnapCandidatePoint const &p, // in desktop coordinates
                  ConstraintLine const &c) const;
 
-    bool isUnselectedNode(Geom::Point const &point, std::vector<std::pair<Geom::Point, int> > const *unselected_nodes) const;
+    bool isUnselectedNode(Geom::Point const &point, std::vector<Inkscape::SnapCandidatePoint> const *unselected_nodes) const;
 
     void _collectPaths(Inkscape::SnapPreferences::PointType const &t,
                   bool const &first_point) const;
@@ -140,11 +114,11 @@ private:
     void _clear_paths() const;
     Geom::PathVector* _getBorderPathv() const;
     Geom::PathVector* _getPathvFromRect(Geom::Rect const rect) const;
-    void _getBorderNodes(std::vector<std::pair<Geom::Point, int> > *points) const;
+    void _getBorderNodes(std::vector<SnapCandidatePoint> *points) const;
 
 }; // end of ObjectSnapper class
 
-void getBBoxPoints(Geom::OptRect const bbox, std::vector<std::pair<Geom::Point, int> > *points, bool const isTarget, bool const includeCorners, bool const includeLineMidpoints, bool const includeObjectMidpoints);
+void getBBoxPoints(Geom::OptRect const bbox, std::vector<SnapCandidatePoint> *points, bool const isTarget, bool const includeCorners, bool const includeLineMidpoints, bool const includeObjectMidpoints);
 
 } // end of namespace Inkscape