Code

fix pasting style after copying a text span
[inkscape.git] / src / object-snapper.cpp
index cf10ab5e27bc0e66ff65b5c2f1a6c6fceb9c6c16..515008964e2864432beda0c36ceb10edce3f9ea1 100644 (file)
@@ -44,13 +44,11 @@ Inkscape::SnapCandidate::~SnapCandidate()
 }
 
 Inkscape::ObjectSnapper::ObjectSnapper(SnapManager *sm, Geom::Coord const d)
-    : Snapper(sm, d), _snap_to_itemnode(true), _snap_to_itempath(true),
-      _snap_to_bboxnode(true), _snap_to_bboxpath(true), _snap_to_page_border(false),
-      _strict_snapping(true)
+    : Snapper(sm, d)
 {
     _candidates = new std::vector<SnapCandidate>;
     _points_to_snap_to = new std::vector<Geom::Point>;
-    _paths_to_snap_to = new std::vector<Geom::PathVector*>;
+    _paths_to_snap_to = new std::vector<std::pair<Geom::PathVector*, SnapTargetType> >;
 }
 
 Inkscape::ObjectSnapper::~ObjectSnapper()
@@ -65,6 +63,21 @@ Inkscape::ObjectSnapper::~ObjectSnapper()
     delete _paths_to_snap_to;
 }
 
+/**
+ *  \return Snap tolerance (desktop coordinates); depends on current zoom so that it's always the same in screen pixels
+ */
+Geom::Coord Inkscape::ObjectSnapper::getSnapperTolerance() const
+{
+       SPDesktop const *dt = _snapmanager->getDesktop();
+       double const zoom =  dt ? dt->current_zoom() : 1;
+       return _snapmanager->snapprefs.getObjectTolerance() / zoom;
+}
+
+bool Inkscape::ObjectSnapper::getSnapperAlwaysSnap() const
+{
+    return _snapmanager->snapprefs.getObjectTolerance() == 10000; //TODO: Replace this threshold of 10000 by a constant; see also tolerance-slider.cpp
+}
+
 /**
  *  Find all items within snapping range.
  *  \param parent Pointer to the document's root, or to a clipped path or mask object
@@ -130,7 +143,7 @@ void Inkscape::ObjectSnapper::_findCandidates(SPObject* parent,
                 }
 
                 if (SP_IS_GROUP(o)) {
-                    _findCandidates(o, it, false, bbox_to_snap, snap_dim, false, Geom::identity());
+                    _findCandidates(o, it, false, bbox_to_snap, snap_dim, clip_or_mask, additional_affine);
                 } else {
                     Geom::OptRect bbox_of_item = Geom::Rect();
                     if (clip_or_mask) {
@@ -176,7 +189,7 @@ void Inkscape::ObjectSnapper::_collectNodes(Inkscape::SnapPreferences::PointType
         // A point considered for snapping should be either a node, a bbox corner or a guide. Pick only ONE!
         g_assert(!((p_is_a_node && p_is_a_bbox) || (p_is_a_bbox && p_is_a_guide) || (p_is_a_node && p_is_a_guide)));
 
-        if (_snap_to_bboxnode) {
+        if (_snapmanager->snapprefs.getSnapToBBoxNode() || _snapmanager->snapprefs.getSnapBBoxEdgeMidpoints() || _snapmanager->snapprefs.getSnapBBoxMidpoints()) {
             Inkscape::Preferences *prefs = Inkscape::Preferences::get();
             bool prefs_bbox = prefs->getBool("/tools/bounding_box");
             bbox_type = !prefs_bbox ?
@@ -184,7 +197,7 @@ void Inkscape::ObjectSnapper::_collectNodes(Inkscape::SnapPreferences::PointType
         }
 
         // Consider the page border for snapping
-        if (_snap_to_page_border) {
+        if (_snapmanager->snapprefs.getSnapToPageBorder()) {
             _getBorderNodes(_points_to_snap_to);
         }
 
@@ -197,55 +210,47 @@ void Inkscape::ObjectSnapper::_collectNodes(Inkscape::SnapPreferences::PointType
             g_return_if_fail(root_item);
 
             //Collect all nodes so we can snap to them
-            if (_snap_to_itemnode) {
-                if (!(_strict_snapping && !p_is_a_node) || p_is_a_guide) {
-                    // Note: there are two ways in which intersections are considered:
-                    // Method 1: Intersections are calculated for each shape individually, for both the
-                    //           snap source and snap target (see sp_shape_snappoints)
-                    // Method 2: Intersections are calculated for each curve or line that we've snapped to, i.e. only for
-                    //           the target (see the intersect() method in the SnappedCurve and SnappedLine classes)
-                    // Some differences:
-                    // - Method 1 doesn't find intersections within a set of multiple objects
-                    // - Method 2 only works for targets
-                    // When considering intersections as snap targets:
-                    // - Method 1 only works when snapping to nodes, whereas
-                    // - Method 2 only works when snapping to paths
-                    // - There will be performance differences too!
-                    // If both methods are being used simultaneously, then this might lead to duplicate targets!
-
-                    // Well, here we will be looking for snap TARGETS. Both methods can therefore be used.
-                    // When snapping to paths, we will get a collection of snapped lines and snapped curves. findBestSnap() will
-                    // go hunting for intersections (but only when asked to in the prefs of course). In that case we can just
-                    // temporarily block the intersections in sp_item_snappoints, we don't need duplicates. If we're not snapping to
-                    // paths though but only to item nodes then we should still look for the intersections in sp_item_snappoints()
-                    bool old_pref = _snapmanager->snapprefs.getSnapIntersectionCS();
-                    if (_snap_to_itempath) {
-                        _snapmanager->snapprefs.setSnapIntersectionCS(false);
-                    }
-
-                    sp_item_snappoints(root_item, SnapPointsIter(*_points_to_snap_to), &_snapmanager->snapprefs);
-
-                    if (_snap_to_itempath) {
-                        _snapmanager->snapprefs.setSnapIntersectionCS(old_pref);
-                    }
-                }
-            }
+                       if (p_is_a_node || !(_snapmanager->snapprefs.getStrictSnapping() && !p_is_a_node) || p_is_a_guide) {
+                               // Note: there are two ways in which intersections are considered:
+                               // Method 1: Intersections are calculated for each shape individually, for both the
+                               //           snap source and snap target (see sp_shape_snappoints)
+                               // Method 2: Intersections are calculated for each curve or line that we've snapped to, i.e. only for
+                               //           the target (see the intersect() method in the SnappedCurve and SnappedLine classes)
+                               // Some differences:
+                               // - Method 1 doesn't find intersections within a set of multiple objects
+                               // - Method 2 only works for targets
+                               // When considering intersections as snap targets:
+                               // - Method 1 only works when snapping to nodes, whereas
+                               // - Method 2 only works when snapping to paths
+                               // - There will be performance differences too!
+                               // If both methods are being used simultaneously, then this might lead to duplicate targets!
+
+                               // Well, here we will be looking for snap TARGETS. Both methods can therefore be used.
+                               // When snapping to paths, we will get a collection of snapped lines and snapped curves. findBestSnap() will
+                               // go hunting for intersections (but only when asked to in the prefs of course). In that case we can just
+                               // temporarily block the intersections in sp_item_snappoints, we don't need duplicates. If we're not snapping to
+                               // paths though but only to item nodes then we should still look for the intersections in sp_item_snappoints()
+                               bool old_pref = _snapmanager->snapprefs.getSnapIntersectionCS();
+                               if (_snapmanager->snapprefs.getSnapToItemPath()) {
+                                       _snapmanager->snapprefs.setSnapIntersectionCS(false);
+                               }
+
+                               sp_item_snappoints(root_item, SnapPointsIter(*_points_to_snap_to), &_snapmanager->snapprefs);
+
+                               if (_snapmanager->snapprefs.getSnapToItemPath()) {
+                                       _snapmanager->snapprefs.setSnapIntersectionCS(old_pref);
+                               }
+                       }
 
             //Collect the bounding box's corners so we can snap to them
-            if (_snap_to_bboxnode) {
-                if (!(_strict_snapping && !p_is_a_bbox) || p_is_a_guide) {
-                    // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
-                    // of the item AND the bbox of the clipping path at the same time
-                    if (!(*i).clip_or_mask) {
-                        Geom::OptRect b = sp_item_bbox_desktop(root_item, bbox_type);
-                        if (b) {
-                            for ( unsigned k = 0 ; k < 4 ; k++ ) {
-                                _points_to_snap_to->push_back(b->corner(k));
-                            }
-                        }
-                    }
-                }
-            }
+                       if (p_is_a_bbox || !(_snapmanager->snapprefs.getStrictSnapping() && !p_is_a_bbox) || p_is_a_guide) {
+                               // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
+                               // of the item AND the bbox of the clipping path at the same time
+                               if (!(*i).clip_or_mask) {
+                                       Geom::OptRect b = sp_item_bbox_desktop(root_item, bbox_type);
+                                       getBBoxPoints(b, _points_to_snap_to, _snapmanager->snapprefs.getSnapToBBoxNode(), _snapmanager->snapprefs.getSnapBBoxEdgeMidpoints(), _snapmanager->snapprefs.getSnapBBoxMidpoints());
+                               }
+                       }
         }
     }
 }
@@ -328,7 +333,7 @@ void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType
 
         bool p_is_a_node = t & Inkscape::SnapPreferences::SNAPPOINT_NODE;
 
-        if (_snap_to_bboxpath) {
+        if (_snapmanager->snapprefs.getSnapToBBoxPath()) {
             Inkscape::Preferences *prefs = Inkscape::Preferences::get();
             int prefs_bbox = prefs->getBool("/tools/bounding_box", 0);
             bbox_type = !prefs_bbox ?
@@ -336,10 +341,10 @@ void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType
         }
 
         // Consider the page border for snapping
-        if (_snap_to_page_border) {
+        if (_snapmanager->snapprefs.getSnapToPageBorder()) {
             Geom::PathVector *border_path = _getBorderPathv();
             if (border_path != NULL) {
-                _paths_to_snap_to->push_back(border_path);
+                _paths_to_snap_to->push_back(std::make_pair<Geom::PathVector*, SnapTargetType>(border_path, SNAPTARGET_PAGE_BORDER));
             }
         }
 
@@ -361,8 +366,8 @@ void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType
             //Build a list of all paths considered for snapping to
 
             //Add the item's path to snap to
-            if (_snap_to_itempath) {
-                if (!(_strict_snapping && !p_is_a_node)) {
+            if (_snapmanager->snapprefs.getSnapToItemPath()) {
+                if (!(_snapmanager->snapprefs.getStrictSnapping() && !p_is_a_node)) {
                     // Snapping to the path of characters is very cool, but for a large
                     // chunk of text this will take ages! So limit snapping to text paths
                     // containing max. 240 characters. Snapping the bbox will not be affected
@@ -387,7 +392,7 @@ void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType
                         if (curve) {
                             // We will get our own copy of the path, which must be freed at some point
                             Geom::PathVector *borderpathv = pathvector_for_curve(root_item, curve, true, true, Geom::identity(), (*i).additional_affine);
-                            _paths_to_snap_to->push_back(borderpathv); // Perhaps for speed, get a reference to the Geom::pathvector, and store the transformation besides it.
+                            _paths_to_snap_to->push_back(std::make_pair<Geom::PathVector*, SnapTargetType>(borderpathv, SNAPTARGET_PATH)); // Perhaps for speed, get a reference to the Geom::pathvector, and store the transformation besides it.
                             curve->unref();
                         }
                     }
@@ -395,8 +400,8 @@ void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType
             }
 
             //Add the item's bounding box to snap to
-            if (_snap_to_bboxpath) {
-                if (!(_strict_snapping && p_is_a_node)) {
+            if (_snapmanager->snapprefs.getSnapToBBoxPath()) {
+                if (!(_snapmanager->snapprefs.getStrictSnapping() && p_is_a_node)) {
                     // Discard the bbox of a clipped path / mask, because we don't want to snap to both the bbox
                     // of the item AND the bbox of the clipping path at the same time
                     if (!(*i).clip_or_mask) {
@@ -404,7 +409,7 @@ void Inkscape::ObjectSnapper::_collectPaths(Inkscape::SnapPreferences::PointType
                         sp_item_invoke_bbox(root_item, rect, i2doc, TRUE, bbox_type);
                         if (rect) {
                             Geom::PathVector *path = _getPathvFromRect(*rect);
-                            _paths_to_snap_to->push_back(path);
+                            _paths_to_snap_to->push_back(std::make_pair<Geom::PathVector*, SnapTargetType>(path, SNAPTARGET_BBOX_EDGE));
                         }
                     }
                 }
@@ -426,7 +431,7 @@ void Inkscape::ObjectSnapper::_snapPaths(SnappedConstraints &sc,
     g_assert(_snapmanager->getDesktop() != NULL);
     Geom::Point const p_doc = _snapmanager->getDesktop()->dt2doc(p);
 
-    bool const node_tool_active = _snap_to_itempath && selected_path != NULL;
+    bool const node_tool_active = _snapmanager->snapprefs.getSnapToItemPath() && selected_path != NULL;
 
     if (first_point) {
         /* findCandidates() is used for snapping to both paths and nodes. It ignores the path that is
@@ -441,20 +446,20 @@ void Inkscape::ObjectSnapper::_snapPaths(SnappedConstraints &sc,
             SPCurve *curve = curve_for_item(SP_ITEM(selected_path));
             if (curve) {
                 Geom::PathVector *pathv = pathvector_for_curve(SP_ITEM(selected_path), curve, true, true, Geom::identity(), Geom::identity()); // We will get our own copy of the path, which must be freed at some point
-                _paths_to_snap_to->push_back(pathv);
+                _paths_to_snap_to->push_back(std::make_pair<Geom::PathVector*, SnapTargetType>(pathv, SNAPTARGET_PATH));
                 curve->unref();
             }
         }
     }
 
-    for (std::vector<Geom::PathVector*>::const_iterator it_p = _paths_to_snap_to->begin(); it_p != _paths_to_snap_to->end(); it_p++) {
+    for (std::vector<std::pair<Geom::PathVector*, SnapTargetType> >::const_iterator it_p = _paths_to_snap_to->begin(); it_p != _paths_to_snap_to->end(); it_p++) {
         bool const being_edited = (node_tool_active && (*it_p) == _paths_to_snap_to->back());
         //if true then this pathvector it_pv is currently being edited in the node tool
 
-        // char * svgd = sp_svg_write_path(**it_p);
+        // char * svgd = sp_svg_write_path(**it_p->first);
         // std::cout << "Dumping the pathvector: " << svgd << std::endl;
 
-        for(Geom::PathVector::iterator it_pv = (*it_p)->begin(); it_pv != (*it_p)->end(); ++it_pv) {
+        for(Geom::PathVector::iterator it_pv = (it_p->first)->begin(); it_pv != (it_p->first)->end(); ++it_pv) {
             // Find a nearest point for each curve within this path
             // n curves will return n time values with 0 <= t <= 1
             std::vector<double> anp = (*it_pv).nearestPointPerCurve(p_doc);
@@ -491,7 +496,7 @@ void Inkscape::ObjectSnapper::_snapPaths(SnappedConstraints &sc,
                 if (!being_edited || (c1 && c2)) {
                     Geom::Coord const dist = Geom::distance(sp_doc, p_doc);
                     if (dist < getSnapperTolerance()) {
-                        sc.curves.push_back(Inkscape::SnappedCurve(from_2geom(sp_dt), dist, getSnapperTolerance(), getSnapperAlwaysSnap(), false, curve));
+                        sc.curves.push_back(Inkscape::SnappedCurve(sp_dt, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), false, curve, it_p->second));
                     }
                 }
             }
@@ -554,12 +559,12 @@ void Inkscape::ObjectSnapper::_snapPathsConstrained(SnappedConstraints &sc,
     cl.appendNew<Geom::LineSegment>(p_max_on_cl);
     clv.push_back(cl);
 
-    for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
-        if (*k) {
-            Geom::CrossingSet cs = Geom::crossings(clv, *(*k));
+    for (std::vector<std::pair<Geom::PathVector*, SnapTargetType> >::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
+        if (k->first) {
+            Geom::CrossingSet cs = Geom::crossings(clv, *(k->first));
             if (cs.size() > 0) {
                 // We need only the first element of cs, because cl is only a single straight linesegment
-                // This first element contains a vector filled with crossings of cl with *k
+                // This first element contains a vector filled with crossings of cl with k->first
                 for (std::vector<Geom::Crossing>::const_iterator m = cs[0].begin(); m != cs[0].end(); m++) {
                     if ((*m).ta >= 0 && (*m).ta <= 1 ) {
                         // Reconstruct the point of intersection
@@ -567,7 +572,7 @@ void Inkscape::ObjectSnapper::_snapPathsConstrained(SnappedConstraints &sc,
                         // When it's within snapping range, then return it
                         // (within snapping range == between p_min_on_cl and p_max_on_cl == 0 < ta < 1)
                         Geom::Coord dist = Geom::L2(_snapmanager->getDesktop()->dt2doc(p_proj_on_cl) - p_inters);
-                        SnappedPoint s(_snapmanager->getDesktop()->doc2dt(p_inters), SNAPTARGET_PATH, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
+                        SnappedPoint s(_snapmanager->getDesktop()->doc2dt(p_inters), k->second, dist, getSnapperTolerance(), getSnapperAlwaysSnap(), true);
                         sc.points.push_back(s);
                     }
                 }
@@ -595,11 +600,15 @@ void Inkscape::ObjectSnapper::freeSnap(SnappedConstraints &sc,
         _findCandidates(sp_document_root(_snapmanager->getDocument()), it, first_point, local_bbox_to_snap, TRANSL_SNAP_XY, false, Geom::identity());
     }
 
-    if (_snap_to_itemnode || _snap_to_bboxnode || _snap_to_page_border) {
+    if (_snapmanager->snapprefs.getSnapToItemNode() || _snapmanager->snapprefs.getSnapSmoothNodes()
+       || _snapmanager->snapprefs.getSnapToBBoxNode() || _snapmanager->snapprefs.getSnapToPageBorder()
+               || _snapmanager->snapprefs.getSnapLineMidpoints() || _snapmanager->snapprefs.getSnapObjectMidpoints()
+               || _snapmanager->snapprefs.getSnapBBoxEdgeMidpoints() || _snapmanager->snapprefs.getSnapBBoxMidpoints()
+               || _snapmanager->snapprefs.getIncludeItemCenter()) {
         _snapNodes(sc, t, p, first_point, unselected_nodes);
     }
 
-    if (_snap_to_itempath || _snap_to_bboxpath || _snap_to_page_border) {
+    if (_snapmanager->snapprefs.getSnapToItemPath() || _snapmanager->snapprefs.getSnapToBBoxPath() || _snapmanager->snapprefs.getSnapToPageBorder()) {
         unsigned n = (unselected_nodes == NULL) ? 0 : unselected_nodes->size();
         if (n > 0) {
             /* While editing a path in the node tool, findCandidates must ignore that path because
@@ -647,7 +656,7 @@ void Inkscape::ObjectSnapper::constrainedSnap( SnappedConstraints &sc,
     // to objects we will only consider the object's paths. Beside, the nodes will be at these paths,
     // so we will more or less snap to them anyhow.
 
-    if (_snap_to_itempath || _snap_to_bboxpath || _snap_to_page_border) {
+    if (_snapmanager->snapprefs.getSnapToItemPath() || _snapmanager->snapprefs.getSnapToBBoxPath() || _snapmanager->snapprefs.getSnapToPageBorder()) {
         _snapPathsConstrained(sc, t, p, first_point, c);
     }
 }
@@ -691,20 +700,28 @@ void Inkscape::ObjectSnapper::guideSnap(SnappedConstraints &sc,
  */
 bool Inkscape::ObjectSnapper::ThisSnapperMightSnap() const
 {
-    bool snap_to_something = _snap_to_itempath || _snap_to_itemnode || _snap_to_bboxpath || _snap_to_bboxnode || _snap_to_page_border;
+    bool snap_to_something = _snapmanager->snapprefs.getSnapToItemPath()
+                                               || _snapmanager->snapprefs.getSnapToItemNode()
+                                               || _snapmanager->snapprefs.getSnapToBBoxPath()
+                                               || _snapmanager->snapprefs.getSnapToBBoxNode()
+                                               || _snapmanager->snapprefs.getSnapToPageBorder()
+                                               || _snapmanager->snapprefs.getSnapLineMidpoints() || _snapmanager->snapprefs.getSnapObjectMidpoints()
+                                               || _snapmanager->snapprefs.getSnapBBoxEdgeMidpoints() || _snapmanager->snapprefs.getSnapBBoxMidpoints()
+                                               || _snapmanager->snapprefs.getIncludeItemCenter();
+
     return (_snap_enabled && _snapmanager->snapprefs.getSnapModeBBoxOrNodes() && snap_to_something);
 }
 
 bool Inkscape::ObjectSnapper::GuidesMightSnap() const
 {
-    bool snap_to_something = _snap_to_itemnode || _snap_to_bboxnode;
+    bool snap_to_something = _snapmanager->snapprefs.getSnapToItemNode() || _snapmanager->snapprefs.getSnapToBBoxNode();
     return (_snap_enabled && _snapmanager->snapprefs.getSnapModeGuide() && snap_to_something);
 }
 
 void Inkscape::ObjectSnapper::_clear_paths() const
 {
-    for (std::vector<Geom::PathVector*>::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
-        g_free(*k);
+    for (std::vector<std::pair<Geom::PathVector*, SnapTargetType> >::const_iterator k = _paths_to_snap_to->begin(); k != _paths_to_snap_to->end(); k++) {
+        g_free(k->first);
     }
     _paths_to_snap_to->clear();
 }
@@ -736,6 +753,25 @@ void Inkscape::ObjectSnapper::_getBorderNodes(std::vector<Geom::Point> *points)
     points->push_back(Geom::Point(w,0));
 }
 
+void Inkscape::getBBoxPoints(Geom::OptRect const bbox, std::vector<Geom::Point> *points, bool const includeCorners, bool const includeLineMidpoints, bool const includeObjectMidpoints)
+{
+       if (bbox) {
+               // collect the corners of the bounding box
+               for ( unsigned k = 0 ; k < 4 ; k++ ) {
+                       if (includeCorners) {
+                               points->push_back(bbox->corner(k));
+                       }
+                       // optionally, collect the midpoints of the bounding box's edges too
+                       if (includeLineMidpoints) {
+                               points->push_back((bbox->corner(k) + bbox->corner((k+1) % 4))/2);
+                       }
+               }
+               if (includeObjectMidpoints) {
+                       points->push_back(bbox->midpoint());
+               }
+       }
+}
+
 /*
   Local Variables:
   mode:c++