summaryrefslogtreecommitdiff
path: root/lib/stitch_plan/lock_stitch.py
blob: ba0e5ba7bca9ebc5c8c0ffa0bf1f25267afb25d0 (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
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
import re
from copy import copy
from math import degrees

from inkex import DirectedLineSegment, Path
from shapely.geometry import LineString
from shapely.ops import substring

from ..i18n import _
from ..svg import PIXELS_PER_MM
from ..utils import string_to_floats
from .stitch import Stitch


class LockStitchDefinition:
    def __init__(self, lock_id=None, name=None, path=None):
        self.id: str = lock_id
        self.name: str = name
        self._path: str = path

    def __repr__(self):
        return "LockStitchDefinition(%s, %s, %s)" % (self.id, self.name, self.path)

    def stitches(self):
        raise NotImplementedError(f"{self.__class__.__name__} must implement stitches()")


class LockStitch:
    def __init__(self, lock_type, lock_id, scale_percent, scale_absolute):
        self.lock_stitch_definition = get_lock_stitch_definition_by_id(lock_type, lock_id)
        self.scale = LockStitchScale(scale_percent, scale_absolute)

    def stitches(self, stitches, pos):
        return self.lock_stitch_definition.stitches(stitches, pos, self.scale)


class LockStitchScale:
    def __init__(self, scale_percent, scale_absolute):
        self.percent = scale_percent / 100
        self.absolute = scale_absolute


class CustomLock(LockStitchDefinition):
    @property
    def path(self):
        return self._path

    @path.setter
    def path(self, path):
        path_type = self._get_path_type(path)
        if path_type in ['svg', 'absolute']:
            self._path = path
        else:
            self._path = None

    def stitches(self, stitches, pos, scale):
        if self.path is None:
            return half_stitch.stitches(stitches, pos)

        path_type = self._get_path_type(self.path)
        if path_type == "svg":
            return SVGLock(self.id,
                           self.name,
                           self.path).stitches(stitches, pos, scale.percent)
        else:
            return AbsoluteLock(self.id,
                                self.name,
                                self.path).stitches(stitches, pos, scale.absolute)

    def _get_path_type(self, path):
        if not path:
            return "invalid"
        if not re.match("^ *[0-9 .,-]*$", path):
            path = Path(path)
            if not path or len(list(path.end_points)) < 3:
                return None
            else:
                return "svg"
        else:
            path = string_to_floats(path, " ")
            if not path:
                return "invalid"
            else:
                return "absolute"


class RelativeLock(LockStitchDefinition):
    def stitches(self, stitches, pos, scale):
        if pos == "end":
            stitches = list(reversed(stitches))

        path = string_to_floats(self._path, " ")

        to_previous = stitches[1] - stitches[0]
        length = to_previous.length()

        lock_stitches = []
        if length > 0.5 * PIXELS_PER_MM:

            # Travel back one stitch, stopping halfway there.
            # Then go forward one stitch, stopping halfway between
            # again.

            # but travel at most 1.5 mm
            length = min(length, 1.5 * PIXELS_PER_MM)

            direction = to_previous.unit()

            for delta in path:
                lock_stitches.append(Stitch(stitches[0] + delta * length * direction, tags=('lock_stitch')))
        else:
            # Too short to travel part of the way to the previous stitch; just go
            # back and forth to it a couple times.
            for i in (1, 0, 1, 0):
                lock_stitches.append(stitches[i])
        return lock_stitches


class AbsoluteLock(LockStitchDefinition):
    def stitches(self, stitches, pos, scale):
        if pos == "end":
            stitches = list(reversed(stitches))

        # make sure the path consists of only floats
        path = string_to_floats(self._path, " ")

        # get the length of our lock stitch path
        if pos == 'start':
            lock_pos = []
            lock = 0
            # reverse the list to make sure we end with the first stitch of the target path
            for tie_path in reversed(path):
                lock = lock - tie_path * scale.absolute
                lock_pos.insert(0, lock)
        elif pos == 'end':
            lock_pos = []
            lock = 0
            for tie_path in path:
                lock = lock + tie_path * scale.absolute
                lock_pos.append(lock)
        max_lock_length = max(lock_pos)

        # calculate the amount stitches we need from the target path
        # and generate a line
        upcoming = [stitches[0]]
        for stitch in stitches[1:]:
            to_start = stitch - upcoming[-1]
            upcoming.append(stitch)
            if to_start.length() >= max_lock_length:
                break
        line = LineString(upcoming)

        # add tie stitches
        lock_stitches = []
        for i, tie_path in enumerate(lock_pos):
            if tie_path < 0:
                stitch = Stitch(stitches[0] + tie_path * (stitches[1] - stitches[0]).unit())
            else:
                point = line.interpolate(tie_path)
                stitch = Stitch(point.x, point.y, tags=('lock_stitch',))
            lock_stitches.append(stitch)
        return lock_stitches


class SVGLock(LockStitchDefinition):
    def stitches(self, stitches, pos, scale):
        if pos == "end":
            stitches = list(reversed(stitches))

        path = Path(self._path)
        path.scale(PIXELS_PER_MM, PIXELS_PER_MM, True)
        path.scale(scale.percent, scale.percent, True)

        end_points = list(path.end_points)

        lock = DirectedLineSegment(end_points[-2], end_points[-1])
        lock_stitch_angle = lock.angle

        stitch = DirectedLineSegment((stitches[0].x, stitches[0].y),
                                     (stitches[1].x, stitches[1].y))
        stitch_angle = stitch.angle

        # rotate and translate the lock stitch
        path.rotate(degrees(stitch_angle - lock_stitch_angle), lock.start, True)
        translate = stitch.start - lock.start
        path.translate(translate.x, translate.y, True)

        # Remove direction indicator from path and also
        # remove start:last/end:first stitch (it is the position of the first/last stitch of the target path)
        path = list(path.end_points)[:-2]

        if pos == 'end':
            path = reversed(path)

        lock_stitches = []
        for i, stitch in enumerate(path):
            stitch = Stitch(stitch[0], stitch[1], tags=('lock_stitch',))
            lock_stitches.append(stitch)
        return lock_stitches


def get_lock_stitch_definition_by_id(pos, lock_type, default="half_stitch"):
    id_list = [lock.id for lock in LOCK_DEFAULTS[pos]]

    try:
        lock = LOCK_DEFAULTS[pos][id_list.index(lock_type)]
    except ValueError:
        lock = LOCK_DEFAULTS[pos][id_list.index(default)]
    return lock


half_stitch = RelativeLock("half_stitch", _("Half Stitch"), "0 0.5 1 0.5 0")
arrow = SVGLock("arrow", _("Arrow"), "M 0.5,0.3 0.3,1.31 -0.11,0.68 H 0.9 L 0.5,1.31 0.4,0.31 V 0.31 1.3")
back_forth = AbsoluteLock("back_forth", _("Back and forth"), "1 1 -1 -1")
bowtie = SVGLock("bowtie", _("Bowtie"), "M 0,0 -0.39,0.97 0.3,0.03 0.14,1.02 0,0 V 0.15")
cross = SVGLock("cross", _("Cross"), "M 0,0 -0.7,-0.7 0.7,0.7 0,0 -0.7,0.7 0.7,-0.7 0,0 -0,-0.7")
star = SVGLock("star", _("Star"), "M 0.67,-0.2 C 0.27,-0.06 -0.22,0.11 -0.67,0.27 L 0.57,0.33 -0.5,-0.27 0,0.67 V 0 -0.5")
simple = SVGLock("simple", _("Simple"), "M -0.03,0 0.09,0.81 0,1.49 V 0 0.48")
triangle = SVGLock("triangle", _("Triangle"), "M -0.26,0.33 H 0.55 L 0,0.84 V 0 L 0.34,0.82")
zigzag = SVGLock("zigzag", _("Zig-zag"), "M -0.25,0.2 0.17,0.77 -0.22,1.45 0.21,2.05 -0.03,3 0,0")
custom = CustomLock("custom", _("Custom"))

LOCK_DEFAULTS = {'start': [half_stitch, arrow, back_forth, bowtie, cross, star, simple, triangle, zigzag, custom],
                 'end': [half_stitch, arrow, back_forth, cross, bowtie, star, simple, triangle, zigzag, custom]}