Code

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