Code

NR::Maybe => boost::optional
[inkscape.git] / src / snap.h
index f7882fc619e1a11ea56a7a09756b7bba6d2c9e13..966d2a5431127968a7de6089d16ed1d3bdf79024 100644 (file)
@@ -9,9 +9,11 @@
  *   Lauris Kaplinski <lauris@kaplinski.com>
  *   Frank Felfe <innerspace@iname.com>
  *   Carl Hetherington <inkscape@carlh.net>
+ *   Diederik van Lierop <mail@diedenrezi.nl>
  *
  * Copyright (C) 2006-2007 Johan Engelen <johan@shouraizou.nl>
  * Copyright (C) 2000-2002 Lauris Kaplinski
+ * Copyright (C) 2000-2008 Authors
  *
  * Released under GNU GPL, read the file 'COPYING' for more information
  */
@@ -44,75 +46,71 @@ public:
     typedef std::list<const Inkscape::Snapper*> SnapperList;
 
     bool SomeSnapperMightSnap() const;
-
-    Inkscape::SnappedPoint freeSnap(Inkscape::Snapper::PointType t,
+    
+    void setup(SPDesktop const *desktop_for_snapindicator = NULL, SPItem const *item_to_ignore = NULL, std::vector<NR::Point> *unselected_nodes = NULL);
+    void setup(SPDesktop const *desktop_for_snapindicator, std::vector<SPItem const *> &items_to_ignore, std::vector<NR::Point> *unselected_nodes = NULL);
+
+    // freeSnapReturnByRef() is preferred over freeSnap(), because it only returns a 
+    // point if snapping has occured (by overwriting p); otherwise p is untouched    
+    void freeSnapReturnByRef(Inkscape::Snapper::PointType point_type,
+                      NR::Point &p,
+                      bool first_point = true,
+                      boost::optional<NR::Rect> const &bbox_to_snap = boost::optional<NR::Rect>()) const;
+    
+    Inkscape::SnappedPoint freeSnap(Inkscape::Snapper::PointType point_type,
                                     NR::Point const &p,
-                                    SPItem const *it) const;
-
-    Inkscape::SnappedPoint freeSnap( Inkscape::Snapper::PointType t,
-                                      NR::Point const &p,
-                                      bool const &first_point,
-                                      std::vector<NR::Point> &points_to_snap,
-                                      std::list<SPItem const *> const &it) const;
-
-    Inkscape::SnappedPoint constrainedSnap(Inkscape::Snapper::PointType t,
-                                           NR::Point const &p,
-                                           Inkscape::Snapper::ConstraintLine const &c,
-                                           SPItem const *it) const;
+                                    bool first_point = true,
+                                    boost::optional<NR::Rect> const &bbox_to_snap = boost::optional<NR::Rect>() ) const;
     
-    Inkscape::SnappedPoint constrainedSnap(Inkscape::Snapper::PointType t,
+    // constrainedSnapReturnByRef() is preferred over constrainedSnap(), because it only returns a 
+    // point, by overwriting p, if snapping has occured; otherwise p is untouched
+    void constrainedSnapReturnByRef(Inkscape::Snapper::PointType point_type,
+                             NR::Point &p,
+                             Inkscape::Snapper::ConstraintLine const &constraint,
+                             bool first_point = true,
+                             boost::optional<NR::Rect> const &bbox_to_snap = boost::optional<NR::Rect>()) const;
+    
+    Inkscape::SnappedPoint constrainedSnap(Inkscape::Snapper::PointType point_type,
                                            NR::Point const &p,
-                                           bool const &first_point,
-                                           std::vector<NR::Point> &points_to_snap,
-                                           Inkscape::Snapper::ConstraintLine const &c,
-                                           std::list<SPItem const *> const &it) const;
+                                           Inkscape::Snapper::ConstraintLine const &constraint,
+                                           bool first_point = true,
+                                           boost::optional<NR::Rect> const &bbox_to_snap = boost::optional<NR::Rect>()) const;
                                            
-    Inkscape::SnappedPoint guideSnap(NR::Point const &p,
-                                     NR::Point const &guide_normal) const;
-
-    std::pair<NR::Point, bool> freeSnapTranslation(Inkscape::Snapper::PointType t,
-                                                   std::vector<NR::Point> const &p,
-                                                   std::list<SPItem const *> const &it,
-                                                   NR::Point const &tr) const;
-
-    std::pair<NR::Point, bool> constrainedSnapTranslation(Inkscape::Snapper::PointType t,
-                                                          std::vector<NR::Point> const &p,
-                                                          std::list<SPItem const *> const &it,
-                                                          Inkscape::Snapper::ConstraintLine const &c,
-                                                          NR::Point const &tr) const;
-
-    std::pair<NR::scale, bool> freeSnapScale(Inkscape::Snapper::PointType t,
-                                             std::vector<NR::Point> const &p,
-                                             std::list<SPItem const *> const &it,
-                                             NR::scale const &s,
-                                             NR::Point const &o) const;
-
-    std::pair<NR::scale, bool> constrainedSnapScale(Inkscape::Snapper::PointType t,
-                                                    std::vector<NR::Point> const &p,
-                                                    std::list<SPItem const *> const &it,
-                                                    Inkscape::Snapper::ConstraintLine const &c,
-                                                    NR::scale const &s,
-                                                    NR::Point const &o) const;
-
-    std::pair<NR::Coord, bool> freeSnapStretch(Inkscape::Snapper::PointType t,
+    void guideSnap(NR::Point &p, NR::Point const &guide_normal) const;
+
+    Inkscape::SnappedPoint freeSnapTranslation(Inkscape::Snapper::PointType point_type,
+                                               std::vector<NR::Point> const &p,
+                                               NR::Point const &tr) const;
+
+    Inkscape::SnappedPoint constrainedSnapTranslation(Inkscape::Snapper::PointType point_type,
+                                                      std::vector<NR::Point> const &p,
+                                                      Inkscape::Snapper::ConstraintLine const &constraint,
+                                                      NR::Point const &tr) const;
+
+    Inkscape::SnappedPoint freeSnapScale(Inkscape::Snapper::PointType point_type,
+                                         std::vector<NR::Point> const &p,
+                                         NR::scale const &s,
+                                         NR::Point const &o) const;
+
+    Inkscape::SnappedPoint constrainedSnapScale(Inkscape::Snapper::PointType point_type,
+                                                std::vector<NR::Point> const &p,
+                                                NR::scale const &s,
+                                                NR::Point const &o) const;
+
+    Inkscape::SnappedPoint constrainedSnapStretch(Inkscape::Snapper::PointType point_type,
+                                                  std::vector<NR::Point> const &p,
+                                                  NR::Coord const &s,
+                                                  NR::Point const &o,
+                                                  NR::Dim2 d,
+                                                  bool uniform) const;
+
+    Inkscape::SnappedPoint constrainedSnapSkew(Inkscape::Snapper::PointType point_type,
                                                std::vector<NR::Point> const &p,
-                                               std::list<SPItem const *> const &it,
-                                               NR::Coord const &s,
+                                               Inkscape::Snapper::ConstraintLine const &constraint,
+                                               NR::Point const &s, // s[0] = skew factor, s[1] = scale factor
                                                NR::Point const &o,
-                                               NR::Dim2 d,
-                                               bool uniform) const;
-
-    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::SnappedPoint guideSnap(NR::Point const &p,
-                           Inkscape::ObjectSnapper::DimensionToSnap const snap_dim) const;
-  
-
+                                               NR::Dim2 d) const;
+                                        
     Inkscape::GuideSnapper guide;      ///< guide snapper
     Inkscape::ObjectSnapper object;    ///< snapper to other objects
 
@@ -128,8 +126,8 @@ public:
     
     void setSnapIntersectionGG(bool enabled) {_intersectionGG = enabled;}
     void setSnapIntersectionLS(bool enabled) {_intersectionLS = enabled;}
-    bool getSnapIntersectionGG() { return _intersectionGG;}
-    bool getSnapIntersectionLS() { return _intersectionLS;}    
+    bool getSnapIntersectionGG() {return _intersectionGG;}
+    bool getSnapIntersectionLS() {return _intersectionLS;}    
 
     void setIncludeItemCenter(bool enabled)    {
         _include_item_center = enabled;
@@ -170,18 +168,22 @@ private:
     bool _intersectionLS;
     bool _snap_enabled_globally; //Toggles ALL snapping
     
-    std::pair<NR::Point, bool> _snapTransformed(Inkscape::Snapper::PointType type,
-                                                std::vector<NR::Point> const &points,
-                                                std::list<SPItem const *> const &ignore,
-                                                bool constrained,
-                                                Inkscape::Snapper::ConstraintLine const &constraint,
-                                                Transformation transformation_type,
-                                                NR::Point const &transformation,
-                                                NR::Point const &origin,
-                                                NR::Dim2 dim,
-                                                bool uniform) const;
+    std::vector<SPItem const *> *_items_to_ignore;
+    SPItem const *_item_to_ignore;
+    SPDesktop const *_desktop_for_snapindicator;    
+    std::vector<NR::Point> *_unselected_nodes;                                    
+    
+    Inkscape::SnappedPoint _snapTransformed(Inkscape::Snapper::PointType type,
+                                            std::vector<NR::Point> const &points,
+                                            bool constrained,
+                                            Inkscape::Snapper::ConstraintLine const &constraint,
+                                            Transformation transformation_type,
+                                            NR::Point const &transformation,
+                                            NR::Point const &origin,
+                                            NR::Dim2 dim,
+                                            bool uniform) const;
                                                 
-    Inkscape::SnappedPoint findBestSnap(NR::Point const &p, SnappedConstraints &sc) const;
+    Inkscape::SnappedPoint findBestSnap(NR::Point const &p, SnappedConstraints &sc, bool constrained) const;
 };
 
 #endif /* !SEEN_SNAP_H */