Code

Connector tool: make connectors avoid the convex hull of shapes.
[inkscape.git] / src / snapper.h
index 25e345305e7e4a2bf0e199745a0fa7f2181dbc3e..110b3d36ad5292fa721e1db7e55b76af01c5ce19 100644 (file)
@@ -7,17 +7,29 @@
  *
  *    Authors:
  *      Carl Hetherington <inkscape@carlh.net>
+ *      Diederik van Lierop <mail@diedenrezi.nl>
  *
  *    Released under GNU GPL, read the file 'COPYING' for more information.
  */
 
 #include <map>
 #include <list>
-#include "libnr/nr-coord.h"
-#include "libnr/nr-point.h"
+#include <boost/optional.hpp>
+
 #include "snapped-point.h"
+#include "snapped-line.h"
+#include "snapped-curve.h"
+#include "snap-preferences.h"
+
+struct SnappedConstraints {
+    std::list<Inkscape::SnappedPoint> points;
+    std::list<Inkscape::SnappedLineSegment> lines;
+    std::list<Inkscape::SnappedLine> grid_lines;
+    std::list<Inkscape::SnappedLine> guide_lines;
+    std::list<Inkscape::SnappedCurve> curves;
+};
 
-struct SPNamedView;
+class SnapManager;
 struct SPItem;
 
 namespace Inkscape
@@ -27,107 +39,84 @@ namespace Inkscape
 class Snapper
 {
 public:
-    Snapper() {}
-    Snapper(SPNamedView const *nv, ::NR::Coord const d);
-    virtual ~Snapper() {}
-
-    /// Point types to snap.
-    typedef int PointType;
-    static const PointType SNAP_POINT;
-    static const PointType BBOX_POINT;
-
-    typedef std::pair<PointType, NR::Point> PointWithType;
+       Snapper() {}
+       Snapper(SnapManager *sm, ::Geom::Coord const t);
+       virtual ~Snapper() {}
 
-    void setSnapTo(PointType t, bool s);
-    void setDistance(::NR::Coord d);
-
-    bool getSnapTo(PointType t) const;
-    ::NR::Coord getDistance() const;
+    virtual Geom::Coord getSnapperTolerance() const = 0; //returns the tolerance of the snapper in screen pixels (i.e. independent of zoom)
+    virtual bool getSnapperAlwaysSnap() const = 0; //if true, then the snapper will always snap, regardless of its tolerance
 
     /**
     *  \return true if this Snapper will snap at least one kind of point.
     */
-    virtual bool ThisSnapperMightSnap() const {return (_enabled && _snap_to != 0);} // will likely be overridden by derived classes
-
+    virtual bool ThisSnapperMightSnap() const {return _snap_enabled;} // will likely be overridden by derived classes
 
+    // These four methods are only used for grids, for which snapping can be enabled individually
     void setEnabled(bool s);
-
-    SnappedPoint freeSnap(PointType t,
-                          NR::Point const &p,
-                          SPItem const *it) const;
-
-    SnappedPoint freeSnap(PointType t,
-                          NR::Point const &p,
-                          std::list<SPItem const *> const &it) const;
+       void setSnapVisibleOnly(bool s);
+    bool getEnabled() const {return _snap_enabled;}
+    bool getSnapVisibleOnly() const {return _snap_visible_only;}
+
+    virtual void freeSnap(SnappedConstraints &/*sc*/,
+                          SnapPreferences::PointType const &/*t*/,
+                          Geom::Point const &/*p*/,
+                          SnapSourceType const &/*source_type*/,
+                          bool const &/*first_point*/,
+                          Geom::OptRect const &/*bbox_to_snap*/,
+                          std::vector<SPItem const *> const */*it*/,
+                          std::vector<std::pair<Geom::Point, int> > */*unselected_nodes*/) const {};
 
     class ConstraintLine
     {
     public:
-        ConstraintLine(NR::Point const &d) : _has_point(false), _direction(d) {}
-        ConstraintLine(NR::Point const &p, NR::Point const &d) : _has_point(true), _point(p), _direction(d) {}
+        ConstraintLine(Geom::Point const &d) : _has_point(false), _direction(d) {}
+        ConstraintLine(Geom::Point const &p, Geom::Point const &d) : _has_point(true), _point(p), _direction(d) {}
 
         bool hasPoint() const {
             return _has_point;
         }
 
-        NR::Point getPoint() const {
+        Geom::Point getPoint() const {
             return _point;
         }
 
-        NR::Point getDirection() const {
+        Geom::Point getDirection() const {
             return _direction;
         }
-        
+
+        void setPoint(Geom::Point const &p) {
+            _point = p;
+            _has_point = true;
+        }
+
+        Geom::Point projection(Geom::Point const &p) const { // returns the projection of p on this constraintline
+               Geom::Point const p1_on_cl = _has_point ? _point : p;
+                       Geom::Point const p2_on_cl = p1_on_cl + _direction;
+               return Geom::projection(p, Geom::Line(p1_on_cl, p2_on_cl));
+        }
+
     private:
 
         bool _has_point;
-        NR::Point _point;
-        NR::Point _direction;
+        Geom::Point _point;
+        Geom::Point _direction;
     };
 
-    SnappedPoint constrainedSnap(PointType t,
-                                 NR::Point const &p,
-                                 ConstraintLine const &c,
-                                 SPItem const *it) const;
+    virtual void constrainedSnap(SnappedConstraints &/*sc*/,
+                                                        SnapPreferences::PointType const &/*t*/,
+                                 Geom::Point const &/*p*/,
+                                 SnapSourceType const &/*source_type*/,
+                                 bool const &/*first_point*/,
+                                 Geom::OptRect const &/*bbox_to_snap*/,
+                                 ConstraintLine const &/*c*/,
+                                 std::vector<SPItem const *> const */*it*/) const {};
 
-    SnappedPoint constrainedSnap(PointType t,
-                                 NR::Point const &p,
-                                 ConstraintLine const &c,
-                                 std::list<SPItem const *> const &it) const;
 protected:
-    SPNamedView const *_named_view;
-    int _snap_to; ///< bitmap of point types that we will snap to
-    bool _enabled; ///< true if this snapper is enabled, otherwise false
-    
-private:
-
-    /**
-     *  Try to snap a point to whatever this snapper is interested in.  Any
-     *  snap that occurs will be to the nearest "interesting" thing (e.g. a
-     *  grid or guide line)
-     *
-     *  \param p Point to snap (desktop coordinates).
-     *  \param it Items that should not be snapped to.
-     *  \return Snapped point.
-     */
-    virtual SnappedPoint _doFreeSnap(NR::Point const &p,
-                                     std::list<SPItem const *> const &it) const = 0;
+       SnapManager *_snapmanager;
 
-    /**
-     *  Try to snap a point to whatever this snapper is interested in, where
-     *  the snap point is constrained to lie along a specified vector from the
-     *  original point.
-     *
-     *  \param p Point to snap (desktop coordinates).
-     *  \param c Vector to constrain the snap to.
-     *  \param it Items that should not be snapped to.
-     *  \return Snapped point.
-     */    
-    virtual SnappedPoint _doConstrainedSnap(NR::Point const &p,
-                                            ConstraintLine const &c,
-                                            std::list<SPItem const *> const &it) const = 0;
-    
-    ::NR::Coord _distance; ///< snap distance (desktop coordinates)
+       // This is only used for grids, for which snapping can be enabled individually
+       bool _snap_enabled; ///< true if this snapper is enabled, otherwise false
+       bool _snap_visible_only;
 };
 
 }