fake-bpy-module 20240620__py3-none-any.whl → 20240621__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- bl_ui/space_userpref/__init__.pyi +225 -0
- bpy/ops/action/__init__.pyi +50 -50
- bpy/ops/anim/__init__.pyi +94 -94
- bpy/ops/armature/__init__.pyi +54 -54
- bpy/ops/asset/__init__.pyi +50 -50
- bpy/ops/brush/__init__.pyi +10 -10
- bpy/ops/buttons/__init__.pyi +88 -88
- bpy/ops/cachefile/__init__.pyi +88 -88
- bpy/ops/camera/__init__.pyi +14 -14
- bpy/ops/clip/__init__.pyi +175 -174
- bpy/ops/cloth/__init__.pyi +6 -6
- bpy/ops/collection/__init__.pyi +8 -8
- bpy/ops/console/__init__.pyi +26 -26
- bpy/ops/constraint/__init__.pyi +42 -42
- bpy/ops/curve/__init__.pyi +167 -122
- bpy/ops/curves/__init__.pyi +75 -58
- bpy/ops/cycles/__init__.pyi +10 -10
- bpy/ops/ed/__init__.pyi +50 -50
- bpy/ops/export_anim/__init__.pyi +14 -14
- bpy/ops/export_scene/__init__.pyi +250 -250
- bpy/ops/extensions/__init__.pyi +73 -73
- bpy/ops/file/__init__.pyi +94 -94
- bpy/ops/fluid/__init__.pyi +6 -6
- bpy/ops/font/__init__.pyi +100 -100
- bpy/ops/geometry/__init__.pyi +20 -20
- bpy/ops/gizmogroup/__init__.pyi +10 -10
- bpy/ops/gpencil/__init__.pyi +411 -410
- bpy/ops/graph/__init__.pyi +194 -194
- bpy/ops/grease_pencil/__init__.pyi +100 -100
- bpy/ops/image/__init__.pyi +399 -390
- bpy/ops/import_anim/__init__.pyi +16 -16
- bpy/ops/import_curve/__init__.pyi +4 -4
- bpy/ops/import_scene/__init__.pyi +56 -56
- bpy/ops/info/__init__.pyi +14 -14
- bpy/ops/lattice/__init__.pyi +8 -8
- bpy/ops/marker/__init__.pyi +34 -34
- bpy/ops/mask/__init__.pyi +63 -62
- bpy/ops/mball/__init__.pyi +12 -12
- bpy/ops/mesh/__init__.pyi +893 -790
- bpy/ops/nla/__init__.pyi +70 -70
- bpy/ops/node/__init__.pyi +192 -192
- bpy/ops/object/__init__.pyi +1013 -840
- bpy/ops/outliner/__init__.pyi +44 -44
- bpy/ops/paint/__init__.pyi +169 -168
- bpy/ops/paintcurve/__init__.pyi +12 -12
- bpy/ops/palette/__init__.pyi +4 -4
- bpy/ops/particle/__init__.pyi +34 -34
- bpy/ops/pose/__init__.pyi +60 -60
- bpy/ops/poselib/__init__.pyi +18 -18
- bpy/ops/preferences/__init__.pyi +150 -150
- bpy/ops/ptcache/__init__.pyi +4 -4
- bpy/ops/render/__init__.pyi +56 -56
- bpy/ops/rigidbody/__init__.pyi +8 -8
- bpy/ops/scene/__init__.pyi +20 -20
- bpy/ops/screen/__init__.pyi +128 -128
- bpy/ops/script/__init__.pyi +6 -6
- bpy/ops/sculpt/__init__.pyi +207 -202
- bpy/ops/sculpt_curves/__init__.pyi +12 -12
- bpy/ops/sequencer/__init__.pyi +465 -464
- bpy/ops/sound/__init__.pyi +154 -154
- bpy/ops/spreadsheet/__init__.pyi +6 -6
- bpy/ops/surface/__init__.pyi +109 -60
- bpy/ops/text/__init__.pyi +110 -110
- bpy/ops/text_editor/__init__.pyi +6 -6
- bpy/ops/transform/__init__.pyi +628 -566
- bpy/ops/ui/__init__.pyi +25 -24
- bpy/ops/uilist/__init__.pyi +12 -12
- bpy/ops/uv/__init__.pyi +235 -234
- bpy/ops/view2d/__init__.pyi +72 -72
- bpy/ops/view3d/__init__.pyi +144 -144
- bpy/ops/wm/__init__.pyi +1813 -1806
- bpy/ops/workspace/__init__.pyi +4 -4
- bpy/types/__init__.pyi +1611 -1802
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240621.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240621.dist-info}/RECORD +77 -77
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240621.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240620.dist-info → fake_bpy_module-20240621.dist-info}/top_level.txt +0 -0
bpy/ops/gpencil/__init__.pyi
CHANGED
|
@@ -2,6 +2,7 @@ import typing
|
|
|
2
2
|
import collections.abc
|
|
3
3
|
import bpy.ops.transform
|
|
4
4
|
import bpy.types
|
|
5
|
+
import mathutils
|
|
5
6
|
|
|
6
7
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
7
8
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
@@ -42,12 +43,12 @@ def annotate(
|
|
|
42
43
|
mode: str | None = "DRAW",
|
|
43
44
|
arrowstyle_start: str | None = "NONE",
|
|
44
45
|
arrowstyle_end: str | None = "NONE",
|
|
45
|
-
use_stabilizer: bool |
|
|
46
|
-
stabilizer_factor:
|
|
47
|
-
stabilizer_radius:
|
|
46
|
+
use_stabilizer: bool | None = False,
|
|
47
|
+
stabilizer_factor: float | None = 0.75,
|
|
48
|
+
stabilizer_radius: int | None = 35,
|
|
48
49
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
49
50
|
| None = None,
|
|
50
|
-
wait_for_input: bool |
|
|
51
|
+
wait_for_input: bool | None = True,
|
|
51
52
|
):
|
|
52
53
|
"""Make annotations on the active data
|
|
53
54
|
|
|
@@ -103,15 +104,15 @@ def annotate(
|
|
|
103
104
|
Square -- Use square style.
|
|
104
105
|
:type arrowstyle_end: str | None
|
|
105
106
|
:param use_stabilizer: Stabilize Stroke, Helper to draw smooth and clean lines. Press Shift for an invert effect (even if this option is not active)
|
|
106
|
-
:type use_stabilizer: bool |
|
|
107
|
+
:type use_stabilizer: bool | None
|
|
107
108
|
:param stabilizer_factor: Stabilizer Stroke Factor, Higher values gives a smoother stroke
|
|
108
|
-
:type stabilizer_factor:
|
|
109
|
+
:type stabilizer_factor: float | None
|
|
109
110
|
:param stabilizer_radius: Stabilizer Stroke Radius, Minimum distance from last point before stroke continues
|
|
110
|
-
:type stabilizer_radius:
|
|
111
|
+
:type stabilizer_radius: int | None
|
|
111
112
|
:param stroke: Stroke
|
|
112
113
|
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
113
114
|
:param wait_for_input: Wait for Input, Wait for first click instead of painting immediately
|
|
114
|
-
:type wait_for_input: bool |
|
|
115
|
+
:type wait_for_input: bool | None
|
|
115
116
|
"""
|
|
116
117
|
|
|
117
118
|
...
|
|
@@ -149,11 +150,11 @@ def bake_grease_pencil_animation(
|
|
|
149
150
|
execution_context: int | str | None = None,
|
|
150
151
|
undo: bool | None = None,
|
|
151
152
|
*,
|
|
152
|
-
frame_start:
|
|
153
|
-
frame_end:
|
|
154
|
-
step:
|
|
155
|
-
only_selected: bool |
|
|
156
|
-
frame_target:
|
|
153
|
+
frame_start: int | None = 1,
|
|
154
|
+
frame_end: int | None = 250,
|
|
155
|
+
step: int | None = 1,
|
|
156
|
+
only_selected: bool | None = False,
|
|
157
|
+
frame_target: int | None = 1,
|
|
157
158
|
project_type: str | None = "KEEP",
|
|
158
159
|
):
|
|
159
160
|
"""Bake grease pencil object transform to grease pencil keyframes
|
|
@@ -162,15 +163,15 @@ def bake_grease_pencil_animation(
|
|
|
162
163
|
:type execution_context: int | str | None
|
|
163
164
|
:type undo: bool | None
|
|
164
165
|
:param frame_start: Start Frame, The start frame
|
|
165
|
-
:type frame_start:
|
|
166
|
+
:type frame_start: int | None
|
|
166
167
|
:param frame_end: End Frame, The end frame of animation
|
|
167
|
-
:type frame_end:
|
|
168
|
+
:type frame_end: int | None
|
|
168
169
|
:param step: Step, Step between generated frames
|
|
169
|
-
:type step:
|
|
170
|
+
:type step: int | None
|
|
170
171
|
:param only_selected: Only Selected Keyframes, Convert only selected keyframes
|
|
171
|
-
:type only_selected: bool |
|
|
172
|
+
:type only_selected: bool | None
|
|
172
173
|
:param frame_target: Target Frame, Destination frame
|
|
173
|
-
:type frame_target:
|
|
174
|
+
:type frame_target: int | None
|
|
174
175
|
:param project_type: Projection Type
|
|
175
176
|
|
|
176
177
|
KEEP
|
|
@@ -201,16 +202,16 @@ def bake_mesh_animation(
|
|
|
201
202
|
undo: bool | None = None,
|
|
202
203
|
*,
|
|
203
204
|
target: str | None = "NEW",
|
|
204
|
-
frame_start:
|
|
205
|
-
frame_end:
|
|
206
|
-
step:
|
|
207
|
-
thickness:
|
|
208
|
-
angle:
|
|
209
|
-
offset:
|
|
210
|
-
seams: bool |
|
|
211
|
-
faces: bool |
|
|
212
|
-
only_selected: bool |
|
|
213
|
-
frame_target:
|
|
205
|
+
frame_start: int | None = 1,
|
|
206
|
+
frame_end: int | None = 250,
|
|
207
|
+
step: int | None = 1,
|
|
208
|
+
thickness: int | None = 1,
|
|
209
|
+
angle: float | None = 1.22173,
|
|
210
|
+
offset: float | None = 0.001,
|
|
211
|
+
seams: bool | None = False,
|
|
212
|
+
faces: bool | None = True,
|
|
213
|
+
only_selected: bool | None = False,
|
|
214
|
+
frame_target: int | None = 1,
|
|
214
215
|
project_type: str | None = "VIEW",
|
|
215
216
|
):
|
|
216
217
|
"""Bake mesh animation to grease pencil strokes
|
|
@@ -221,25 +222,25 @@ def bake_mesh_animation(
|
|
|
221
222
|
:param target: Target Object, Target grease pencil
|
|
222
223
|
:type target: str | None
|
|
223
224
|
:param frame_start: Start Frame, The start frame
|
|
224
|
-
:type frame_start:
|
|
225
|
+
:type frame_start: int | None
|
|
225
226
|
:param frame_end: End Frame, The end frame of animation
|
|
226
|
-
:type frame_end:
|
|
227
|
+
:type frame_end: int | None
|
|
227
228
|
:param step: Step, Step between generated frames
|
|
228
|
-
:type step:
|
|
229
|
+
:type step: int | None
|
|
229
230
|
:param thickness: Thickness
|
|
230
|
-
:type thickness:
|
|
231
|
+
:type thickness: int | None
|
|
231
232
|
:param angle: Threshold Angle, Threshold to determine ends of the strokes
|
|
232
|
-
:type angle:
|
|
233
|
+
:type angle: float | None
|
|
233
234
|
:param offset: Stroke Offset, Offset strokes from fill
|
|
234
|
-
:type offset:
|
|
235
|
+
:type offset: float | None
|
|
235
236
|
:param seams: Only Seam Edges, Convert only seam edges
|
|
236
|
-
:type seams: bool |
|
|
237
|
+
:type seams: bool | None
|
|
237
238
|
:param faces: Export Faces, Export faces as filled strokes
|
|
238
|
-
:type faces: bool |
|
|
239
|
+
:type faces: bool | None
|
|
239
240
|
:param only_selected: Only Selected Keyframes, Convert only selected keyframes
|
|
240
|
-
:type only_selected: bool |
|
|
241
|
+
:type only_selected: bool | None
|
|
241
242
|
:param frame_target: Target Frame, Destination frame
|
|
242
|
-
:type frame_target:
|
|
243
|
+
:type frame_target: int | None
|
|
243
244
|
:param project_type: Projection Type
|
|
244
245
|
|
|
245
246
|
KEEP
|
|
@@ -269,7 +270,7 @@ def blank_frame_add(
|
|
|
269
270
|
execution_context: int | str | None = None,
|
|
270
271
|
undo: bool | None = None,
|
|
271
272
|
*,
|
|
272
|
-
all_layers: bool |
|
|
273
|
+
all_layers: bool | None = False,
|
|
273
274
|
):
|
|
274
275
|
"""Insert a blank frame on the current frame (all subsequently existing frames, if any, are shifted right by one frame)
|
|
275
276
|
|
|
@@ -277,7 +278,7 @@ def blank_frame_add(
|
|
|
277
278
|
:type execution_context: int | str | None
|
|
278
279
|
:type undo: bool | None
|
|
279
280
|
:param all_layers: All Layers, Create blank frame in all layers, not only active
|
|
280
|
-
:type all_layers: bool |
|
|
281
|
+
:type all_layers: bool | None
|
|
281
282
|
"""
|
|
282
283
|
|
|
283
284
|
...
|
|
@@ -316,20 +317,20 @@ def convert(
|
|
|
316
317
|
undo: bool | None = None,
|
|
317
318
|
*,
|
|
318
319
|
type: str | None = "PATH",
|
|
319
|
-
bevel_depth:
|
|
320
|
-
bevel_resolution:
|
|
321
|
-
use_normalize_weights: bool |
|
|
322
|
-
radius_multiplier:
|
|
323
|
-
use_link_strokes: bool |
|
|
320
|
+
bevel_depth: float | None = 0.0,
|
|
321
|
+
bevel_resolution: int | None = 0,
|
|
322
|
+
use_normalize_weights: bool | None = True,
|
|
323
|
+
radius_multiplier: float | None = 1.0,
|
|
324
|
+
use_link_strokes: bool | None = False,
|
|
324
325
|
timing_mode: str | None = "FULL",
|
|
325
|
-
frame_range:
|
|
326
|
-
start_frame:
|
|
327
|
-
use_realtime: bool |
|
|
328
|
-
end_frame:
|
|
329
|
-
gap_duration:
|
|
330
|
-
gap_randomness:
|
|
331
|
-
seed:
|
|
332
|
-
use_timing_data: bool |
|
|
326
|
+
frame_range: int | None = 100,
|
|
327
|
+
start_frame: int | None = 1,
|
|
328
|
+
use_realtime: bool | None = False,
|
|
329
|
+
end_frame: int | None = 250,
|
|
330
|
+
gap_duration: float | None = 0.0,
|
|
331
|
+
gap_randomness: float | None = 0.0,
|
|
332
|
+
seed: int | None = 0,
|
|
333
|
+
use_timing_data: bool | None = False,
|
|
333
334
|
):
|
|
334
335
|
"""Convert the active Grease Pencil layer to a new Curve Object
|
|
335
336
|
|
|
@@ -348,15 +349,15 @@ def convert(
|
|
|
348
349
|
Polygon Curve -- Bézier curve with straight-line segments (vector handles).
|
|
349
350
|
:type type: str | None
|
|
350
351
|
:param bevel_depth: Bevel Depth
|
|
351
|
-
:type bevel_depth:
|
|
352
|
+
:type bevel_depth: float | None
|
|
352
353
|
:param bevel_resolution: Bevel Resolution, Bevel resolution when depth is non-zero
|
|
353
|
-
:type bevel_resolution:
|
|
354
|
+
:type bevel_resolution: int | None
|
|
354
355
|
:param use_normalize_weights: Normalize Weight, Normalize weight (set from stroke width)
|
|
355
|
-
:type use_normalize_weights: bool |
|
|
356
|
+
:type use_normalize_weights: bool | None
|
|
356
357
|
:param radius_multiplier: Radius Factor, Multiplier for the points' radii (set from stroke width)
|
|
357
|
-
:type radius_multiplier:
|
|
358
|
+
:type radius_multiplier: float | None
|
|
358
359
|
:param use_link_strokes: Link Strokes, Whether to link strokes with zero-radius sections of curves
|
|
359
|
-
:type use_link_strokes: bool |
|
|
360
|
+
:type use_link_strokes: bool | None
|
|
360
361
|
:param timing_mode: Timing Mode, How to use timing data stored in strokes
|
|
361
362
|
|
|
362
363
|
NONE
|
|
@@ -372,21 +373,21 @@ def convert(
|
|
|
372
373
|
Custom Gaps -- Use the original timing, but with custom gap lengths (in frames).
|
|
373
374
|
:type timing_mode: str | None
|
|
374
375
|
:param frame_range: Frame Range, The duration of evaluation of the path control curve
|
|
375
|
-
:type frame_range:
|
|
376
|
+
:type frame_range: int | None
|
|
376
377
|
:param start_frame: Start Frame, The start frame of the path control curve
|
|
377
|
-
:type start_frame:
|
|
378
|
+
:type start_frame: int | None
|
|
378
379
|
:param use_realtime: Realtime, Whether the path control curve reproduces the drawing in realtime, starting from Start Frame
|
|
379
|
-
:type use_realtime: bool |
|
|
380
|
+
:type use_realtime: bool | None
|
|
380
381
|
:param end_frame: End Frame, The end frame of the path control curve (if Realtime is not set)
|
|
381
|
-
:type end_frame:
|
|
382
|
+
:type end_frame: int | None
|
|
382
383
|
:param gap_duration: Gap Duration, Custom Gap mode: (Average) length of gaps, in frames (Note: Realtime value, will be scaled if Realtime is not set)
|
|
383
|
-
:type gap_duration:
|
|
384
|
+
:type gap_duration: float | None
|
|
384
385
|
:param gap_randomness: Gap Randomness, Custom Gap mode: Number of frames that gap lengths can vary
|
|
385
|
-
:type gap_randomness:
|
|
386
|
+
:type gap_randomness: float | None
|
|
386
387
|
:param seed: Random Seed, Custom Gap mode: Random generator seed
|
|
387
|
-
:type seed:
|
|
388
|
+
:type seed: int | None
|
|
388
389
|
:param use_timing_data: Has Valid Timing, Whether the converted Grease Pencil layer has valid timing data (internal use)
|
|
389
|
-
:type use_timing_data: bool |
|
|
390
|
+
:type use_timing_data: bool | None
|
|
390
391
|
"""
|
|
391
392
|
|
|
392
393
|
...
|
|
@@ -396,7 +397,7 @@ def convert_old_files(
|
|
|
396
397
|
execution_context: int | str | None = None,
|
|
397
398
|
undo: bool | None = None,
|
|
398
399
|
*,
|
|
399
|
-
annotation: bool |
|
|
400
|
+
annotation: bool | None = False,
|
|
400
401
|
):
|
|
401
402
|
"""Convert 2.7x grease pencil files to 2.80
|
|
402
403
|
|
|
@@ -404,7 +405,7 @@ def convert_old_files(
|
|
|
404
405
|
:type execution_context: int | str | None
|
|
405
406
|
:type undo: bool | None
|
|
406
407
|
:param annotation: Annotation, Convert to Annotations
|
|
407
|
-
:type annotation: bool |
|
|
408
|
+
:type annotation: bool | None
|
|
408
409
|
"""
|
|
409
410
|
|
|
410
411
|
...
|
|
@@ -499,11 +500,11 @@ def draw(
|
|
|
499
500
|
mode: str | None = "DRAW",
|
|
500
501
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
501
502
|
| None = None,
|
|
502
|
-
wait_for_input: bool |
|
|
503
|
-
disable_straight: bool |
|
|
504
|
-
disable_fill: bool |
|
|
505
|
-
disable_stabilizer: bool |
|
|
506
|
-
guide_last_angle:
|
|
503
|
+
wait_for_input: bool | None = True,
|
|
504
|
+
disable_straight: bool | None = False,
|
|
505
|
+
disable_fill: bool | None = False,
|
|
506
|
+
disable_stabilizer: bool | None = False,
|
|
507
|
+
guide_last_angle: float | None = 0.0,
|
|
507
508
|
):
|
|
508
509
|
"""Draw a new stroke in the active Grease Pencil object
|
|
509
510
|
|
|
@@ -524,15 +525,15 @@ def draw(
|
|
|
524
525
|
:param stroke: Stroke
|
|
525
526
|
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
526
527
|
:param wait_for_input: Wait for Input, Wait for first click instead of painting immediately
|
|
527
|
-
:type wait_for_input: bool |
|
|
528
|
+
:type wait_for_input: bool | None
|
|
528
529
|
:param disable_straight: No Straight lines, Disable key for straight lines
|
|
529
|
-
:type disable_straight: bool |
|
|
530
|
+
:type disable_straight: bool | None
|
|
530
531
|
:param disable_fill: No Fill Areas, Disable fill to use stroke as fill boundary
|
|
531
|
-
:type disable_fill: bool |
|
|
532
|
+
:type disable_fill: bool | None
|
|
532
533
|
:param disable_stabilizer: No Stabilizer
|
|
533
|
-
:type disable_stabilizer: bool |
|
|
534
|
+
:type disable_stabilizer: bool | None
|
|
534
535
|
:param guide_last_angle: Angle, Speed guide angle
|
|
535
|
-
:type guide_last_angle:
|
|
536
|
+
:type guide_last_angle: float | None
|
|
536
537
|
"""
|
|
537
538
|
|
|
538
539
|
...
|
|
@@ -577,7 +578,7 @@ def editmode_toggle(
|
|
|
577
578
|
execution_context: int | str | None = None,
|
|
578
579
|
undo: bool | None = None,
|
|
579
580
|
*,
|
|
580
|
-
back: bool |
|
|
581
|
+
back: bool | None = False,
|
|
581
582
|
):
|
|
582
583
|
"""Enter/Exit edit mode for Grease Pencil strokes
|
|
583
584
|
|
|
@@ -585,7 +586,7 @@ def editmode_toggle(
|
|
|
585
586
|
:type execution_context: int | str | None
|
|
586
587
|
:type undo: bool | None
|
|
587
588
|
:param back: Return to Previous Mode, Return to previous mode
|
|
588
|
-
:type back: bool |
|
|
589
|
+
:type back: bool | None
|
|
589
590
|
"""
|
|
590
591
|
|
|
591
592
|
...
|
|
@@ -595,8 +596,8 @@ def extract_palette_vertex(
|
|
|
595
596
|
execution_context: int | str | None = None,
|
|
596
597
|
undo: bool | None = None,
|
|
597
598
|
*,
|
|
598
|
-
selected: bool |
|
|
599
|
-
threshold:
|
|
599
|
+
selected: bool | None = False,
|
|
600
|
+
threshold: int | None = 1,
|
|
600
601
|
):
|
|
601
602
|
"""Extract all colors used in Grease Pencil Vertex and create a Palette
|
|
602
603
|
|
|
@@ -604,9 +605,9 @@ def extract_palette_vertex(
|
|
|
604
605
|
:type execution_context: int | str | None
|
|
605
606
|
:type undo: bool | None
|
|
606
607
|
:param selected: Only Selected, Convert only selected strokes
|
|
607
|
-
:type selected: bool |
|
|
608
|
+
:type selected: bool | None
|
|
608
609
|
:param threshold: Threshold
|
|
609
|
-
:type threshold:
|
|
610
|
+
:type threshold: int | None
|
|
610
611
|
"""
|
|
611
612
|
|
|
612
613
|
...
|
|
@@ -651,7 +652,7 @@ def fill(
|
|
|
651
652
|
execution_context: int | str | None = None,
|
|
652
653
|
undo: bool | None = None,
|
|
653
654
|
*,
|
|
654
|
-
on_back: bool |
|
|
655
|
+
on_back: bool | None = False,
|
|
655
656
|
):
|
|
656
657
|
"""Fill with color the shape formed by strokes
|
|
657
658
|
|
|
@@ -659,7 +660,7 @@ def fill(
|
|
|
659
660
|
:type execution_context: int | str | None
|
|
660
661
|
:type undo: bool | None
|
|
661
662
|
:param on_back: Draw on Back, Send new stroke to back
|
|
662
|
-
:type on_back: bool |
|
|
663
|
+
:type on_back: bool | None
|
|
663
664
|
"""
|
|
664
665
|
|
|
665
666
|
...
|
|
@@ -711,7 +712,7 @@ def frame_clean_loose(
|
|
|
711
712
|
execution_context: int | str | None = None,
|
|
712
713
|
undo: bool | None = None,
|
|
713
714
|
*,
|
|
714
|
-
limit:
|
|
715
|
+
limit: int | None = 1,
|
|
715
716
|
):
|
|
716
717
|
"""Remove loose points
|
|
717
718
|
|
|
@@ -719,7 +720,7 @@ def frame_clean_loose(
|
|
|
719
720
|
:type execution_context: int | str | None
|
|
720
721
|
:type undo: bool | None
|
|
721
722
|
:param limit: Limit, Number of points to consider stroke as loose
|
|
722
|
-
:type limit:
|
|
723
|
+
:type limit: int | None
|
|
723
724
|
"""
|
|
724
725
|
|
|
725
726
|
...
|
|
@@ -755,8 +756,8 @@ def generate_weights(
|
|
|
755
756
|
*,
|
|
756
757
|
mode: str | None = "NAME",
|
|
757
758
|
armature: str | None = "DEFAULT",
|
|
758
|
-
ratio:
|
|
759
|
-
decay:
|
|
759
|
+
ratio: float | None = 0.1,
|
|
760
|
+
decay: float | None = 0.8,
|
|
760
761
|
):
|
|
761
762
|
"""Generate automatic weights for armatures (requires armature modifier)
|
|
762
763
|
|
|
@@ -768,9 +769,9 @@ def generate_weights(
|
|
|
768
769
|
:param armature: Armature, Armature to use
|
|
769
770
|
:type armature: str | None
|
|
770
771
|
:param ratio: Ratio, Ratio between bone length and influence radius
|
|
771
|
-
:type ratio:
|
|
772
|
+
:type ratio: float | None
|
|
772
773
|
:param decay: Decay, Factor to reduce influence depending of distance to bone axis
|
|
773
|
-
:type decay:
|
|
774
|
+
:type decay: float | None
|
|
774
775
|
"""
|
|
775
776
|
|
|
776
777
|
...
|
|
@@ -780,8 +781,8 @@ def guide_rotate(
|
|
|
780
781
|
execution_context: int | str | None = None,
|
|
781
782
|
undo: bool | None = None,
|
|
782
783
|
*,
|
|
783
|
-
increment: bool |
|
|
784
|
-
angle:
|
|
784
|
+
increment: bool | None = True,
|
|
785
|
+
angle: float | None = 0.0,
|
|
785
786
|
):
|
|
786
787
|
"""Rotate guide angle
|
|
787
788
|
|
|
@@ -789,9 +790,9 @@ def guide_rotate(
|
|
|
789
790
|
:type execution_context: int | str | None
|
|
790
791
|
:type undo: bool | None
|
|
791
792
|
:param increment: Increment, Increment angle
|
|
792
|
-
:type increment: bool |
|
|
793
|
+
:type increment: bool | None
|
|
793
794
|
:param angle: Angle, Guide angle
|
|
794
|
-
:type angle:
|
|
795
|
+
:type angle: float | None
|
|
795
796
|
"""
|
|
796
797
|
|
|
797
798
|
...
|
|
@@ -801,7 +802,7 @@ def hide(
|
|
|
801
802
|
execution_context: int | str | None = None,
|
|
802
803
|
undo: bool | None = None,
|
|
803
804
|
*,
|
|
804
|
-
unselected: bool |
|
|
805
|
+
unselected: bool | None = False,
|
|
805
806
|
):
|
|
806
807
|
"""Hide selected/unselected Grease Pencil layers
|
|
807
808
|
|
|
@@ -809,7 +810,7 @@ def hide(
|
|
|
809
810
|
:type execution_context: int | str | None
|
|
810
811
|
:type undo: bool | None
|
|
811
812
|
:param unselected: Unselected, Hide unselected rather than selected layers
|
|
812
|
-
:type unselected: bool |
|
|
813
|
+
:type unselected: bool | None
|
|
813
814
|
"""
|
|
814
815
|
|
|
815
816
|
...
|
|
@@ -819,8 +820,8 @@ def image_to_grease_pencil(
|
|
|
819
820
|
execution_context: int | str | None = None,
|
|
820
821
|
undo: bool | None = None,
|
|
821
822
|
*,
|
|
822
|
-
size:
|
|
823
|
-
mask: bool |
|
|
823
|
+
size: float | None = 0.005,
|
|
824
|
+
mask: bool | None = False,
|
|
824
825
|
):
|
|
825
826
|
"""Generate a Grease Pencil Object using Image as source
|
|
826
827
|
|
|
@@ -828,9 +829,9 @@ def image_to_grease_pencil(
|
|
|
828
829
|
:type execution_context: int | str | None
|
|
829
830
|
:type undo: bool | None
|
|
830
831
|
:param size: Point Size, Size used for grease pencil points
|
|
831
|
-
:type size:
|
|
832
|
+
:type size: float | None
|
|
832
833
|
:param mask: Generate Mask, Create an inverted image for masking using alpha channel
|
|
833
|
-
:type mask: bool |
|
|
834
|
+
:type mask: bool | None
|
|
834
835
|
"""
|
|
835
836
|
|
|
836
837
|
...
|
|
@@ -840,14 +841,14 @@ def interpolate(
|
|
|
840
841
|
execution_context: int | str | None = None,
|
|
841
842
|
undo: bool | None = None,
|
|
842
843
|
*,
|
|
843
|
-
shift:
|
|
844
|
+
shift: float | None = 0.0,
|
|
844
845
|
layers: str | None = "ACTIVE",
|
|
845
|
-
interpolate_selected_only: bool |
|
|
846
|
-
exclude_breakdowns: bool |
|
|
846
|
+
interpolate_selected_only: bool | None = False,
|
|
847
|
+
exclude_breakdowns: bool | None = False,
|
|
847
848
|
flip: str | None = "AUTO",
|
|
848
|
-
smooth_steps:
|
|
849
|
-
smooth_factor:
|
|
850
|
-
release_confirm: bool |
|
|
849
|
+
smooth_steps: int | None = 1,
|
|
850
|
+
smooth_factor: float | None = 0.0,
|
|
851
|
+
release_confirm: bool | None = False,
|
|
851
852
|
):
|
|
852
853
|
"""Interpolate grease pencil strokes between frames
|
|
853
854
|
|
|
@@ -855,21 +856,21 @@ def interpolate(
|
|
|
855
856
|
:type execution_context: int | str | None
|
|
856
857
|
:type undo: bool | None
|
|
857
858
|
:param shift: Shift, Bias factor for which frame has more influence on the interpolated strokes
|
|
858
|
-
:type shift:
|
|
859
|
+
:type shift: float | None
|
|
859
860
|
:param layers: Layer, Layers included in the interpolation
|
|
860
861
|
:type layers: str | None
|
|
861
862
|
:param interpolate_selected_only: Only Selected, Interpolate only selected strokes
|
|
862
|
-
:type interpolate_selected_only: bool |
|
|
863
|
+
:type interpolate_selected_only: bool | None
|
|
863
864
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
864
|
-
:type exclude_breakdowns: bool |
|
|
865
|
+
:type exclude_breakdowns: bool | None
|
|
865
866
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
866
867
|
:type flip: str | None
|
|
867
868
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
868
|
-
:type smooth_steps:
|
|
869
|
+
:type smooth_steps: int | None
|
|
869
870
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
870
|
-
:type smooth_factor:
|
|
871
|
+
:type smooth_factor: float | None
|
|
871
872
|
:param release_confirm: Confirm on Release
|
|
872
|
-
:type release_confirm: bool |
|
|
873
|
+
:type release_confirm: bool | None
|
|
873
874
|
"""
|
|
874
875
|
|
|
875
876
|
...
|
|
@@ -893,18 +894,18 @@ def interpolate_sequence(
|
|
|
893
894
|
execution_context: int | str | None = None,
|
|
894
895
|
undo: bool | None = None,
|
|
895
896
|
*,
|
|
896
|
-
step:
|
|
897
|
+
step: int | None = 1,
|
|
897
898
|
layers: str | None = "ACTIVE",
|
|
898
|
-
interpolate_selected_only: bool |
|
|
899
|
-
exclude_breakdowns: bool |
|
|
899
|
+
interpolate_selected_only: bool | None = False,
|
|
900
|
+
exclude_breakdowns: bool | None = False,
|
|
900
901
|
flip: str | None = "AUTO",
|
|
901
|
-
smooth_steps:
|
|
902
|
-
smooth_factor:
|
|
902
|
+
smooth_steps: int | None = 1,
|
|
903
|
+
smooth_factor: float | None = 0.0,
|
|
903
904
|
type: str | None = "LINEAR",
|
|
904
905
|
easing: str | None = "AUTO",
|
|
905
|
-
back:
|
|
906
|
-
amplitude:
|
|
907
|
-
period:
|
|
906
|
+
back: float | None = 1.702,
|
|
907
|
+
amplitude: float | None = 0.15,
|
|
908
|
+
period: float | None = 0.15,
|
|
908
909
|
):
|
|
909
910
|
"""Generate 'in-betweens' to smoothly interpolate between Grease Pencil frames
|
|
910
911
|
|
|
@@ -912,19 +913,19 @@ def interpolate_sequence(
|
|
|
912
913
|
:type execution_context: int | str | None
|
|
913
914
|
:type undo: bool | None
|
|
914
915
|
:param step: Step, Number of frames between generated interpolated frames
|
|
915
|
-
:type step:
|
|
916
|
+
:type step: int | None
|
|
916
917
|
:param layers: Layer, Layers included in the interpolation
|
|
917
918
|
:type layers: str | None
|
|
918
919
|
:param interpolate_selected_only: Only Selected, Interpolate only selected strokes
|
|
919
|
-
:type interpolate_selected_only: bool |
|
|
920
|
+
:type interpolate_selected_only: bool | None
|
|
920
921
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
921
|
-
:type exclude_breakdowns: bool |
|
|
922
|
+
:type exclude_breakdowns: bool | None
|
|
922
923
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
923
924
|
:type flip: str | None
|
|
924
925
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
925
|
-
:type smooth_steps:
|
|
926
|
+
:type smooth_steps: int | None
|
|
926
927
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
927
|
-
:type smooth_factor:
|
|
928
|
+
:type smooth_factor: float | None
|
|
928
929
|
:param type: Type, Interpolation method to use the next time 'Interpolate Sequence' is run
|
|
929
930
|
|
|
930
931
|
LINEAR
|
|
@@ -978,11 +979,11 @@ def interpolate_sequence(
|
|
|
978
979
|
Ease In and Out -- Segment between both keyframes.
|
|
979
980
|
:type easing: str | None
|
|
980
981
|
:param back: Back, Amount of overshoot for 'back' easing
|
|
981
|
-
:type back:
|
|
982
|
+
:type back: float | None
|
|
982
983
|
:param amplitude: Amplitude, Amount to boost elastic bounces for 'elastic' easing
|
|
983
|
-
:type amplitude:
|
|
984
|
+
:type amplitude: float | None
|
|
984
985
|
:param period: Period, Time between bounces for elastic easing
|
|
985
|
-
:type period:
|
|
986
|
+
:type period: float | None
|
|
986
987
|
"""
|
|
987
988
|
|
|
988
989
|
...
|
|
@@ -992,7 +993,7 @@ def layer_active(
|
|
|
992
993
|
execution_context: int | str | None = None,
|
|
993
994
|
undo: bool | None = None,
|
|
994
995
|
*,
|
|
995
|
-
layer:
|
|
996
|
+
layer: int | None = 0,
|
|
996
997
|
):
|
|
997
998
|
"""Active Grease Pencil layer
|
|
998
999
|
|
|
@@ -1000,7 +1001,7 @@ def layer_active(
|
|
|
1000
1001
|
:type execution_context: int | str | None
|
|
1001
1002
|
:type undo: bool | None
|
|
1002
1003
|
:param layer: Grease Pencil Layer
|
|
1003
|
-
:type layer:
|
|
1004
|
+
:type layer: int | None
|
|
1004
1005
|
"""
|
|
1005
1006
|
|
|
1006
1007
|
...
|
|
@@ -1010,8 +1011,8 @@ def layer_add(
|
|
|
1010
1011
|
execution_context: int | str | None = None,
|
|
1011
1012
|
undo: bool | None = None,
|
|
1012
1013
|
*,
|
|
1013
|
-
layer:
|
|
1014
|
-
new_layer_name: str
|
|
1014
|
+
layer: int | None = 0,
|
|
1015
|
+
new_layer_name: str = "",
|
|
1015
1016
|
):
|
|
1016
1017
|
"""Add new layer or note for the active data-block
|
|
1017
1018
|
|
|
@@ -1019,9 +1020,9 @@ def layer_add(
|
|
|
1019
1020
|
:type execution_context: int | str | None
|
|
1020
1021
|
:type undo: bool | None
|
|
1021
1022
|
:param layer: Grease Pencil Layer
|
|
1022
|
-
:type layer:
|
|
1023
|
+
:type layer: int | None
|
|
1023
1024
|
:param new_layer_name: Name, Name of the newly added layer
|
|
1024
|
-
:type new_layer_name: str
|
|
1025
|
+
:type new_layer_name: str
|
|
1025
1026
|
"""
|
|
1026
1027
|
|
|
1027
1028
|
...
|
|
@@ -1114,7 +1115,7 @@ def layer_duplicate_object(
|
|
|
1114
1115
|
undo: bool | None = None,
|
|
1115
1116
|
*,
|
|
1116
1117
|
mode: str | None = "ALL",
|
|
1117
|
-
only_active: bool |
|
|
1118
|
+
only_active: bool | None = True,
|
|
1118
1119
|
):
|
|
1119
1120
|
"""Make a copy of the active Grease Pencil layer to selected object
|
|
1120
1121
|
|
|
@@ -1124,7 +1125,7 @@ def layer_duplicate_object(
|
|
|
1124
1125
|
:param mode: Mode
|
|
1125
1126
|
:type mode: str | None
|
|
1126
1127
|
:param only_active: Only Active, Copy only active Layer, uncheck to append all layers
|
|
1127
|
-
:type only_active: bool |
|
|
1128
|
+
:type only_active: bool | None
|
|
1128
1129
|
"""
|
|
1129
1130
|
|
|
1130
1131
|
...
|
|
@@ -1134,7 +1135,7 @@ def layer_isolate(
|
|
|
1134
1135
|
execution_context: int | str | None = None,
|
|
1135
1136
|
undo: bool | None = None,
|
|
1136
1137
|
*,
|
|
1137
|
-
affect_visibility: bool |
|
|
1138
|
+
affect_visibility: bool | None = False,
|
|
1138
1139
|
):
|
|
1139
1140
|
"""Toggle whether the active layer is the only one that can be edited and/or visible
|
|
1140
1141
|
|
|
@@ -1142,7 +1143,7 @@ def layer_isolate(
|
|
|
1142
1143
|
:type execution_context: int | str | None
|
|
1143
1144
|
:type undo: bool | None
|
|
1144
1145
|
:param affect_visibility: Affect Visibility, In addition to toggling the editability, also affect the visibility
|
|
1145
|
-
:type affect_visibility: bool |
|
|
1146
|
+
:type affect_visibility: bool | None
|
|
1146
1147
|
"""
|
|
1147
1148
|
|
|
1148
1149
|
...
|
|
@@ -1152,7 +1153,7 @@ def layer_mask_add(
|
|
|
1152
1153
|
execution_context: int | str | None = None,
|
|
1153
1154
|
undo: bool | None = None,
|
|
1154
1155
|
*,
|
|
1155
|
-
name: str
|
|
1156
|
+
name: str = "",
|
|
1156
1157
|
):
|
|
1157
1158
|
"""Add new layer as masking
|
|
1158
1159
|
|
|
@@ -1160,7 +1161,7 @@ def layer_mask_add(
|
|
|
1160
1161
|
:type execution_context: int | str | None
|
|
1161
1162
|
:type undo: bool | None
|
|
1162
1163
|
:param name: Layer, Name of the layer
|
|
1163
|
-
:type name: str
|
|
1164
|
+
:type name: str
|
|
1164
1165
|
"""
|
|
1165
1166
|
|
|
1166
1167
|
...
|
|
@@ -1286,7 +1287,7 @@ def material_hide(
|
|
|
1286
1287
|
execution_context: int | str | None = None,
|
|
1287
1288
|
undo: bool | None = None,
|
|
1288
1289
|
*,
|
|
1289
|
-
unselected: bool |
|
|
1290
|
+
unselected: bool | None = False,
|
|
1290
1291
|
):
|
|
1291
1292
|
"""Hide selected/unselected Grease Pencil materials
|
|
1292
1293
|
|
|
@@ -1294,7 +1295,7 @@ def material_hide(
|
|
|
1294
1295
|
:type execution_context: int | str | None
|
|
1295
1296
|
:type undo: bool | None
|
|
1296
1297
|
:param unselected: Unselected, Hide unselected rather than selected colors
|
|
1297
|
-
:type unselected: bool |
|
|
1298
|
+
:type unselected: bool | None
|
|
1298
1299
|
"""
|
|
1299
1300
|
|
|
1300
1301
|
...
|
|
@@ -1304,7 +1305,7 @@ def material_isolate(
|
|
|
1304
1305
|
execution_context: int | str | None = None,
|
|
1305
1306
|
undo: bool | None = None,
|
|
1306
1307
|
*,
|
|
1307
|
-
affect_visibility: bool |
|
|
1308
|
+
affect_visibility: bool | None = False,
|
|
1308
1309
|
):
|
|
1309
1310
|
"""Toggle whether the active material is the only one that is editable and/or visible
|
|
1310
1311
|
|
|
@@ -1312,7 +1313,7 @@ def material_isolate(
|
|
|
1312
1313
|
:type execution_context: int | str | None
|
|
1313
1314
|
:type undo: bool | None
|
|
1314
1315
|
:param affect_visibility: Affect Visibility, In addition to toggling the editability, also affect the visibility
|
|
1315
|
-
:type affect_visibility: bool |
|
|
1316
|
+
:type affect_visibility: bool | None
|
|
1316
1317
|
"""
|
|
1317
1318
|
|
|
1318
1319
|
...
|
|
@@ -1364,7 +1365,7 @@ def material_select(
|
|
|
1364
1365
|
execution_context: int | str | None = None,
|
|
1365
1366
|
undo: bool | None = None,
|
|
1366
1367
|
*,
|
|
1367
|
-
deselect: bool |
|
|
1368
|
+
deselect: bool | None = False,
|
|
1368
1369
|
):
|
|
1369
1370
|
"""Select/Deselect all Grease Pencil strokes using current material
|
|
1370
1371
|
|
|
@@ -1372,7 +1373,7 @@ def material_select(
|
|
|
1372
1373
|
:type execution_context: int | str | None
|
|
1373
1374
|
:type undo: bool | None
|
|
1374
1375
|
:param deselect: Deselect, Unselect strokes
|
|
1375
|
-
:type deselect: bool |
|
|
1376
|
+
:type deselect: bool | None
|
|
1376
1377
|
"""
|
|
1377
1378
|
|
|
1378
1379
|
...
|
|
@@ -1400,10 +1401,10 @@ def material_to_vertex_color(
|
|
|
1400
1401
|
execution_context: int | str | None = None,
|
|
1401
1402
|
undo: bool | None = None,
|
|
1402
1403
|
*,
|
|
1403
|
-
remove: bool |
|
|
1404
|
-
palette: bool |
|
|
1405
|
-
selected: bool |
|
|
1406
|
-
threshold:
|
|
1404
|
+
remove: bool | None = True,
|
|
1405
|
+
palette: bool | None = True,
|
|
1406
|
+
selected: bool | None = False,
|
|
1407
|
+
threshold: int | None = 3,
|
|
1407
1408
|
):
|
|
1408
1409
|
"""Replace materials in strokes with Vertex Color
|
|
1409
1410
|
|
|
@@ -1411,13 +1412,13 @@ def material_to_vertex_color(
|
|
|
1411
1412
|
:type execution_context: int | str | None
|
|
1412
1413
|
:type undo: bool | None
|
|
1413
1414
|
:param remove: Remove Unused Materials, Remove any unused material after the conversion
|
|
1414
|
-
:type remove: bool |
|
|
1415
|
+
:type remove: bool | None
|
|
1415
1416
|
:param palette: Create Palette, Create a new palette with colors
|
|
1416
|
-
:type palette: bool |
|
|
1417
|
+
:type palette: bool | None
|
|
1417
1418
|
:param selected: Only Selected, Convert only selected strokes
|
|
1418
|
-
:type selected: bool |
|
|
1419
|
+
:type selected: bool | None
|
|
1419
1420
|
:param threshold: Threshold
|
|
1420
|
-
:type threshold:
|
|
1421
|
+
:type threshold: int | None
|
|
1421
1422
|
"""
|
|
1422
1423
|
|
|
1423
1424
|
...
|
|
@@ -1441,7 +1442,7 @@ def materials_copy_to_object(
|
|
|
1441
1442
|
execution_context: int | str | None = None,
|
|
1442
1443
|
undo: bool | None = None,
|
|
1443
1444
|
*,
|
|
1444
|
-
only_active: bool |
|
|
1445
|
+
only_active: bool | None = True,
|
|
1445
1446
|
):
|
|
1446
1447
|
"""Append Materials of the active Grease Pencil to other object
|
|
1447
1448
|
|
|
@@ -1449,7 +1450,7 @@ def materials_copy_to_object(
|
|
|
1449
1450
|
:type execution_context: int | str | None
|
|
1450
1451
|
:type undo: bool | None
|
|
1451
1452
|
:param only_active: Only Active, Append only active material, uncheck to append all materials
|
|
1452
|
-
:type only_active: bool |
|
|
1453
|
+
:type only_active: bool | None
|
|
1453
1454
|
"""
|
|
1454
1455
|
|
|
1455
1456
|
...
|
|
@@ -1459,8 +1460,8 @@ def move_to_layer(
|
|
|
1459
1460
|
execution_context: int | str | None = None,
|
|
1460
1461
|
undo: bool | None = None,
|
|
1461
1462
|
*,
|
|
1462
|
-
layer:
|
|
1463
|
-
new_layer_name: str
|
|
1463
|
+
layer: int | None = 0,
|
|
1464
|
+
new_layer_name: str = "",
|
|
1464
1465
|
):
|
|
1465
1466
|
"""Move selected strokes to another layer
|
|
1466
1467
|
|
|
@@ -1468,9 +1469,9 @@ def move_to_layer(
|
|
|
1468
1469
|
:type execution_context: int | str | None
|
|
1469
1470
|
:type undo: bool | None
|
|
1470
1471
|
:param layer: Grease Pencil Layer
|
|
1471
|
-
:type layer:
|
|
1472
|
+
:type layer: int | None
|
|
1472
1473
|
:param new_layer_name: Name, Name of the newly added layer
|
|
1473
|
-
:type new_layer_name: str
|
|
1474
|
+
:type new_layer_name: str
|
|
1474
1475
|
"""
|
|
1475
1476
|
|
|
1476
1477
|
...
|
|
@@ -1480,7 +1481,7 @@ def paintmode_toggle(
|
|
|
1480
1481
|
execution_context: int | str | None = None,
|
|
1481
1482
|
undo: bool | None = None,
|
|
1482
1483
|
*,
|
|
1483
|
-
back: bool |
|
|
1484
|
+
back: bool | None = False,
|
|
1484
1485
|
):
|
|
1485
1486
|
"""Enter/Exit paint mode for Grease Pencil strokes
|
|
1486
1487
|
|
|
@@ -1488,7 +1489,7 @@ def paintmode_toggle(
|
|
|
1488
1489
|
:type execution_context: int | str | None
|
|
1489
1490
|
:type undo: bool | None
|
|
1490
1491
|
:param back: Return to Previous Mode, Return to previous mode
|
|
1491
|
-
:type back: bool |
|
|
1492
|
+
:type back: bool | None
|
|
1492
1493
|
"""
|
|
1493
1494
|
|
|
1494
1495
|
...
|
|
@@ -1499,7 +1500,7 @@ def paste(
|
|
|
1499
1500
|
undo: bool | None = None,
|
|
1500
1501
|
*,
|
|
1501
1502
|
type: str | None = "ACTIVE",
|
|
1502
|
-
paste_back: bool |
|
|
1503
|
+
paste_back: bool | None = False,
|
|
1503
1504
|
):
|
|
1504
1505
|
"""Paste previously copied strokes to active layer or to original layer
|
|
1505
1506
|
|
|
@@ -1509,7 +1510,7 @@ def paste(
|
|
|
1509
1510
|
:param type: Type
|
|
1510
1511
|
:type type: str | None
|
|
1511
1512
|
:param paste_back: Paste on Back, Add pasted strokes behind all strokes
|
|
1512
|
-
:type paste_back: bool |
|
|
1513
|
+
:type paste_back: bool | None
|
|
1513
1514
|
"""
|
|
1514
1515
|
|
|
1515
1516
|
...
|
|
@@ -1519,10 +1520,10 @@ def primitive_box(
|
|
|
1519
1520
|
execution_context: int | str | None = None,
|
|
1520
1521
|
undo: bool | None = None,
|
|
1521
1522
|
*,
|
|
1522
|
-
subdivision:
|
|
1523
|
-
edges:
|
|
1523
|
+
subdivision: int | None = 3,
|
|
1524
|
+
edges: int | None = 1,
|
|
1524
1525
|
type: str | None = "BOX",
|
|
1525
|
-
wait_for_input: bool |
|
|
1526
|
+
wait_for_input: bool | None = True,
|
|
1526
1527
|
):
|
|
1527
1528
|
"""Create predefined grease pencil stroke box shapes
|
|
1528
1529
|
|
|
@@ -1530,13 +1531,13 @@ def primitive_box(
|
|
|
1530
1531
|
:type execution_context: int | str | None
|
|
1531
1532
|
:type undo: bool | None
|
|
1532
1533
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1533
|
-
:type subdivision:
|
|
1534
|
+
:type subdivision: int | None
|
|
1534
1535
|
:param edges: Edges, Number of points per segment
|
|
1535
|
-
:type edges:
|
|
1536
|
+
:type edges: int | None
|
|
1536
1537
|
:param type: Type, Type of shape
|
|
1537
1538
|
:type type: str | None
|
|
1538
1539
|
:param wait_for_input: Wait for Input
|
|
1539
|
-
:type wait_for_input: bool |
|
|
1540
|
+
:type wait_for_input: bool | None
|
|
1540
1541
|
"""
|
|
1541
1542
|
|
|
1542
1543
|
...
|
|
@@ -1546,10 +1547,10 @@ def primitive_circle(
|
|
|
1546
1547
|
execution_context: int | str | None = None,
|
|
1547
1548
|
undo: bool | None = None,
|
|
1548
1549
|
*,
|
|
1549
|
-
subdivision:
|
|
1550
|
-
edges:
|
|
1550
|
+
subdivision: int | None = 94,
|
|
1551
|
+
edges: int | None = 1,
|
|
1551
1552
|
type: str | None = "CIRCLE",
|
|
1552
|
-
wait_for_input: bool |
|
|
1553
|
+
wait_for_input: bool | None = True,
|
|
1553
1554
|
):
|
|
1554
1555
|
"""Create predefined grease pencil stroke circle shapes
|
|
1555
1556
|
|
|
@@ -1557,13 +1558,13 @@ def primitive_circle(
|
|
|
1557
1558
|
:type execution_context: int | str | None
|
|
1558
1559
|
:type undo: bool | None
|
|
1559
1560
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1560
|
-
:type subdivision:
|
|
1561
|
+
:type subdivision: int | None
|
|
1561
1562
|
:param edges: Edges, Number of points per segment
|
|
1562
|
-
:type edges:
|
|
1563
|
+
:type edges: int | None
|
|
1563
1564
|
:param type: Type, Type of shape
|
|
1564
1565
|
:type type: str | None
|
|
1565
1566
|
:param wait_for_input: Wait for Input
|
|
1566
|
-
:type wait_for_input: bool |
|
|
1567
|
+
:type wait_for_input: bool | None
|
|
1567
1568
|
"""
|
|
1568
1569
|
|
|
1569
1570
|
...
|
|
@@ -1573,10 +1574,10 @@ def primitive_curve(
|
|
|
1573
1574
|
execution_context: int | str | None = None,
|
|
1574
1575
|
undo: bool | None = None,
|
|
1575
1576
|
*,
|
|
1576
|
-
subdivision:
|
|
1577
|
-
edges:
|
|
1577
|
+
subdivision: int | None = 62,
|
|
1578
|
+
edges: int | None = 1,
|
|
1578
1579
|
type: str | None = "CURVE",
|
|
1579
|
-
wait_for_input: bool |
|
|
1580
|
+
wait_for_input: bool | None = True,
|
|
1580
1581
|
):
|
|
1581
1582
|
"""Create predefined grease pencil stroke curve shapes
|
|
1582
1583
|
|
|
@@ -1584,13 +1585,13 @@ def primitive_curve(
|
|
|
1584
1585
|
:type execution_context: int | str | None
|
|
1585
1586
|
:type undo: bool | None
|
|
1586
1587
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1587
|
-
:type subdivision:
|
|
1588
|
+
:type subdivision: int | None
|
|
1588
1589
|
:param edges: Edges, Number of points per segment
|
|
1589
|
-
:type edges:
|
|
1590
|
+
:type edges: int | None
|
|
1590
1591
|
:param type: Type, Type of shape
|
|
1591
1592
|
:type type: str | None
|
|
1592
1593
|
:param wait_for_input: Wait for Input
|
|
1593
|
-
:type wait_for_input: bool |
|
|
1594
|
+
:type wait_for_input: bool | None
|
|
1594
1595
|
"""
|
|
1595
1596
|
|
|
1596
1597
|
...
|
|
@@ -1600,10 +1601,10 @@ def primitive_line(
|
|
|
1600
1601
|
execution_context: int | str | None = None,
|
|
1601
1602
|
undo: bool | None = None,
|
|
1602
1603
|
*,
|
|
1603
|
-
subdivision:
|
|
1604
|
-
edges:
|
|
1604
|
+
subdivision: int | None = 6,
|
|
1605
|
+
edges: int | None = 1,
|
|
1605
1606
|
type: str | None = "LINE",
|
|
1606
|
-
wait_for_input: bool |
|
|
1607
|
+
wait_for_input: bool | None = True,
|
|
1607
1608
|
):
|
|
1608
1609
|
"""Create predefined grease pencil stroke lines
|
|
1609
1610
|
|
|
@@ -1611,13 +1612,13 @@ def primitive_line(
|
|
|
1611
1612
|
:type execution_context: int | str | None
|
|
1612
1613
|
:type undo: bool | None
|
|
1613
1614
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1614
|
-
:type subdivision:
|
|
1615
|
+
:type subdivision: int | None
|
|
1615
1616
|
:param edges: Edges, Number of points per segment
|
|
1616
|
-
:type edges:
|
|
1617
|
+
:type edges: int | None
|
|
1617
1618
|
:param type: Type, Type of shape
|
|
1618
1619
|
:type type: str | None
|
|
1619
1620
|
:param wait_for_input: Wait for Input
|
|
1620
|
-
:type wait_for_input: bool |
|
|
1621
|
+
:type wait_for_input: bool | None
|
|
1621
1622
|
"""
|
|
1622
1623
|
|
|
1623
1624
|
...
|
|
@@ -1627,10 +1628,10 @@ def primitive_polyline(
|
|
|
1627
1628
|
execution_context: int | str | None = None,
|
|
1628
1629
|
undo: bool | None = None,
|
|
1629
1630
|
*,
|
|
1630
|
-
subdivision:
|
|
1631
|
-
edges:
|
|
1631
|
+
subdivision: int | None = 6,
|
|
1632
|
+
edges: int | None = 1,
|
|
1632
1633
|
type: str | None = "POLYLINE",
|
|
1633
|
-
wait_for_input: bool |
|
|
1634
|
+
wait_for_input: bool | None = True,
|
|
1634
1635
|
):
|
|
1635
1636
|
"""Create predefined grease pencil stroke polylines
|
|
1636
1637
|
|
|
@@ -1638,13 +1639,13 @@ def primitive_polyline(
|
|
|
1638
1639
|
:type execution_context: int | str | None
|
|
1639
1640
|
:type undo: bool | None
|
|
1640
1641
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1641
|
-
:type subdivision:
|
|
1642
|
+
:type subdivision: int | None
|
|
1642
1643
|
:param edges: Edges, Number of points per segment
|
|
1643
|
-
:type edges:
|
|
1644
|
+
:type edges: int | None
|
|
1644
1645
|
:param type: Type, Type of shape
|
|
1645
1646
|
:type type: str | None
|
|
1646
1647
|
:param wait_for_input: Wait for Input
|
|
1647
|
-
:type wait_for_input: bool |
|
|
1648
|
+
:type wait_for_input: bool | None
|
|
1648
1649
|
"""
|
|
1649
1650
|
|
|
1650
1651
|
...
|
|
@@ -1669,8 +1670,8 @@ def reproject(
|
|
|
1669
1670
|
undo: bool | None = None,
|
|
1670
1671
|
*,
|
|
1671
1672
|
type: str | None = "VIEW",
|
|
1672
|
-
keep_original: bool |
|
|
1673
|
-
offset:
|
|
1673
|
+
keep_original: bool | None = False,
|
|
1674
|
+
offset: float | None = 0.0,
|
|
1674
1675
|
):
|
|
1675
1676
|
"""Reproject the selected strokes from the current viewpoint as if they had been newly drawn (e.g. to fix problems from accidental 3D cursor movement or accidental viewport changes, or for matching deforming geometry)
|
|
1676
1677
|
|
|
@@ -1698,9 +1699,9 @@ def reproject(
|
|
|
1698
1699
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
1699
1700
|
:type type: str | None
|
|
1700
1701
|
:param keep_original: Keep Original, Keep original strokes and create a copy before reprojecting
|
|
1701
|
-
:type keep_original: bool |
|
|
1702
|
+
:type keep_original: bool | None
|
|
1702
1703
|
:param offset: Surface Offset
|
|
1703
|
-
:type offset:
|
|
1704
|
+
:type offset: float | None
|
|
1704
1705
|
"""
|
|
1705
1706
|
|
|
1706
1707
|
...
|
|
@@ -1728,7 +1729,7 @@ def reveal(
|
|
|
1728
1729
|
execution_context: int | str | None = None,
|
|
1729
1730
|
undo: bool | None = None,
|
|
1730
1731
|
*,
|
|
1731
|
-
select: bool |
|
|
1732
|
+
select: bool | None = True,
|
|
1732
1733
|
):
|
|
1733
1734
|
"""Show all Grease Pencil layers
|
|
1734
1735
|
|
|
@@ -1736,7 +1737,7 @@ def reveal(
|
|
|
1736
1737
|
:type execution_context: int | str | None
|
|
1737
1738
|
:type undo: bool | None
|
|
1738
1739
|
:param select: Select
|
|
1739
|
-
:type select: bool |
|
|
1740
|
+
:type select: bool | None
|
|
1740
1741
|
"""
|
|
1741
1742
|
|
|
1742
1743
|
...
|
|
@@ -1748,7 +1749,7 @@ def sculpt_paint(
|
|
|
1748
1749
|
*,
|
|
1749
1750
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
1750
1751
|
| None = None,
|
|
1751
|
-
wait_for_input: bool |
|
|
1752
|
+
wait_for_input: bool | None = True,
|
|
1752
1753
|
):
|
|
1753
1754
|
"""Apply tweaks to strokes by painting over the strokes
|
|
1754
1755
|
|
|
@@ -1758,7 +1759,7 @@ def sculpt_paint(
|
|
|
1758
1759
|
:param stroke: Stroke
|
|
1759
1760
|
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
1760
1761
|
:param wait_for_input: Wait for Input, Enter a mini 'sculpt-mode' if enabled, otherwise, exit after drawing a single stroke
|
|
1761
|
-
:type wait_for_input: bool |
|
|
1762
|
+
:type wait_for_input: bool | None
|
|
1762
1763
|
"""
|
|
1763
1764
|
|
|
1764
1765
|
...
|
|
@@ -1768,7 +1769,7 @@ def sculptmode_toggle(
|
|
|
1768
1769
|
execution_context: int | str | None = None,
|
|
1769
1770
|
undo: bool | None = None,
|
|
1770
1771
|
*,
|
|
1771
|
-
back: bool |
|
|
1772
|
+
back: bool | None = False,
|
|
1772
1773
|
):
|
|
1773
1774
|
"""Enter/Exit sculpt mode for Grease Pencil strokes
|
|
1774
1775
|
|
|
@@ -1776,7 +1777,7 @@ def sculptmode_toggle(
|
|
|
1776
1777
|
:type execution_context: int | str | None
|
|
1777
1778
|
:type undo: bool | None
|
|
1778
1779
|
:param back: Return to Previous Mode, Return to previous mode
|
|
1779
|
-
:type back: bool |
|
|
1780
|
+
:type back: bool | None
|
|
1780
1781
|
"""
|
|
1781
1782
|
|
|
1782
1783
|
...
|
|
@@ -1786,7 +1787,7 @@ def segment_add(
|
|
|
1786
1787
|
execution_context: int | str | None = None,
|
|
1787
1788
|
undo: bool | None = None,
|
|
1788
1789
|
*,
|
|
1789
|
-
modifier: str
|
|
1790
|
+
modifier: str = "",
|
|
1790
1791
|
):
|
|
1791
1792
|
"""Add a segment to the dash modifier
|
|
1792
1793
|
|
|
@@ -1794,7 +1795,7 @@ def segment_add(
|
|
|
1794
1795
|
:type execution_context: int | str | None
|
|
1795
1796
|
:type undo: bool | None
|
|
1796
1797
|
:param modifier: Modifier, Name of the modifier to edit
|
|
1797
|
-
:type modifier: str
|
|
1798
|
+
:type modifier: str
|
|
1798
1799
|
"""
|
|
1799
1800
|
|
|
1800
1801
|
...
|
|
@@ -1804,7 +1805,7 @@ def segment_move(
|
|
|
1804
1805
|
execution_context: int | str | None = None,
|
|
1805
1806
|
undo: bool | None = None,
|
|
1806
1807
|
*,
|
|
1807
|
-
modifier: str
|
|
1808
|
+
modifier: str = "",
|
|
1808
1809
|
type: str | None = "UP",
|
|
1809
1810
|
):
|
|
1810
1811
|
"""Move the active dash segment up or down
|
|
@@ -1813,7 +1814,7 @@ def segment_move(
|
|
|
1813
1814
|
:type execution_context: int | str | None
|
|
1814
1815
|
:type undo: bool | None
|
|
1815
1816
|
:param modifier: Modifier, Name of the modifier to edit
|
|
1816
|
-
:type modifier: str
|
|
1817
|
+
:type modifier: str
|
|
1817
1818
|
:param type: Type
|
|
1818
1819
|
:type type: str | None
|
|
1819
1820
|
"""
|
|
@@ -1825,8 +1826,8 @@ def segment_remove(
|
|
|
1825
1826
|
execution_context: int | str | None = None,
|
|
1826
1827
|
undo: bool | None = None,
|
|
1827
1828
|
*,
|
|
1828
|
-
modifier: str
|
|
1829
|
-
index:
|
|
1829
|
+
modifier: str = "",
|
|
1830
|
+
index: int | None = 0,
|
|
1830
1831
|
):
|
|
1831
1832
|
"""Remove the active segment from the dash modifier
|
|
1832
1833
|
|
|
@@ -1834,9 +1835,9 @@ def segment_remove(
|
|
|
1834
1835
|
:type execution_context: int | str | None
|
|
1835
1836
|
:type undo: bool | None
|
|
1836
1837
|
:param modifier: Modifier, Name of the modifier to edit
|
|
1837
|
-
:type modifier: str
|
|
1838
|
+
:type modifier: str
|
|
1838
1839
|
:param index: Index, Index of the segment to remove
|
|
1839
|
-
:type index:
|
|
1840
|
+
:type index: int | None
|
|
1840
1841
|
"""
|
|
1841
1842
|
|
|
1842
1843
|
...
|
|
@@ -1846,14 +1847,14 @@ def select(
|
|
|
1846
1847
|
execution_context: int | str | None = None,
|
|
1847
1848
|
undo: bool | None = None,
|
|
1848
1849
|
*,
|
|
1849
|
-
extend: bool |
|
|
1850
|
-
deselect: bool |
|
|
1851
|
-
toggle: bool |
|
|
1852
|
-
deselect_all: bool |
|
|
1853
|
-
select_passthrough: bool |
|
|
1854
|
-
entire_strokes: bool |
|
|
1855
|
-
location:
|
|
1856
|
-
use_shift_extend: bool |
|
|
1850
|
+
extend: bool | None = False,
|
|
1851
|
+
deselect: bool | None = False,
|
|
1852
|
+
toggle: bool | None = False,
|
|
1853
|
+
deselect_all: bool | None = False,
|
|
1854
|
+
select_passthrough: bool | None = False,
|
|
1855
|
+
entire_strokes: bool | None = False,
|
|
1856
|
+
location: collections.abc.Iterable[int] | None = (0, 0),
|
|
1857
|
+
use_shift_extend: bool | None = False,
|
|
1857
1858
|
):
|
|
1858
1859
|
"""Select Grease Pencil strokes and/or stroke points
|
|
1859
1860
|
|
|
@@ -1861,21 +1862,21 @@ def select(
|
|
|
1861
1862
|
:type execution_context: int | str | None
|
|
1862
1863
|
:type undo: bool | None
|
|
1863
1864
|
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
1864
|
-
:type extend: bool |
|
|
1865
|
+
:type extend: bool | None
|
|
1865
1866
|
:param deselect: Deselect, Remove from selection
|
|
1866
|
-
:type deselect: bool |
|
|
1867
|
+
:type deselect: bool | None
|
|
1867
1868
|
:param toggle: Toggle Selection, Toggle the selection
|
|
1868
|
-
:type toggle: bool |
|
|
1869
|
+
:type toggle: bool | None
|
|
1869
1870
|
:param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
|
|
1870
|
-
:type deselect_all: bool |
|
|
1871
|
+
:type deselect_all: bool | None
|
|
1871
1872
|
:param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
|
|
1872
|
-
:type select_passthrough: bool |
|
|
1873
|
+
:type select_passthrough: bool | None
|
|
1873
1874
|
:param entire_strokes: Entire Strokes, Select entire strokes instead of just the nearest stroke vertex
|
|
1874
|
-
:type entire_strokes: bool |
|
|
1875
|
+
:type entire_strokes: bool | None
|
|
1875
1876
|
:param location: Location, Mouse location
|
|
1876
|
-
:type location:
|
|
1877
|
+
:type location: collections.abc.Iterable[int] | None
|
|
1877
1878
|
:param use_shift_extend: Extend
|
|
1878
|
-
:type use_shift_extend: bool |
|
|
1879
|
+
:type use_shift_extend: bool | None
|
|
1879
1880
|
"""
|
|
1880
1881
|
|
|
1881
1882
|
...
|
|
@@ -1915,7 +1916,7 @@ def select_alternate(
|
|
|
1915
1916
|
execution_context: int | str | None = None,
|
|
1916
1917
|
undo: bool | None = None,
|
|
1917
1918
|
*,
|
|
1918
|
-
unselect_ends: bool |
|
|
1919
|
+
unselect_ends: bool | None = False,
|
|
1919
1920
|
):
|
|
1920
1921
|
"""Select alternative points in same strokes as already selected points
|
|
1921
1922
|
|
|
@@ -1923,7 +1924,7 @@ def select_alternate(
|
|
|
1923
1924
|
:type execution_context: int | str | None
|
|
1924
1925
|
:type undo: bool | None
|
|
1925
1926
|
:param unselect_ends: Unselect Ends, Do not select the first and last point of the stroke
|
|
1926
|
-
:type unselect_ends: bool |
|
|
1927
|
+
:type unselect_ends: bool | None
|
|
1927
1928
|
"""
|
|
1928
1929
|
|
|
1929
1930
|
...
|
|
@@ -1933,11 +1934,11 @@ def select_box(
|
|
|
1933
1934
|
execution_context: int | str | None = None,
|
|
1934
1935
|
undo: bool | None = None,
|
|
1935
1936
|
*,
|
|
1936
|
-
xmin:
|
|
1937
|
-
xmax:
|
|
1938
|
-
ymin:
|
|
1939
|
-
ymax:
|
|
1940
|
-
wait_for_input: bool |
|
|
1937
|
+
xmin: int | None = 0,
|
|
1938
|
+
xmax: int | None = 0,
|
|
1939
|
+
ymin: int | None = 0,
|
|
1940
|
+
ymax: int | None = 0,
|
|
1941
|
+
wait_for_input: bool | None = True,
|
|
1941
1942
|
mode: str | None = "SET",
|
|
1942
1943
|
):
|
|
1943
1944
|
"""Select Grease Pencil strokes within a rectangular region
|
|
@@ -1946,15 +1947,15 @@ def select_box(
|
|
|
1946
1947
|
:type execution_context: int | str | None
|
|
1947
1948
|
:type undo: bool | None
|
|
1948
1949
|
:param xmin: X Min
|
|
1949
|
-
:type xmin:
|
|
1950
|
+
:type xmin: int | None
|
|
1950
1951
|
:param xmax: X Max
|
|
1951
|
-
:type xmax:
|
|
1952
|
+
:type xmax: int | None
|
|
1952
1953
|
:param ymin: Y Min
|
|
1953
|
-
:type ymin:
|
|
1954
|
+
:type ymin: int | None
|
|
1954
1955
|
:param ymax: Y Max
|
|
1955
|
-
:type ymax:
|
|
1956
|
+
:type ymax: int | None
|
|
1956
1957
|
:param wait_for_input: Wait for Input
|
|
1957
|
-
:type wait_for_input: bool |
|
|
1958
|
+
:type wait_for_input: bool | None
|
|
1958
1959
|
:param mode: Mode
|
|
1959
1960
|
|
|
1960
1961
|
SET
|
|
@@ -1981,10 +1982,10 @@ def select_circle(
|
|
|
1981
1982
|
execution_context: int | str | None = None,
|
|
1982
1983
|
undo: bool | None = None,
|
|
1983
1984
|
*,
|
|
1984
|
-
x:
|
|
1985
|
-
y:
|
|
1986
|
-
radius:
|
|
1987
|
-
wait_for_input: bool |
|
|
1985
|
+
x: int | None = 0,
|
|
1986
|
+
y: int | None = 0,
|
|
1987
|
+
radius: int | None = 25,
|
|
1988
|
+
wait_for_input: bool | None = True,
|
|
1988
1989
|
mode: str | None = "SET",
|
|
1989
1990
|
):
|
|
1990
1991
|
"""Select Grease Pencil strokes using brush selection
|
|
@@ -1993,13 +1994,13 @@ def select_circle(
|
|
|
1993
1994
|
:type execution_context: int | str | None
|
|
1994
1995
|
:type undo: bool | None
|
|
1995
1996
|
:param x: X
|
|
1996
|
-
:type x:
|
|
1997
|
+
:type x: int | None
|
|
1997
1998
|
:param y: Y
|
|
1998
|
-
:type y:
|
|
1999
|
+
:type y: int | None
|
|
1999
2000
|
:param radius: Radius
|
|
2000
|
-
:type radius:
|
|
2001
|
+
:type radius: int | None
|
|
2001
2002
|
:param wait_for_input: Wait for Input
|
|
2002
|
-
:type wait_for_input: bool |
|
|
2003
|
+
:type wait_for_input: bool | None
|
|
2003
2004
|
:param mode: Mode
|
|
2004
2005
|
|
|
2005
2006
|
SET
|
|
@@ -2020,8 +2021,8 @@ def select_first(
|
|
|
2020
2021
|
execution_context: int | str | None = None,
|
|
2021
2022
|
undo: bool | None = None,
|
|
2022
2023
|
*,
|
|
2023
|
-
only_selected_strokes: bool |
|
|
2024
|
-
extend: bool |
|
|
2024
|
+
only_selected_strokes: bool | None = False,
|
|
2025
|
+
extend: bool | None = False,
|
|
2025
2026
|
):
|
|
2026
2027
|
"""Select first point in Grease Pencil strokes
|
|
2027
2028
|
|
|
@@ -2029,9 +2030,9 @@ def select_first(
|
|
|
2029
2030
|
:type execution_context: int | str | None
|
|
2030
2031
|
:type undo: bool | None
|
|
2031
2032
|
:param only_selected_strokes: Selected Strokes Only, Only select the first point of strokes that already have points selected
|
|
2032
|
-
:type only_selected_strokes: bool |
|
|
2033
|
+
:type only_selected_strokes: bool | None
|
|
2033
2034
|
:param extend: Extend, Extend selection instead of deselecting all other selected points
|
|
2034
|
-
:type extend: bool |
|
|
2035
|
+
:type extend: bool | None
|
|
2035
2036
|
"""
|
|
2036
2037
|
|
|
2037
2038
|
...
|
|
@@ -2101,8 +2102,8 @@ def select_last(
|
|
|
2101
2102
|
execution_context: int | str | None = None,
|
|
2102
2103
|
undo: bool | None = None,
|
|
2103
2104
|
*,
|
|
2104
|
-
only_selected_strokes: bool |
|
|
2105
|
-
extend: bool |
|
|
2105
|
+
only_selected_strokes: bool | None = False,
|
|
2106
|
+
extend: bool | None = False,
|
|
2106
2107
|
):
|
|
2107
2108
|
"""Select last point in Grease Pencil strokes
|
|
2108
2109
|
|
|
@@ -2110,9 +2111,9 @@ def select_last(
|
|
|
2110
2111
|
:type execution_context: int | str | None
|
|
2111
2112
|
:type undo: bool | None
|
|
2112
2113
|
:param only_selected_strokes: Selected Strokes Only, Only select the last point of strokes that already have points selected
|
|
2113
|
-
:type only_selected_strokes: bool |
|
|
2114
|
+
:type only_selected_strokes: bool | None
|
|
2114
2115
|
:param extend: Extend, Extend selection instead of deselecting all other selected points
|
|
2115
|
-
:type extend: bool |
|
|
2116
|
+
:type extend: bool | None
|
|
2116
2117
|
"""
|
|
2117
2118
|
|
|
2118
2119
|
...
|
|
@@ -2164,10 +2165,10 @@ def select_random(
|
|
|
2164
2165
|
execution_context: int | str | None = None,
|
|
2165
2166
|
undo: bool | None = None,
|
|
2166
2167
|
*,
|
|
2167
|
-
ratio:
|
|
2168
|
-
seed:
|
|
2168
|
+
ratio: float | None = 0.5,
|
|
2169
|
+
seed: int | None = 0,
|
|
2169
2170
|
action: str | None = "SELECT",
|
|
2170
|
-
unselect_ends: bool |
|
|
2171
|
+
unselect_ends: bool | None = False,
|
|
2171
2172
|
):
|
|
2172
2173
|
"""Select random points for non selected strokes
|
|
2173
2174
|
|
|
@@ -2175,9 +2176,9 @@ def select_random(
|
|
|
2175
2176
|
:type execution_context: int | str | None
|
|
2176
2177
|
:type undo: bool | None
|
|
2177
2178
|
:param ratio: Ratio, Portion of items to select randomly
|
|
2178
|
-
:type ratio:
|
|
2179
|
+
:type ratio: float | None
|
|
2179
2180
|
:param seed: Random Seed, Seed for the random number generator
|
|
2180
|
-
:type seed:
|
|
2181
|
+
:type seed: int | None
|
|
2181
2182
|
:param action: Action, Selection action to execute
|
|
2182
2183
|
|
|
2183
2184
|
SELECT
|
|
@@ -2187,7 +2188,7 @@ def select_random(
|
|
|
2187
2188
|
Deselect -- Deselect all elements.
|
|
2188
2189
|
:type action: str | None
|
|
2189
2190
|
:param unselect_ends: Unselect Ends, Do not select the first and last point of the stroke
|
|
2190
|
-
:type unselect_ends: bool |
|
|
2191
|
+
:type unselect_ends: bool | None
|
|
2191
2192
|
"""
|
|
2192
2193
|
|
|
2193
2194
|
...
|
|
@@ -2197,7 +2198,7 @@ def select_vertex_color(
|
|
|
2197
2198
|
execution_context: int | str | None = None,
|
|
2198
2199
|
undo: bool | None = None,
|
|
2199
2200
|
*,
|
|
2200
|
-
threshold:
|
|
2201
|
+
threshold: int | None = 0,
|
|
2201
2202
|
):
|
|
2202
2203
|
"""Select all points with similar vertex color of current selected
|
|
2203
2204
|
|
|
@@ -2205,7 +2206,7 @@ def select_vertex_color(
|
|
|
2205
2206
|
:type execution_context: int | str | None
|
|
2206
2207
|
:type undo: bool | None
|
|
2207
2208
|
:param threshold: Threshold, Tolerance of the selection. Higher values select a wider range of similar colors
|
|
2208
|
-
:type threshold:
|
|
2209
|
+
:type threshold: int | None
|
|
2209
2210
|
"""
|
|
2210
2211
|
|
|
2211
2212
|
...
|
|
@@ -2229,7 +2230,7 @@ def selectmode_toggle(
|
|
|
2229
2230
|
execution_context: int | str | None = None,
|
|
2230
2231
|
undo: bool | None = None,
|
|
2231
2232
|
*,
|
|
2232
|
-
mode:
|
|
2233
|
+
mode: int | None = 0,
|
|
2233
2234
|
):
|
|
2234
2235
|
"""Set selection mode for Grease Pencil strokes
|
|
2235
2236
|
|
|
@@ -2237,7 +2238,7 @@ def selectmode_toggle(
|
|
|
2237
2238
|
:type execution_context: int | str | None
|
|
2238
2239
|
:type undo: bool | None
|
|
2239
2240
|
:param mode: Select Mode, Select mode
|
|
2240
|
-
:type mode:
|
|
2241
|
+
:type mode: int | None
|
|
2241
2242
|
"""
|
|
2242
2243
|
|
|
2243
2244
|
...
|
|
@@ -2275,7 +2276,7 @@ def snap_to_cursor(
|
|
|
2275
2276
|
execution_context: int | str | None = None,
|
|
2276
2277
|
undo: bool | None = None,
|
|
2277
2278
|
*,
|
|
2278
|
-
use_offset: bool |
|
|
2279
|
+
use_offset: bool | None = True,
|
|
2279
2280
|
):
|
|
2280
2281
|
"""Snap selected points/strokes to the cursor
|
|
2281
2282
|
|
|
@@ -2283,7 +2284,7 @@ def snap_to_cursor(
|
|
|
2283
2284
|
:type execution_context: int | str | None
|
|
2284
2285
|
:type undo: bool | None
|
|
2285
2286
|
:param use_offset: With Offset, Offset the entire stroke instead of selected points only
|
|
2286
|
-
:type use_offset: bool |
|
|
2287
|
+
:type use_offset: bool | None
|
|
2287
2288
|
"""
|
|
2288
2289
|
|
|
2289
2290
|
...
|
|
@@ -2369,7 +2370,7 @@ def stroke_change_color(
|
|
|
2369
2370
|
execution_context: int | str | None = None,
|
|
2370
2371
|
undo: bool | None = None,
|
|
2371
2372
|
*,
|
|
2372
|
-
material: str
|
|
2373
|
+
material: str = "",
|
|
2373
2374
|
):
|
|
2374
2375
|
"""Move selected strokes to active material
|
|
2375
2376
|
|
|
@@ -2377,7 +2378,7 @@ def stroke_change_color(
|
|
|
2377
2378
|
:type execution_context: int | str | None
|
|
2378
2379
|
:type undo: bool | None
|
|
2379
2380
|
:param material: Material, Name of the material
|
|
2380
|
-
:type material: str
|
|
2381
|
+
:type material: str
|
|
2381
2382
|
"""
|
|
2382
2383
|
|
|
2383
2384
|
...
|
|
@@ -2388,7 +2389,7 @@ def stroke_cutter(
|
|
|
2388
2389
|
undo: bool | None = None,
|
|
2389
2390
|
*,
|
|
2390
2391
|
path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None = None,
|
|
2391
|
-
flat_caps: bool |
|
|
2392
|
+
flat_caps: bool | None = False,
|
|
2392
2393
|
):
|
|
2393
2394
|
"""Select section and cut
|
|
2394
2395
|
|
|
@@ -2398,7 +2399,7 @@ def stroke_cutter(
|
|
|
2398
2399
|
:param path: Path
|
|
2399
2400
|
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
2400
2401
|
:param flat_caps: Flat Caps
|
|
2401
|
-
:type flat_caps: bool |
|
|
2402
|
+
:type flat_caps: bool | None
|
|
2402
2403
|
"""
|
|
2403
2404
|
|
|
2404
2405
|
...
|
|
@@ -2409,7 +2410,7 @@ def stroke_cyclical_set(
|
|
|
2409
2410
|
undo: bool | None = None,
|
|
2410
2411
|
*,
|
|
2411
2412
|
type: str | None = "TOGGLE",
|
|
2412
|
-
geometry: bool |
|
|
2413
|
+
geometry: bool | None = False,
|
|
2413
2414
|
):
|
|
2414
2415
|
"""Close or open the selected stroke adding a segment from last to first point
|
|
2415
2416
|
|
|
@@ -2419,7 +2420,7 @@ def stroke_cyclical_set(
|
|
|
2419
2420
|
:param type: Type
|
|
2420
2421
|
:type type: str | None
|
|
2421
2422
|
:param geometry: Create Geometry, Create new geometry for closing stroke
|
|
2422
|
-
:type geometry: bool |
|
|
2423
|
+
:type geometry: bool | None
|
|
2423
2424
|
"""
|
|
2424
2425
|
|
|
2425
2426
|
...
|
|
@@ -2447,7 +2448,7 @@ def stroke_enter_editcurve_mode(
|
|
|
2447
2448
|
execution_context: int | str | None = None,
|
|
2448
2449
|
undo: bool | None = None,
|
|
2449
2450
|
*,
|
|
2450
|
-
error_threshold:
|
|
2451
|
+
error_threshold: float | None = 0.1,
|
|
2451
2452
|
):
|
|
2452
2453
|
"""Called to transform a stroke into a curve
|
|
2453
2454
|
|
|
@@ -2455,7 +2456,7 @@ def stroke_enter_editcurve_mode(
|
|
|
2455
2456
|
:type execution_context: int | str | None
|
|
2456
2457
|
:type undo: bool | None
|
|
2457
2458
|
:param error_threshold: Error Threshold, Threshold on the maximum deviation from the actual stroke
|
|
2458
|
-
:type error_threshold:
|
|
2459
|
+
:type error_threshold: float | None
|
|
2459
2460
|
"""
|
|
2460
2461
|
|
|
2461
2462
|
...
|
|
@@ -2480,7 +2481,7 @@ def stroke_join(
|
|
|
2480
2481
|
undo: bool | None = None,
|
|
2481
2482
|
*,
|
|
2482
2483
|
type: str | None = "JOIN",
|
|
2483
|
-
leave_gaps: bool |
|
|
2484
|
+
leave_gaps: bool | None = False,
|
|
2484
2485
|
):
|
|
2485
2486
|
"""Join selected strokes (optionally as new stroke)
|
|
2486
2487
|
|
|
@@ -2490,7 +2491,7 @@ def stroke_join(
|
|
|
2490
2491
|
:param type: Type
|
|
2491
2492
|
:type type: str | None
|
|
2492
2493
|
:param leave_gaps: Leave Gaps, Leave gaps between joined strokes instead of linking them
|
|
2493
|
-
:type leave_gaps: bool |
|
|
2494
|
+
:type leave_gaps: bool | None
|
|
2494
2495
|
"""
|
|
2495
2496
|
|
|
2496
2497
|
...
|
|
@@ -2501,11 +2502,11 @@ def stroke_merge(
|
|
|
2501
2502
|
undo: bool | None = None,
|
|
2502
2503
|
*,
|
|
2503
2504
|
mode: str | None = "STROKE",
|
|
2504
|
-
back: bool |
|
|
2505
|
-
additive: bool |
|
|
2506
|
-
cyclic: bool |
|
|
2507
|
-
clear_point: bool |
|
|
2508
|
-
clear_stroke: bool |
|
|
2505
|
+
back: bool | None = False,
|
|
2506
|
+
additive: bool | None = False,
|
|
2507
|
+
cyclic: bool | None = False,
|
|
2508
|
+
clear_point: bool | None = False,
|
|
2509
|
+
clear_stroke: bool | None = False,
|
|
2509
2510
|
):
|
|
2510
2511
|
"""Create a new stroke with the selected stroke points
|
|
2511
2512
|
|
|
@@ -2515,15 +2516,15 @@ def stroke_merge(
|
|
|
2515
2516
|
:param mode: Mode
|
|
2516
2517
|
:type mode: str | None
|
|
2517
2518
|
:param back: Draw on Back, Draw new stroke below all previous strokes
|
|
2518
|
-
:type back: bool |
|
|
2519
|
+
:type back: bool | None
|
|
2519
2520
|
:param additive: Additive Drawing, Add to previous drawing
|
|
2520
|
-
:type additive: bool |
|
|
2521
|
+
:type additive: bool | None
|
|
2521
2522
|
:param cyclic: Cyclic, Close new stroke
|
|
2522
|
-
:type cyclic: bool |
|
|
2523
|
+
:type cyclic: bool | None
|
|
2523
2524
|
:param clear_point: Dissolve Points, Dissolve old selected points
|
|
2524
|
-
:type clear_point: bool |
|
|
2525
|
+
:type clear_point: bool | None
|
|
2525
2526
|
:param clear_stroke: Delete Strokes, Delete old selected strokes
|
|
2526
|
-
:type clear_stroke: bool |
|
|
2527
|
+
:type clear_stroke: bool | None
|
|
2527
2528
|
"""
|
|
2528
2529
|
|
|
2529
2530
|
...
|
|
@@ -2533,8 +2534,8 @@ def stroke_merge_by_distance(
|
|
|
2533
2534
|
execution_context: int | str | None = None,
|
|
2534
2535
|
undo: bool | None = None,
|
|
2535
2536
|
*,
|
|
2536
|
-
threshold:
|
|
2537
|
-
use_unselected: bool |
|
|
2537
|
+
threshold: float | None = 0.001,
|
|
2538
|
+
use_unselected: bool | None = False,
|
|
2538
2539
|
):
|
|
2539
2540
|
"""Merge points by distance
|
|
2540
2541
|
|
|
@@ -2542,9 +2543,9 @@ def stroke_merge_by_distance(
|
|
|
2542
2543
|
:type execution_context: int | str | None
|
|
2543
2544
|
:type undo: bool | None
|
|
2544
2545
|
:param threshold: Threshold
|
|
2545
|
-
:type threshold:
|
|
2546
|
+
:type threshold: float | None
|
|
2546
2547
|
:param use_unselected: Unselected, Use whole stroke, not only selected points
|
|
2547
|
-
:type use_unselected: bool |
|
|
2548
|
+
:type use_unselected: bool | None
|
|
2548
2549
|
"""
|
|
2549
2550
|
|
|
2550
2551
|
...
|
|
@@ -2554,9 +2555,9 @@ def stroke_merge_material(
|
|
|
2554
2555
|
execution_context: int | str | None = None,
|
|
2555
2556
|
undo: bool | None = None,
|
|
2556
2557
|
*,
|
|
2557
|
-
hue_threshold:
|
|
2558
|
-
sat_threshold:
|
|
2559
|
-
val_threshold:
|
|
2558
|
+
hue_threshold: float | None = 0.001,
|
|
2559
|
+
sat_threshold: float | None = 0.001,
|
|
2560
|
+
val_threshold: float | None = 0.001,
|
|
2560
2561
|
):
|
|
2561
2562
|
"""Replace materials in strokes merging similar
|
|
2562
2563
|
|
|
@@ -2564,11 +2565,11 @@ def stroke_merge_material(
|
|
|
2564
2565
|
:type execution_context: int | str | None
|
|
2565
2566
|
:type undo: bool | None
|
|
2566
2567
|
:param hue_threshold: Hue Threshold
|
|
2567
|
-
:type hue_threshold:
|
|
2568
|
+
:type hue_threshold: float | None
|
|
2568
2569
|
:param sat_threshold: Saturation Threshold
|
|
2569
|
-
:type sat_threshold:
|
|
2570
|
+
:type sat_threshold: float | None
|
|
2570
2571
|
:param val_threshold: Value Threshold
|
|
2571
|
-
:type val_threshold:
|
|
2572
|
+
:type val_threshold: float | None
|
|
2572
2573
|
"""
|
|
2573
2574
|
|
|
2574
2575
|
...
|
|
@@ -2579,8 +2580,8 @@ def stroke_normalize(
|
|
|
2579
2580
|
undo: bool | None = None,
|
|
2580
2581
|
*,
|
|
2581
2582
|
mode: str | None = "THICKNESS",
|
|
2582
|
-
factor:
|
|
2583
|
-
value:
|
|
2583
|
+
factor: float | None = 1.0,
|
|
2584
|
+
value: int | None = 10,
|
|
2584
2585
|
):
|
|
2585
2586
|
"""Normalize stroke attributes
|
|
2586
2587
|
|
|
@@ -2596,9 +2597,9 @@ def stroke_normalize(
|
|
|
2596
2597
|
Opacity -- Normalizes the stroke opacity by making all points use the same opacity value.
|
|
2597
2598
|
:type mode: str | None
|
|
2598
2599
|
:param factor: Factor
|
|
2599
|
-
:type factor:
|
|
2600
|
+
:type factor: float | None
|
|
2600
2601
|
:param value: Value, Value
|
|
2601
|
-
:type value:
|
|
2602
|
+
:type value: int | None
|
|
2602
2603
|
"""
|
|
2603
2604
|
|
|
2604
2605
|
...
|
|
@@ -2610,10 +2611,10 @@ def stroke_outline(
|
|
|
2610
2611
|
*,
|
|
2611
2612
|
view_mode: str | None = "VIEW",
|
|
2612
2613
|
material_mode: str | None = "ACTIVE",
|
|
2613
|
-
thickness:
|
|
2614
|
-
keep: bool |
|
|
2615
|
-
subdivisions:
|
|
2616
|
-
length:
|
|
2614
|
+
thickness: int | None = 1,
|
|
2615
|
+
keep: bool | None = True,
|
|
2616
|
+
subdivisions: int | None = 3,
|
|
2617
|
+
length: float | None = 0.0,
|
|
2617
2618
|
):
|
|
2618
2619
|
"""Convert stroke to perimeter
|
|
2619
2620
|
|
|
@@ -2634,13 +2635,13 @@ def stroke_outline(
|
|
|
2634
2635
|
New Material.
|
|
2635
2636
|
:type material_mode: str | None
|
|
2636
2637
|
:param thickness: Thickness, Thickness of the stroke perimeter
|
|
2637
|
-
:type thickness:
|
|
2638
|
+
:type thickness: int | None
|
|
2638
2639
|
:param keep: Keep Shape, Try to keep global shape when the stroke thickness change
|
|
2639
|
-
:type keep: bool |
|
|
2640
|
+
:type keep: bool | None
|
|
2640
2641
|
:param subdivisions: Subdivisions
|
|
2641
|
-
:type subdivisions:
|
|
2642
|
+
:type subdivisions: int | None
|
|
2642
2643
|
:param length: Sample Length
|
|
2643
|
-
:type length:
|
|
2644
|
+
:type length: float | None
|
|
2644
2645
|
"""
|
|
2645
2646
|
|
|
2646
2647
|
...
|
|
@@ -2677,8 +2678,8 @@ def stroke_sample(
|
|
|
2677
2678
|
execution_context: int | str | None = None,
|
|
2678
2679
|
undo: bool | None = None,
|
|
2679
2680
|
*,
|
|
2680
|
-
length:
|
|
2681
|
-
sharp_threshold:
|
|
2681
|
+
length: float | None = 0.1,
|
|
2682
|
+
sharp_threshold: float | None = 0.1,
|
|
2682
2683
|
):
|
|
2683
2684
|
"""Sample stroke points to predefined segment length
|
|
2684
2685
|
|
|
@@ -2686,9 +2687,9 @@ def stroke_sample(
|
|
|
2686
2687
|
:type execution_context: int | str | None
|
|
2687
2688
|
:type undo: bool | None
|
|
2688
2689
|
:param length: Length
|
|
2689
|
-
:type length:
|
|
2690
|
+
:type length: float | None
|
|
2690
2691
|
:param sharp_threshold: Sharp Threshold
|
|
2691
|
-
:type sharp_threshold:
|
|
2692
|
+
:type sharp_threshold: float | None
|
|
2692
2693
|
"""
|
|
2693
2694
|
|
|
2694
2695
|
...
|
|
@@ -2725,7 +2726,7 @@ def stroke_simplify(
|
|
|
2725
2726
|
execution_context: int | str | None = None,
|
|
2726
2727
|
undo: bool | None = None,
|
|
2727
2728
|
*,
|
|
2728
|
-
factor:
|
|
2729
|
+
factor: float | None = 0.0,
|
|
2729
2730
|
):
|
|
2730
2731
|
"""Simplify selected strokes, reducing number of points
|
|
2731
2732
|
|
|
@@ -2733,7 +2734,7 @@ def stroke_simplify(
|
|
|
2733
2734
|
:type execution_context: int | str | None
|
|
2734
2735
|
:type undo: bool | None
|
|
2735
2736
|
:param factor: Factor
|
|
2736
|
-
:type factor:
|
|
2737
|
+
:type factor: float | None
|
|
2737
2738
|
"""
|
|
2738
2739
|
|
|
2739
2740
|
...
|
|
@@ -2743,7 +2744,7 @@ def stroke_simplify_fixed(
|
|
|
2743
2744
|
execution_context: int | str | None = None,
|
|
2744
2745
|
undo: bool | None = None,
|
|
2745
2746
|
*,
|
|
2746
|
-
step:
|
|
2747
|
+
step: int | None = 1,
|
|
2747
2748
|
):
|
|
2748
2749
|
"""Simplify selected strokes, reducing number of points using fixed algorithm
|
|
2749
2750
|
|
|
@@ -2751,7 +2752,7 @@ def stroke_simplify_fixed(
|
|
|
2751
2752
|
:type execution_context: int | str | None
|
|
2752
2753
|
:type undo: bool | None
|
|
2753
2754
|
:param step: Steps, Number of simplify steps
|
|
2754
|
-
:type step:
|
|
2755
|
+
:type step: int | None
|
|
2755
2756
|
"""
|
|
2756
2757
|
|
|
2757
2758
|
...
|
|
@@ -2761,13 +2762,13 @@ def stroke_smooth(
|
|
|
2761
2762
|
execution_context: int | str | None = None,
|
|
2762
2763
|
undo: bool | None = None,
|
|
2763
2764
|
*,
|
|
2764
|
-
repeat:
|
|
2765
|
-
factor:
|
|
2766
|
-
only_selected: bool |
|
|
2767
|
-
smooth_position: bool |
|
|
2768
|
-
smooth_thickness: bool |
|
|
2769
|
-
smooth_strength: bool |
|
|
2770
|
-
smooth_uv: bool |
|
|
2765
|
+
repeat: int | None = 2,
|
|
2766
|
+
factor: float | None = 1.0,
|
|
2767
|
+
only_selected: bool | None = True,
|
|
2768
|
+
smooth_position: bool | None = True,
|
|
2769
|
+
smooth_thickness: bool | None = True,
|
|
2770
|
+
smooth_strength: bool | None = False,
|
|
2771
|
+
smooth_uv: bool | None = False,
|
|
2771
2772
|
):
|
|
2772
2773
|
"""Smooth selected strokes
|
|
2773
2774
|
|
|
@@ -2775,19 +2776,19 @@ def stroke_smooth(
|
|
|
2775
2776
|
:type execution_context: int | str | None
|
|
2776
2777
|
:type undo: bool | None
|
|
2777
2778
|
:param repeat: Repeat
|
|
2778
|
-
:type repeat:
|
|
2779
|
+
:type repeat: int | None
|
|
2779
2780
|
:param factor: Factor
|
|
2780
|
-
:type factor:
|
|
2781
|
+
:type factor: float | None
|
|
2781
2782
|
:param only_selected: Selected Points, Smooth only selected points in the stroke
|
|
2782
|
-
:type only_selected: bool |
|
|
2783
|
+
:type only_selected: bool | None
|
|
2783
2784
|
:param smooth_position: Position
|
|
2784
|
-
:type smooth_position: bool |
|
|
2785
|
+
:type smooth_position: bool | None
|
|
2785
2786
|
:param smooth_thickness: Thickness
|
|
2786
|
-
:type smooth_thickness: bool |
|
|
2787
|
+
:type smooth_thickness: bool | None
|
|
2787
2788
|
:param smooth_strength: Strength
|
|
2788
|
-
:type smooth_strength: bool |
|
|
2789
|
+
:type smooth_strength: bool | None
|
|
2789
2790
|
:param smooth_uv: UV
|
|
2790
|
-
:type smooth_uv: bool |
|
|
2791
|
+
:type smooth_uv: bool | None
|
|
2791
2792
|
"""
|
|
2792
2793
|
|
|
2793
2794
|
...
|
|
@@ -2825,14 +2826,14 @@ def stroke_subdivide(
|
|
|
2825
2826
|
execution_context: int | str | None = None,
|
|
2826
2827
|
undo: bool | None = None,
|
|
2827
2828
|
*,
|
|
2828
|
-
number_cuts:
|
|
2829
|
-
factor:
|
|
2830
|
-
repeat:
|
|
2831
|
-
only_selected: bool |
|
|
2832
|
-
smooth_position: bool |
|
|
2833
|
-
smooth_thickness: bool |
|
|
2834
|
-
smooth_strength: bool |
|
|
2835
|
-
smooth_uv: bool |
|
|
2829
|
+
number_cuts: int | None = 1,
|
|
2830
|
+
factor: float | None = 0.0,
|
|
2831
|
+
repeat: int | None = 1,
|
|
2832
|
+
only_selected: bool | None = True,
|
|
2833
|
+
smooth_position: bool | None = True,
|
|
2834
|
+
smooth_thickness: bool | None = True,
|
|
2835
|
+
smooth_strength: bool | None = False,
|
|
2836
|
+
smooth_uv: bool | None = False,
|
|
2836
2837
|
):
|
|
2837
2838
|
"""Subdivide between continuous selected points of the stroke adding a point half way between them
|
|
2838
2839
|
|
|
@@ -2840,21 +2841,21 @@ def stroke_subdivide(
|
|
|
2840
2841
|
:type execution_context: int | str | None
|
|
2841
2842
|
:type undo: bool | None
|
|
2842
2843
|
:param number_cuts: Number of Cuts
|
|
2843
|
-
:type number_cuts:
|
|
2844
|
+
:type number_cuts: int | None
|
|
2844
2845
|
:param factor: Smooth
|
|
2845
|
-
:type factor:
|
|
2846
|
+
:type factor: float | None
|
|
2846
2847
|
:param repeat: Repeat
|
|
2847
|
-
:type repeat:
|
|
2848
|
+
:type repeat: int | None
|
|
2848
2849
|
:param only_selected: Selected Points, Smooth only selected points in the stroke
|
|
2849
|
-
:type only_selected: bool |
|
|
2850
|
+
:type only_selected: bool | None
|
|
2850
2851
|
:param smooth_position: Position
|
|
2851
|
-
:type smooth_position: bool |
|
|
2852
|
+
:type smooth_position: bool | None
|
|
2852
2853
|
:param smooth_thickness: Thickness
|
|
2853
|
-
:type smooth_thickness: bool |
|
|
2854
|
+
:type smooth_thickness: bool | None
|
|
2854
2855
|
:param smooth_strength: Strength
|
|
2855
|
-
:type smooth_strength: bool |
|
|
2856
|
+
:type smooth_strength: bool | None
|
|
2856
2857
|
:param smooth_uv: UV
|
|
2857
|
-
:type smooth_uv: bool |
|
|
2858
|
+
:type smooth_uv: bool | None
|
|
2858
2859
|
"""
|
|
2859
2860
|
|
|
2860
2861
|
...
|
|
@@ -2878,7 +2879,7 @@ def time_segment_add(
|
|
|
2878
2879
|
execution_context: int | str | None = None,
|
|
2879
2880
|
undo: bool | None = None,
|
|
2880
2881
|
*,
|
|
2881
|
-
modifier: str
|
|
2882
|
+
modifier: str = "",
|
|
2882
2883
|
):
|
|
2883
2884
|
"""Add a segment to the time modifier
|
|
2884
2885
|
|
|
@@ -2886,7 +2887,7 @@ def time_segment_add(
|
|
|
2886
2887
|
:type execution_context: int | str | None
|
|
2887
2888
|
:type undo: bool | None
|
|
2888
2889
|
:param modifier: Modifier, Name of the modifier to edit
|
|
2889
|
-
:type modifier: str
|
|
2890
|
+
:type modifier: str
|
|
2890
2891
|
"""
|
|
2891
2892
|
|
|
2892
2893
|
...
|
|
@@ -2896,7 +2897,7 @@ def time_segment_move(
|
|
|
2896
2897
|
execution_context: int | str | None = None,
|
|
2897
2898
|
undo: bool | None = None,
|
|
2898
2899
|
*,
|
|
2899
|
-
modifier: str
|
|
2900
|
+
modifier: str = "",
|
|
2900
2901
|
type: str | None = "UP",
|
|
2901
2902
|
):
|
|
2902
2903
|
"""Move the active time segment up or down
|
|
@@ -2905,7 +2906,7 @@ def time_segment_move(
|
|
|
2905
2906
|
:type execution_context: int | str | None
|
|
2906
2907
|
:type undo: bool | None
|
|
2907
2908
|
:param modifier: Modifier, Name of the modifier to edit
|
|
2908
|
-
:type modifier: str
|
|
2909
|
+
:type modifier: str
|
|
2909
2910
|
:param type: Type
|
|
2910
2911
|
:type type: str | None
|
|
2911
2912
|
"""
|
|
@@ -2917,8 +2918,8 @@ def time_segment_remove(
|
|
|
2917
2918
|
execution_context: int | str | None = None,
|
|
2918
2919
|
undo: bool | None = None,
|
|
2919
2920
|
*,
|
|
2920
|
-
modifier: str
|
|
2921
|
-
index:
|
|
2921
|
+
modifier: str = "",
|
|
2922
|
+
index: int | None = 0,
|
|
2922
2923
|
):
|
|
2923
2924
|
"""Remove the active segment from the time modifier
|
|
2924
2925
|
|
|
@@ -2926,9 +2927,9 @@ def time_segment_remove(
|
|
|
2926
2927
|
:type execution_context: int | str | None
|
|
2927
2928
|
:type undo: bool | None
|
|
2928
2929
|
:param modifier: Modifier, Name of the modifier to edit
|
|
2929
|
-
:type modifier: str
|
|
2930
|
+
:type modifier: str
|
|
2930
2931
|
:param index: Index, Index of the segment to remove
|
|
2931
|
-
:type index:
|
|
2932
|
+
:type index: int | None
|
|
2932
2933
|
"""
|
|
2933
2934
|
|
|
2934
2935
|
...
|
|
@@ -2953,15 +2954,15 @@ def trace_image(
|
|
|
2953
2954
|
undo: bool | None = None,
|
|
2954
2955
|
*,
|
|
2955
2956
|
target: str | None = "NEW",
|
|
2956
|
-
thickness:
|
|
2957
|
-
resolution:
|
|
2958
|
-
scale:
|
|
2959
|
-
sample:
|
|
2960
|
-
threshold:
|
|
2957
|
+
thickness: int | None = 10,
|
|
2958
|
+
resolution: int | None = 5,
|
|
2959
|
+
scale: float | None = 1.0,
|
|
2960
|
+
sample: float | None = 0.0,
|
|
2961
|
+
threshold: float | None = 0.5,
|
|
2961
2962
|
turnpolicy: str | None = "MINORITY",
|
|
2962
2963
|
mode: str | None = "SINGLE",
|
|
2963
|
-
use_current_frame: bool |
|
|
2964
|
-
frame_number:
|
|
2964
|
+
use_current_frame: bool | None = True,
|
|
2965
|
+
frame_number: int | None = 0,
|
|
2965
2966
|
):
|
|
2966
2967
|
"""Extract Grease Pencil strokes from image
|
|
2967
2968
|
|
|
@@ -2971,15 +2972,15 @@ def trace_image(
|
|
|
2971
2972
|
:param target: Target Object, Target grease pencil
|
|
2972
2973
|
:type target: str | None
|
|
2973
2974
|
:param thickness: Thickness
|
|
2974
|
-
:type thickness:
|
|
2975
|
+
:type thickness: int | None
|
|
2975
2976
|
:param resolution: Resolution, Resolution of the generated curves
|
|
2976
|
-
:type resolution:
|
|
2977
|
+
:type resolution: int | None
|
|
2977
2978
|
:param scale: Scale, Scale of the final stroke
|
|
2978
|
-
:type scale:
|
|
2979
|
+
:type scale: float | None
|
|
2979
2980
|
:param sample: Sample, Distance to sample points, zero to disable
|
|
2980
|
-
:type sample:
|
|
2981
|
+
:type sample: float | None
|
|
2981
2982
|
:param threshold: Color Threshold, Determine the lightness threshold above which strokes are generated
|
|
2982
|
-
:type threshold:
|
|
2983
|
+
:type threshold: float | None
|
|
2983
2984
|
:param turnpolicy: Turn Policy, Determines how to resolve ambiguities during decomposition of bitmaps into paths
|
|
2984
2985
|
|
|
2985
2986
|
BLACK
|
|
@@ -3012,9 +3013,9 @@ def trace_image(
|
|
|
3012
3013
|
Sequence -- Trace full sequence.
|
|
3013
3014
|
:type mode: str | None
|
|
3014
3015
|
:param use_current_frame: Start At Current Frame, Trace Image starting in current image frame
|
|
3015
|
-
:type use_current_frame: bool |
|
|
3016
|
+
:type use_current_frame: bool | None
|
|
3016
3017
|
:param frame_number: Trace Frame, Used to trace only one frame of the image sequence, set to zero to trace all
|
|
3017
|
-
:type frame_number:
|
|
3018
|
+
:type frame_number: int | None
|
|
3018
3019
|
"""
|
|
3019
3020
|
|
|
3020
3021
|
...
|
|
@@ -3025,10 +3026,10 @@ def transform_fill(
|
|
|
3025
3026
|
undo: bool | None = None,
|
|
3026
3027
|
*,
|
|
3027
3028
|
mode: str | None = "ROTATE",
|
|
3028
|
-
location:
|
|
3029
|
-
rotation:
|
|
3030
|
-
scale:
|
|
3031
|
-
release_confirm: bool |
|
|
3029
|
+
location: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
|
|
3030
|
+
rotation: float | None = 0.0,
|
|
3031
|
+
scale: float | None = 0.0,
|
|
3032
|
+
release_confirm: bool | None = False,
|
|
3032
3033
|
):
|
|
3033
3034
|
"""Transform grease pencil stroke fill
|
|
3034
3035
|
|
|
@@ -3038,13 +3039,13 @@ def transform_fill(
|
|
|
3038
3039
|
:param mode: Mode
|
|
3039
3040
|
:type mode: str | None
|
|
3040
3041
|
:param location: Location
|
|
3041
|
-
:type location:
|
|
3042
|
+
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
3042
3043
|
:param rotation: Rotation
|
|
3043
|
-
:type rotation:
|
|
3044
|
+
:type rotation: float | None
|
|
3044
3045
|
:param scale: Scale
|
|
3045
|
-
:type scale:
|
|
3046
|
+
:type scale: float | None
|
|
3046
3047
|
:param release_confirm: Confirm on Release
|
|
3047
|
-
:type release_confirm: bool |
|
|
3048
|
+
:type release_confirm: bool | None
|
|
3048
3049
|
"""
|
|
3049
3050
|
|
|
3050
3051
|
...
|
|
@@ -3069,8 +3070,8 @@ def vertex_color_brightness_contrast(
|
|
|
3069
3070
|
undo: bool | None = None,
|
|
3070
3071
|
*,
|
|
3071
3072
|
mode: str | None = "BOTH",
|
|
3072
|
-
brightness:
|
|
3073
|
-
contrast:
|
|
3073
|
+
brightness: float | None = 0.0,
|
|
3074
|
+
contrast: float | None = 0.0,
|
|
3074
3075
|
):
|
|
3075
3076
|
"""Adjust vertex color brightness/contrast
|
|
3076
3077
|
|
|
@@ -3080,9 +3081,9 @@ def vertex_color_brightness_contrast(
|
|
|
3080
3081
|
:param mode: Mode
|
|
3081
3082
|
:type mode: str | None
|
|
3082
3083
|
:param brightness: Brightness
|
|
3083
|
-
:type brightness:
|
|
3084
|
+
:type brightness: float | None
|
|
3084
3085
|
:param contrast: Contrast
|
|
3085
|
-
:type contrast:
|
|
3086
|
+
:type contrast: float | None
|
|
3086
3087
|
"""
|
|
3087
3088
|
|
|
3088
3089
|
...
|
|
@@ -3093,9 +3094,9 @@ def vertex_color_hsv(
|
|
|
3093
3094
|
undo: bool | None = None,
|
|
3094
3095
|
*,
|
|
3095
3096
|
mode: str | None = "BOTH",
|
|
3096
|
-
h:
|
|
3097
|
-
s:
|
|
3098
|
-
v:
|
|
3097
|
+
h: float | None = 0.5,
|
|
3098
|
+
s: float | None = 1.0,
|
|
3099
|
+
v: float | None = 1.0,
|
|
3099
3100
|
):
|
|
3100
3101
|
"""Adjust vertex color HSV values
|
|
3101
3102
|
|
|
@@ -3105,11 +3106,11 @@ def vertex_color_hsv(
|
|
|
3105
3106
|
:param mode: Mode
|
|
3106
3107
|
:type mode: str | None
|
|
3107
3108
|
:param h: Hue
|
|
3108
|
-
:type h:
|
|
3109
|
+
:type h: float | None
|
|
3109
3110
|
:param s: Saturation
|
|
3110
|
-
:type s:
|
|
3111
|
+
:type s: float | None
|
|
3111
3112
|
:param v: Value
|
|
3112
|
-
:type v:
|
|
3113
|
+
:type v: float | None
|
|
3113
3114
|
"""
|
|
3114
3115
|
|
|
3115
3116
|
...
|
|
@@ -3138,8 +3139,8 @@ def vertex_color_levels(
|
|
|
3138
3139
|
undo: bool | None = None,
|
|
3139
3140
|
*,
|
|
3140
3141
|
mode: str | None = "BOTH",
|
|
3141
|
-
offset:
|
|
3142
|
-
gain:
|
|
3142
|
+
offset: float | None = 0.0,
|
|
3143
|
+
gain: float | None = 1.0,
|
|
3143
3144
|
):
|
|
3144
3145
|
"""Adjust levels of vertex colors
|
|
3145
3146
|
|
|
@@ -3149,9 +3150,9 @@ def vertex_color_levels(
|
|
|
3149
3150
|
:param mode: Mode
|
|
3150
3151
|
:type mode: str | None
|
|
3151
3152
|
:param offset: Offset, Value to add to colors
|
|
3152
|
-
:type offset:
|
|
3153
|
+
:type offset: float | None
|
|
3153
3154
|
:param gain: Gain, Value to multiply colors by
|
|
3154
|
-
:type gain:
|
|
3155
|
+
:type gain: float | None
|
|
3155
3156
|
"""
|
|
3156
3157
|
|
|
3157
3158
|
...
|
|
@@ -3162,7 +3163,7 @@ def vertex_color_set(
|
|
|
3162
3163
|
undo: bool | None = None,
|
|
3163
3164
|
*,
|
|
3164
3165
|
mode: str | None = "BOTH",
|
|
3165
|
-
factor:
|
|
3166
|
+
factor: float | None = 1.0,
|
|
3166
3167
|
):
|
|
3167
3168
|
"""Set active color to all selected vertex
|
|
3168
3169
|
|
|
@@ -3172,7 +3173,7 @@ def vertex_color_set(
|
|
|
3172
3173
|
:param mode: Mode
|
|
3173
3174
|
:type mode: str | None
|
|
3174
3175
|
:param factor: Factor, Mix Factor
|
|
3175
|
-
:type factor:
|
|
3176
|
+
:type factor: float | None
|
|
3176
3177
|
"""
|
|
3177
3178
|
|
|
3178
3179
|
...
|
|
@@ -3238,7 +3239,7 @@ def vertex_group_normalize_all(
|
|
|
3238
3239
|
execution_context: int | str | None = None,
|
|
3239
3240
|
undo: bool | None = None,
|
|
3240
3241
|
*,
|
|
3241
|
-
lock_active: bool |
|
|
3242
|
+
lock_active: bool | None = True,
|
|
3242
3243
|
):
|
|
3243
3244
|
"""Normalize all weights of all vertex groups, so that for each vertex, the sum of all weights is 1.0
|
|
3244
3245
|
|
|
@@ -3246,7 +3247,7 @@ def vertex_group_normalize_all(
|
|
|
3246
3247
|
:type execution_context: int | str | None
|
|
3247
3248
|
:type undo: bool | None
|
|
3248
3249
|
:param lock_active: Lock Active, Keep the values of the active group while normalizing others
|
|
3249
|
-
:type lock_active: bool |
|
|
3250
|
+
:type lock_active: bool | None
|
|
3250
3251
|
"""
|
|
3251
3252
|
|
|
3252
3253
|
...
|
|
@@ -3284,8 +3285,8 @@ def vertex_group_smooth(
|
|
|
3284
3285
|
execution_context: int | str | None = None,
|
|
3285
3286
|
undo: bool | None = None,
|
|
3286
3287
|
*,
|
|
3287
|
-
factor:
|
|
3288
|
-
repeat:
|
|
3288
|
+
factor: float | None = 0.5,
|
|
3289
|
+
repeat: int | None = 1,
|
|
3289
3290
|
):
|
|
3290
3291
|
"""Smooth weights to the active vertex group
|
|
3291
3292
|
|
|
@@ -3293,9 +3294,9 @@ def vertex_group_smooth(
|
|
|
3293
3294
|
:type execution_context: int | str | None
|
|
3294
3295
|
:type undo: bool | None
|
|
3295
3296
|
:param factor: Factor
|
|
3296
|
-
:type factor:
|
|
3297
|
+
:type factor: float | None
|
|
3297
3298
|
:param repeat: Iterations
|
|
3298
|
-
:type repeat:
|
|
3299
|
+
:type repeat: int | None
|
|
3299
3300
|
"""
|
|
3300
3301
|
|
|
3301
3302
|
...
|
|
@@ -3307,7 +3308,7 @@ def vertex_paint(
|
|
|
3307
3308
|
*,
|
|
3308
3309
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
3309
3310
|
| None = None,
|
|
3310
|
-
wait_for_input: bool |
|
|
3311
|
+
wait_for_input: bool | None = True,
|
|
3311
3312
|
):
|
|
3312
3313
|
"""Paint stroke points with a color
|
|
3313
3314
|
|
|
@@ -3317,7 +3318,7 @@ def vertex_paint(
|
|
|
3317
3318
|
:param stroke: Stroke
|
|
3318
3319
|
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
3319
3320
|
:param wait_for_input: Wait for Input
|
|
3320
|
-
:type wait_for_input: bool |
|
|
3321
|
+
:type wait_for_input: bool | None
|
|
3321
3322
|
"""
|
|
3322
3323
|
|
|
3323
3324
|
...
|
|
@@ -3327,7 +3328,7 @@ def vertexmode_toggle(
|
|
|
3327
3328
|
execution_context: int | str | None = None,
|
|
3328
3329
|
undo: bool | None = None,
|
|
3329
3330
|
*,
|
|
3330
|
-
back: bool |
|
|
3331
|
+
back: bool | None = False,
|
|
3331
3332
|
):
|
|
3332
3333
|
"""Enter/Exit vertex paint mode for Grease Pencil strokes
|
|
3333
3334
|
|
|
@@ -3335,7 +3336,7 @@ def vertexmode_toggle(
|
|
|
3335
3336
|
:type execution_context: int | str | None
|
|
3336
3337
|
:type undo: bool | None
|
|
3337
3338
|
:param back: Return to Previous Mode, Return to previous mode
|
|
3338
|
-
:type back: bool |
|
|
3339
|
+
:type back: bool | None
|
|
3339
3340
|
"""
|
|
3340
3341
|
|
|
3341
3342
|
...
|
|
@@ -3347,7 +3348,7 @@ def weight_paint(
|
|
|
3347
3348
|
*,
|
|
3348
3349
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
3349
3350
|
| None = None,
|
|
3350
|
-
wait_for_input: bool |
|
|
3351
|
+
wait_for_input: bool | None = True,
|
|
3351
3352
|
):
|
|
3352
3353
|
"""Draw weight on stroke points
|
|
3353
3354
|
|
|
@@ -3357,7 +3358,7 @@ def weight_paint(
|
|
|
3357
3358
|
:param stroke: Stroke
|
|
3358
3359
|
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
3359
3360
|
:param wait_for_input: Wait for Input
|
|
3360
|
-
:type wait_for_input: bool |
|
|
3361
|
+
:type wait_for_input: bool | None
|
|
3361
3362
|
"""
|
|
3362
3363
|
|
|
3363
3364
|
...
|
|
@@ -3395,7 +3396,7 @@ def weightmode_toggle(
|
|
|
3395
3396
|
execution_context: int | str | None = None,
|
|
3396
3397
|
undo: bool | None = None,
|
|
3397
3398
|
*,
|
|
3398
|
-
back: bool |
|
|
3399
|
+
back: bool | None = False,
|
|
3399
3400
|
):
|
|
3400
3401
|
"""Enter/Exit weight paint mode for Grease Pencil strokes
|
|
3401
3402
|
|
|
@@ -3403,7 +3404,7 @@ def weightmode_toggle(
|
|
|
3403
3404
|
:type execution_context: int | str | None
|
|
3404
3405
|
:type undo: bool | None
|
|
3405
3406
|
:param back: Return to Previous Mode, Return to previous mode
|
|
3406
|
-
:type back: bool |
|
|
3407
|
+
:type back: bool | None
|
|
3407
3408
|
"""
|
|
3408
3409
|
|
|
3409
3410
|
...
|