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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
/**
* \file snap-preferences.cpp
* \brief Storing of snapping preferences
*
* Authors:
* Diederik van Lierop <mail@diedenrezi.nl>
*
* Copyright (C) 2008 - 2011 Authors
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include "inkscape.h"
#include "snap-preferences.h"
#include <glib.h> // g_assert()
Inkscape::SnapPreferences::SnapPreferences() :
_snap_enabled_globally(true),
_snap_postponed_globally(false),
_strict_snapping(true)
{
// Check for powers of two; see the comments in snap-enums.h
g_assert((SNAPTARGET_BBOX_CATEGORY != 0) && !(SNAPTARGET_BBOX_CATEGORY & (SNAPTARGET_BBOX_CATEGORY - 1)));
g_assert((SNAPTARGET_NODE_CATEGORY != 0) && !(SNAPTARGET_NODE_CATEGORY & (SNAPTARGET_NODE_CATEGORY - 1)));
g_assert((SNAPTARGET_DATUMS_CATEGORY != 0) && !(SNAPTARGET_DATUMS_CATEGORY & (SNAPTARGET_DATUMS_CATEGORY - 1)));
g_assert((SNAPTARGET_OTHERS_CATEGORY != 0) && !(SNAPTARGET_OTHERS_CATEGORY & (SNAPTARGET_OTHERS_CATEGORY - 1)));
setSnapFrom(SnapSourceType(SNAPSOURCE_BBOX_CATEGORY | SNAPSOURCE_NODE_CATEGORY | SNAPSOURCE_DATUMS_CATEGORY | SNAPSOURCE_OTHERS_CATEGORY), true); //Snap any point. In v0.45 and earlier, this was controlled in the preferences tab
for (int n = 0; n < Inkscape::SNAPTARGET_MAX_ENUM_VALUE; n++) {
_active_snap_targets[n] = -1;
}
}
/*
* The snappers have too many parameters to adjust individually. Therefore only
* three snapping modes are presented to the user: snapping bounding box corners (to
* other bounding boxes, grids or guides), and/or snapping nodes (to other nodes,
* paths, grids or guides), and or snapping to/from others (e.g. grids, guide, text, etc)
* To select either of these three modes (or all), use the
* methods defined below: setSnapModeBBox(), setSnapModeNode(), or setSnapModeOthers()
*
* */
void Inkscape::SnapPreferences::setSnapModeBBox(bool enabled)
{
if (enabled) {
_snap_from = SnapSourceType(_snap_from | Inkscape::SNAPSOURCE_BBOX_CATEGORY);
} else {
_snap_from = SnapSourceType(_snap_from & ~Inkscape::SNAPSOURCE_BBOX_CATEGORY);
}
setTargetSnappable(SNAPTARGET_BBOX_CATEGORY, enabled);
}
bool Inkscape::SnapPreferences::getSnapModeBBox() const
{
return (_snap_from & Inkscape::SNAPSOURCE_BBOX_CATEGORY);
}
void Inkscape::SnapPreferences::setSnapModeNode(bool enabled)
{
if (enabled) {
_snap_from = SnapSourceType(_snap_from | Inkscape::SNAPSOURCE_NODE_CATEGORY);
} else {
_snap_from = SnapSourceType(_snap_from & ~Inkscape::SNAPSOURCE_NODE_CATEGORY);
}
setTargetSnappable(SNAPTARGET_NODE_CATEGORY, enabled);
}
bool Inkscape::SnapPreferences::getSnapModeNode() const
{
return (_snap_from & Inkscape::SNAPSOURCE_NODE_CATEGORY);
}
void Inkscape::SnapPreferences::setSnapModeOthers(bool enabled)
{
if (enabled) {
_snap_from = SnapSourceType(_snap_from | Inkscape::SNAPSOURCE_OTHERS_CATEGORY);
} else {
_snap_from = SnapSourceType(_snap_from & ~Inkscape::SNAPSOURCE_OTHERS_CATEGORY);
}
setTargetSnappable(SNAPTARGET_OTHERS_CATEGORY, enabled);
}
bool Inkscape::SnapPreferences::getSnapModeOthers() const
{
return (_snap_from & Inkscape::SNAPSOURCE_OTHERS_CATEGORY);
}
bool Inkscape::SnapPreferences::getSnapModeDatums() const
{
return isTargetSnappable(Inkscape::SNAPTARGET_GUIDE);
}
bool Inkscape::SnapPreferences::getSnapModeAny() const
{
return (_snap_from != 0);
}
/**
* Turn on/off snapping of specific point types.
* \param t Point type.
* \param s true to snap to this point type, otherwise false;
*/
void Inkscape::SnapPreferences::setSnapFrom(Inkscape::SnapSourceType t, bool s)
{
if (s) {
_snap_from = SnapSourceType(_snap_from | t);
} else {
_snap_from = SnapSourceType(_snap_from & ~t);
}
}
/**
* \param t Point type.
* \return true if snapper will snap this type of point, otherwise false.
*/
bool Inkscape::SnapPreferences::getSnapFrom(Inkscape::SnapSourceType t) const
{
return (_snap_from & t);
}
/**
* \brief Map snap target to array index.
*
* The status of each snap toggle (in the snap toolbar) is stored as a boolean value in an array. This method returns the position
* of relevant boolean in that array, for any given type of snap target. For most snap targets, the enumerated value of that targets
* matches the position in the array (primary snap targets). This however does not hold for snap targets which don't have their own
* toggle button (secondary snap targets).
*
* PS:
* - For snap sources, just pass the corresponding snap target instead (each snap source should have a twin snap target, but not vice versa)
* - All parameters are passed by reference, and will be overwritten
*
* \param target Stores the enumerated snap target, which can be modified to correspond to the array index of this snap target
* \param always_on If true, then this snap target is always active and cannot be toggled
* \param group_on If true, then this snap target is in a snap group that has been enabled (e.g. bbox group, nodes/paths group, or "others" group
*/
void Inkscape::SnapPreferences::_mapTargetToArrayIndex(Inkscape::SnapTargetType &target, bool &always_on, bool &group_on) const
{
if (target & SNAPTARGET_BBOX_CATEGORY) {
group_on = getSnapModeBBox(); // Only if the group with bbox sources/targets has been enabled, then we might snap to any of the bbox targets
} else if (target & SNAPTARGET_NODE_CATEGORY) {
group_on = getSnapModeNode(); // Only if the group with path/node sources/targets has been enabled, then we might snap to any of the nodes/paths
if (target == SNAPTARGET_RECT_CORNER) {
target = SNAPTARGET_NODE_CUSP;
} else if (target == SNAPTARGET_ELLIPSE_QUADRANT_POINT) {
target = SNAPTARGET_NODE_SMOOTH;
}
} else if (target & SNAPTARGET_DATUMS_CATEGORY) {
group_on = true; // These snap targets cannot be disabled as part of a disabled group;
switch (target) {
// Some snap targets don't have their own toggle. These targets are called "secondary targets". We will re-map
// them to their cousin which does have a toggle, and which is called a "primary target"case SNAPTARGET_GRID_INTERSECTION:
case SNAPTARGET_GRID_INTERSECTION:
target = SNAPTARGET_GRID;
break;
case SNAPTARGET_GUIDE_INTERSECTION:
case SNAPTARGET_GUIDE_ORIGIN:
target = SNAPTARGET_GUIDE;
break;
case SNAPTARGET_PAGE_CORNER:
target = SNAPTARGET_PAGE_BORDER;
break;
// Some snap targets cannot be toggled at all, and are therefore always enabled
case SNAPTARGET_GRID_GUIDE_INTERSECTION:
always_on = true; // Doesn't have it's own button
break;
// These are only listed for completeness
case SNAPTARGET_GRID:
case SNAPTARGET_GUIDE:
case SNAPTARGET_PAGE_BORDER:
case SNAPTARGET_DATUMS_CATEGORY:
break;
default:
g_warning("Snap-preferences warning: Undefined snap target (#%i)", target);
break;
}
} else if (target & SNAPTARGET_OTHERS_CATEGORY) {
// Only if the group with "other" snap sources/targets has been enabled, then we might snap to any of those targets
// ... but this doesn't hold for the page border, grids, and guides
group_on = getSnapModeOthers();
switch (target) {
// Some snap targets don't have their own toggle. These targets are called "secondary targets". We will re-map
// them to their cousin which does have a toggle, and which is called a "primary target"
case SNAPTARGET_TEXT_ANCHOR:
target = SNAPTARGET_TEXT_BASELINE;
break;
case SNAPTARGET_IMG_CORNER: // Doesn't have its own button, on if the group is on
target = SNAPTARGET_OTHERS_CATEGORY;
break;
// Some snap targets cannot be toggled at all, and are therefore always enabled
case SNAPTARGET_CONSTRAINED_ANGLE:
case SNAPTARGET_CONSTRAINT:
always_on = true; // Doesn't have it's own button
break;
// These are only listed for completeness
case SNAPTARGET_OBJECT_MIDPOINT:
case SNAPTARGET_ROTATION_CENTER:
case SNAPTARGET_TEXT_BASELINE:
case SNAPTARGET_OTHERS_CATEGORY:
break;
default:
g_warning("Snap-preferences warning: Undefined snap target (#%i)", target);
break;
}
} else if (target == SNAPTARGET_UNDEFINED ) {
g_warning("Snap-preferences warning: Undefined snaptarget (#%i)", target);
}
}
void Inkscape::SnapPreferences::setTargetSnappable(Inkscape::SnapTargetType const target, bool enabled)
{
bool always_on = false;
bool group_on = false; // Only needed as a dummy
Inkscape::SnapTargetType index = target;
_mapTargetToArrayIndex(index, always_on, group_on);
if (always_on) { // If true, then this snap target is always active and cannot be toggled
// Catch coding errors
g_warning("Snap-preferences warning: Trying to enable/disable a snap target (#%i) that's always on by definition", index);
} else {
if (index == target) { // I.e. if it has not been re-mapped, then we have a primary target at hand
_active_snap_targets[index] = enabled;
} else { // If it has been re-mapped though, then this target does not have its own toggle button and should therefore not be set
g_warning("Snap-preferences warning: Trying to enable/disable a secondary snap target (#%i); only primary targets can be set", index);
}
}
}
bool Inkscape::SnapPreferences::isTargetSnappable(Inkscape::SnapTargetType const target) const
{
bool always_on = false;
bool group_on = false;
Inkscape::SnapTargetType index = target;
_mapTargetToArrayIndex(index, always_on, group_on);
if (group_on) { // If true, then this snap target is in a snap group that has been enabled (e.g. bbox group, nodes/paths group, or "others" group
if (always_on) { // If true, then this snap target is always active and cannot be toggled
return true;
} else {
if (_active_snap_targets[index] == -1) {
// Catch coding errors
g_warning("Snap-preferences warning: Using an uninitialized snap target setting (#%i)", index);
}
return _active_snap_targets[index];
}
} else {
return false;
}
}
bool Inkscape::SnapPreferences::isTargetSnappable(Inkscape::SnapTargetType const target1, Inkscape::SnapTargetType const target2) const {
return isTargetSnappable(target1) || isTargetSnappable(target2);
}
bool Inkscape::SnapPreferences::isTargetSnappable(Inkscape::SnapTargetType const target1, Inkscape::SnapTargetType const target2, Inkscape::SnapTargetType const target3) const {
return isTargetSnappable(target1) || isTargetSnappable(target2) || isTargetSnappable(target3);
}
bool Inkscape::SnapPreferences::isTargetSnappable(Inkscape::SnapTargetType const target1, Inkscape::SnapTargetType const target2, Inkscape::SnapTargetType const target3, Inkscape::SnapTargetType const target4) const {
return isTargetSnappable(target1) || isTargetSnappable(target2) || isTargetSnappable(target3) || isTargetSnappable(target4);
}
bool Inkscape::SnapPreferences::isTargetSnappable(Inkscape::SnapTargetType const target1, Inkscape::SnapTargetType const target2, Inkscape::SnapTargetType const target3, Inkscape::SnapTargetType const target4, Inkscape::SnapTargetType const target5) const {
return isTargetSnappable(target1) || isTargetSnappable(target2) || isTargetSnappable(target3) || isTargetSnappable(target4) || isTargetSnappable(target5);
}
bool Inkscape::SnapPreferences::isSnapButtonEnabled(Inkscape::SnapTargetType const target) const
{
bool always_on = false; // Only needed as a dummy
bool group_on = false; // Only needed as a dummy
Inkscape::SnapTargetType index = target;
_mapTargetToArrayIndex(index, always_on, group_on);
if (_active_snap_targets[index] == -1) {
// Catch coding errors
g_warning("Snap-preferences warning: Using an uninitialized snap target setting (#%i)", index);
} else {
if (index == target) { // I.e. if it has not been re-mapped, then we have a primary target at hand, which does have its own toggle button
return _active_snap_targets[index];
} else { // If it has been re-mapped though, then this target does not have its own toggle button and therefore the button status cannot be read
g_warning("Snap-preferences warning: Trying to determine the button status of a secondary snap target (#%i); However, only primary targets have a button", index);
}
}
return false;
}
/*
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:fileencoding=utf-8:textwidth=99 :
|