Code

Merge from fe-moved
[inkscape.git] / src / snap.h
index 49c4987898dc8ee454404a4c40dfc7de718faf14..05af0d20281fcbc043f9c4c4435b90987b0b083c 100644 (file)
@@ -3,14 +3,17 @@
 
 /**
  * \file snap.h
- * \brief Various snapping methods.
+ * \brief SnapManager class.
  *
  * Authors:
  *   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
  */
 #include <libnr/nr-coord.h>
 #include <libnr/nr-dim2.h>
 #include <libnr/nr-forward.h>
-#include "grid-snapper.h"
+#include <libnr/nr-scale.h>
+
 #include "guide-snapper.h"
 #include "object-snapper.h"
+#include "snap-preferences.h"
 
 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:
-    bool willSnapSomething() const;
+    SnapManager(SPNamedView const *v);
 
-    Inkscape::SnappedPoint freeSnap(Inkscape::Snapper::PointType t,
-                                    NR::Point const &p,
-                                    SPItem const *it) const;
+    typedef std::list<const Inkscape::Snapper*> SnapperList;
 
-    Inkscape::SnappedPoint freeSnap(Inkscape::Snapper::PointType t,
-                                    NR::Point const &p,
-                                    std::list<SPItem const *> const &it) const;
+    bool someSnapperMightSnap() const;
     
-    Inkscape::SnappedPoint constrainedSnap(Inkscape::Snapper::PointType t,
-                                           NR::Point const &p,
-                                           NR::Point const &c,
-                                           SPItem const *it) const;
+    void setup(SPDesktop const *desktop, bool snapindicator = true, SPItem const *item_to_ignore = NULL, std::vector<Geom::Point> *unselected_nodes = NULL);
+    void setup(SPDesktop const *desktop, bool snapindicator, std::vector<SPItem const *> &items_to_ignore, std::vector<Geom::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::SnapPreferences::PointType point_type,
+                      Geom::Point &p,
+                      bool first_point = true,
+                      Geom::OptRect const &bbox_to_snap = Geom::OptRect()) const;
     
-    Inkscape::SnappedPoint constrainedSnap(Inkscape::Snapper::PointType t,
-                                           NR::Point const &p,
-                                           NR::Point const &c,
-                                           std::list<SPItem const *> const &it) 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,
-                                                          NR::Point const &c,
-                                                          std::list<SPItem const *> const &it,
-                                                          NR::Point const &tr) const;
-
-    Inkscape::GridSnapper grid;
-    Inkscape::GuideSnapper guide;
-    Inkscape::ObjectSnapper object;
+    Inkscape::SnappedPoint freeSnap(Inkscape::SnapPreferences::PointType point_type,
+                                    Geom::Point const &p,
+                                    bool first_point = true,
+                                    Geom::OptRect const &bbox_to_snap = Geom::OptRect() ) const;
+    
+    Geom::Point multipleOfGridPitch(Geom::Point const &t) const;
+    
+    // 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::SnapPreferences::PointType point_type,
+                             Geom::Point &p,
+                             Inkscape::Snapper::ConstraintLine const &constraint,
+                             bool first_point = true,
+                             Geom::OptRect const &bbox_to_snap = Geom::OptRect()) const;
+    
+    Inkscape::SnappedPoint constrainedSnap(Inkscape::SnapPreferences::PointType point_type,
+                                           Geom::Point const &p,
+                                           Inkscape::Snapper::ConstraintLine const &constraint,
+                                           bool first_point = true,
+                                           Geom::OptRect const &bbox_to_snap = Geom::OptRect()) const;
+                                           
+    void guideSnap(Geom::Point &p, Geom::Point const &guide_normal) const;
+
+    Inkscape::SnappedPoint freeSnapTranslation(Inkscape::SnapPreferences::PointType point_type,
+                                               std::vector<Geom::Point> const &p,
+                                               Geom::Point const &pointer,
+                                               Geom::Point const &tr) const;
+
+    Inkscape::SnappedPoint constrainedSnapTranslation(Inkscape::SnapPreferences::PointType point_type,
+                                                      std::vector<Geom::Point> const &p,
+                                                      Geom::Point const &pointer,
+                                                      Inkscape::Snapper::ConstraintLine const &constraint,
+                                                      Geom::Point const &tr) const;
+
+    Inkscape::SnappedPoint freeSnapScale(Inkscape::SnapPreferences::PointType point_type,
+                                         std::vector<Geom::Point> const &p,
+                                         Geom::Point const &pointer,
+                                         Geom::Scale const &s,
+                                         Geom::Point const &o) const;
+
+    Inkscape::SnappedPoint constrainedSnapScale(Inkscape::SnapPreferences::PointType point_type,
+                                                std::vector<Geom::Point> const &p,
+                                                Geom::Point const &pointer,
+                                                Geom::Scale const &s,
+                                                Geom::Point const &o) const;
+
+    Inkscape::SnappedPoint constrainedSnapStretch(Inkscape::SnapPreferences::PointType point_type,
+                                                  std::vector<Geom::Point> const &p,
+                                                  Geom::Point const &pointer,
+                                                  Geom::Coord const &s,
+                                                  Geom::Point const &o,
+                                                  Geom::Dim2 d,
+                                                  bool uniform) const;
+
+    Inkscape::SnappedPoint constrainedSnapSkew(Inkscape::SnapPreferences::PointType point_type,
+                                               std::vector<Geom::Point> const &p,
+                                               Geom::Point const &pointer,
+                                               Inkscape::Snapper::ConstraintLine const &constraint,
+                                               Geom::Point const &s, // s[0] = skew factor, s[1] = scale factor
+                                               Geom::Point const &o,
+                                               Geom::Dim2 d) const;
+                                        
+    Inkscape::GuideSnapper guide;      ///< guide snapper
+    Inkscape::ObjectSnapper object;    ///< snapper to other objects
+    Inkscape::SnapPreferences snapprefs;
 
-    typedef std::list<const Inkscape::Snapper*> SnapperList;
     SnapperList getSnappers() const;
+    SnapperList getGridSnappers() const;
+    
+    SPDesktop const *getDesktop() const {return _desktop;}
+    SPNamedView const *getNamedView() const {return _named_view;}
+    SPDocument *getDocument() const;
+    
+protected:
+    SPNamedView const *_named_view;
+
+private:
+       enum Transformation {
+        TRANSLATION,
+        SCALE,
+        STRETCH,
+        SKEW
+    };
+    
+    std::vector<SPItem const *> *_items_to_ignore;
+    SPItem const *_item_to_ignore;
+    SPDesktop const *_desktop;
+    bool _snapindicator;
+    std::vector<Geom::Point> *_unselected_nodes;                                    
+    
+    Inkscape::SnappedPoint _snapTransformed(Inkscape::SnapPreferences::PointType type,
+                                            std::vector<Geom::Point> const &points,
+                                            Geom::Point const &pointer,
+                                            bool constrained,
+                                            Inkscape::Snapper::ConstraintLine const &constraint,
+                                            Transformation transformation_type,
+                                            Geom::Point const &transformation,
+                                            Geom::Point const &origin,
+                                            Geom::Dim2 dim,
+                                            bool uniform) const;
+                                                
+    Inkscape::SnappedPoint findBestSnap(Geom::Point const &p, SnappedConstraints &sc, bool constrained) 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 */
-
-std::pair<double, bool> namedview_vector_snap_list(SPNamedView const *nv,
-                                                   Inkscape::Snapper::PointType t, const std::vector<NR::Point> &p,
-                                                   NR::Point const &norm, NR::scale const &s,
-                                                   std::list<SPItem const *> const &it
-                                                   );
-
-std::pair<double, bool> namedview_dim_snap_list_scale(SPNamedView const *nv,
-                                                      Inkscape::Snapper::PointType t, const std::vector<NR::Point> &p,
-                                                      NR::Point const &norm, double const sx,
-                                                      NR::Dim2 const dim,
-                                                      std::list<SPItem const *> const &it);
-
-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 */
 
 /*