summaryrefslogtreecommitdiffstats
path: root/share/extensions/grid_cartesian.py
blob: e2082c131c6c1f1969f31a91e035deef05343aeb (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
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
#!/usr/bin/env python
# coding=utf-8
#
# Copyright (C) 2007 John Beard john.j.beard@gmail.com
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
"""
This extension allows you to draw a Cartesian grid in Inkscape.

There is a wide range of options including subdivision, subsubdivions and
logarithmic scales. Custom line widths are also possible.

All elements are grouped with similar elements (eg all x-subdivs)
"""

from math import log

import inkex
from inkex import Group, PathElement, Rectangle


def draw_line(x1, y1, x2, y2, width, name, parent):
    """Draw an SVG line"""
    line = parent.add(PathElement())
    line.style = {"stroke": "#000000", "stroke-width": str(width), "fill": "none"}
    line.path = "M {},{} L {},{}".format(x1, y1, x2, y2)
    line.label = name


def draw_rect(x, y, w, h, width, fill, name, parent):
    """Draw an SVG Rectangle"""
    rect = parent.add(Rectangle(x=str(x), y=str(y), width=str(w), height=str(h)))
    rect.style = {"stroke": "#000000", "stroke-width": str(width), "fill": fill}
    rect.label = name


class GridCartesian(inkex.GenerateExtension):
    def add_arguments(self, pars):
        pars.add_argument("--border_th", type=float, default=1.0)
        pars.add_argument("--border_th_unit", default="px")
        pars.add_argument("--tab", default="x_tab")
        pars.add_argument("--x_divs", type=int, default=6)
        pars.add_argument("--dx", type=float, default=5.0)
        pars.add_argument("--dx_unit", default="mm")
        pars.add_argument("--x_subdivs", type=int, default=1)
        pars.add_argument("--x_log", type=inkex.Boolean, default=False)
        pars.add_argument("--x_subsubdivs", type=int, default=1)
        pars.add_argument("--x_half_freq", type=int, default=1)
        pars.add_argument("--x_divs_th", type=float, default=1.0)
        pars.add_argument("--x_subdivs_th", type=float, default=0.5)
        pars.add_argument("--x_subsubdivs_th", type=float, default=0.3)
        pars.add_argument("--x_div_unit", default="px")
        pars.add_argument("--y_divs", type=int, default=5)
        pars.add_argument("--dy", type=float, default=5.0)
        pars.add_argument("--dy_unit", default="mm")
        pars.add_argument("--y_subdivs", type=int, default=1)
        pars.add_argument("--y_log", type=inkex.Boolean, default=False)
        pars.add_argument("--y_subsubdivs", type=int, default=5)
        pars.add_argument("--y_half_freq", type=int, default=1)
        pars.add_argument("--y_divs_th", type=float, default=1.0)
        pars.add_argument("--y_subdivs_th", type=float, default=0.5)
        pars.add_argument("--y_subsubdivs_th", type=float, default=0.3)
        pars.add_argument("--y_div_unit", default="px")

    def generate(self):
        self.options.border_th = self.svg.unittouu(
            str(self.options.border_th) + self.options.border_th_unit
        )

        self.options.dx = self.svg.unittouu(str(self.options.dx) + self.options.dx_unit)
        self.options.x_divs_th = self.svg.unittouu(
            str(self.options.x_divs_th) + self.options.x_div_unit
        )
        self.options.x_subdivs_th = self.svg.unittouu(
            str(self.options.x_subdivs_th) + self.options.x_div_unit
        )
        self.options.x_subsubdivs_th = self.svg.unittouu(
            str(self.options.x_subsubdivs_th) + self.options.x_div_unit
        )

        self.options.dy = self.svg.unittouu(str(self.options.dy) + self.options.dy_unit)
        self.options.y_divs_th = self.svg.unittouu(
            str(self.options.y_divs_th) + self.options.y_div_unit
        )
        self.options.y_subdivs_th = self.svg.unittouu(
            str(self.options.y_subdivs_th) + self.options.y_div_unit
        )
        self.options.y_subsubdivs_th = self.svg.unittouu(
            str(self.options.y_subsubdivs_th) + self.options.y_div_unit
        )

        # find the pixel dimensions of the overall grid
        ymax = self.options.dy * self.options.y_divs
        xmax = self.options.dx * self.options.x_divs

        # Embed grid in group
        # Put in in the centre of the current view

        grid = Group.new("GridCartesian:X{0.x_divs}:Y{0.y_divs}".format(self.options))

        (pos_x, pos_y) = self.svg.namedview.center
        grid.transform.add_translate(pos_x - xmax / 2.0, pos_y - ymax / 2.0)

        # Group for major x gridlines
        majglx = grid.add(Group.new("MajorXGridlines"))
        # Group for major y gridlines
        majgly = grid.add(Group.new("MajorYGridlines"))

        # Group for minor x gridlines
        if self.options.x_subdivs > 1:  # if there are any minor x gridlines
            minglx = grid.add(Group.new("MinorXGridlines"))

        # Group for subminor x gridlines
        if self.options.x_subsubdivs > 1:  # if there are any minor minor x gridlines
            mminglx = grid.add(Group.new("SubMinorXGridlines"))

        # Group for minor y gridlines
        if self.options.y_subdivs > 1:  # if there are any minor y gridlines
            mingly = grid.add(Group.new("MinorYGridlines"))

        # Group for subminor y gridlines
        if self.options.y_subsubdivs > 1:  # if there are any minor minor x gridlines
            mmingly = grid.add(Group.new("SubMinorYGridlines"))

        draw_rect(
            0, 0, xmax, ymax, self.options.border_th, "none", "Border", grid
        )  # border rectangle

        # DO THE X DIVISIONS======================================
        sd = self.options.x_subdivs  # sub divs per div
        ssd = self.options.x_subsubdivs  # subsubdivs per subdiv

        for i in range(0, self.options.x_divs):  # Major x divisions
            if i > 0:  # don't draw first line (we made a proper border)
                draw_line(
                    self.options.dx * i,
                    0,
                    self.options.dx * i,
                    ymax,
                    self.options.x_divs_th,
                    "MajorXDiv" + str(i),
                    majglx,
                )

            if self.options.x_log:  # log x subdivs
                for j in range(1, sd):
                    if j > 1:  # the first loop is only for subsubdivs
                        draw_line(
                            self.options.dx * (i + log(j, sd)),
                            0,
                            self.options.dx * (i + log(j, sd)),
                            ymax,
                            self.options.x_subdivs_th,
                            "MinorXDiv" + str(i) + ":" + str(j),
                            minglx,
                        )

                    for k in range(1, ssd):  # subsub divs
                        if (j <= self.options.x_half_freq) or (
                            k % 2 == 0
                        ):  # only draw half the subsubdivs past the half-freq point
                            if (ssd % 2 > 0) and (
                                j > self.options.y_half_freq
                            ):  # half frequency won't work with odd numbers of subsubdivs,
                                ssd2 = ssd + 1  # make even
                            else:
                                ssd2 = ssd  # no change
                            draw_line(
                                self.options.dx * (i + log(j + k / float(ssd2), sd)),
                                0,
                                self.options.dx * (i + log(j + k / float(ssd2), sd)),
                                ymax,
                                self.options.x_subsubdivs_th,
                                "SubminorXDiv" + str(i) + ":" + str(j) + ":" + str(k),
                                mminglx,
                            )

            else:  # linear x subdivs
                for j in range(0, sd):
                    if (
                        j > 0
                    ):  # not for the first loop (this loop is for the subsubdivs before the first subdiv)
                        draw_line(
                            self.options.dx * (i + j / float(sd)),
                            0,
                            self.options.dx * (i + j / float(sd)),
                            ymax,
                            self.options.x_subdivs_th,
                            "MinorXDiv" + str(i) + ":" + str(j),
                            minglx,
                        )

                    for k in range(1, ssd):  # subsub divs
                        draw_line(
                            self.options.dx * (i + (j * ssd + k) / (float(sd) * ssd)),
                            0,
                            self.options.dx * (i + (j * ssd + k) / (float(sd) * ssd)),
                            ymax,
                            self.options.x_subsubdivs_th,
                            "SubminorXDiv" + str(i) + ":" + str(j) + ":" + str(k),
                            mminglx,
                        )

        # DO THE Y DIVISIONS========================================
        sd = self.options.y_subdivs  # sub divs per div
        ssd = self.options.y_subsubdivs  # subsubdivs per subdiv

        for i in range(0, self.options.y_divs):  # Major y divisions
            if i > 0:  # don't draw first line (we will make a border)
                draw_line(
                    0,
                    self.options.dy * i,
                    xmax,
                    self.options.dy * i,
                    self.options.y_divs_th,
                    "MajorYDiv" + str(i),
                    majgly,
                )

            if self.options.y_log:  # log y subdivs
                for j in range(1, sd):
                    if j > 1:  # the first loop is only for subsubdivs
                        draw_line(
                            0,
                            self.options.dy * (i + 1 - log(j, sd)),
                            xmax,
                            self.options.dy * (i + 1 - log(j, sd)),
                            self.options.y_subdivs_th,
                            "MinorXDiv" + str(i) + ":" + str(j),
                            mingly,
                        )

                    for k in range(1, ssd):  # subsub divs
                        if (j <= self.options.y_half_freq) or (
                            k % 2 == 0
                        ):  # only draw half the subsubdivs past the half-freq point
                            if (ssd % 2 > 0) and (
                                j > self.options.y_half_freq
                            ):  # half frequency won't work with odd numbers of subsubdivs,
                                ssd2 = ssd + 1
                            else:
                                ssd2 = ssd  # no change
                            draw_line(
                                0,
                                self.options.dx
                                * (i + 1 - log(j + k / float(ssd2), sd)),
                                xmax,
                                self.options.dx
                                * (i + 1 - log(j + k / float(ssd2), sd)),
                                self.options.y_subsubdivs_th,
                                "SubminorXDiv" + str(i) + ":" + str(j) + ":" + str(k),
                                mmingly,
                            )
            else:  # linear y subdivs
                for j in range(0, self.options.y_subdivs):
                    if (
                        j > 0
                    ):  # not for the first loop (this loop is for the subsubdivs before the first subdiv)
                        draw_line(
                            0,
                            self.options.dy * (i + j / float(sd)),
                            xmax,
                            self.options.dy * (i + j / float(sd)),
                            self.options.y_subdivs_th,
                            "MinorXYiv" + str(i) + ":" + str(j),
                            mingly,
                        )

                    for k in range(1, ssd):  # subsub divs
                        draw_line(
                            0,
                            self.options.dy * (i + (j * ssd + k) / (float(sd) * ssd)),
                            xmax,
                            self.options.dy * (i + (j * ssd + k) / (float(sd) * ssd)),
                            self.options.y_subsubdivs_th,
                            "SubminorXDiv" + str(i) + ":" + str(j) + ":" + str(k),
                            mmingly,
                        )

        return grid


if __name__ == "__main__":
    GridCartesian().run()