summaryrefslogtreecommitdiffstats
path: root/src/snapper.h
blob: 02f7cb7e96998e6892388c326526e281a2852cba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
#ifndef SEEN_SNAPPER_H
#define SEEN_SNAPPER_H

/**
 *    \file src/snapper.h
 *    \brief Snapper class.
 *
 *    Authors:
 *      Carl Hetherington <inkscape@carlh.net>
 *
 *    Released under GNU GPL, read the file 'COPYING' for more information.
 */

#include <map>
#include <list>
#include "libnr/nr-coord.h"
#include "libnr/nr-point.h"
#include "snapped-point.h"

struct SPNamedView;
struct SPItem;

namespace Inkscape
{

/// Parent for classes that can snap points to something
class Snapper
{
public:
    Snapper(SPNamedView const *nv, ::NR::Coord const d);
    virtual ~Snapper() {}

    /// Point types to snap.
    typedef int PointType;
    static const PointType SNAP_POINT;
    static const PointType BBOX_POINT;

    typedef std::pair<PointType, NR::Point> PointWithType;

    void setSnapTo(PointType t, bool s);
    void setDistance(::NR::Coord d);

    bool getSnapTo(PointType t) const;
    ::NR::Coord getDistance() const;

    bool willSnapSomething() const;

    SnappedPoint freeSnap(PointType t,
                          NR::Point const &p,
                          SPItem const *it) const;

    SnappedPoint freeSnap(PointType t,
                          NR::Point const &p,
                          std::list<SPItem const *> const &it) const;

    SnappedPoint constrainedSnap(PointType t,
                                 NR::Point const &p,
                                 NR::Point const &c,
                                 SPItem const *it) const;

    SnappedPoint constrainedSnap(PointType t,
                                 NR::Point const &p,
                                 NR::Point const &c,
                                 std::list<SPItem const *> const &it) const;
protected:
    SPNamedView const *_named_view;
    
private:

    /**
     *  Try to snap a point to whatever this snapper is interested in.  Any
     *  snap that occurs will be to the nearest "interesting" thing (e.g. a
     *  grid or guide line)
     *
     *  \param p Point to snap (desktop coordinates).
     *  \param it Items that should not be snapped to.
     *  \return Snapped point.
     */
    virtual SnappedPoint _doFreeSnap(NR::Point const &p,
                                     std::list<SPItem const *> const &it) const = 0;

    /**
     *  Try to snap a point to whatever this snapper is interested in, where
     *  the snap point is constrained to lie along a specified vector from the
     *  original point.
     *
     *  \param p Point to snap (desktop coordinates).
     *  \param c Vector to constrain the snap to.
     *  \param it Items that should not be snapped to.
     *  \return Snapped point.
     */    
    virtual SnappedPoint _doConstrainedSnap(NR::Point const &p,
                                            NR::Point const &c,
                                            std::list<SPItem const *> const &it) const = 0;
    
    ::NR::Coord _distance; ///< snap distance (desktop coordinates)
    int _snap_to; ///< bitmap of point types that we will snap to 
};

}

#endif /* !SEEN_SNAPPER_H */

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :