Code

Store cached icons to disk between runs, and invalidate/purge as needed.
[inkscape.git] / src / snapped-line.cpp
index 663da2e8af6745320d78213871dfdcd7ad745edc..090eadf0a26abea58a13614fbd57b5ac97e9303a 100644 (file)
@@ -9,24 +9,39 @@
  */
 
 #include "snapped-line.h"
-#include "geom.h"
-#include "libnr/nr-values.h"
+#include <2geom/line.h>
 
-Inkscape::SnappedLineSegment::SnappedLineSegment(NR::Point snapped_point, NR::Coord snapped_distance, NR::Point start_point_of_line, NR::Point end_point_of_line)
-    : _start_point_of_line(start_point_of_line), _end_point_of_line(end_point_of_line) 
+Inkscape::SnappedLineSegment::SnappedLineSegment(Geom::Point const &snapped_point, Geom::Coord const &snapped_distance, SnapSourceType const &source, long source_num, SnapTargetType const &target, Geom::Coord const &snapped_tolerance, bool const &always_snap, Geom::Point const &start_point_of_line, Geom::Point const &end_point_of_line)
+    : _start_point_of_line(start_point_of_line), _end_point_of_line(end_point_of_line)
 {
-       _distance = snapped_distance;
-       _point = snapped_point;
-       _at_intersection = false;
+    _point = snapped_point;
+    _source = source;
+    _source_num = source_num;
+    _target = target;
+    _distance = snapped_distance;
+    _tolerance = std::max(snapped_tolerance, 1.0);
+    _always_snap = always_snap;
+    _at_intersection = false;
+    _second_distance = NR_HUGE;
+    _second_tolerance = 1;
+    _second_always_snap = false;
 }
 
-Inkscape::SnappedLineSegment::SnappedLineSegment() 
+Inkscape::SnappedLineSegment::SnappedLineSegment()
 {
-       _start_point_of_line = NR::Point(0,0);
-       _end_point_of_line = NR::Point(0,0);
-       _distance = NR_HUGE;
-       _point = NR::Point(0,0);
-       _at_intersection = false;
+    _start_point_of_line = Geom::Point(0,0);
+    _end_point_of_line = Geom::Point(0,0);
+    _point = Geom::Point(0,0);
+    _source = SNAPSOURCE_UNDEFINED;
+    _source_num = -1;
+    _target = SNAPTARGET_UNDEFINED;
+    _distance = NR_HUGE;
+    _tolerance = 1;
+    _always_snap = false;
+    _at_intersection = false;
+    _second_distance = NR_HUGE;
+    _second_tolerance = 1;
+    _second_always_snap = false;
 }
 
 
@@ -34,132 +49,244 @@ Inkscape::SnappedLineSegment::~SnappedLineSegment()
 {
 }
 
-Inkscape::SnappedPoint Inkscape::SnappedLineSegment::intersect(SnappedLineSegment const &line) const 
+Inkscape::SnappedPoint Inkscape::SnappedLineSegment::intersect(SnappedLineSegment const &line) const
 {
-       //TODO: Diederik, implement the intersection    
-       NR::Point const intersection = NR::Point(NR_HUGE, NR_HUGE);
-        
-       //if (result == INTERSECTS) {
-               /* The relevant snapped distance is the distance to the closest snapped line, not the
-               distance to the intersection. For example, when a box is almost aligned with a grid
-               in both horizontal and vertical directions, the distance to the intersection of the
-               grid lines will always be larger then the distance to a grid line. We will be snapping
-               to the closest snapped point however, so if we ever want to snap to the intersection
-               then the distance to it should at least be equal to the other distance, not greater 
-               than it, as that would rule the intersection out
-               */
-       NR::Coord distance = std::min(_distance, line.getDistance());
-       //}
-       return SnappedPoint(intersection, distance);
+    Geom::OptCrossing inters = Geom::OptCrossing(); // empty by default
+    try
+    {
+        inters = Geom::intersection(getLineSegment(), line.getLineSegment());
+    }
+    catch (Geom::InfiniteSolutions e)
+    {
+        // We're probably dealing with parallel lines, so they don't really cross
+        inters = Geom::OptCrossing();
+    }
+
+    if (inters) {
+        Geom::Point inters_pt = getLineSegment().pointAt((*inters).ta);
+        /* If a snapper has been told to "always snap", then this one should be preferred
+         * over the other, if that other one has not been told so. (The preferred snapper
+         * will be labeled "primary" below)
+        */
+        bool const c1 = this->getAlwaysSnap() && !line.getAlwaysSnap(); //do not use _tolerance directly!
+        /* If neither or both have been told to "always snap", then cast a vote based on
+         * the snapped distance. For this we should consider the distance to the snapped
+         * line, not the distance to the intersection.
+         * See the comment in Inkscape::SnappedLine::intersect
+        */
+        bool const c2 = _distance < line.getSnapDistance();
+        bool const use_this_as_primary = c1 || c2;
+        Inkscape::SnappedLineSegment const *primarySLS = use_this_as_primary ? this : &line;
+        Inkscape::SnappedLineSegment const *secondarySLS = use_this_as_primary ? &line : this;
+        Geom::Coord primaryDist = use_this_as_primary ? Geom::L2(inters_pt - this->getPoint()) : Geom::L2(inters_pt - line.getPoint());
+        Geom::Coord secondaryDist = use_this_as_primary ? Geom::L2(inters_pt - line.getPoint()) : Geom::L2(inters_pt - this->getPoint());
+        return SnappedPoint(inters_pt, SNAPSOURCE_UNDEFINED, primarySLS->getSourceNum(), SNAPTARGET_PATH_INTERSECTION, primaryDist, primarySLS->getTolerance(), primarySLS->getAlwaysSnap(), true, false, true,
+                                          secondaryDist, secondarySLS->getTolerance(), secondarySLS->getAlwaysSnap());
+    }
+
+    // No intersection
+    return SnappedPoint(Geom::Point(NR_HUGE, NR_HUGE), SNAPSOURCE_UNDEFINED, 0, SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false, false, false, NR_HUGE, 0, false);
 };
 
 
 
-Inkscape::SnappedLine::SnappedLine(NR::Point snapped_point, NR::Coord snapped_distance, NR::Point normal_to_line, NR::Point point_on_line)
+Inkscape::SnappedLine::SnappedLine(Geom::Point const &snapped_point, Geom::Coord const &snapped_distance, SnapSourceType const &source, long source_num, SnapTargetType const &target, Geom::Coord const &snapped_tolerance, bool const &always_snap, Geom::Point const &normal_to_line, Geom::Point const &point_on_line)
     : _normal_to_line(normal_to_line), _point_on_line(point_on_line)
 {
-       _distance = snapped_distance;
-       _point = snapped_point;
-       _at_intersection = false;
+    _source = source;
+    _source_num = source_num;
+    _target = target;
+    _distance = snapped_distance;
+    _tolerance = std::max(snapped_tolerance, 1.0);
+    _always_snap = always_snap;
+    _second_distance = NR_HUGE;
+    _second_tolerance = 1;
+    _second_always_snap = false;
+    _point = snapped_point;
+    _at_intersection = false;
 }
 
-Inkscape::SnappedLine::SnappedLine() 
+Inkscape::SnappedLine::SnappedLine()
 {
-       _normal_to_line = NR::Point(0,0);
-       _point_on_line = NR::Point(0,0);
-       _distance = NR_HUGE;
-       _point = NR::Point(0,0);
-       _at_intersection = false;
+    _normal_to_line = Geom::Point(0,0);
+    _point_on_line = Geom::Point(0,0);
+    _source = SNAPSOURCE_UNDEFINED;
+    _source_num = -1;
+    _target = SNAPTARGET_UNDEFINED;
+    _distance = NR_HUGE;
+    _tolerance = 1;
+    _always_snap = false;
+    _second_distance = NR_HUGE;
+    _second_tolerance = 1;
+    _second_always_snap = false;
+    _point = Geom::Point(0,0);
+    _at_intersection = false;
 }
 
 Inkscape::SnappedLine::~SnappedLine()
 {
 }
 
-Inkscape::SnappedPoint Inkscape::SnappedLine::intersect(SnappedLine const &line) const 
+Inkscape::SnappedPoint Inkscape::SnappedLine::intersect(SnappedLine const &line) const
 {
-       // Calculate the intersection of to lines, which are both within snapping range
-       // The point of intersection should be considered for snapping, but might be outside the snapping range
-       
-       NR::Point intersection = NR::Point(NR_HUGE, NR_HUGE);
-       NR::Coord distance = NR_HUGE;
-       
-       IntersectorKind result = intersector_line_intersection(getNormal(), getConstTerm(), 
-                                               line.getNormal(), line.getConstTerm(), intersection);
-        
-       if (result == INTERSECTS) {
-               /* The relevant snapped distance is the distance to the closest snapped line, not the
-               distance to the intersection. For example, when a box is almost aligned with a grid
-               in both horizontal and vertical directions, the distance to the intersection of the
-               grid lines will always be larger then the distance to a grid line. We will be snapping
-               to the closest snapped point however, so if we ever want to snap to the intersection
-               then the distance to it should at least be equal to the other distance, not greater 
-               than it, as that would rule the intersection out
-               */
-               distance = std::min(_distance, line.getDistance());
-               //std::cout << "Intersected nicely, now getSIL distance = " << distance << std::endl;
-       }
-       
-       return SnappedPoint(intersection, distance, result == INTERSECTS);      
+    // Calculate the intersection of two lines, which are both within snapping range
+    // One could be a grid line, whereas the other could be a guide line
+    // The point of intersection should be considered for snapping, but might be outside the snapping range
+
+    Geom::OptCrossing inters = Geom::OptCrossing(); // empty by default
+    try
+    {
+        inters = Geom::intersection(getLine(), line.getLine());
+    }
+    catch (Geom::InfiniteSolutions e)
+    {
+        // We're probably dealing with parallel lines, so they don't really cross
+        inters = Geom::OptCrossing();
+    }
+
+    if (inters) {
+        Geom::Point inters_pt = getLine().pointAt((*inters).ta);
+        /* If a snapper has been told to "always snap", then this one should be preferred
+         * over the other, if that other one has not been told so. (The preferred snapper
+         * will be labelled "primary" below)
+        */
+        bool const c1 = this->getAlwaysSnap() && !line.getAlwaysSnap();
+        /* If neither or both have been told to "always snap", then cast a vote based on
+         * the snapped distance. For this we should consider the distance to the snapped
+         * line or to the intersection
+         */
+        bool const c2 = _distance < line.getSnapDistance();
+        bool const use_this_as_primary = c1 || c2;
+        Inkscape::SnappedLine const *primarySL = use_this_as_primary ? this : &line;
+        Inkscape::SnappedLine const *secondarySL = use_this_as_primary ? &line : this;
+        Geom::Coord primaryDist = use_this_as_primary ? Geom::L2(inters_pt - this->getPoint()) : Geom::L2(inters_pt - line.getPoint());
+        Geom::Coord secondaryDist = use_this_as_primary ? Geom::L2(inters_pt - line.getPoint()) : Geom::L2(inters_pt - this->getPoint());
+        return SnappedPoint(inters_pt, Inkscape::SNAPSOURCE_UNDEFINED, primarySL->getSourceNum(), Inkscape::SNAPTARGET_UNDEFINED, primaryDist, primarySL->getTolerance(), primarySL->getAlwaysSnap(), true, false, true,
+                                          secondaryDist, secondarySL->getTolerance(), secondarySL->getAlwaysSnap());
+        // The type of the snap target is yet undefined, as we cannot tell whether
+        // we're snapping to grid or the guide lines; must be set by on a higher level
+    }
+
+    // No intersection
+    return SnappedPoint(Geom::Point(NR_HUGE, NR_HUGE), SNAPSOURCE_UNDEFINED, 0, SNAPTARGET_UNDEFINED, NR_HUGE, 0, false, false, false, false, NR_HUGE, 0, false);
+}
+
+// search for the closest snapped line segment
+bool getClosestSLS(std::list<Inkscape::SnappedLineSegment> const &list, Inkscape::SnappedLineSegment &result)
+{
+    bool success = false;
+
+    for (std::list<Inkscape::SnappedLineSegment>::const_iterator i = list.begin(); i != list.end(); i++) {
+        if ((i == list.begin()) || (*i).getSnapDistance() < result.getSnapDistance()) {
+            result = *i;
+            success = true;
+        }
+    }
+
+    return success;
+}
+
+// search for the closest intersection of two snapped line segments, which are both member of the same collection
+bool getClosestIntersectionSLS(std::list<Inkscape::SnappedLineSegment> const &list, Inkscape::SnappedPoint &result)
+{
+    bool success = false;
+
+    for (std::list<Inkscape::SnappedLineSegment>::const_iterator i = list.begin(); i != list.end(); i++) {
+        std::list<Inkscape::SnappedLineSegment>::const_iterator j = i;
+        j++;
+        for (; j != list.end(); j++) {
+            Inkscape::SnappedPoint sp = (*i).intersect(*j);
+            if (sp.getAtIntersection()) {
+                // if it's the first point
+                 bool const c1 = !success;
+                // or, if it's closer
+                bool const c2 = sp.getSnapDistance() < result.getSnapDistance();
+                // or, if it's just then look at the other distance
+                // (only relevant for snapped points which are at an intersection
+                bool const c3 = (sp.getSnapDistance() == result.getSnapDistance()) && (sp.getSecondSnapDistance() < result.getSecondSnapDistance());
+                // then prefer this point over the previous one
+                if (c1 || c2 || c3) {
+                    result = sp;
+                    success = true;
+                }
+            }
+        }
+    }
+
+    return success;
 }
 
 // search for the closest snapped line
-bool getClosestSL(std::list<Inkscape::SnappedLine> &list, Inkscape::SnappedLine &result) 
+bool getClosestSL(std::list<Inkscape::SnappedLine> const &list, Inkscape::SnappedLine &result)
 {
-       bool success = false;
-       
-       for (std::list<Inkscape::SnappedLine>::const_iterator i = list.begin(); i != list.end(); i++) {
-               if ((i == list.begin()) || (*i).getDistance() < result.getDistance()) {
-                       result = *i;
-                       success = true;
-               }       
-       }
-       
-       return success; 
+    bool success = false;
+
+    for (std::list<Inkscape::SnappedLine>::const_iterator i = list.begin(); i != list.end(); i++) {
+        if ((i == list.begin()) || (*i).getSnapDistance() < result.getSnapDistance()) {
+            result = *i;
+            success = true;
+        }
+    }
+
+    return success;
 }
 
 // search for the closest intersection of two snapped lines, which are both member of the same collection
-bool getClosestIntersectionSL(std::list<Inkscape::SnappedLine> &list, Inkscape::SnappedPoint &result)
+bool getClosestIntersectionSL(std::list<Inkscape::SnappedLine> const &list, Inkscape::SnappedPoint &result)
 {
-       bool success = false;
-       
-       for (std::list<Inkscape::SnappedLine>::const_iterator i = list.begin(); i != list.end(); i++) {
-               std::list<Inkscape::SnappedLine>::const_iterator j = i;
-               j++;
-               for (; j != list.end(); j++) {
-                       Inkscape::SnappedPoint sp = (*i).intersect(*j);
-                       if (sp.getAtIntersection()) {
-                               if (!success || sp.getDistance() < result.getDistance()) {  
-                                       // !success because the first intersection cannot be compared to a previous one
-                                       result = sp;
-                                       success = true;
-                               }
-                       }                               
-               }
-       }
-       
-       return success; 
+    bool success = false;
+
+    for (std::list<Inkscape::SnappedLine>::const_iterator i = list.begin(); i != list.end(); i++) {
+        std::list<Inkscape::SnappedLine>::const_iterator j = i;
+        j++;
+        for (; j != list.end(); j++) {
+            Inkscape::SnappedPoint sp = (*i).intersect(*j);
+            if (sp.getAtIntersection()) {
+                // if it's the first point
+                 bool const c1 = !success;
+                // or, if it's closer
+                bool const c2 = sp.getSnapDistance() < result.getSnapDistance();
+                // or, if it's just then look at the other distance
+                // (only relevant for snapped points which are at an intersection
+                bool const c3 = (sp.getSnapDistance() == result.getSnapDistance()) && (sp.getSecondSnapDistance() < result.getSecondSnapDistance());
+                // then prefer this point over the previous one
+                if (c1 || c2 || c3) {
+                    result = sp;
+                    success = true;
+                }
+            }
+        }
+    }
+
+    return success;
 }
 
 // search for the closest intersection of two snapped lines, which are in two different collections
-bool getClosestIntersectionSL(std::list<Inkscape::SnappedLine> &list1, std::list<Inkscape::SnappedLine> &list2, Inkscape::SnappedPoint &result)
+bool getClosestIntersectionSL(std::list<Inkscape::SnappedLine> const &list1, std::list<Inkscape::SnappedLine> const &list2, Inkscape::SnappedPoint &result)
 {
-       bool success = false;
-       
-       for (std::list<Inkscape::SnappedLine>::const_iterator i = list1.begin(); i != list1.end(); i++) {
-               for (std::list<Inkscape::SnappedLine>::const_iterator j = list2.begin(); j != list2.end(); j++) {
-                       Inkscape::SnappedPoint sp = (*i).intersect(*j);
-                       if (sp.getAtIntersection()) {
-                               if (!success || sp.getDistance() < result.getDistance()) {
-                                       // !success because the first intersection cannot be compared to a previous one
-                                       result = sp;
-                                       success = true;
-                               }
-                       }                               
-               }
-       }
-       
-       return success;
+    bool success = false;
+
+    for (std::list<Inkscape::SnappedLine>::const_iterator i = list1.begin(); i != list1.end(); i++) {
+        for (std::list<Inkscape::SnappedLine>::const_iterator j = list2.begin(); j != list2.end(); j++) {
+            Inkscape::SnappedPoint sp = (*i).intersect(*j);
+            if (sp.getAtIntersection()) {
+                // if it's the first point
+                 bool const c1 = !success;
+                // or, if it's closer
+                bool const c2 = sp.getSnapDistance() < result.getSnapDistance();
+                // or, if it's just then look at the other distance
+                // (only relevant for snapped points which are at an intersection
+                bool const c3 = (sp.getSnapDistance() == result.getSnapDistance()) && (sp.getSecondSnapDistance() < result.getSecondSnapDistance());
+                // then prefer this point over the previous one
+                if (c1 || c2 || c3) {
+                    result = sp;
+                    success = true;
+                }
+            }
+        }
+    }
+
+    return success;
 }
 
 /*