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
|
# Authors: see git history
#
# Copyright (c) 2010 Authors
# Licensed under the GNU GPL version 3.0 or later. See the file LICENSE for details.
import inkex
from ..elements import EmptyDObject, SatinColumn, Stroke
from ..i18n import _
from ..svg.tags import ORIGINAL_D, PATH_EFFECT, SODIPODI_NODETYPES
from .base import InkstitchExtension
class StrokeToLpeSatin(InkstitchExtension):
"""Convert a satin column into a running stitch."""
def __init__(self, *args, **kwargs):
InkstitchExtension.__init__(self, *args, **kwargs)
self.arg_parser.add_argument("--lpe_satin", type=str, default=None)
self.arg_parser.add_argument("--options", type=str, default=None)
self.arg_parser.add_argument("--info", type=str, default=None)
self.arg_parser.add_argument("-p", "--pattern", type=str, default="normal", dest="pattern")
self.arg_parser.add_argument("-i", "--min-width", type=float, default=1.5, dest="min_width")
self.arg_parser.add_argument("-a", "--max-width", type=float, default=7, dest="max_width")
self.arg_parser.add_argument("-l", "--length", type=float, default=15, dest="length")
self.arg_parser.add_argument("-t", "--stretched", type=inkex.Boolean, default=False, dest="stretched")
self.arg_parser.add_argument("-r", "--rungs", type=inkex.Boolean, default=False, dest="add_rungs")
self.arg_parser.add_argument("-s", "--path-specific", type=inkex.Boolean, default=True, dest="path_specific")
def effect(self):
if not self.svg.selection or not self.get_elements():
inkex.errormsg(_("Please select at least one stroke."))
return
if not any((isinstance(item, Stroke) or isinstance(item, SatinColumn)) for item in self.elements):
# L10N: Convert To Satin extension, user selected one or more objects that were not lines.
if any(isinstance(item, EmptyDObject) for item in self.elements):
inkex.errormsg(_("This element has lost its path information. Please move the element slightly back and forth before you try again."))
else:
inkex.errormsg(_("Please select at least one stroke to convert to a satin column."))
return
pattern = self.options.pattern
if pattern not in satin_patterns:
inkex.errormsg(_("Could not find the specified pattern."))
return
# convert user input values to the units of the current svg
min_width = inkex.units.convert_unit(str(max(self.options.min_width, 0.5)) + 'mm', self.svg.unit)
max_width = inkex.units.convert_unit(str(max(self.options.max_width, 0.5)) + 'mm', self.svg.unit)
length = inkex.units.convert_unit(str(self.options.length) + 'mm', self.svg.unit)
# get pattern path and nodetypes
pattern_obj = satin_patterns[pattern]
pattern_path = pattern_obj.get_path(self.options.add_rungs, min_width, max_width, length, self.svg.unit)
pattern_node_type = pattern_obj.node_types
copy_type = 'repeated' if self.options.stretched is False else 'repeated_stretched'
if not self.options.path_specific:
lpe = self._create_lpe_element(pattern, pattern_path, pattern_node_type, copy_type)
for element in self.elements:
if self.options.path_specific:
lpe = self._create_lpe_element(pattern, pattern_path, pattern_node_type, copy_type, element)
if isinstance(element, SatinColumn):
self._process_satin_column(element, lpe, pattern_path, copy_type)
elif isinstance(element, Stroke):
self._process_stroke(element, lpe)
def _create_lpe_element(self, pattern, pattern_path, pattern_node_type, copy_type, element=None):
# define id for the lpe path
if not element:
lpe_id = f'inkstitch-effect-{pattern}'
else:
lpe_id = f'inkstitch-effect-{pattern}-{element.id}'
# it is possible, that there is already a path effect with this id, if so, use it
previous_lpe = self.svg.getElementById(lpe_id)
if previous_lpe is not None:
return previous_lpe
lpe = inkex.PathEffect(attrib={'id': lpe_id,
'effect': "skeletal",
'is_visible': "true",
'lpeversion': "1",
'pattern': pattern_path,
'copytype': copy_type,
'prop_scale': "1",
'scale_y_rel': "false",
'spacing': "0",
'normal_offset': "0",
'tang_offset': "0",
'prop_units': "false",
'vertical_pattern': "false",
'hide_knot': "false",
'fuse_tolerance': "0.2",
'pattern-nodetypes': pattern_node_type})
# add the path effect element to the defs section
self.svg.defs.add(lpe)
return lpe
def _process_stroke(self, element, lpe):
element = self._ensure_path_element(element, lpe)
previous_effects = element.node.get(PATH_EFFECT, None)
if not previous_effects:
element.node.set(PATH_EFFECT, lpe.get_id(as_url=1))
element.node.set(ORIGINAL_D, element.node.get('d', ''))
else:
url = previous_effects + ';' + lpe.get_id(as_url=1)
element.node.set(PATH_EFFECT, url)
element.node.pop('d')
element.set_param('satin_column', 'true')
element.node.style['stroke-width'] = self.svg.viewport_to_unit('0.756')
def _ensure_path_element(self, element, lpe):
# elements other than paths (rectangle, circles, etc.) can be handled by inkscape for lpe
# but they are way easier to handle for us if we turn them into paths
if element.node.TAG == 'path':
return element
path_element = element.node.to_path_element()
parent = element.node.getparent()
parent.replace(element.node, path_element)
return Stroke(path_element)
def _process_satin_column(self, element, lpe, pattern_path, copy_type):
current_effects = element.node.get(PATH_EFFECT, None)
# there are possibly multiple path effects, let's check if inkstitch-effect is among them
if not current_effects or 'inkstitch-effect' not in current_effects:
# it wouldn't make sense to apply it to a normal satin column without the inkstitch-effect
inkex.errormsg(_('Cannot convert a satin column into a live path effect satin. Please select a stroke.'))
return
# get the inkstitch effect
current_effects = current_effects.split(';')
inkstitch_effect_position = [i for i, effect in enumerate(current_effects) if 'inkstitch-effect' in effect][0]
inkstitch_effect = current_effects[inkstitch_effect_position][1:]
old_effect_element = self.svg.getElementById(inkstitch_effect)
old_pattern_type = inkstitch_effect[17:]
# update pattern if it is equal to the previous pattern
if not self.options.path_specific and old_pattern_type == self.options.pattern:
old_effect_element.set('pattern', pattern_path)
old_effect_element.set('copytype', copy_type)
element.node.pop('d')
return
# remove the old inkstitch-effect if it was path specific
if inkstitch_effect.endswith(element.id):
if old_pattern_type.startswith(self.options.pattern) and self.options.path_specific:
old_effect_element.set('pattern', pattern_path)
old_effect_element.set('copytype', copy_type)
else:
old_effect_element.getparent().remove(old_effect_element)
# update path effect link
current_effects[inkstitch_effect_position] = lpe.get_id(as_url=1)
element.node.set(PATH_EFFECT, ';'.join(current_effects))
element.node.pop('d')
class SatinPattern:
def __init__(self, path=None, node_types=None, flip=True, rung_node=1):
self.path: str = path
self.node_types: str = node_types
self.flip: bool = flip
self.rung_node: int = rung_node
def get_path(self, add_rungs, min_width, max_width, length, to_unit):
# scale the pattern path to fit the unit of the current svg
scale_factor = 1 / inkex.units.convert_unit('1mm', f'{to_unit}')
pattern_path = inkex.Path(self.path).transform(inkex.Transform(f'scale({scale_factor})'), True)
# create a path element
el1 = inkex.PathElement(attrib={'d': str(pattern_path),
SODIPODI_NODETYPES: self.node_types})
# transform to fit user input size values
bbox = el1.bounding_box()
scale_x = length / max(bbox.width, 0.1)
if bbox.height == 0:
scale_y = 1
else:
scale_y = (max_width - min_width) / (bbox.height * 2)
el1.transform = inkex.Transform(f'scale({scale_x}, {scale_y})')
el1.apply_transform()
path1 = el1.get_path()
# copy first path and (optionally) flip it to generate the second satin rail
el2 = el1.copy()
if self.flip:
el2.transform = inkex.Transform(f'scale(1, -1) translate(0, {min_width})')
else:
el2.transform = inkex.Transform(f'translate(0, {-min_width})')
el2.apply_transform()
path2 = el2.get_path()
# setup a rung
point1 = list(path1.end_points)[self.rung_node]
point2 = list(path2.end_points)[self.rung_node]
rungs = ''
if add_rungs:
rungs = f' M {point1[0]} {point1[1] + 0.1} L {point2[0]} {point2[1] - 0.2}'
return str(path1) + str(path2) + rungs
satin_patterns = {'normal': SatinPattern('M 0,0 H 4 H 8', 'cc'),
'pearl': SatinPattern('M 0,0 C 0,0.22 0.18,0.4 0.4,0.4 0.62,0.4 0.8,0.22 0.8,0', 'csc'),
'diamond': SatinPattern('M 0,0 0.4,0.2 0.8,0', 'ccc'),
'triangle': SatinPattern('M 0,0 0.4,0.1 0.78,0.2 0.8,0', 'cccc'),
'square': SatinPattern('M 0,0 H 0.2 0.4 L 0.47,0.2 H 0.8 L 0.86,0', 'ccccc'),
'wave': SatinPattern('M 0,0 C 0.2,0.01 0.29,0.2 0.4,0.2 0.51,0.2 0.58,0.01 0.8,0', 'cac'),
'arch': SatinPattern('M 0,0.25 C 0,0.25 0.07,0.05 0.4,0.05 0.7,0.05 0.8,0.25 0.8,0.25', 'czcczc', False)}
|
