src/snapped-point.cpp

   1 /**
   2  *  \file src/snapped-point.cpp
   3  *  \brief SnappedPoint class.
   4  *
   5  *  Authors:
   6  *    Mathieu Dimanche <mdimanche@free.fr>
   7  *    Diederik van Lierop <mail@diedenrezi.nl>
   8  *
   9  *  Released under GNU GPL, read the file 'COPYING' for more information.
  10  */
  11
  12 #include <gtk/gtk.h>
  13 #include "snapped-point.h"
  14 #include "preferences.h"
  15
  16 // overloaded constructor
  17 Inkscape::SnappedPoint::SnappedPoint(Geom::Point const &p, SnapTargetType const &target, Geom::Coord const &d, Geom::Coord const &t, bool const &a, bool const &fully_constrained)
  18     : _point(p), _target(target), _distance(d), _tolerance(std::max(t,1.0)), _always_snap(a)
  19 {
  20     // tolerance should never be smaller than 1 px, as it is used for normalization in isOtherSnapBetter. We don't want a division by zero.
  21     _at_intersection = false;
  22     _fully_constrained = fully_constrained;
  23     _second_distance = NR_HUGE;
  24     _second_tolerance = 1;
  25     _second_always_snap = false;
  26     _transformation = Geom::Point(1,1);
  27     _pointer_distance = NR_HUGE;
  28 }
  29
  30 Inkscape::SnappedPoint::SnappedPoint(Geom::Point const &p, SnapTargetType const &target, Geom::Coord const &d, Geom::Coord const &t, bool const &a, bool const &at_intersection, bool const &fully_constrained, Geom::Coord const &d2, Geom::Coord const &t2, bool const &a2)
  31     : _point(p), _target(target), _at_intersection(at_intersection), _fully_constrained(fully_constrained), _distance(d), _tolerance(std::max(t,1.0)), _always_snap(a),
  32     _second_distance(d2), _second_tolerance(std::max(t2,1.0)), _second_always_snap(a2)
  33 {
  34     // tolerance should never be smaller than 1 px, as it is used for normalization in
  35     // isOtherSnapBetter. We don't want a division by zero.
  36     _transformation = Geom::Point(1,1);
  37     _pointer_distance = NR_HUGE;
  38 }
  39
  40 Inkscape::SnappedPoint::SnappedPoint()
  41 {
  42     _point = Geom::Point(0,0);
  43     _target = SNAPTARGET_UNDEFINED,
  44     _at_intersection = false;
  45     _fully_constrained = false;
  46     _distance = NR_HUGE;
  47     _tolerance = 1;
  48     _always_snap = false;
  49     _second_distance = NR_HUGE;
  50     _second_tolerance = 1;
  51     _second_always_snap = false;
  52     _transformation = Geom::Point(1,1);
  53     _pointer_distance = NR_HUGE;
  54 }
  55
  56 Inkscape::SnappedPoint::~SnappedPoint()
  57 {
  58 }
  59
  60 void Inkscape::SnappedPoint::getPoint(Geom::Point &p) const
  61 {
  62     // When we have snapped
  63     if (getSnapped()) {
  64         // then return the snapped point by overwriting p
  65         p = _point;
  66     } //otherwise p will be left untouched; this way the caller doesn't have to check wether we've snapped
  67 }
  68
  69 // search for the closest snapped point
  70 bool getClosestSP(std::list<Inkscape::SnappedPoint> &list, Inkscape::SnappedPoint &result)
  71 {
  72     bool success = false;
  73
  74     for (std::list<Inkscape::SnappedPoint>::const_iterator i = list.begin(); i != list.end(); i++) {
  75         if ((i == list.begin()) || (*i).getSnapDistance() < result.getSnapDistance()) {
  76             result = *i;
  77             success = true;
  78         }
  79     }
  80
  81     return success;
  82 }
  83
  84 bool Inkscape::SnappedPoint::isOtherSnapBetter(Inkscape::SnappedPoint const &other_one, bool weighted) const
  85 {
  86
  87     double dist_other = other_one.getSnapDistance();
  88     double dist_this = getSnapDistance();
  89
  90     // The distance to the pointer should only be taken into account when finding the best snapped source node (when
  91     // there's more than one). It is not useful when trying to find the best snapped target point.
  92     // (both the snap distance and the pointer distance are measured in document pixels, not in screen pixels)
  93     if (weighted) {
  94         // Weight factor: controls which node should be preferred for snapping, which is either
  95         // the node with the closest snap (w = 0), or the node closest to the mousepointer (w = 1)
  96         Inkscape::Preferences *prefs = Inkscape::Preferences::get();
  97         double w = prefs->getDoubleLimited("/options/snapweight/value", 0.5, 0, 1);
  98         if (prefs->getBool("/options/snapclosestonly/value", false)) {
  99             w = 1;
 100         }
 101         if (w > 0) {
 102             // When accounting for the distance to the mouse pointer, then at least one of the snapped points should
 103             // have that distance set. If not, then this is a bug. Either "weighted" must be set to false, or the
 104             // mouse pointer distance must be set.
 105             g_assert(getPointerDistance() != NR_HUGE || other_one.getPointerDistance() != NR_HUGE);
 106             // The snap distance will always be smaller than the tolerance set for the snapper. The pointer distance can
 107             // however be very large. To compare these in a fair way, we will have to normalize these metrics first
 108             // The closest pointer distance will be normalized to 1.0; the other one will be > 1.0
 109             // The snap distance will be normalized to 1.0 if it's equal to the snapper tolerance
 110             double const norm_p = std::min(getPointerDistance(), other_one.getPointerDistance());
 111             double const norm_t_other = std::min(50.0, other_one.getTolerance());
 112             double const norm_t_this = std::min(50.0, getTolerance());
 113             dist_other = w * other_one.getPointerDistance() / norm_p + (1-w) * dist_other / norm_t_other;
 114             dist_this = w * getPointerDistance() / norm_p + (1-w) * dist_this / norm_t_this;
 115         }
 116     }
 117
 118     // If it's closer
 119     bool c1 = dist_other < dist_this;
 120     // or, if it's for a snapper with "always snap" turned on, and the previous wasn't
 121     bool c2 = other_one.getAlwaysSnap() && !getAlwaysSnap();
 122     // But in no case fall back from a snapper with "always snap" on to one with "always snap" off
 123     bool c2n = !other_one.getAlwaysSnap() && getAlwaysSnap();
 124     // or, if we have a fully constrained snappoint (e.g. to a node or an intersection), while the previous one was only partly constrained (e.g. to a line)
 125     bool c3 = other_one.getFullyConstrained() && !getFullyConstrained();
 126     // But in no case fall back; (has less priority than c3n, so it is allowed to fall back when c3 is true, see below)
 127     bool c3n = !other_one.getFullyConstrained() && getFullyConstrained();
 128     // or, if it's just as close then consider the second distance
 129     bool c4a = (dist_other == dist_this);
 130     bool c4b = other_one.getSecondSnapDistance() < getSecondSnapDistance();
 131
 132     // std::cout << other_one.getPoint() << " (Other one) vs. " << getPoint() << " (this one) ---> ";
 133     // std::cout << "c1 = " << c1 << " | c2 = " << c2 << " | c2n = " << c2n << " | c3 = " << c3 << " | c3n = " << c3n << " | c4a = " << c4a << " | c4b = " << c4b << std::endl;
 134     return (c1 || c2 || c3 || (c4a && c4b)) && !c2n && (!c3n || c2);
 135 }
 136
 137 /*
 138   Local Variables:
 139   mode:c++
 140   c-file-style:"stroustrup"
 141   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 142   indent-tabs-mode:nil
 143   fill-column:99
 144   End:
 145 */
 146 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :