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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/* This file is part of the KDE project
* Copyright (C) 2008-2009 Jan Hambrecht <jaham@gmx.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KOSNAPGUIDE_H
#define KOSNAPGUIDE_H
#include "flake_export.h"
#include <KoPathSegment.h>
#include <QPointF>
#include <QList>
#include <QRectF>
#include <QPainterPath>
class KoSnapStrategy;
class KoShape;
class KoPathPoint;
class KoViewConverter;
class KoCanvasBase;
class QPainter;
class KoCanvasBase;
/**
* This class is the place where all the snapping (i.e. snap to grid) is handled.
*
* What this class does is snapping a given position (i.e. mouse position) to various
* snapping targets like grid, boundbox etc.
* The snap guide does not know anything about the specific snapping target. This
* is handled by the different snapping strategies which are derived from KoSnapStrategy.
* Snapping strategies can be enabled/disabled by passing a mask of corresponding
* snapping ids to KoSnapGuide::enableSnapStrategies. There can be one or more snapping
* strategies enabled at the same time. The best result (with the nearest distance to the
* original position) is then returned to the caller of KoSnapGuide::snap.
*
* The snap guide is part of the KoCanvasBase class and thus can be accessed by any tool
* or application via the canvas pointer.
* For letting the user manage which snap stratgies to enable, there is a snap guide config
* widget in guiutils.
*
*/
class FLAKE_EXPORT KoSnapGuide
{
public:
/// the different possible snap Strategies
enum Strategy
{
OrthogonalSnapping = 1,
NodeSnapping = 2,
ExtensionSnapping = 4,
IntersectionSnapping = 8,
GridSnapping = 0x10,
BoundingBoxSnapping = 0x20,
GuideLineSnapping = 0x40,
CustomSnapping = 0x80
};
Q_DECLARE_FLAGS(Strategies, Strategy)
/// Creates the snap guide to work on the given canvas
KoSnapGuide(KoCanvasBase *canvas);
virtual ~KoSnapGuide();
/// snaps the mouse position, returns if mouse was snapped
QPointF snap(const QPointF &mousePosition, Qt::KeyboardModifiers modifiers);
/// paints the guide
void paint(QPainter &painter, const KoViewConverter &converter);
/// returns the bounding rect of the guide
QRectF boundingRect();
/// Adds an additional shape to snap to (useful when creating a path)
void setEditedShape(KoShape *shape);
/// returns the extra shapes to use
KoShape *editedShape() const;
/// enables the strategies used for snapping
void enableSnapStrategies(Strategies strategies);
/// returns the enabled snap strategies
KoSnapGuide::Strategies enabledSnapStrategies() const;
/**
* Adds a custom snap strategy
*
* The snap guide take ownership of the strategy. All custom strategies
* are destroyed when calling reset().
*/
bool addCustomSnapStrategy(KoSnapStrategy *customStrategy);
/// enables the snapping guides
void enableSnapping(bool on);
/// returns if snapping is enabled
bool isSnapping() const;
/// sets the snap distances in pixels
void setSnapDistance(int distance);
/// returns the snap distance in pixels
int snapDistance() const;
/// returns the canvas the snap guide is working on
KoCanvasBase *canvas() const;
/// Sets a list of path points to ignore
void setIgnoredPathPoints(const QList<KoPathPoint*> &ignoredPoints);
/// Returns list of ignored points
QList<KoPathPoint*> ignoredPathPoints() const;
/// Sets list of ignored shapes
void setIgnoredShapes(const QList<KoShape*> &ignoredShapes);
/// Returns list of ignored shapes
QList<KoShape*> ignoredShapes() const;
/// Resets the snap guide
void reset();
private:
class Private;
Private * const d;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KoSnapGuide::Strategies)
#endif // KOSNAPGUIDE_H
|
