src/snapped-point.h

   1 #ifndef SEEN_SNAPPEDPOINT_H
   2 #define SEEN_SNAPPEDPOINT_H
   3
   4 /**
   5  *    \file src/snapped-point.h
   6  *    \brief SnappedPoint class.
   7  *
   8  *    Authors:
   9  *      Mathieu Dimanche <mdimanche@free.fr>
  10  *      Diederik van Lierop <mail@diedenrezi.nl>
  11  *
  12  *    Released under GNU GPL, read the file 'COPYING' for more information.
  13  */
  14
  15 #include <vector>
  16 #include <list>
  17 #include <libnr/nr-values.h> //Because of NR_HUGE
  18 #include <2geom/geom.h>
  19
  20 namespace Inkscape
  21 {
  22
  23 enum SnapTargetType {
  24     SNAPTARGET_UNDEFINED = 0,
  25     SNAPTARGET_GRID,
  26     SNAPTARGET_GRID_INTERSECTION,
  27     SNAPTARGET_GUIDE,
  28     SNAPTARGET_GUIDE_INTERSECTION,
  29     SNAPTARGET_GUIDE_ORIGIN,
  30     SNAPTARGET_GRID_GUIDE_INTERSECTION,
  31     SNAPTARGET_NODE_SMOOTH,
  32     SNAPTARGET_NODE_CUSP,
  33     SNAPTARGET_LINE_MIDPOINT,
  34     SNAPTARGET_OBJECT_MIDPOINT,
  35     SNAPTARGET_ROTATION_CENTER,
  36     SNAPTARGET_HANDLE,
  37     SNAPTARGET_PATH,
  38     SNAPTARGET_PATH_INTERSECTION,
  39     SNAPTARGET_BBOX_CORNER,
  40     SNAPTARGET_BBOX_EDGE,
  41     SNAPTARGET_BBOX_EDGE_MIDPOINT,
  42     SNAPTARGET_BBOX_MIDPOINT,
  43     SNAPTARGET_GRADIENTS_PARENT_BBOX,
  44     SNAPTARGET_PAGE_BORDER,
  45     SNAPTARGET_PAGE_CORNER,
  46     SNAPTARGET_CONVEX_HULL_CORNER,
  47     SNAPTARGET_ELLIPSE_QUADRANT_POINT,
  48     SNAPTARGET_CENTER, // of ellipse
  49     SNAPTARGET_CORNER, // of image or of rectangle
  50     SNAPTARGET_TEXT_BASELINE
  51 };
  52
  53 enum SnapSourceType {
  54     SNAPSOURCE_UNDEFINED = 0,
  55     SNAPSOURCE_BBOX_CORNER,
  56     SNAPSOURCE_BBOX_MIDPOINT,
  57     SNAPSOURCE_BBOX_EDGE_MIDPOINT,
  58     SNAPSOURCE_NODE_SMOOTH,
  59     SNAPSOURCE_NODE_CUSP,
  60     SNAPSOURCE_LINE_MIDPOINT,
  61     SNAPSOURCE_OBJECT_MIDPOINT,
  62     SNAPSOURCE_ROTATION_CENTER,
  63     SNAPSOURCE_HANDLE,
  64     SNAPSOURCE_PATH_INTERSECTION,
  65     SNAPSOURCE_GUIDE,
  66     SNAPSOURCE_GUIDE_ORIGIN,
  67     SNAPSOURCE_CONVEX_HULL_CORNER,
  68     SNAPSOURCE_ELLIPSE_QUADRANT_POINT,
  69     SNAPSOURCE_CENTER, // of ellipse
  70     SNAPSOURCE_CORNER, // of image or of rectangle
  71     SNAPSOURCE_TEXT_BASELINE
  72 };
  73
  74
  75 /// Class describing the result of an attempt to snap.
  76 class SnappedPoint
  77 {
  78
  79 public:
  80     SnappedPoint();
  81     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 &fully_constrained, Geom::Coord const &d2, Geom::Coord const &t2, bool const &a2);
  82     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 &fully_constrained);
  83     ~SnappedPoint();
  84
  85     Geom::Coord getSnapDistance() const {return _distance;}
  86     void setSnapDistance(Geom::Coord const d) {_distance = d;}
  87     Geom::Coord getTolerance() const {return _tolerance;}
  88     bool getAlwaysSnap() const {return _always_snap;}
  89     Geom::Coord getSecondSnapDistance() const {return _second_distance;}
  90     void setSecondSnapDistance(Geom::Coord const d) {_second_distance = d;}
  91     Geom::Coord getSecondTolerance() const {return _second_tolerance;}
  92     bool getSecondAlwaysSnap() const {return _second_always_snap;}
  93     Geom::Coord getPointerDistance() const {return _pointer_distance;}
  94     void setPointerDistance(Geom::Coord const d) {_pointer_distance = d;}
  95
  96     /* This is the preferred method to find out which point we have snapped
  97      * to, because it only returns a point if snapping has actually occurred
  98      * (by overwriting p)
  99      */
 100     void getPoint(Geom::Point &p) const;
 101
 102     /* This method however always returns a point, even if no snapping
 103      * has occurred; A check should be implemented in the calling code
 104      * to check for snapping. Use this method only when really needed, e.g.
 105      * when the calling code is trying to snap multiple points and must
 106      * determine itself which point is most appropriate
 107      */
 108     Geom::Point getPoint() const {return _point;}
 109
 110     bool getAtIntersection() const {return _at_intersection;}
 111     bool getFullyConstrained() const {return _fully_constrained;}
 112     bool getSnapped() const {return _distance < NR_HUGE;}
 113     Geom::Point getTransformation() const {return _transformation;}
 114     void setTransformation(Geom::Point const t) {_transformation = t;}
 115     void setTarget(SnapTargetType const target) {_target = target;}
 116     SnapTargetType getTarget() const {return _target;}
 117     void setSource(SnapSourceType const source) {_source = source;}
 118     SnapSourceType getSource() const {return _source;}
 119     long getSourceNum() const {return _source_num;}
 120
 121     bool isOtherSnapBetter(SnappedPoint const &other_one, bool weighted) const;
 122
 123     /*void dump() const {
 124         std::cout << "_point              = " << _point << std::endl;
 125         std::cout << "_source             = " << _source << std::endl;
 126         std::cout << "_source_num         = " << _source_num << std::endl;
 127         std::cout << "_target             = " << _target << std::endl;
 128         std::cout << "_at_intersection    = " << _at_intersection << std::endl;
 129         std::cout << "_fully_constrained  = " << _fully_constrained << std::endl;
 130         std::cout << "_distance           = " << _distance << std::endl;
 131         std::cout << "_tolerance          = " << _tolerance << std::endl;
 132         std::cout << "_always_snap        = " << _always_snap << std::endl;
 133         std::cout << "_second_distance    = " << _second_distance << std::endl;
 134         std::cout << "_second_tolerance   = " << _second_tolerance << std::endl;
 135         std::cout << "_second_always_snap = " << _second_always_snap << std::endl;
 136         std::cout << "_transformation     = " << _transformation << std::endl;
 137         std::cout << "_pointer_distance   = " << _pointer_distance << std::endl;
 138     }*/
 139
 140 protected:
 141     Geom::Point _point; // Location of the snapped point
 142     SnapSourceType _source; // Describes what snapped
 143     long _source_num; // Sequence number of the source point that snapped, if that point is part of a set of points. (starting at zero)
 144     SnapTargetType _target; // Describes to what we've snapped to
 145     bool _at_intersection; // If true, the snapped point is at an intersection
 146     bool _fully_constrained; // When snapping for example to a node, then the snap will be "fully constrained".
 147                             // When snapping to a line however, the snap is only partly constrained (i.e. only in one dimension)
 148
 149     /* Distance from original point to snapped point. If the snapped point is at
 150        an intersection of e.g. two lines, then this is the distance to the closest
 151        line */
 152     Geom::Coord _distance;
 153     /* The snapping tolerance in screen pixels (depends on zoom)*/
 154     Geom::Coord _tolerance;
 155     /* If true then "Always snap" is on */
 156     bool _always_snap;
 157
 158     /* If the snapped point is at an intersection of e.g. two lines, then this is
 159        the distance to the farthest line */
 160     Geom::Coord _second_distance;
 161     /* The snapping tolerance in screen pixels (depends on zoom)*/
 162     Geom::Coord _second_tolerance;
 163     /* If true then "Always snap" is on */
 164     bool _second_always_snap;
 165     /* The transformation (translation, scale, skew, or stretch) from the original point to the snapped point */
 166     Geom::Point _transformation;
 167     /* Distance from the un-transformed point to the mouse pointer, measured at the point in time when dragging started */
 168     Geom::Coord _pointer_distance;
 169 };
 170
 171 }// end of namespace Inkscape
 172
 173 bool getClosestSP(std::list<Inkscape::SnappedPoint> &list, Inkscape::SnappedPoint &result);
 174
 175 #endif /* !SEEN_SNAPPEDPOINT_H */
 176
 177 /*
 178   Local Variables:
 179   mode:c++
 180   c-file-style:"stroustrup"
 181   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 182   indent-tabs-mode:nil
 183   fill-column:99
 184   End:
 185 */
 186 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :