fake-bpy-module 20240803__py3-none-any.whl → 20240804__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.
- aud/__init__.pyi +77 -77
- bmesh/ops/__init__.pyi +54 -36
- bmesh/types/__init__.pyi +24 -24
- bpy/ops/action/__init__.pyi +55 -32
- bpy/ops/anim/__init__.pyi +22 -22
- bpy/ops/armature/__init__.pyi +47 -20
- bpy/ops/asset/__init__.pyi +5 -2
- bpy/ops/boid/__init__.pyi +12 -2
- bpy/ops/brush/__init__.pyi +18 -12
- bpy/ops/buttons/__init__.pyi +10 -4
- bpy/ops/cachefile/__init__.pyi +12 -6
- bpy/ops/clip/__init__.pyi +54 -38
- bpy/ops/console/__init__.pyi +17 -6
- bpy/ops/constraint/__init__.pyi +28 -28
- bpy/ops/curve/__init__.pyi +72 -34
- bpy/ops/curves/__init__.pyi +16 -16
- bpy/ops/dpaint/__init__.pyi +4 -4
- bpy/ops/ed/__init__.pyi +5 -2
- bpy/ops/export_anim/__init__.pyi +3 -2
- bpy/ops/export_scene/__init__.pyi +55 -45
- bpy/ops/file/__init__.pyi +40 -16
- bpy/ops/font/__init__.pyi +59 -16
- bpy/ops/geometry/__init__.pyi +55 -20
- bpy/ops/gpencil/__init__.pyi +155 -122
- bpy/ops/graph/__init__.pyi +131 -52
- bpy/ops/grease_pencil/__init__.pyi +78 -58
- bpy/ops/image/__init__.pyi +77 -54
- bpy/ops/import_anim/__init__.pyi +11 -8
- bpy/ops/import_scene/__init__.pyi +20 -18
- bpy/ops/info/__init__.pyi +4 -4
- bpy/ops/lattice/__init__.pyi +8 -8
- bpy/ops/marker/__init__.pyi +6 -6
- bpy/ops/mask/__init__.pyi +13 -12
- bpy/ops/mball/__init__.pyi +6 -6
- bpy/ops/mesh/__init__.pyi +290 -150
- bpy/ops/nla/__init__.pyi +28 -20
- bpy/ops/node/__init__.pyi +43 -32
- bpy/ops/object/__init__.pyi +651 -210
- bpy/ops/outliner/__init__.pyi +113 -32
- bpy/ops/paint/__init__.pyi +65 -56
- bpy/ops/palette/__init__.pyi +4 -4
- bpy/ops/particle/__init__.pyi +14 -14
- bpy/ops/pose/__init__.pyi +121 -44
- bpy/ops/preferences/__init__.pyi +9 -6
- bpy/ops/render/__init__.pyi +3 -2
- bpy/ops/rigidbody/__init__.pyi +45 -14
- bpy/ops/scene/__init__.pyi +69 -22
- bpy/ops/screen/__init__.pyi +78 -16
- bpy/ops/sculpt/__init__.pyi +131 -74
- bpy/ops/sculpt_curves/__init__.pyi +2 -2
- bpy/ops/sequencer/__init__.pyi +156 -60
- bpy/ops/sound/__init__.pyi +40 -16
- bpy/ops/surface/__init__.pyi +12 -12
- bpy/ops/text/__init__.pyi +65 -20
- bpy/ops/texture/__init__.pyi +2 -2
- bpy/ops/transform/__init__.pyi +344 -72
- bpy/ops/ui/__init__.pyi +9 -6
- bpy/ops/uilist/__init__.pyi +2 -2
- bpy/ops/uv/__init__.pyi +90 -66
- bpy/ops/view3d/__init__.pyi +36 -30
- bpy/ops/wm/__init__.pyi +443 -156
- bpy/types/__init__.pyi +28064 -2857
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/RECORD +72 -72
- freestyle/chainingiterators/__init__.pyi +4 -4
- freestyle/types/__init__.pyi +76 -63
- idprop/types/__init__.pyi +2 -2
- imbuf/types/__init__.pyi +2 -2
- mathutils/__init__.pyi +1004 -970
- mathutils/bvhtree/__init__.pyi +2 -2
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240803.dist-info → fake_bpy_module-20240804.dist-info}/top_level.txt +0 -0
bpy/ops/gpencil/__init__.pyi
CHANGED
|
@@ -41,9 +41,16 @@ def annotate(
|
|
|
41
41
|
execution_context: int | str | None = None,
|
|
42
42
|
undo: bool | None = None,
|
|
43
43
|
*,
|
|
44
|
-
mode:
|
|
45
|
-
|
|
46
|
-
|
|
44
|
+
mode: typing.Literal["DRAW", "DRAW_STRAIGHT", "DRAW_POLY", "ERASER"]
|
|
45
|
+
| None = "DRAW",
|
|
46
|
+
arrowstyle_start: typing.Literal[
|
|
47
|
+
"NONE", "ARROW", "ARROW_OPEN", "ARROW_OPEN_INVERTED", "DIAMOND"
|
|
48
|
+
]
|
|
49
|
+
| None = "NONE",
|
|
50
|
+
arrowstyle_end: typing.Literal[
|
|
51
|
+
"NONE", "ARROW", "ARROW_OPEN", "ARROW_OPEN_INVERTED", "DIAMOND"
|
|
52
|
+
]
|
|
53
|
+
| None = "NONE",
|
|
47
54
|
use_stabilizer: bool | None = False,
|
|
48
55
|
stabilizer_factor: float | None = 0.75,
|
|
49
56
|
stabilizer_radius: int | None = 35,
|
|
@@ -69,7 +76,7 @@ def annotate(
|
|
|
69
76
|
|
|
70
77
|
ERASER
|
|
71
78
|
Eraser -- Erase Annotation strokes.
|
|
72
|
-
:type mode:
|
|
79
|
+
:type mode: typing.Literal['DRAW','DRAW_STRAIGHT','DRAW_POLY','ERASER'] | None
|
|
73
80
|
:param arrowstyle_start: Start Arrow Style, Stroke start style
|
|
74
81
|
|
|
75
82
|
NONE
|
|
@@ -86,7 +93,7 @@ def annotate(
|
|
|
86
93
|
|
|
87
94
|
DIAMOND
|
|
88
95
|
Square -- Use square style.
|
|
89
|
-
:type arrowstyle_start:
|
|
96
|
+
:type arrowstyle_start: typing.Literal['NONE','ARROW','ARROW_OPEN','ARROW_OPEN_INVERTED','DIAMOND'] | None
|
|
90
97
|
:param arrowstyle_end: End Arrow Style, Stroke end style
|
|
91
98
|
|
|
92
99
|
NONE
|
|
@@ -103,7 +110,7 @@ def annotate(
|
|
|
103
110
|
|
|
104
111
|
DIAMOND
|
|
105
112
|
Square -- Use square style.
|
|
106
|
-
:type arrowstyle_end:
|
|
113
|
+
:type arrowstyle_end: typing.Literal['NONE','ARROW','ARROW_OPEN','ARROW_OPEN_INVERTED','DIAMOND'] | None
|
|
107
114
|
: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)
|
|
108
115
|
:type use_stabilizer: bool | None
|
|
109
116
|
:param stabilizer_factor: Stabilizer Stroke Factor, Higher values gives a smoother stroke
|
|
@@ -156,7 +163,8 @@ def bake_grease_pencil_animation(
|
|
|
156
163
|
step: int | None = 1,
|
|
157
164
|
only_selected: bool | None = False,
|
|
158
165
|
frame_target: int | None = 1,
|
|
159
|
-
project_type:
|
|
166
|
+
project_type: typing.Literal["KEEP", "FRONT", "SIDE", "TOP", "VIEW", "CURSOR"]
|
|
167
|
+
| None = "KEEP",
|
|
160
168
|
):
|
|
161
169
|
"""Bake grease pencil object transform to grease pencil keyframes
|
|
162
170
|
|
|
@@ -192,7 +200,7 @@ def bake_grease_pencil_animation(
|
|
|
192
200
|
|
|
193
201
|
CURSOR
|
|
194
202
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
195
|
-
:type project_type:
|
|
203
|
+
:type project_type: typing.Literal['KEEP','FRONT','SIDE','TOP','VIEW','CURSOR'] | None
|
|
196
204
|
"""
|
|
197
205
|
|
|
198
206
|
...
|
|
@@ -202,7 +210,7 @@ def bake_mesh_animation(
|
|
|
202
210
|
execution_context: int | str | None = None,
|
|
203
211
|
undo: bool | None = None,
|
|
204
212
|
*,
|
|
205
|
-
target:
|
|
213
|
+
target: typing.Literal["NEW", "SELECTED"] | None = "NEW",
|
|
206
214
|
frame_start: int | None = 1,
|
|
207
215
|
frame_end: int | None = 250,
|
|
208
216
|
step: int | None = 1,
|
|
@@ -213,7 +221,8 @@ def bake_mesh_animation(
|
|
|
213
221
|
faces: bool | None = True,
|
|
214
222
|
only_selected: bool | None = False,
|
|
215
223
|
frame_target: int | None = 1,
|
|
216
|
-
project_type:
|
|
224
|
+
project_type: typing.Literal["KEEP", "FRONT", "SIDE", "TOP", "VIEW", "CURSOR"]
|
|
225
|
+
| None = "VIEW",
|
|
217
226
|
):
|
|
218
227
|
"""Bake mesh animation to grease pencil strokes
|
|
219
228
|
|
|
@@ -221,7 +230,7 @@ def bake_mesh_animation(
|
|
|
221
230
|
:type execution_context: int | str | None
|
|
222
231
|
:type undo: bool | None
|
|
223
232
|
:param target: Target Object, Target grease pencil
|
|
224
|
-
:type target:
|
|
233
|
+
:type target: typing.Literal['NEW','SELECTED'] | None
|
|
225
234
|
:param frame_start: Start Frame, The start frame
|
|
226
235
|
:type frame_start: int | None
|
|
227
236
|
:param frame_end: End Frame, The end frame of animation
|
|
@@ -261,7 +270,7 @@ def bake_mesh_animation(
|
|
|
261
270
|
|
|
262
271
|
CURSOR
|
|
263
272
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
264
|
-
:type project_type:
|
|
273
|
+
:type project_type: typing.Literal['KEEP','FRONT','SIDE','TOP','VIEW','CURSOR'] | None
|
|
265
274
|
"""
|
|
266
275
|
|
|
267
276
|
...
|
|
@@ -289,13 +298,13 @@ def convert(
|
|
|
289
298
|
execution_context: int | str | None = None,
|
|
290
299
|
undo: bool | None = None,
|
|
291
300
|
*,
|
|
292
|
-
type:
|
|
301
|
+
type: typing.Literal["PATH", "CURVE", "POLY"] | None = "PATH",
|
|
293
302
|
bevel_depth: float | None = 0.0,
|
|
294
303
|
bevel_resolution: int | None = 0,
|
|
295
304
|
use_normalize_weights: bool | None = True,
|
|
296
305
|
radius_multiplier: float | None = 1.0,
|
|
297
306
|
use_link_strokes: bool | None = False,
|
|
298
|
-
timing_mode:
|
|
307
|
+
timing_mode: typing.Literal["NONE", "LINEAR", "FULL", "CUSTOMGAP"] | None = "FULL",
|
|
299
308
|
frame_range: int | None = 100,
|
|
300
309
|
start_frame: int | None = 1,
|
|
301
310
|
use_realtime: bool | None = False,
|
|
@@ -320,7 +329,7 @@ def convert(
|
|
|
320
329
|
|
|
321
330
|
POLY
|
|
322
331
|
Polygon Curve -- Bézier curve with straight-line segments (vector handles).
|
|
323
|
-
:type type:
|
|
332
|
+
:type type: typing.Literal['PATH','CURVE','POLY'] | None
|
|
324
333
|
:param bevel_depth: Bevel Depth
|
|
325
334
|
:type bevel_depth: float | None
|
|
326
335
|
:param bevel_resolution: Bevel Resolution, Bevel resolution when depth is non-zero
|
|
@@ -344,7 +353,7 @@ def convert(
|
|
|
344
353
|
|
|
345
354
|
CUSTOMGAP
|
|
346
355
|
Custom Gaps -- Use the original timing, but with custom gap lengths (in frames).
|
|
347
|
-
:type timing_mode:
|
|
356
|
+
:type timing_mode: typing.Literal['NONE','LINEAR','FULL','CUSTOMGAP'] | None
|
|
348
357
|
:param frame_range: Frame Range, The duration of evaluation of the path control curve
|
|
349
358
|
:type frame_range: int | None
|
|
350
359
|
:param start_frame: Start Frame, The start frame of the path control curve
|
|
@@ -416,7 +425,7 @@ def delete(
|
|
|
416
425
|
execution_context: int | str | None = None,
|
|
417
426
|
undo: bool | None = None,
|
|
418
427
|
*,
|
|
419
|
-
type:
|
|
428
|
+
type: typing.Literal["POINTS", "STROKES", "FRAME"] | None = "POINTS",
|
|
420
429
|
):
|
|
421
430
|
"""Delete selected Grease Pencil strokes, vertices, or frames
|
|
422
431
|
|
|
@@ -433,7 +442,7 @@ def delete(
|
|
|
433
442
|
|
|
434
443
|
FRAME
|
|
435
444
|
Frame -- Delete active frame.
|
|
436
|
-
:type type:
|
|
445
|
+
:type type: typing.Literal['POINTS','STROKES','FRAME'] | None
|
|
437
446
|
"""
|
|
438
447
|
|
|
439
448
|
...
|
|
@@ -443,7 +452,7 @@ def dissolve(
|
|
|
443
452
|
execution_context: int | str | None = None,
|
|
444
453
|
undo: bool | None = None,
|
|
445
454
|
*,
|
|
446
|
-
type:
|
|
455
|
+
type: typing.Literal["POINTS", "BETWEEN", "UNSELECT"] | None = "POINTS",
|
|
447
456
|
):
|
|
448
457
|
"""Delete selected points without splitting strokes
|
|
449
458
|
|
|
@@ -460,7 +469,7 @@ def dissolve(
|
|
|
460
469
|
|
|
461
470
|
UNSELECT
|
|
462
471
|
Dissolve Unselect -- Dissolve all unselected points.
|
|
463
|
-
:type type:
|
|
472
|
+
:type type: typing.Literal['POINTS','BETWEEN','UNSELECT'] | None
|
|
464
473
|
"""
|
|
465
474
|
|
|
466
475
|
...
|
|
@@ -470,7 +479,7 @@ def draw(
|
|
|
470
479
|
execution_context: int | str | None = None,
|
|
471
480
|
undo: bool | None = None,
|
|
472
481
|
*,
|
|
473
|
-
mode:
|
|
482
|
+
mode: typing.Literal["DRAW", "DRAW_STRAIGHT", "ERASER"] | None = "DRAW",
|
|
474
483
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
475
484
|
| None = None,
|
|
476
485
|
wait_for_input: bool | None = True,
|
|
@@ -494,7 +503,7 @@ def draw(
|
|
|
494
503
|
|
|
495
504
|
ERASER
|
|
496
505
|
Eraser -- Erase Grease Pencil strokes.
|
|
497
|
-
:type mode:
|
|
506
|
+
:type mode: typing.Literal['DRAW','DRAW_STRAIGHT','ERASER'] | None
|
|
498
507
|
:param stroke: Stroke
|
|
499
508
|
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
500
509
|
:param wait_for_input: Wait for Input, Wait for first click instead of painting immediately
|
|
@@ -643,7 +652,7 @@ def frame_clean_duplicate(
|
|
|
643
652
|
execution_context: int | str | None = None,
|
|
644
653
|
undo: bool | None = None,
|
|
645
654
|
*,
|
|
646
|
-
type:
|
|
655
|
+
type: typing.Literal["ALL", "SELECTED"] | None = "ALL",
|
|
647
656
|
):
|
|
648
657
|
"""Remove duplicate keyframes
|
|
649
658
|
|
|
@@ -651,7 +660,7 @@ def frame_clean_duplicate(
|
|
|
651
660
|
:type execution_context: int | str | None
|
|
652
661
|
:type undo: bool | None
|
|
653
662
|
:param type: Type
|
|
654
|
-
:type type:
|
|
663
|
+
:type type: typing.Literal['ALL','SELECTED'] | None
|
|
655
664
|
"""
|
|
656
665
|
|
|
657
666
|
...
|
|
@@ -661,7 +670,7 @@ def frame_clean_fill(
|
|
|
661
670
|
execution_context: int | str | None = None,
|
|
662
671
|
undo: bool | None = None,
|
|
663
672
|
*,
|
|
664
|
-
mode:
|
|
673
|
+
mode: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
|
|
665
674
|
):
|
|
666
675
|
"""Remove 'no fill' boundary strokes
|
|
667
676
|
|
|
@@ -675,7 +684,7 @@ def frame_clean_fill(
|
|
|
675
684
|
|
|
676
685
|
ALL
|
|
677
686
|
All Frames -- Clean all frames in all layers.
|
|
678
|
-
:type mode:
|
|
687
|
+
:type mode: typing.Literal['ACTIVE','ALL'] | None
|
|
679
688
|
"""
|
|
680
689
|
|
|
681
690
|
...
|
|
@@ -703,7 +712,7 @@ def frame_duplicate(
|
|
|
703
712
|
execution_context: int | str | None = None,
|
|
704
713
|
undo: bool | None = None,
|
|
705
714
|
*,
|
|
706
|
-
mode:
|
|
715
|
+
mode: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
|
|
707
716
|
):
|
|
708
717
|
"""Make a copy of the active Grease Pencil Frame
|
|
709
718
|
|
|
@@ -717,7 +726,7 @@ def frame_duplicate(
|
|
|
717
726
|
|
|
718
727
|
ALL
|
|
719
728
|
All -- Duplicate active frames in all layers.
|
|
720
|
-
:type mode:
|
|
729
|
+
:type mode: typing.Literal['ACTIVE','ALL'] | None
|
|
721
730
|
"""
|
|
722
731
|
|
|
723
732
|
...
|
|
@@ -727,7 +736,7 @@ def generate_weights(
|
|
|
727
736
|
execution_context: int | str | None = None,
|
|
728
737
|
undo: bool | None = None,
|
|
729
738
|
*,
|
|
730
|
-
mode:
|
|
739
|
+
mode: typing.Literal["NAME", "AUTO"] | None = "NAME",
|
|
731
740
|
armature: str | None = "DEFAULT",
|
|
732
741
|
ratio: float | None = 0.1,
|
|
733
742
|
decay: float | None = 0.8,
|
|
@@ -738,7 +747,7 @@ def generate_weights(
|
|
|
738
747
|
:type execution_context: int | str | None
|
|
739
748
|
:type undo: bool | None
|
|
740
749
|
:param mode: Mode
|
|
741
|
-
:type mode:
|
|
750
|
+
:type mode: typing.Literal['NAME','AUTO'] | None
|
|
742
751
|
:param armature: Armature, Armature to use
|
|
743
752
|
:type armature: str | None
|
|
744
753
|
:param ratio: Ratio, Ratio between bone length and influence radius
|
|
@@ -815,10 +824,10 @@ def interpolate(
|
|
|
815
824
|
undo: bool | None = None,
|
|
816
825
|
*,
|
|
817
826
|
shift: float | None = 0.0,
|
|
818
|
-
layers:
|
|
827
|
+
layers: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
|
|
819
828
|
interpolate_selected_only: bool | None = False,
|
|
820
829
|
exclude_breakdowns: bool | None = False,
|
|
821
|
-
flip:
|
|
830
|
+
flip: typing.Literal["NOFLIP", "FLIP", "AUTO"] | None = "AUTO",
|
|
822
831
|
smooth_steps: int | None = 1,
|
|
823
832
|
smooth_factor: float | None = 0.0,
|
|
824
833
|
release_confirm: bool | None = False,
|
|
@@ -831,13 +840,13 @@ def interpolate(
|
|
|
831
840
|
:param shift: Shift, Bias factor for which frame has more influence on the interpolated strokes
|
|
832
841
|
:type shift: float | None
|
|
833
842
|
:param layers: Layer, Layers included in the interpolation
|
|
834
|
-
:type layers:
|
|
843
|
+
:type layers: typing.Literal['ACTIVE','ALL'] | None
|
|
835
844
|
:param interpolate_selected_only: Only Selected, Interpolate only selected strokes
|
|
836
845
|
:type interpolate_selected_only: bool | None
|
|
837
846
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
838
847
|
:type exclude_breakdowns: bool | None
|
|
839
848
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
840
|
-
:type flip:
|
|
849
|
+
:type flip: typing.Literal['NOFLIP','FLIP','AUTO'] | None
|
|
841
850
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
842
851
|
:type smooth_steps: int | None
|
|
843
852
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
@@ -868,14 +877,29 @@ def interpolate_sequence(
|
|
|
868
877
|
undo: bool | None = None,
|
|
869
878
|
*,
|
|
870
879
|
step: int | None = 1,
|
|
871
|
-
layers:
|
|
880
|
+
layers: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
|
|
872
881
|
interpolate_selected_only: bool | None = False,
|
|
873
882
|
exclude_breakdowns: bool | None = False,
|
|
874
|
-
flip:
|
|
883
|
+
flip: typing.Literal["NOFLIP", "FLIP", "AUTO"] | None = "AUTO",
|
|
875
884
|
smooth_steps: int | None = 1,
|
|
876
885
|
smooth_factor: float | None = 0.0,
|
|
877
|
-
type:
|
|
878
|
-
|
|
886
|
+
type: typing.Literal[
|
|
887
|
+
"LINEAR",
|
|
888
|
+
"CUSTOM",
|
|
889
|
+
"SINE",
|
|
890
|
+
"QUAD",
|
|
891
|
+
"CUBIC",
|
|
892
|
+
"QUART",
|
|
893
|
+
"QUINT",
|
|
894
|
+
"EXPO",
|
|
895
|
+
"CIRC",
|
|
896
|
+
"BACK",
|
|
897
|
+
"BOUNCE",
|
|
898
|
+
"ELASTIC",
|
|
899
|
+
]
|
|
900
|
+
| None = "LINEAR",
|
|
901
|
+
easing: typing.Literal["AUTO", "EASE_IN", "EASE_OUT", "EASE_IN_OUT"]
|
|
902
|
+
| None = "AUTO",
|
|
879
903
|
back: float | None = 1.702,
|
|
880
904
|
amplitude: float | None = 0.15,
|
|
881
905
|
period: float | None = 0.15,
|
|
@@ -888,13 +912,13 @@ def interpolate_sequence(
|
|
|
888
912
|
:param step: Step, Number of frames between generated interpolated frames
|
|
889
913
|
:type step: int | None
|
|
890
914
|
:param layers: Layer, Layers included in the interpolation
|
|
891
|
-
:type layers:
|
|
915
|
+
:type layers: typing.Literal['ACTIVE','ALL'] | None
|
|
892
916
|
:param interpolate_selected_only: Only Selected, Interpolate only selected strokes
|
|
893
917
|
:type interpolate_selected_only: bool | None
|
|
894
918
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
895
919
|
:type exclude_breakdowns: bool | None
|
|
896
920
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
897
|
-
:type flip:
|
|
921
|
+
:type flip: typing.Literal['NOFLIP','FLIP','AUTO'] | None
|
|
898
922
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
899
923
|
:type smooth_steps: int | None
|
|
900
924
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
@@ -936,7 +960,7 @@ def interpolate_sequence(
|
|
|
936
960
|
|
|
937
961
|
ELASTIC
|
|
938
962
|
Elastic -- Exponentially decaying sine wave, like an elastic band.
|
|
939
|
-
:type type:
|
|
963
|
+
:type type: typing.Literal['LINEAR','CUSTOM','SINE','QUAD','CUBIC','QUART','QUINT','EXPO','CIRC','BACK','BOUNCE','ELASTIC'] | None
|
|
940
964
|
:param easing: Easing, Which ends of the segment between the preceding and following grease pencil frames easing interpolation is applied to
|
|
941
965
|
|
|
942
966
|
AUTO
|
|
@@ -950,7 +974,7 @@ def interpolate_sequence(
|
|
|
950
974
|
|
|
951
975
|
EASE_IN_OUT
|
|
952
976
|
Ease In and Out -- Segment between both keyframes.
|
|
953
|
-
:type easing:
|
|
977
|
+
:type easing: typing.Literal['AUTO','EASE_IN','EASE_OUT','EASE_IN_OUT'] | None
|
|
954
978
|
:param back: Back, Amount of overshoot for 'back' easing
|
|
955
979
|
:type back: float | None
|
|
956
980
|
:param amplitude: Amplitude, Amount to boost elastic bounces for 'elastic' easing
|
|
@@ -1019,7 +1043,7 @@ def layer_annotation_move(
|
|
|
1019
1043
|
execution_context: int | str | None = None,
|
|
1020
1044
|
undo: bool | None = None,
|
|
1021
1045
|
*,
|
|
1022
|
-
type:
|
|
1046
|
+
type: typing.Literal["UP", "DOWN"] | None = "UP",
|
|
1023
1047
|
):
|
|
1024
1048
|
"""Move the active Annotation layer up/down in the list
|
|
1025
1049
|
|
|
@@ -1027,7 +1051,7 @@ def layer_annotation_move(
|
|
|
1027
1051
|
:type execution_context: int | str | None
|
|
1028
1052
|
:type undo: bool | None
|
|
1029
1053
|
:param type: Type
|
|
1030
|
-
:type type:
|
|
1054
|
+
:type type: typing.Literal['UP','DOWN'] | None
|
|
1031
1055
|
"""
|
|
1032
1056
|
|
|
1033
1057
|
...
|
|
@@ -1069,7 +1093,7 @@ def layer_duplicate(
|
|
|
1069
1093
|
execution_context: int | str | None = None,
|
|
1070
1094
|
undo: bool | None = None,
|
|
1071
1095
|
*,
|
|
1072
|
-
mode:
|
|
1096
|
+
mode: typing.Literal["ALL", "EMPTY"] | None = "ALL",
|
|
1073
1097
|
):
|
|
1074
1098
|
"""Make a copy of the active Grease Pencil layer
|
|
1075
1099
|
|
|
@@ -1077,7 +1101,7 @@ def layer_duplicate(
|
|
|
1077
1101
|
:type execution_context: int | str | None
|
|
1078
1102
|
:type undo: bool | None
|
|
1079
1103
|
:param mode: Mode
|
|
1080
|
-
:type mode:
|
|
1104
|
+
:type mode: typing.Literal['ALL','EMPTY'] | None
|
|
1081
1105
|
"""
|
|
1082
1106
|
|
|
1083
1107
|
...
|
|
@@ -1087,7 +1111,7 @@ def layer_duplicate_object(
|
|
|
1087
1111
|
execution_context: int | str | None = None,
|
|
1088
1112
|
undo: bool | None = None,
|
|
1089
1113
|
*,
|
|
1090
|
-
mode:
|
|
1114
|
+
mode: typing.Literal["ALL", "ACTIVE"] | None = "ALL",
|
|
1091
1115
|
only_active: bool | None = True,
|
|
1092
1116
|
):
|
|
1093
1117
|
"""Make a copy of the active Grease Pencil layer to selected object
|
|
@@ -1096,7 +1120,7 @@ def layer_duplicate_object(
|
|
|
1096
1120
|
:type execution_context: int | str | None
|
|
1097
1121
|
:type undo: bool | None
|
|
1098
1122
|
:param mode: Mode
|
|
1099
|
-
:type mode:
|
|
1123
|
+
:type mode: typing.Literal['ALL','ACTIVE'] | None
|
|
1100
1124
|
:param only_active: Only Active, Copy only active Layer, uncheck to append all layers
|
|
1101
1125
|
:type only_active: bool | None
|
|
1102
1126
|
"""
|
|
@@ -1144,7 +1168,7 @@ def layer_mask_move(
|
|
|
1144
1168
|
execution_context: int | str | None = None,
|
|
1145
1169
|
undo: bool | None = None,
|
|
1146
1170
|
*,
|
|
1147
|
-
type:
|
|
1171
|
+
type: typing.Literal["UP", "DOWN"] | None = "UP",
|
|
1148
1172
|
):
|
|
1149
1173
|
"""Move the active Grease Pencil mask layer up/down in the list
|
|
1150
1174
|
|
|
@@ -1152,7 +1176,7 @@ def layer_mask_move(
|
|
|
1152
1176
|
:type execution_context: int | str | None
|
|
1153
1177
|
:type undo: bool | None
|
|
1154
1178
|
:param type: Type
|
|
1155
|
-
:type type:
|
|
1179
|
+
:type type: typing.Literal['UP','DOWN'] | None
|
|
1156
1180
|
"""
|
|
1157
1181
|
|
|
1158
1182
|
...
|
|
@@ -1176,7 +1200,7 @@ def layer_merge(
|
|
|
1176
1200
|
execution_context: int | str | None = None,
|
|
1177
1201
|
undo: bool | None = None,
|
|
1178
1202
|
*,
|
|
1179
|
-
mode:
|
|
1203
|
+
mode: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
|
|
1180
1204
|
):
|
|
1181
1205
|
"""Combine Layers
|
|
1182
1206
|
|
|
@@ -1190,7 +1214,7 @@ def layer_merge(
|
|
|
1190
1214
|
|
|
1191
1215
|
ALL
|
|
1192
1216
|
All -- Combine all layers into the active layer.
|
|
1193
|
-
:type mode:
|
|
1217
|
+
:type mode: typing.Literal['ACTIVE','ALL'] | None
|
|
1194
1218
|
"""
|
|
1195
1219
|
|
|
1196
1220
|
...
|
|
@@ -1200,7 +1224,7 @@ def layer_move(
|
|
|
1200
1224
|
execution_context: int | str | None = None,
|
|
1201
1225
|
undo: bool | None = None,
|
|
1202
1226
|
*,
|
|
1203
|
-
type:
|
|
1227
|
+
type: typing.Literal["UP", "DOWN"] | None = "UP",
|
|
1204
1228
|
):
|
|
1205
1229
|
"""Move the active Grease Pencil layer up/down in the list
|
|
1206
1230
|
|
|
@@ -1208,7 +1232,7 @@ def layer_move(
|
|
|
1208
1232
|
:type execution_context: int | str | None
|
|
1209
1233
|
:type undo: bool | None
|
|
1210
1234
|
:param type: Type
|
|
1211
|
-
:type type:
|
|
1235
|
+
:type type: typing.Literal['UP','DOWN'] | None
|
|
1212
1236
|
"""
|
|
1213
1237
|
|
|
1214
1238
|
...
|
|
@@ -1472,7 +1496,7 @@ def paste(
|
|
|
1472
1496
|
execution_context: int | str | None = None,
|
|
1473
1497
|
undo: bool | None = None,
|
|
1474
1498
|
*,
|
|
1475
|
-
type:
|
|
1499
|
+
type: typing.Literal["ACTIVE", "LAYER"] | None = "ACTIVE",
|
|
1476
1500
|
paste_back: bool | None = False,
|
|
1477
1501
|
):
|
|
1478
1502
|
"""Paste previously copied strokes to active layer or to original layer
|
|
@@ -1481,7 +1505,7 @@ def paste(
|
|
|
1481
1505
|
:type execution_context: int | str | None
|
|
1482
1506
|
:type undo: bool | None
|
|
1483
1507
|
:param type: Type
|
|
1484
|
-
:type type:
|
|
1508
|
+
:type type: typing.Literal['ACTIVE','LAYER'] | None
|
|
1485
1509
|
:param paste_back: Paste on Back, Add pasted strokes behind all strokes
|
|
1486
1510
|
:type paste_back: bool | None
|
|
1487
1511
|
"""
|
|
@@ -1495,7 +1519,8 @@ def primitive_box(
|
|
|
1495
1519
|
*,
|
|
1496
1520
|
subdivision: int | None = 3,
|
|
1497
1521
|
edges: int | None = 1,
|
|
1498
|
-
type:
|
|
1522
|
+
type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
|
|
1523
|
+
| None = "BOX",
|
|
1499
1524
|
wait_for_input: bool | None = True,
|
|
1500
1525
|
):
|
|
1501
1526
|
"""Create predefined grease pencil stroke box shapes
|
|
@@ -1508,7 +1533,7 @@ def primitive_box(
|
|
|
1508
1533
|
:param edges: Edges, Number of points per segment
|
|
1509
1534
|
:type edges: int | None
|
|
1510
1535
|
:param type: Type, Type of shape
|
|
1511
|
-
:type type:
|
|
1536
|
+
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1512
1537
|
:param wait_for_input: Wait for Input
|
|
1513
1538
|
:type wait_for_input: bool | None
|
|
1514
1539
|
"""
|
|
@@ -1522,7 +1547,8 @@ def primitive_circle(
|
|
|
1522
1547
|
*,
|
|
1523
1548
|
subdivision: int | None = 94,
|
|
1524
1549
|
edges: int | None = 1,
|
|
1525
|
-
type:
|
|
1550
|
+
type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
|
|
1551
|
+
| None = "CIRCLE",
|
|
1526
1552
|
wait_for_input: bool | None = True,
|
|
1527
1553
|
):
|
|
1528
1554
|
"""Create predefined grease pencil stroke circle shapes
|
|
@@ -1535,7 +1561,7 @@ def primitive_circle(
|
|
|
1535
1561
|
:param edges: Edges, Number of points per segment
|
|
1536
1562
|
:type edges: int | None
|
|
1537
1563
|
:param type: Type, Type of shape
|
|
1538
|
-
:type type:
|
|
1564
|
+
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1539
1565
|
:param wait_for_input: Wait for Input
|
|
1540
1566
|
:type wait_for_input: bool | None
|
|
1541
1567
|
"""
|
|
@@ -1549,7 +1575,8 @@ def primitive_curve(
|
|
|
1549
1575
|
*,
|
|
1550
1576
|
subdivision: int | None = 62,
|
|
1551
1577
|
edges: int | None = 1,
|
|
1552
|
-
type:
|
|
1578
|
+
type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
|
|
1579
|
+
| None = "CURVE",
|
|
1553
1580
|
wait_for_input: bool | None = True,
|
|
1554
1581
|
):
|
|
1555
1582
|
"""Create predefined grease pencil stroke curve shapes
|
|
@@ -1562,7 +1589,7 @@ def primitive_curve(
|
|
|
1562
1589
|
:param edges: Edges, Number of points per segment
|
|
1563
1590
|
:type edges: int | None
|
|
1564
1591
|
:param type: Type, Type of shape
|
|
1565
|
-
:type type:
|
|
1592
|
+
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1566
1593
|
:param wait_for_input: Wait for Input
|
|
1567
1594
|
:type wait_for_input: bool | None
|
|
1568
1595
|
"""
|
|
@@ -1576,7 +1603,8 @@ def primitive_line(
|
|
|
1576
1603
|
*,
|
|
1577
1604
|
subdivision: int | None = 6,
|
|
1578
1605
|
edges: int | None = 1,
|
|
1579
|
-
type:
|
|
1606
|
+
type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
|
|
1607
|
+
| None = "LINE",
|
|
1580
1608
|
wait_for_input: bool | None = True,
|
|
1581
1609
|
):
|
|
1582
1610
|
"""Create predefined grease pencil stroke lines
|
|
@@ -1589,7 +1617,7 @@ def primitive_line(
|
|
|
1589
1617
|
:param edges: Edges, Number of points per segment
|
|
1590
1618
|
:type edges: int | None
|
|
1591
1619
|
:param type: Type, Type of shape
|
|
1592
|
-
:type type:
|
|
1620
|
+
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1593
1621
|
:param wait_for_input: Wait for Input
|
|
1594
1622
|
:type wait_for_input: bool | None
|
|
1595
1623
|
"""
|
|
@@ -1603,7 +1631,8 @@ def primitive_polyline(
|
|
|
1603
1631
|
*,
|
|
1604
1632
|
subdivision: int | None = 6,
|
|
1605
1633
|
edges: int | None = 1,
|
|
1606
|
-
type:
|
|
1634
|
+
type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
|
|
1635
|
+
| None = "POLYLINE",
|
|
1607
1636
|
wait_for_input: bool | None = True,
|
|
1608
1637
|
):
|
|
1609
1638
|
"""Create predefined grease pencil stroke polylines
|
|
@@ -1616,7 +1645,7 @@ def primitive_polyline(
|
|
|
1616
1645
|
:param edges: Edges, Number of points per segment
|
|
1617
1646
|
:type edges: int | None
|
|
1618
1647
|
:param type: Type, Type of shape
|
|
1619
|
-
:type type:
|
|
1648
|
+
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1620
1649
|
:param wait_for_input: Wait for Input
|
|
1621
1650
|
:type wait_for_input: bool | None
|
|
1622
1651
|
"""
|
|
@@ -1642,7 +1671,8 @@ def reproject(
|
|
|
1642
1671
|
execution_context: int | str | None = None,
|
|
1643
1672
|
undo: bool | None = None,
|
|
1644
1673
|
*,
|
|
1645
|
-
type:
|
|
1674
|
+
type: typing.Literal["FRONT", "SIDE", "TOP", "VIEW", "SURFACE", "CURSOR"]
|
|
1675
|
+
| None = "VIEW",
|
|
1646
1676
|
keep_original: bool | None = False,
|
|
1647
1677
|
offset: float | None = 0.0,
|
|
1648
1678
|
):
|
|
@@ -1670,7 +1700,7 @@ def reproject(
|
|
|
1670
1700
|
|
|
1671
1701
|
CURSOR
|
|
1672
1702
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
1673
|
-
:type type:
|
|
1703
|
+
:type type: typing.Literal['FRONT','SIDE','TOP','VIEW','SURFACE','CURSOR'] | None
|
|
1674
1704
|
:param keep_original: Keep Original, Keep original strokes and create a copy before reprojecting
|
|
1675
1705
|
:type keep_original: bool | None
|
|
1676
1706
|
:param offset: Surface Offset
|
|
@@ -1684,7 +1714,7 @@ def reset_transform_fill(
|
|
|
1684
1714
|
execution_context: int | str | None = None,
|
|
1685
1715
|
undo: bool | None = None,
|
|
1686
1716
|
*,
|
|
1687
|
-
mode:
|
|
1717
|
+
mode: typing.Literal["ALL", "TRANSLATE", "ROTATE", "SCALE"] | None = "ALL",
|
|
1688
1718
|
):
|
|
1689
1719
|
"""Reset any UV transformation and back to default values
|
|
1690
1720
|
|
|
@@ -1692,7 +1722,7 @@ def reset_transform_fill(
|
|
|
1692
1722
|
:type execution_context: int | str | None
|
|
1693
1723
|
:type undo: bool | None
|
|
1694
1724
|
:param mode: Mode
|
|
1695
|
-
:type mode:
|
|
1725
|
+
:type mode: typing.Literal['ALL','TRANSLATE','ROTATE','SCALE'] | None
|
|
1696
1726
|
"""
|
|
1697
1727
|
|
|
1698
1728
|
...
|
|
@@ -1799,7 +1829,7 @@ def select_all(
|
|
|
1799
1829
|
execution_context: int | str | None = None,
|
|
1800
1830
|
undo: bool | None = None,
|
|
1801
1831
|
*,
|
|
1802
|
-
action:
|
|
1832
|
+
action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
|
|
1803
1833
|
):
|
|
1804
1834
|
"""Change selection of all Grease Pencil strokes currently visible
|
|
1805
1835
|
|
|
@@ -1819,7 +1849,7 @@ def select_all(
|
|
|
1819
1849
|
|
|
1820
1850
|
INVERT
|
|
1821
1851
|
Invert -- Invert selection of all elements.
|
|
1822
|
-
:type action:
|
|
1852
|
+
:type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
|
|
1823
1853
|
"""
|
|
1824
1854
|
|
|
1825
1855
|
...
|
|
@@ -1852,7 +1882,7 @@ def select_box(
|
|
|
1852
1882
|
ymin: int | None = 0,
|
|
1853
1883
|
ymax: int | None = 0,
|
|
1854
1884
|
wait_for_input: bool | None = True,
|
|
1855
|
-
mode:
|
|
1885
|
+
mode: typing.Literal["SET", "ADD", "SUB", "XOR", "AND"] | None = "SET",
|
|
1856
1886
|
):
|
|
1857
1887
|
"""Select Grease Pencil strokes within a rectangular region
|
|
1858
1888
|
|
|
@@ -1885,7 +1915,7 @@ def select_box(
|
|
|
1885
1915
|
|
|
1886
1916
|
AND
|
|
1887
1917
|
Intersect -- Intersect existing selection.
|
|
1888
|
-
:type mode:
|
|
1918
|
+
:type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
|
|
1889
1919
|
"""
|
|
1890
1920
|
|
|
1891
1921
|
...
|
|
@@ -1899,7 +1929,7 @@ def select_circle(
|
|
|
1899
1929
|
y: int | None = 0,
|
|
1900
1930
|
radius: int | None = 25,
|
|
1901
1931
|
wait_for_input: bool | None = True,
|
|
1902
|
-
mode:
|
|
1932
|
+
mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
|
|
1903
1933
|
):
|
|
1904
1934
|
"""Select Grease Pencil strokes using brush selection
|
|
1905
1935
|
|
|
@@ -1924,7 +1954,7 @@ def select_circle(
|
|
|
1924
1954
|
|
|
1925
1955
|
SUB
|
|
1926
1956
|
Subtract -- Subtract existing selection.
|
|
1927
|
-
:type mode:
|
|
1957
|
+
:type mode: typing.Literal['SET','ADD','SUB'] | None
|
|
1928
1958
|
"""
|
|
1929
1959
|
|
|
1930
1960
|
...
|
|
@@ -1955,7 +1985,7 @@ def select_grouped(
|
|
|
1955
1985
|
execution_context: int | str | None = None,
|
|
1956
1986
|
undo: bool | None = None,
|
|
1957
1987
|
*,
|
|
1958
|
-
type:
|
|
1988
|
+
type: typing.Literal["LAYER", "MATERIAL"] | None = "LAYER",
|
|
1959
1989
|
):
|
|
1960
1990
|
"""Select all strokes with similar characteristics
|
|
1961
1991
|
|
|
@@ -1969,7 +1999,7 @@ def select_grouped(
|
|
|
1969
1999
|
|
|
1970
2000
|
MATERIAL
|
|
1971
2001
|
Material -- Shared materials.
|
|
1972
|
-
:type type:
|
|
2002
|
+
:type type: typing.Literal['LAYER','MATERIAL'] | None
|
|
1973
2003
|
"""
|
|
1974
2004
|
|
|
1975
2005
|
...
|
|
@@ -1979,7 +2009,7 @@ def select_lasso(
|
|
|
1979
2009
|
execution_context: int | str | None = None,
|
|
1980
2010
|
undo: bool | None = None,
|
|
1981
2011
|
*,
|
|
1982
|
-
mode:
|
|
2012
|
+
mode: typing.Literal["SET", "ADD", "SUB", "XOR", "AND"] | None = "SET",
|
|
1983
2013
|
path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None = None,
|
|
1984
2014
|
use_smooth_stroke: bool | None = False,
|
|
1985
2015
|
smooth_stroke_factor: float | None = 0.75,
|
|
@@ -2006,7 +2036,7 @@ def select_lasso(
|
|
|
2006
2036
|
|
|
2007
2037
|
AND
|
|
2008
2038
|
Intersect -- Intersect existing selection.
|
|
2009
|
-
:type mode:
|
|
2039
|
+
:type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
|
|
2010
2040
|
:param path: Path
|
|
2011
2041
|
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
2012
2042
|
:param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
|
|
@@ -2089,7 +2119,7 @@ def select_random(
|
|
|
2089
2119
|
*,
|
|
2090
2120
|
ratio: float | None = 0.5,
|
|
2091
2121
|
seed: int | None = 0,
|
|
2092
|
-
action:
|
|
2122
|
+
action: typing.Literal["SELECT", "DESELECT"] | None = "SELECT",
|
|
2093
2123
|
unselect_ends: bool | None = False,
|
|
2094
2124
|
):
|
|
2095
2125
|
"""Select random points for non selected strokes
|
|
@@ -2108,7 +2138,7 @@ def select_random(
|
|
|
2108
2138
|
|
|
2109
2139
|
DESELECT
|
|
2110
2140
|
Deselect -- Deselect all elements.
|
|
2111
|
-
:type action:
|
|
2141
|
+
:type action: typing.Literal['SELECT','DESELECT'] | None
|
|
2112
2142
|
:param unselect_ends: Unselect Ends, Do not select the first and last point of the stroke
|
|
2113
2143
|
:type unselect_ends: bool | None
|
|
2114
2144
|
"""
|
|
@@ -2244,7 +2274,7 @@ def stroke_arrange(
|
|
|
2244
2274
|
execution_context: int | str | None = None,
|
|
2245
2275
|
undo: bool | None = None,
|
|
2246
2276
|
*,
|
|
2247
|
-
direction:
|
|
2277
|
+
direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "UP",
|
|
2248
2278
|
):
|
|
2249
2279
|
"""Arrange selected strokes up/down in the display order of the active layer
|
|
2250
2280
|
|
|
@@ -2252,7 +2282,7 @@ def stroke_arrange(
|
|
|
2252
2282
|
:type execution_context: int | str | None
|
|
2253
2283
|
:type undo: bool | None
|
|
2254
2284
|
:param direction: Direction
|
|
2255
|
-
:type direction:
|
|
2285
|
+
:type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
|
|
2256
2286
|
"""
|
|
2257
2287
|
|
|
2258
2288
|
...
|
|
@@ -2262,7 +2292,7 @@ def stroke_caps_set(
|
|
|
2262
2292
|
execution_context: int | str | None = None,
|
|
2263
2293
|
undo: bool | None = None,
|
|
2264
2294
|
*,
|
|
2265
|
-
type:
|
|
2295
|
+
type: typing.Literal["TOGGLE", "START", "END", "DEFAULT"] | None = "TOGGLE",
|
|
2266
2296
|
):
|
|
2267
2297
|
"""Change stroke caps mode (rounded or flat)
|
|
2268
2298
|
|
|
@@ -2282,7 +2312,7 @@ def stroke_caps_set(
|
|
|
2282
2312
|
|
|
2283
2313
|
DEFAULT
|
|
2284
2314
|
Default -- Set as default rounded.
|
|
2285
|
-
:type type:
|
|
2315
|
+
:type type: typing.Literal['TOGGLE','START','END','DEFAULT'] | None
|
|
2286
2316
|
"""
|
|
2287
2317
|
|
|
2288
2318
|
...
|
|
@@ -2340,7 +2370,7 @@ def stroke_cyclical_set(
|
|
|
2340
2370
|
execution_context: int | str | None = None,
|
|
2341
2371
|
undo: bool | None = None,
|
|
2342
2372
|
*,
|
|
2343
|
-
type:
|
|
2373
|
+
type: typing.Literal["CLOSE", "OPEN", "TOGGLE"] | None = "TOGGLE",
|
|
2344
2374
|
geometry: bool | None = False,
|
|
2345
2375
|
):
|
|
2346
2376
|
"""Close or open the selected stroke adding a segment from last to first point
|
|
@@ -2349,7 +2379,7 @@ def stroke_cyclical_set(
|
|
|
2349
2379
|
:type execution_context: int | str | None
|
|
2350
2380
|
:type undo: bool | None
|
|
2351
2381
|
:param type: Type
|
|
2352
|
-
:type type:
|
|
2382
|
+
:type type: typing.Literal['CLOSE','OPEN','TOGGLE'] | None
|
|
2353
2383
|
:param geometry: Create Geometry, Create new geometry for closing stroke
|
|
2354
2384
|
:type geometry: bool | None
|
|
2355
2385
|
"""
|
|
@@ -2361,7 +2391,7 @@ def stroke_editcurve_set_handle_type(
|
|
|
2361
2391
|
execution_context: int | str | None = None,
|
|
2362
2392
|
undo: bool | None = None,
|
|
2363
2393
|
*,
|
|
2364
|
-
type:
|
|
2394
|
+
type: typing.Literal["FREE", "AUTOMATIC", "VECTOR", "ALIGNED"] | None = "AUTOMATIC",
|
|
2365
2395
|
):
|
|
2366
2396
|
"""Set the type of an edit curve handle
|
|
2367
2397
|
|
|
@@ -2369,7 +2399,7 @@ def stroke_editcurve_set_handle_type(
|
|
|
2369
2399
|
:type execution_context: int | str | None
|
|
2370
2400
|
:type undo: bool | None
|
|
2371
2401
|
:param type: Type, Spline type
|
|
2372
|
-
:type type:
|
|
2402
|
+
:type type: typing.Literal['FREE','AUTOMATIC','VECTOR','ALIGNED'] | None
|
|
2373
2403
|
"""
|
|
2374
2404
|
|
|
2375
2405
|
...
|
|
@@ -2411,7 +2441,7 @@ def stroke_join(
|
|
|
2411
2441
|
execution_context: int | str | None = None,
|
|
2412
2442
|
undo: bool | None = None,
|
|
2413
2443
|
*,
|
|
2414
|
-
type:
|
|
2444
|
+
type: typing.Literal["JOIN", "JOINCOPY"] | None = "JOIN",
|
|
2415
2445
|
leave_gaps: bool | None = False,
|
|
2416
2446
|
):
|
|
2417
2447
|
"""Join selected strokes (optionally as new stroke)
|
|
@@ -2420,7 +2450,7 @@ def stroke_join(
|
|
|
2420
2450
|
:type execution_context: int | str | None
|
|
2421
2451
|
:type undo: bool | None
|
|
2422
2452
|
:param type: Type
|
|
2423
|
-
:type type:
|
|
2453
|
+
:type type: typing.Literal['JOIN','JOINCOPY'] | None
|
|
2424
2454
|
:param leave_gaps: Leave Gaps, Leave gaps between joined strokes instead of linking them
|
|
2425
2455
|
:type leave_gaps: bool | None
|
|
2426
2456
|
"""
|
|
@@ -2432,7 +2462,7 @@ def stroke_merge(
|
|
|
2432
2462
|
execution_context: int | str | None = None,
|
|
2433
2463
|
undo: bool | None = None,
|
|
2434
2464
|
*,
|
|
2435
|
-
mode:
|
|
2465
|
+
mode: typing.Literal["STROKE", "POINT"] | None = "STROKE",
|
|
2436
2466
|
back: bool | None = False,
|
|
2437
2467
|
additive: bool | None = False,
|
|
2438
2468
|
cyclic: bool | None = False,
|
|
@@ -2445,7 +2475,7 @@ def stroke_merge(
|
|
|
2445
2475
|
:type execution_context: int | str | None
|
|
2446
2476
|
:type undo: bool | None
|
|
2447
2477
|
:param mode: Mode
|
|
2448
|
-
:type mode:
|
|
2478
|
+
:type mode: typing.Literal['STROKE','POINT'] | None
|
|
2449
2479
|
:param back: Draw on Back, Draw new stroke below all previous strokes
|
|
2450
2480
|
:type back: bool | None
|
|
2451
2481
|
:param additive: Additive Drawing, Add to previous drawing
|
|
@@ -2510,7 +2540,7 @@ def stroke_normalize(
|
|
|
2510
2540
|
execution_context: int | str | None = None,
|
|
2511
2541
|
undo: bool | None = None,
|
|
2512
2542
|
*,
|
|
2513
|
-
mode:
|
|
2543
|
+
mode: typing.Literal["THICKNESS", "OPACITY"] | None = "THICKNESS",
|
|
2514
2544
|
factor: float | None = 1.0,
|
|
2515
2545
|
value: int | None = 10,
|
|
2516
2546
|
):
|
|
@@ -2526,7 +2556,7 @@ def stroke_normalize(
|
|
|
2526
2556
|
|
|
2527
2557
|
OPACITY
|
|
2528
2558
|
Opacity -- Normalizes the stroke opacity by making all points use the same opacity value.
|
|
2529
|
-
:type mode:
|
|
2559
|
+
:type mode: typing.Literal['THICKNESS','OPACITY'] | None
|
|
2530
2560
|
:param factor: Factor
|
|
2531
2561
|
:type factor: float | None
|
|
2532
2562
|
:param value: Value, Value
|
|
@@ -2540,8 +2570,8 @@ def stroke_outline(
|
|
|
2540
2570
|
execution_context: int | str | None = None,
|
|
2541
2571
|
undo: bool | None = None,
|
|
2542
2572
|
*,
|
|
2543
|
-
view_mode:
|
|
2544
|
-
material_mode:
|
|
2573
|
+
view_mode: typing.Literal["VIEW", "FRONT", "SIDE", "TOP", "CAMERA"] | None = "VIEW",
|
|
2574
|
+
material_mode: typing.Literal["ACTIVE", "KEEP", "NEW"] | None = "ACTIVE",
|
|
2545
2575
|
thickness: int | None = 1,
|
|
2546
2576
|
keep: bool | None = True,
|
|
2547
2577
|
subdivisions: int | None = 3,
|
|
@@ -2553,7 +2583,7 @@ def stroke_outline(
|
|
|
2553
2583
|
:type execution_context: int | str | None
|
|
2554
2584
|
:type undo: bool | None
|
|
2555
2585
|
:param view_mode: View
|
|
2556
|
-
:type view_mode:
|
|
2586
|
+
:type view_mode: typing.Literal['VIEW','FRONT','SIDE','TOP','CAMERA'] | None
|
|
2557
2587
|
:param material_mode: Material Mode
|
|
2558
2588
|
|
|
2559
2589
|
ACTIVE
|
|
@@ -2564,7 +2594,7 @@ def stroke_outline(
|
|
|
2564
2594
|
|
|
2565
2595
|
NEW
|
|
2566
2596
|
New Material.
|
|
2567
|
-
:type material_mode:
|
|
2597
|
+
:type material_mode: typing.Literal['ACTIVE','KEEP','NEW'] | None
|
|
2568
2598
|
:param thickness: Thickness, Thickness of the stroke perimeter
|
|
2569
2599
|
:type thickness: int | None
|
|
2570
2600
|
:param keep: Keep Shape, Try to keep global shape when the stroke thickness change
|
|
@@ -2582,7 +2612,7 @@ def stroke_reset_vertex_color(
|
|
|
2582
2612
|
execution_context: int | str | None = None,
|
|
2583
2613
|
undo: bool | None = None,
|
|
2584
2614
|
*,
|
|
2585
|
-
mode:
|
|
2615
|
+
mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
|
|
2586
2616
|
):
|
|
2587
2617
|
"""Reset vertex color for all or selected strokes
|
|
2588
2618
|
|
|
@@ -2599,7 +2629,7 @@ def stroke_reset_vertex_color(
|
|
|
2599
2629
|
|
|
2600
2630
|
BOTH
|
|
2601
2631
|
Stroke & Fill -- Reset Vertex Color to Stroke and Fill.
|
|
2602
|
-
:type mode:
|
|
2632
|
+
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2603
2633
|
"""
|
|
2604
2634
|
|
|
2605
2635
|
...
|
|
@@ -2630,7 +2660,7 @@ def stroke_separate(
|
|
|
2630
2660
|
execution_context: int | str | None = None,
|
|
2631
2661
|
undo: bool | None = None,
|
|
2632
2662
|
*,
|
|
2633
|
-
mode:
|
|
2663
|
+
mode: typing.Literal["POINT", "STROKE", "LAYER"] | None = "POINT",
|
|
2634
2664
|
):
|
|
2635
2665
|
"""Separate the selected strokes or layer in a new grease pencil object
|
|
2636
2666
|
|
|
@@ -2647,7 +2677,7 @@ def stroke_separate(
|
|
|
2647
2677
|
|
|
2648
2678
|
LAYER
|
|
2649
2679
|
Active Layer -- Separate the strokes of the current layer.
|
|
2650
|
-
:type mode:
|
|
2680
|
+
:type mode: typing.Literal['POINT','STROKE','LAYER'] | None
|
|
2651
2681
|
"""
|
|
2652
2682
|
|
|
2653
2683
|
...
|
|
@@ -2824,14 +2854,17 @@ def trace_image(
|
|
|
2824
2854
|
execution_context: int | str | None = None,
|
|
2825
2855
|
undo: bool | None = None,
|
|
2826
2856
|
*,
|
|
2827
|
-
target:
|
|
2857
|
+
target: typing.Literal["NEW", "SELECTED"] | None = "NEW",
|
|
2828
2858
|
thickness: int | None = 10,
|
|
2829
2859
|
resolution: int | None = 5,
|
|
2830
2860
|
scale: float | None = 1.0,
|
|
2831
2861
|
sample: float | None = 0.0,
|
|
2832
2862
|
threshold: float | None = 0.5,
|
|
2833
|
-
turnpolicy:
|
|
2834
|
-
|
|
2863
|
+
turnpolicy: typing.Literal[
|
|
2864
|
+
"BLACK", "WHITE", "LEFT", "RIGHT", "MINORITY", "MAJORITY", "RANDOM"
|
|
2865
|
+
]
|
|
2866
|
+
| None = "MINORITY",
|
|
2867
|
+
mode: typing.Literal["SINGLE", "SEQUENCE"] | None = "SINGLE",
|
|
2835
2868
|
use_current_frame: bool | None = True,
|
|
2836
2869
|
frame_number: int | None = 0,
|
|
2837
2870
|
):
|
|
@@ -2841,7 +2874,7 @@ def trace_image(
|
|
|
2841
2874
|
:type execution_context: int | str | None
|
|
2842
2875
|
:type undo: bool | None
|
|
2843
2876
|
:param target: Target Object, Target grease pencil
|
|
2844
|
-
:type target:
|
|
2877
|
+
:type target: typing.Literal['NEW','SELECTED'] | None
|
|
2845
2878
|
:param thickness: Thickness
|
|
2846
2879
|
:type thickness: int | None
|
|
2847
2880
|
:param resolution: Resolution, Resolution of the generated curves
|
|
@@ -2874,7 +2907,7 @@ def trace_image(
|
|
|
2874
2907
|
|
|
2875
2908
|
RANDOM
|
|
2876
2909
|
Random -- Choose pseudo-randomly.
|
|
2877
|
-
:type turnpolicy:
|
|
2910
|
+
:type turnpolicy: typing.Literal['BLACK','WHITE','LEFT','RIGHT','MINORITY','MAJORITY','RANDOM'] | None
|
|
2878
2911
|
:param mode: Mode, Determines if trace simple image or full sequence
|
|
2879
2912
|
|
|
2880
2913
|
SINGLE
|
|
@@ -2882,7 +2915,7 @@ def trace_image(
|
|
|
2882
2915
|
|
|
2883
2916
|
SEQUENCE
|
|
2884
2917
|
Sequence -- Trace full sequence.
|
|
2885
|
-
:type mode:
|
|
2918
|
+
:type mode: typing.Literal['SINGLE','SEQUENCE'] | None
|
|
2886
2919
|
:param use_current_frame: Start At Current Frame, Trace Image starting in current image frame
|
|
2887
2920
|
:type use_current_frame: bool | None
|
|
2888
2921
|
:param frame_number: Trace Frame, Used to trace only one frame of the image sequence, set to zero to trace all
|
|
@@ -2896,7 +2929,7 @@ def transform_fill(
|
|
|
2896
2929
|
execution_context: int | str | None = None,
|
|
2897
2930
|
undo: bool | None = None,
|
|
2898
2931
|
*,
|
|
2899
|
-
mode:
|
|
2932
|
+
mode: typing.Literal["TRANSLATE", "ROTATE", "SCALE"] | None = "ROTATE",
|
|
2900
2933
|
location: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
|
|
2901
2934
|
rotation: float | None = 0.0,
|
|
2902
2935
|
scale: float | None = 0.0,
|
|
@@ -2908,7 +2941,7 @@ def transform_fill(
|
|
|
2908
2941
|
:type execution_context: int | str | None
|
|
2909
2942
|
:type undo: bool | None
|
|
2910
2943
|
:param mode: Mode
|
|
2911
|
-
:type mode:
|
|
2944
|
+
:type mode: typing.Literal['TRANSLATE','ROTATE','SCALE'] | None
|
|
2912
2945
|
:param location: Location
|
|
2913
2946
|
:type location: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
2914
2947
|
:param rotation: Rotation
|
|
@@ -2940,7 +2973,7 @@ def vertex_color_brightness_contrast(
|
|
|
2940
2973
|
execution_context: int | str | None = None,
|
|
2941
2974
|
undo: bool | None = None,
|
|
2942
2975
|
*,
|
|
2943
|
-
mode:
|
|
2976
|
+
mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
|
|
2944
2977
|
brightness: float | None = 0.0,
|
|
2945
2978
|
contrast: float | None = 0.0,
|
|
2946
2979
|
):
|
|
@@ -2950,7 +2983,7 @@ def vertex_color_brightness_contrast(
|
|
|
2950
2983
|
:type execution_context: int | str | None
|
|
2951
2984
|
:type undo: bool | None
|
|
2952
2985
|
:param mode: Mode
|
|
2953
|
-
:type mode:
|
|
2986
|
+
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2954
2987
|
:param brightness: Brightness
|
|
2955
2988
|
:type brightness: float | None
|
|
2956
2989
|
:param contrast: Contrast
|
|
@@ -2964,7 +2997,7 @@ def vertex_color_hsv(
|
|
|
2964
2997
|
execution_context: int | str | None = None,
|
|
2965
2998
|
undo: bool | None = None,
|
|
2966
2999
|
*,
|
|
2967
|
-
mode:
|
|
3000
|
+
mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
|
|
2968
3001
|
h: float | None = 0.5,
|
|
2969
3002
|
s: float | None = 1.0,
|
|
2970
3003
|
v: float | None = 1.0,
|
|
@@ -2975,7 +3008,7 @@ def vertex_color_hsv(
|
|
|
2975
3008
|
:type execution_context: int | str | None
|
|
2976
3009
|
:type undo: bool | None
|
|
2977
3010
|
:param mode: Mode
|
|
2978
|
-
:type mode:
|
|
3011
|
+
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2979
3012
|
:param h: Hue
|
|
2980
3013
|
:type h: float | None
|
|
2981
3014
|
:param s: Saturation
|
|
@@ -2991,7 +3024,7 @@ def vertex_color_invert(
|
|
|
2991
3024
|
execution_context: int | str | None = None,
|
|
2992
3025
|
undo: bool | None = None,
|
|
2993
3026
|
*,
|
|
2994
|
-
mode:
|
|
3027
|
+
mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
|
|
2995
3028
|
):
|
|
2996
3029
|
"""Invert RGB values
|
|
2997
3030
|
|
|
@@ -2999,7 +3032,7 @@ def vertex_color_invert(
|
|
|
2999
3032
|
:type execution_context: int | str | None
|
|
3000
3033
|
:type undo: bool | None
|
|
3001
3034
|
:param mode: Mode
|
|
3002
|
-
:type mode:
|
|
3035
|
+
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
3003
3036
|
"""
|
|
3004
3037
|
|
|
3005
3038
|
...
|
|
@@ -3009,7 +3042,7 @@ def vertex_color_levels(
|
|
|
3009
3042
|
execution_context: int | str | None = None,
|
|
3010
3043
|
undo: bool | None = None,
|
|
3011
3044
|
*,
|
|
3012
|
-
mode:
|
|
3045
|
+
mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
|
|
3013
3046
|
offset: float | None = 0.0,
|
|
3014
3047
|
gain: float | None = 1.0,
|
|
3015
3048
|
):
|
|
@@ -3019,7 +3052,7 @@ def vertex_color_levels(
|
|
|
3019
3052
|
:type execution_context: int | str | None
|
|
3020
3053
|
:type undo: bool | None
|
|
3021
3054
|
:param mode: Mode
|
|
3022
|
-
:type mode:
|
|
3055
|
+
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
3023
3056
|
:param offset: Offset, Value to add to colors
|
|
3024
3057
|
:type offset: float | None
|
|
3025
3058
|
:param gain: Gain, Value to multiply colors by
|
|
@@ -3033,7 +3066,7 @@ def vertex_color_set(
|
|
|
3033
3066
|
execution_context: int | str | None = None,
|
|
3034
3067
|
undo: bool | None = None,
|
|
3035
3068
|
*,
|
|
3036
|
-
mode:
|
|
3069
|
+
mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
|
|
3037
3070
|
factor: float | None = 1.0,
|
|
3038
3071
|
):
|
|
3039
3072
|
"""Set active color to all selected vertex
|
|
@@ -3042,7 +3075,7 @@ def vertex_color_set(
|
|
|
3042
3075
|
:type execution_context: int | str | None
|
|
3043
3076
|
:type undo: bool | None
|
|
3044
3077
|
:param mode: Mode
|
|
3045
|
-
:type mode:
|
|
3078
|
+
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
3046
3079
|
:param factor: Factor, Mix Factor
|
|
3047
3080
|
:type factor: float | None
|
|
3048
3081
|
"""
|