Code

Store cached icons to disk between runs, and invalidate/purge as needed.
[inkscape.git] / src / snapped-point.h
index 309e322a6ed9600253c05c18b70f4e2ba5d5c4bc..b2a9fa1ce02d7b2698c7beeeccbf9f479b673f69 100644 (file)
 
 #include <vector>
 #include <list>
-#include "libnr/nr-coord.h"
-#include "libnr/nr-point.h"
-#include <libnr/nr-values.h>
+#include <libnr/nr-values.h> //Because of NR_HUGE
+#include <2geom/geom.h>
+#include <snap-candidate.h>
 
 namespace Inkscape
 {
-    
+
 /// Class describing the result of an attempt to snap.
 class SnappedPoint
 {
+
 public:
     SnappedPoint();
-    SnappedPoint(NR::Point p, NR::Coord d, NR::Coord t, bool a, bool at_intersection, NR::Coord d2, NR::Coord t2, bool a2);
-    SnappedPoint(NR::Point p, NR::Coord d, NR::Coord t, bool a);
+    SnappedPoint(Geom::Point const &p);
+    SnappedPoint(Geom::Point const &p, SnapSourceType const &source, long source_num, SnapTargetType const &target, Geom::Coord const &d, Geom::Coord const &t, bool const &a, bool const &at_intersection, bool const &constrained_snap, bool const &fully_constrained, Geom::Coord const &d2, Geom::Coord const &t2, bool const &a2);
+    SnappedPoint(Geom::Point const &p, SnapSourceType const &source, long source_num, SnapTargetType const &target, Geom::Coord const &d, Geom::Coord const &t, bool const &a, bool const &constrained_snap, bool const &fully_constrained, Geom::OptRect target_bbox = Geom::OptRect());
+    SnappedPoint(SnapCandidatePoint const &p, SnapTargetType const &target, Geom::Coord const &d, Geom::Coord const &t, bool const &a, bool const &constrained_snap, bool const &fully_constrained);
     ~SnappedPoint();
 
-    NR::Coord getDistance() const;
-    void setDistance(NR::Coord d) {_distance = d;}
-    NR::Coord getTolerance() const;
-    bool getAlwaysSnap() const;
-    NR::Coord getSecondDistance() const;
-    NR::Coord getSecondTolerance() const;
-    bool getSecondAlwaysSnap() const;
-    NR::Point getPoint() const;
+    Geom::Coord getSnapDistance() const {return _distance;}
+    void setSnapDistance(Geom::Coord const d) {_distance = d;}
+    Geom::Coord getTolerance() const {return _tolerance;}
+    bool getAlwaysSnap() const {return _always_snap;}
+    Geom::Coord getSecondSnapDistance() const {return _second_distance;}
+    void setSecondSnapDistance(Geom::Coord const d) {_second_distance = d;}
+    Geom::Coord getSecondTolerance() const {return _second_tolerance;}
+    bool getSecondAlwaysSnap() const {return _second_always_snap;}
+    Geom::Coord getPointerDistance() const {return _pointer_distance;}
+    void setPointerDistance(Geom::Coord const d) {_pointer_distance = d;}
+
+    /* This is the preferred method to find out which point we have snapped
+     * to, because it only returns a point if snapping has actually occurred
+     * (by overwriting p)
+     */
+    void getPointIfSnapped(Geom::Point &p) const;
+
+    /* This method however always returns a point, even if no snapping
+     * has occurred; A check should be implemented in the calling code
+     * to check for snapping. Use this method only when really needed, e.g.
+     * when the calling code is trying to snap multiple points and must
+     * determine itself which point is most appropriate, or when doing a
+     * constrainedSnap that also enforces projection onto the constraint (in
+     * which case you need the new point anyway, even if we didn't snap)
+     */
+    Geom::Point getPoint() const {return _point;}
+    void setPoint(Geom::Point const &p) {_point = p;}
+
     bool getAtIntersection() const {return _at_intersection;}
+    bool getFullyConstrained() const {return _fully_constrained;}
+    bool getConstrainedSnap() const {return _constrained_snap;}
     bool getSnapped() const {return _distance < NR_HUGE;}
-    NR::Point getTransformation() const {return _transformation;}
-    void setTransformation(NR::Point t) {_transformation = t;}
-    
+    Geom::Point getTransformation() const {return _transformation;}
+    void setTransformation(Geom::Point const t) {_transformation = t;}
+    void setTarget(SnapTargetType const target) {_target = target;}
+    SnapTargetType getTarget() const {return _target;}
+    void setTargetBBox(Geom::OptRect const target) {_target_bbox = target;}
+    Geom::OptRect const getTargetBBox() const {return _target_bbox;}
+    void setSource(SnapSourceType const source) {_source = source;}
+    SnapSourceType getSource() const {return _source;}
+    long getSourceNum() const {return _source_num;}
+
+    bool isOtherSnapBetter(SnappedPoint const &other_one, bool weighted) const;
+
+    /*void dump() const {
+        std::cout << "_point              = " << _point << std::endl;
+        std::cout << "_source             = " << _source << std::endl;
+        std::cout << "_source_num         = " << _source_num << std::endl;
+        std::cout << "_target             = " << _target << std::endl;
+        std::cout << "_at_intersection    = " << _at_intersection << std::endl;
+        std::cout << "_fully_constrained  = " << _fully_constrained << std::endl;
+        std::cout << "_distance           = " << _distance << std::endl;
+        std::cout << "_tolerance          = " << _tolerance << std::endl;
+        std::cout << "_always_snap        = " << _always_snap << std::endl;
+        std::cout << "_second_distance    = " << _second_distance << std::endl;
+        std::cout << "_second_tolerance   = " << _second_tolerance << std::endl;
+        std::cout << "_second_always_snap = " << _second_always_snap << std::endl;
+        std::cout << "_transformation     = " << _transformation << std::endl;
+        std::cout << "_pointer_distance   = " << _pointer_distance << std::endl;
+    }*/
+
 protected:
-    NR::Point _point; // Location of the snapped point
-    bool _at_intersection; // If true, the snapped point is at an intersection 
-    
+    Geom::Point _point; // Location of the snapped point
+    SnapSourceType _source; // Describes what snapped
+    long _source_num; // Sequence number of the source point that snapped, if that point is part of a set of points. (starting at zero if we might have a set of points; -1 if we only have a single point)
+    SnapTargetType _target; // Describes to what we've snapped to
+    bool _at_intersection; // If true, the snapped point is at an intersection
+    bool _constrained_snap; // If true, then the snapped point was found when looking for a constrained snap
+    bool _fully_constrained; // When snapping for example to a node, then the snap will be "fully constrained".
+                            // When snapping to a line however, the snap is only partly constrained (i.e. only in one dimension)
+
     /* Distance from original point to snapped point. If the snapped point is at
        an intersection of e.g. two lines, then this is the distance to the closest
-       line */    
-    NR::Coord _distance; 
-    /* The snapping tolerance in screen pixels (depends on zoom)*/  
-    NR::Coord _tolerance;
+       line */
+    Geom::Coord _distance;
+    /* The snapping tolerance in screen pixels (depends on zoom)*/
+    Geom::Coord _tolerance;
     /* If true then "Always snap" is on */
     bool _always_snap;
-    
+
     /* If the snapped point is at an intersection of e.g. two lines, then this is
-       the distance to the fartest line */    
-    NR::Coord _second_distance;
+       the distance to the farthest line */
+    Geom::Coord _second_distance;
     /* The snapping tolerance in screen pixels (depends on zoom)*/
-    NR::Coord _second_tolerance;
+    Geom::Coord _second_tolerance;
     /* If true then "Always snap" is on */
     bool _second_always_snap;
     /* The transformation (translation, scale, skew, or stretch) from the original point to the snapped point */
-    NR::Point _transformation;
-};    
-
-}
+    Geom::Point _transformation;
+    /* The bounding box we've snapped to (when applicable); will be used by the snapindicator */
+    Geom::OptRect _target_bbox;
+    /* Distance from the un-transformed point to the mouse pointer, measured at the point in time when dragging started */
+    Geom::Coord _pointer_distance;
+};
 
-bool getClosestSP(std::list<Inkscape::SnappedPoint> &list, Inkscape::SnappedPoint &result);
+}// end of namespace Inkscape
 
+bool getClosestSP(std::list<Inkscape::SnappedPoint> const &list, Inkscape::SnappedPoint &result);
 
 #endif /* !SEEN_SNAPPEDPOINT_H */