File: bl_pyapi_grease_pencil.py

package info (click to toggle)
blender 5.0.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 329,128 kB
  • sloc: cpp: 2,489,823; python: 349,859; ansic: 261,364; xml: 2,103; sh: 999; javascript: 317; makefile: 193
file content (305 lines) | stat: -rw-r--r-- 11,394 bytes parent folder | download
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
# SPDX-FileCopyrightText: 2024 Blender Authors
#
# SPDX-License-Identifier: Apache-2.0

# ./blender.bin --background --python tests/python/bl_pyapi_grease_pencil.py -- --verbose
import bpy
import unittest


# -----------------------------------------------------------------------------
# Tests

class TestGreasePencil(unittest.TestCase):
    def setUp(self):
        self.gp = bpy.data.grease_pencils.new("test_grease_pencil")

    def tearDown(self):
        bpy.data.grease_pencils.remove(self.gp)
        del self.gp

    def test_grease_pencil_new(self):
        self.assertEqual(self.gp.name, "test_grease_pencil")
        self.assertEqual(len(self.gp.layers), 0)


class TestGreasePencilLayers(unittest.TestCase):
    tint_factors = [0.3, 0.6, 0.9]

    def setUp(self):
        self.gp = bpy.data.grease_pencils.new("test_grease_pencil")
        self.gp.layers.new("test_layer01")
        self.gp.layers.new("test_layer02")
        self.gp.layers.new("test_layer03")

        for i, layer in enumerate(self.gp.layers):
            layer.tint_factor = self.tint_factors[i]

    def tearDown(self):
        bpy.data.grease_pencils.remove(self.gp)
        del self.gp

    def test_grease_pencil_layers_new(self):
        self.assertEqual(len(self.gp.layers), 3)
        # Test empty name
        self.gp.layers.new("")
        self.assertEqual(self.gp.layers[-1].name, "Layer")
        self.gp.layers.new("")
        self.assertEqual(self.gp.layers[-1].name, "Layer.001")

    def test_grease_pencil_layers_rename(self):
        self.gp.layers[0].name = "test"
        self.assertEqual(self.gp.layers[0].name, "test")
        self.gp.layers[0].name = ""
        self.assertEqual(self.gp.layers[0].name, "Layer")
        self.gp.layers[0].name = "test_layer02"
        self.assertEqual(self.gp.layers[0].name, "test_layer02.001")

    def test_grease_pencil_layers_remove(self):
        self.gp.layers.remove(self.gp.layers[-1])
        self.assertEqual(len(self.gp.layers), 2)
        self.assertEqual(self.gp.layers[-1].name, "test_layer02")

    def test_grease_pencil_layers_move_down(self):
        # Move the top most layer down
        self.gp.layers.move(self.gp.layers[-1], 'DOWN')
        self.assertEqual(self.gp.layers[0].name, "test_layer01")
        self.assertEqual(self.gp.layers[1].name, "test_layer03")
        self.assertEqual(self.gp.layers[2].name, "test_layer02")

    def test_grease_pencil_layers_move_up(self):
        # Move the bottom most layer up
        self.gp.layers.move(self.gp.layers[0], 'UP')
        self.assertEqual(self.gp.layers[0].name, "test_layer02")
        self.assertEqual(self.gp.layers[1].name, "test_layer01")
        self.assertEqual(self.gp.layers[2].name, "test_layer03")

    def test_grease_pencil_layers_attribute_reorder(self):
        layer = self.gp.layers[0]
        self.gp.layers.move_top(layer)
        # Check layer attribute
        self.assertEqual(round(self.gp.layers[0].tint_factor, 1), self.tint_factors[1])
        self.assertEqual(round(self.gp.layers[1].tint_factor, 1), self.tint_factors[2])
        self.assertEqual(round(self.gp.layers[2].tint_factor, 1), self.tint_factors[0])


class TestGreasePencilFrame(unittest.TestCase):
    def setUp(self):
        self.gp = bpy.data.grease_pencils.new("test_grease_pencil")
        self.layer = self.gp.layers.new("test_layer01")

    def tearDown(self):
        bpy.data.grease_pencils.remove(self.gp)
        del self.gp

    def test_grease_pencil_frame_add(self):
        frame1 = self.layer.frames.new(0)
        frame2 = self.layer.frames.new(-100)
        frame3 = self.layer.frames.new(10)
        with self.assertRaises(RuntimeError):
            self.layer.frames.new(10)

        self.assertEqual(len(self.layer.frames), 3)
        self.assertEqual(frame1.frame_number, 0)
        self.assertEqual(frame2.frame_number, -100)
        self.assertEqual(frame3.frame_number, 10)

    def test_grease_pencil_frame_remove(self):
        self.layer.frames.new(0)
        self.layer.frames.new(-10)
        frame3 = self.layer.frames.new(20)

        self.assertEqual(len(self.layer.frames), 3)

        self.layer.frames.remove(0)
        self.layer.frames.remove(-10)

        with self.assertRaises(RuntimeError):
            self.layer.frames.remove(19)

        self.assertEqual(len(self.layer.frames), 1)
        self.assertEqual(frame3.frame_number, 20)

    def test_grease_pencil_frame_copy(self):
        self.layer.frames.new(0)
        self.layer.frames.new(-10)
        self.layer.frames.new(20)

        self.assertEqual(len(self.layer.frames), 3)

        frame = self.layer.frames.copy(0, 1)

        self.assertEqual(len(self.layer.frames), 4)
        self.assertEqual(frame.frame_number, 1)

        with self.assertRaises(RuntimeError):
            self.layer.frames.copy(0, 1)

        with self.assertRaises(RuntimeError):
            self.layer.frames.copy(10, 20)

    def test_grease_pencil_frame_move(self):
        self.layer.frames.new(0)
        self.layer.frames.new(-10)
        self.layer.frames.new(20)

        self.assertEqual(len(self.layer.frames), 3)

        frame = self.layer.frames.move(0, 1)

        self.assertEqual(frame.frame_number, 1)

        with self.assertRaises(RuntimeError):
            self.layer.frames.move(0, 1)

        with self.assertRaises(RuntimeError):
            self.layer.frames.move(-10, 20)

    def test_grease_pencil_frame_set(self):
        frame1 = self.layer.frames.new(0)
        frame1.drawing.add_strokes([3, 5, 7, 11])

        self.assertEqual(len(frame1.drawing.strokes), 4)

        frame1.drawing = None
        self.assertEqual(len(frame1.drawing.strokes), 0)

        frame2 = self.layer.frames.new(10)
        frame2.drawing.add_strokes([13, 17])

        frame1.drawing = frame2.drawing
        self.assertEqual(len(frame1.drawing.strokes), 2)
        self.assertEqual(len(frame1.drawing.strokes[0].points), 13)
        self.assertEqual(len(frame1.drawing.strokes[1].points), 17)

        layer2 = self.gp.layers.new("test_layer02")
        frame2 = layer2.frames.new(0)
        frame2.drawing.add_strokes([19, 23])

        frame1.drawing = frame2.drawing
        self.assertEqual(len(frame1.drawing.strokes), 2)
        self.assertEqual(len(frame1.drawing.strokes[0].points), 19)
        self.assertEqual(len(frame1.drawing.strokes[1].points), 23)


class TestGreasePencilDrawing(unittest.TestCase):
    def setUp(self):
        self.gp = bpy.data.grease_pencils.new("test_grease_pencil")
        layer = self.gp.layers.new("test_layer01")
        frame = layer.frames.new(0)
        self.drawing = frame.drawing

        stroke_sizes = [3, 5, 7, 11]
        self.drawing.add_strokes(stroke_sizes)

    def tearDown(self):
        bpy.data.grease_pencils.remove(self.gp)
        del self.gp

    def test_grease_pencil_drawing_add_strokes(self):
        self.assertEqual(len(self.drawing.strokes), 4)
        self.assertEqual(len(self.drawing.strokes[0].points), 3)
        self.assertEqual(len(self.drawing.strokes[1].points), 5)
        self.assertEqual(len(self.drawing.strokes[2].points), 7)
        self.assertEqual(len(self.drawing.strokes[3].points), 11)

    def test_grease_pencil_drawing_remove_all_strokes(self):
        self.drawing.remove_strokes()
        self.assertEqual(len(self.drawing.strokes), 0)

    def test_grease_pencil_drawing_remove_strokes(self):
        self.drawing.remove_strokes(indices=[0, 2])
        self.assertEqual(len(self.drawing.strokes), 2)
        self.assertEqual(len(self.drawing.strokes[0].points), 5)
        self.assertEqual(len(self.drawing.strokes[1].points), 11)

    def test_grease_pencil_drawing_resize_strokes(self):
        self.drawing.resize_strokes([20, 25, 15, 30])
        self.assertEqual(len(self.drawing.strokes), 4)
        self.assertEqual(len(self.drawing.strokes[0].points), 20)
        self.assertEqual(len(self.drawing.strokes[1].points), 25)
        self.assertEqual(len(self.drawing.strokes[2].points), 15)
        self.assertEqual(len(self.drawing.strokes[3].points), 30)

        self.drawing.resize_strokes([1, 2], indices=[0, 2])
        self.assertEqual(len(self.drawing.strokes), 4)
        self.assertEqual(len(self.drawing.strokes[0].points), 1)
        self.assertEqual(len(self.drawing.strokes[1].points), 25)
        self.assertEqual(len(self.drawing.strokes[2].points), 2)
        self.assertEqual(len(self.drawing.strokes[3].points), 30)

    def test_grease_pencil_drawing_stroke_add_points(self):
        self.drawing.strokes[0].add_points(5)
        self.assertEqual(len(self.drawing.strokes[0].points), 8)

        new_points = self.drawing.strokes[1].add_points(5)
        self.assertEqual(len(new_points), 5)

    def test_grease_pencil_drawing_stroke_remove_points(self):
        self.drawing.strokes[0].remove_points(1)
        self.assertEqual(len(self.drawing.strokes[0].points), 2)

        self.drawing.strokes[1].remove_points(10)
        self.assertEqual(len(self.drawing.strokes[1].points), 1)

    def test_grease_pencil_drawing_strokes_slice(self):
        self.assertEqual(len(self.drawing.strokes[:]), 4)
        self.assertEqual(len(self.drawing.strokes[0:]), 4)
        self.assertEqual(len(self.drawing.strokes[:4]), 4)
        self.assertEqual(len(self.drawing.strokes[-4:]), 4)

        self.assertEqual(len(self.drawing.strokes[:5]), 4)
        self.assertEqual(len(self.drawing.strokes[-5:]), 4)

        self.assertEqual(len(self.drawing.strokes[4:]), 0)
        self.assertEqual(len(self.drawing.strokes[:0]), 0)
        self.assertEqual(len(self.drawing.strokes[:-4]), 0)

        strokes = self.drawing.strokes[1:]
        self.assertEqual(len(strokes), 3)
        self.assertEqual(len(strokes[0].points), 5)
        self.assertEqual(len(strokes[1].points), 7)
        self.assertEqual(len(strokes[2].points), 11)

        strokes = self.drawing.strokes[:-1]
        self.assertEqual(len(strokes), 3)
        self.assertEqual(len(strokes[0].points), 3)
        self.assertEqual(len(strokes[1].points), 5)
        self.assertEqual(len(strokes[2].points), 7)

        strokes = self.drawing.strokes[:1]
        self.assertEqual(len(strokes), 1)
        self.assertEqual(len(strokes[0].points), 3)

        strokes = self.drawing.strokes[-1:]
        self.assertEqual(len(strokes), 1)
        self.assertEqual(len(strokes[0].points), 11)

        strokes = self.drawing.strokes[1:-1]
        self.assertEqual(len(strokes), 2)
        self.assertEqual(len(strokes[0].points), 5)
        self.assertEqual(len(strokes[1].points), 7)

        strokes = self.drawing.strokes[1:][1:]
        self.assertEqual(len(strokes), 2)
        self.assertEqual(len(strokes[0].points), 7)
        self.assertEqual(len(strokes[1].points), 11)

        strokes = self.drawing.strokes[:-1][1:]
        self.assertEqual(len(strokes), 2)
        self.assertEqual(len(strokes[0].points), 5)
        self.assertEqual(len(strokes[1].points), 7)

        strokes = self.drawing.strokes[1:-1][1:]
        self.assertEqual(len(strokes), 1)
        self.assertEqual(len(strokes[0].points), 7)

        strokes = self.drawing.strokes[1:-1][:-1]
        self.assertEqual(len(strokes), 1)
        self.assertEqual(len(strokes[0].points), 5)


if __name__ == '__main__':
    import sys
    sys.argv = [__file__] + (sys.argv[sys.argv.index("--") + 1:] if "--" in sys.argv else [])
    unittest.main()