fake-bpy-module 20250828__py3-none-any.whl → 20260118__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.
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +0 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +0 -5
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +0 -11
- {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +0 -10
- {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +1 -0
- {bl_i18n_utils → _bl_i18n_utils}/bl_extract_messages/__init__.pyi +1 -0
- {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +2 -0
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- _bpy_internal/__init__.pyi +3 -1
- _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
- _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
- _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
- _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
- _bpy_internal/filesystem/__init__.pyi +5 -0
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_types/__init__.pyi +115 -117
- {rna_info → _rna_info}/__init__.pyi +0 -1
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +66 -142
- bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
- bl_app_templates_system/__init__.pyi +5 -0
- bl_app_templates_system/py.typed +0 -0
- bl_math/__init__.pyi +2 -12
- bl_operators/__init__.pyi +1 -0
- bl_operators/add_mesh_torus/__init__.pyi +0 -2
- bl_operators/anim/__init__.pyi +47 -24
- bl_operators/assets/__init__.pyi +0 -6
- bl_operators/bone_selection_sets/__init__.pyi +0 -28
- bl_operators/clip/__init__.pyi +0 -20
- bl_operators/connect_to_output/__init__.pyi +0 -2
- bl_operators/console/__init__.pyi +0 -10
- bl_operators/constraint/__init__.pyi +0 -8
- bl_operators/copy_global_transform/__init__.pyi +261 -0
- bl_operators/file/__init__.pyi +0 -6
- bl_operators/freestyle/__init__.pyi +0 -8
- bl_operators/geometry_nodes/__init__.pyi +0 -8
- bl_operators/grease_pencil/__init__.pyi +0 -2
- bl_operators/image/__init__.pyi +0 -10
- bl_operators/image_as_planes/__init__.pyi +0 -4
- bl_operators/mesh/__init__.pyi +0 -47
- bl_operators/node/__init__.pyi +277 -57
- bl_operators/object/__init__.pyi +0 -37
- bl_operators/object_align/__init__.pyi +0 -2
- bl_operators/object_quick_effects/__init__.pyi +0 -8
- bl_operators/object_randomize_transform/__init__.pyi +0 -2
- bl_operators/presets/__init__.pyi +1 -51
- bl_operators/rigidbody/__init__.pyi +0 -6
- bl_operators/screen_play_rendered_anim/__init__.pyi +0 -2
- bl_operators/sequencer/__init__.pyi +0 -16
- bl_operators/spreadsheet/__init__.pyi +0 -2
- bl_operators/userpref/__init__.pyi +0 -50
- bl_operators/uvcalc_follow_active/__init__.pyi +1 -3
- bl_operators/uvcalc_lightmap/__init__.pyi +0 -2
- bl_operators/uvcalc_transform/__init__.pyi +21 -12
- bl_operators/vertexpaint_dirt/__init__.pyi +0 -2
- bl_operators/view3d/__init__.pyi +0 -16
- bl_operators/wm/__init__.pyi +0 -92
- bl_operators/world/__init__.pyi +0 -2
- bl_ui/__init__.pyi +3 -4
- bl_ui/anim/__init__.pyi +0 -2
- bl_ui/asset_shelf/__init__.pyi +0 -2
- bl_ui/generic_ui_list/__init__.pyi +1 -17
- bl_ui/node_add_menu/__init__.pyi +261 -6
- bl_ui/node_add_menu_compositor/__init__.pyi +96 -80
- bl_ui/node_add_menu_geometry/__init__.pyi +266 -306
- bl_ui/node_add_menu_shader/__init__.pyi +49 -50
- bl_ui/node_add_menu_texture/__init__.pyi +16 -62
- bl_ui/properties_collection/__init__.pyi +0 -14
- bl_ui/properties_constraint/__init__.pyi +55 -209
- bl_ui/properties_data_armature/__init__.pyi +0 -36
- bl_ui/properties_data_bone/__init__.pyi +0 -20
- bl_ui/properties_data_camera/__init__.pyi +0 -30
- bl_ui/properties_data_curve/__init__.pyi +0 -30
- bl_ui/properties_data_curves/__init__.pyi +0 -16
- bl_ui/properties_data_empty/__init__.pyi +0 -4
- bl_ui/properties_data_grease_pencil/__init__.pyi +0 -40
- bl_ui/properties_data_lattice/__init__.pyi +0 -8
- bl_ui/properties_data_light/__init__.pyi +0 -20
- bl_ui/properties_data_lightprobe/__init__.pyi +0 -28
- bl_ui/properties_data_mesh/__init__.pyi +1 -42
- bl_ui/properties_data_metaball/__init__.pyi +0 -12
- bl_ui/properties_data_modifier/__init__.pyi +12 -19
- bl_ui/properties_data_pointcloud/__init__.pyi +0 -12
- bl_ui/properties_data_shaderfx/__init__.pyi +0 -2
- bl_ui/properties_data_speaker/__init__.pyi +0 -12
- bl_ui/properties_data_volume/__init__.pyi +0 -18
- bl_ui/properties_freestyle/__init__.pyi +0 -50
- bl_ui/properties_grease_pencil_common/__init__.pyi +0 -159
- bl_ui/properties_mask_common/__init__.pyi +0 -14
- bl_ui/properties_material/__init__.pyi +0 -32
- bl_ui/properties_material_gpencil/__init__.pyi +23 -45
- bl_ui/properties_object/__init__.pyi +35 -42
- bl_ui/properties_output/__init__.pyi +0 -40
- bl_ui/properties_paint_common/__init__.pyi +23 -19
- bl_ui/properties_particle/__init__.pyi +0 -106
- bl_ui/properties_physics_cloth/__init__.pyi +0 -28
- bl_ui/properties_physics_common/__init__.pyi +0 -2
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +0 -44
- bl_ui/properties_physics_field/__init__.pyi +0 -20
- bl_ui/properties_physics_fluid/__init__.pyi +0 -56
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +0 -2
- bl_ui/properties_physics_rigidbody/__init__.pyi +0 -16
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +0 -26
- bl_ui/properties_physics_softbody/__init__.pyi +0 -30
- bl_ui/properties_render/__init__.pyi +58 -86
- bl_ui/properties_scene/__init__.pyi +0 -34
- bl_ui/properties_strip/__init__.pyi +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +0 -54
- bl_ui/properties_view_layer/__init__.pyi +7 -28
- bl_ui/properties_workspace/__init__.pyi +0 -8
- bl_ui/properties_world/__init__.pyi +0 -22
- bl_ui/space_clip/__init__.pyi +82 -166
- bl_ui/space_console/__init__.pyi +0 -12
- bl_ui/space_dopesheet/__init__.pyi +67 -76
- bl_ui/space_filebrowser/__init__.pyi +0 -60
- bl_ui/space_graph/__init__.pyi +0 -66
- bl_ui/space_image/__init__.pyi +28 -162
- bl_ui/space_info/__init__.pyi +0 -12
- bl_ui/space_nla/__init__.pyi +0 -58
- bl_ui/space_node/__init__.pyi +99 -132
- bl_ui/space_outliner/__init__.pyi +0 -30
- bl_ui/space_properties/__init__.pyi +29 -6
- bl_ui/space_sequencer/__init__.pyi +159 -987
- bl_ui/space_spreadsheet/__init__.pyi +0 -6
- bl_ui/space_statusbar/__init__.pyi +0 -2
- bl_ui/space_text/__init__.pyi +0 -32
- bl_ui/space_time/__init__.pyi +29 -22
- bl_ui/space_toolsystem_toolbar/__init__.pyi +7 -2
- bl_ui/space_topbar/__init__.pyi +7 -52
- bl_ui/space_userpref/__init__.pyi +77 -225
- bl_ui/space_view3d/__init__.pyi +69 -551
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +22 -799
- bl_ui/utils/__init__.pyi +0 -17
- blf/__init__.pyi +6 -50
- bmesh/__init__.pyi +0 -7
- bmesh/geometry/__init__.pyi +0 -3
- bmesh/ops/__init__.pyi +5 -450
- bmesh/types/__init__.pyi +298 -639
- bmesh/utils/__init__.pyi +16 -43
- bpy/app/__init__.pyi +66 -58
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +0 -6
- bpy/app/translations/__init__.pyi +1 -16
- bpy/msgbus/__init__.pyi +1 -4
- bpy/ops/action/__init__.pyi +17 -186
- bpy/ops/anim/__init__.pyi +38 -279
- bpy/ops/armature/__init__.pyi +20 -191
- bpy/ops/asset/__init__.pyi +11 -97
- bpy/ops/boid/__init__.pyi +7 -38
- bpy/ops/brush/__init__.pyi +3 -104
- bpy/ops/buttons/__init__.pyi +4 -71
- bpy/ops/cachefile/__init__.pyi +2 -63
- bpy/ops/camera/__init__.pyi +0 -11
- bpy/ops/clip/__init__.pyi +43 -427
- bpy/ops/cloth/__init__.pyi +0 -5
- bpy/ops/collection/__init__.pyi +3 -35
- bpy/ops/console/__init__.pyi +10 -88
- bpy/ops/constraint/__init__.pyi +3 -80
- bpy/ops/curve/__init__.pyi +23 -254
- bpy/ops/curves/__init__.pyi +54 -149
- bpy/ops/cycles/__init__.pyi +1 -14
- bpy/ops/dpaint/__init__.pyi +3 -21
- bpy/ops/ed/__init__.pyi +10 -82
- bpy/ops/export_anim/__init__.pyi +2 -10
- bpy/ops/export_scene/__init__.pyi +1 -155
- bpy/ops/extensions/__init__.pyi +15 -150
- bpy/ops/file/__init__.pyi +29 -216
- bpy/ops/fluid/__init__.pyi +13 -70
- bpy/ops/font/__init__.pyi +10 -134
- bpy/ops/geometry/__init__.pyi +3 -124
- bpy/ops/gizmogroup/__init__.pyi +1 -12
- bpy/ops/gpencil/__init__.pyi +5 -49
- bpy/ops/graph/__init__.pyi +20 -315
- bpy/ops/grease_pencil/__init__.pyi +62 -523
- bpy/ops/image/__init__.pyi +19 -379
- bpy/ops/import_anim/__init__.pyi +2 -16
- bpy/ops/import_curve/__init__.pyi +0 -6
- bpy/ops/import_scene/__init__.pyi +0 -50
- bpy/ops/info/__init__.pyi +4 -35
- bpy/ops/lattice/__init__.pyi +3 -33
- bpy/ops/marker/__init__.pyi +4 -49
- bpy/ops/mask/__init__.pyi +17 -176
- bpy/ops/material/__init__.pyi +3 -15
- bpy/ops/mball/__init__.pyi +1 -30
- bpy/ops/mesh/__init__.pyi +34 -932
- bpy/ops/nla/__init__.pyi +22 -183
- bpy/ops/node/__init__.pyi +420 -625
- bpy/ops/object/__init__.pyi +197 -1239
- bpy/ops/outliner/__init__.pyi +47 -327
- bpy/ops/paint/__init__.pyi +29 -282
- bpy/ops/paintcurve/__init__.pyi +4 -36
- bpy/ops/palette/__init__.pyi +3 -27
- bpy/ops/particle/__init__.pyi +20 -160
- bpy/ops/pointcloud/__init__.pyi +3 -35
- bpy/ops/pose/__init__.pyi +29 -234
- bpy/ops/poselib/__init__.pyi +19 -66
- bpy/ops/preferences/__init__.pyi +9 -177
- bpy/ops/ptcache/__init__.pyi +5 -31
- bpy/ops/render/__init__.pyi +10 -68
- bpy/ops/rigidbody/__init__.pyi +6 -56
- bpy/ops/scene/__init__.pyi +23 -168
- bpy/ops/screen/__init__.pyi +36 -202
- bpy/ops/script/__init__.pyi +1 -12
- bpy/ops/sculpt/__init__.pyi +42 -313
- bpy/ops/sculpt_curves/__init__.pyi +6 -21
- bpy/ops/sequencer/__init__.pyi +187 -644
- bpy/ops/sound/__init__.pyi +3 -109
- bpy/ops/spreadsheet/__init__.pyi +5 -32
- bpy/ops/surface/__init__.pyi +0 -48
- bpy/ops/text/__init__.pyi +27 -225
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +3 -18
- bpy/ops/transform/__init__.pyi +10 -382
- bpy/ops/ui/__init__.pyi +29 -154
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +195 -288
- bpy/ops/view2d/__init__.pyi +3 -73
- bpy/ops/view3d/__init__.pyi +37 -339
- bpy/ops/wm/__init__.pyi +129 -1317
- bpy/ops/workspace/__init__.pyi +7 -39
- bpy/ops/world/__init__.pyi +2 -10
- bpy/path/__init__.pyi +0 -34
- bpy/props/__init__.pyi +332 -203
- bpy/stub_internal/rna_enums/__init__.pyi +102 -82
- bpy/types/__init__.pyi +51712 -89245
- bpy/utils/__init__.pyi +4 -75
- bpy/utils/previews/__init__.pyi +1 -10
- bpy/utils/units/__init__.pyi +0 -12
- bpy_extras/anim_utils/__init__.pyi +24 -16
- bpy_extras/bmesh_utils/__init__.pyi +0 -1
- bpy_extras/id_map_utils/__init__.pyi +14 -6
- bpy_extras/image_utils/__init__.pyi +0 -9
- bpy_extras/io_utils/__init__.pyi +4 -23
- bpy_extras/keyconfig_utils/__init__.pyi +1 -1
- bpy_extras/mesh_utils/__init__.pyi +0 -12
- bpy_extras/node_shader_utils/__init__.pyi +0 -8
- bpy_extras/object_utils/__init__.pyi +0 -14
- bpy_extras/view3d_utils/__init__.pyi +0 -18
- {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260118.dist-info}/METADATA +4 -1
- fake_bpy_module-20260118.dist-info/RECORD +385 -0
- {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260118.dist-info}/top_level.txt +15 -14
- freestyle/chainingiterators/__init__.pyi +0 -22
- freestyle/functions/__init__.pyi +0 -139
- freestyle/predicates/__init__.pyi +0 -51
- freestyle/shaders/__init__.pyi +0 -65
- freestyle/types/__init__.pyi +139 -777
- freestyle/utils/ContextFunctions/__init__.pyi +0 -23
- freestyle/utils/__init__.pyi +0 -6
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +1 -10
- gpu/platform/__init__.pyi +0 -5
- gpu/shader/__init__.pyi +22 -6
- gpu/state/__init__.pyi +59 -38
- gpu/texture/__init__.pyi +0 -2
- gpu/types/__init__.pyi +84 -152
- gpu_extras/batch/__init__.pyi +0 -4
- gpu_extras/presets/__init__.pyi +6 -8
- idprop/types/__init__.pyi +6 -6
- imbuf/__init__.pyi +2 -9
- imbuf/types/__init__.pyi +5 -25
- keyingsets_builtins/__init__.pyi +1 -45
- mathutils/__init__.pyi +106 -2168
- mathutils/bvhtree/__init__.pyi +3 -25
- mathutils/geometry/__init__.pyi +41 -133
- mathutils/interpolate/__init__.pyi +3 -4
- mathutils/kdtree/__init__.pyi +0 -11
- mathutils/noise/__init__.pyi +0 -62
- fake_bpy_module-20250828.dist-info/RECORD +0 -370
- {animsys_refactor → _animsys_refactor}/__init__.pyi +0 -0
- {animsys_refactor → _animsys_refactor}/py.typed +0 -0
- {bl_console_utils → _bl_console_utils}/__init__.pyi +0 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +0 -0
- {bl_console_utils → _bl_console_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_cli/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_languages_menu/__init__.pyi +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/bl_previews_render/__init__.pyi +0 -0
- {bl_previews_utils → _bl_previews_utils}/py.typed +0 -0
- {bl_rna_utils → _bl_rna_utils}/__init__.pyi +0 -0
- {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +0 -0
- {bl_rna_utils → _bl_rna_utils}/py.typed +0 -0
- {bl_text_utils → _bl_text_utils}/__init__.pyi +0 -0
- {bl_text_utils → _bl_text_utils}/external_editor/__init__.pyi +0 -0
- {bl_text_utils → _bl_text_utils}/py.typed +0 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
- {bl_ui_utils → _bl_ui_utils}/py.typed +0 -0
- /_bpy_internal/{freedesktop → platform/freedesktop}/__init__.pyi +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
- {console_python → _console_python}/__init__.pyi +0 -0
- {console_python → _console_python}/py.typed +0 -0
- {console_shell → _console_shell}/__init__.pyi +0 -0
- {console_shell → _console_shell}/py.typed +0 -0
- {graphviz_export → _graphviz_export}/__init__.pyi +0 -0
- {graphviz_export → _graphviz_export}/py.typed +0 -0
- {keyingsets_utils → _keyingsets_utils}/__init__.pyi +0 -0
- {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
- {rna_info → _rna_info}/py.typed +0 -0
- {rna_xml → _rna_xml}/__init__.pyi +0 -0
- {rna_xml → _rna_xml}/py.typed +0 -0
- {fake_bpy_module-20250828.dist-info → fake_bpy_module-20260118.dist-info}/WHEEL +0 -0
|
@@ -15,10 +15,7 @@ def active_frame_delete(
|
|
|
15
15
|
) -> None:
|
|
16
16
|
"""Delete the active Grease Pencil frame(s)
|
|
17
17
|
|
|
18
|
-
:type execution_context: int | str | None
|
|
19
|
-
:type undo: bool | None
|
|
20
18
|
:param all: Delete all, Delete active keyframes of all layers
|
|
21
|
-
:type all: bool | None
|
|
22
19
|
"""
|
|
23
20
|
|
|
24
21
|
def bake_grease_pencil_animation(
|
|
@@ -36,18 +33,11 @@ def bake_grease_pencil_animation(
|
|
|
36
33
|
) -> None:
|
|
37
34
|
"""Bake Grease Pencil object transform to Grease Pencil keyframes
|
|
38
35
|
|
|
39
|
-
:type execution_context: int | str | None
|
|
40
|
-
:type undo: bool | None
|
|
41
36
|
:param frame_start: Start Frame, The start frame
|
|
42
|
-
:type frame_start: int | None
|
|
43
37
|
:param frame_end: End Frame, The end frame of animation
|
|
44
|
-
:type frame_end: int | None
|
|
45
38
|
:param step: Step, Step between generated frames
|
|
46
|
-
:type step: int | None
|
|
47
39
|
:param only_selected: Only Selected Keyframes, Convert only selected keyframes
|
|
48
|
-
:type only_selected: bool | None
|
|
49
40
|
:param frame_target: Target Frame, Destination frame
|
|
50
|
-
:type frame_target: int | None
|
|
51
41
|
:param project_type: Projection Type
|
|
52
42
|
|
|
53
43
|
KEEP
|
|
@@ -67,7 +57,6 @@ def bake_grease_pencil_animation(
|
|
|
67
57
|
|
|
68
58
|
CURSOR
|
|
69
59
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
70
|
-
:type project_type: typing.Literal['KEEP','FRONT','SIDE','TOP','VIEW','CURSOR'] | None
|
|
71
60
|
"""
|
|
72
61
|
|
|
73
62
|
def brush_stroke(
|
|
@@ -77,15 +66,13 @@ def brush_stroke(
|
|
|
77
66
|
*,
|
|
78
67
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
79
68
|
| None = None,
|
|
80
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
69
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
70
|
+
| None = "NORMAL",
|
|
81
71
|
pen_flip: bool | None = False,
|
|
82
72
|
) -> None:
|
|
83
73
|
"""Draw a new stroke in the active Grease Pencil object
|
|
84
74
|
|
|
85
|
-
:type execution_context: int | str | None
|
|
86
|
-
:type undo: bool | None
|
|
87
75
|
:param stroke: Stroke
|
|
88
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
89
76
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
90
77
|
|
|
91
78
|
NORMAL
|
|
@@ -99,9 +86,10 @@ def brush_stroke(
|
|
|
99
86
|
|
|
100
87
|
ERASE
|
|
101
88
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
102
|
-
|
|
89
|
+
|
|
90
|
+
MASK
|
|
91
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
103
92
|
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
104
|
-
:type pen_flip: bool | None
|
|
105
93
|
"""
|
|
106
94
|
|
|
107
95
|
def caps_set(
|
|
@@ -113,8 +101,6 @@ def caps_set(
|
|
|
113
101
|
) -> None:
|
|
114
102
|
"""Change curve caps mode (rounded or flat)
|
|
115
103
|
|
|
116
|
-
:type execution_context: int | str | None
|
|
117
|
-
:type undo: bool | None
|
|
118
104
|
:param type: Type
|
|
119
105
|
|
|
120
106
|
ROUND
|
|
@@ -128,7 +114,6 @@ def caps_set(
|
|
|
128
114
|
|
|
129
115
|
END
|
|
130
116
|
Toggle End.
|
|
131
|
-
:type type: typing.Literal['ROUND','FLAT','START','END'] | None
|
|
132
117
|
"""
|
|
133
118
|
|
|
134
119
|
def clean_loose(
|
|
@@ -140,10 +125,7 @@ def clean_loose(
|
|
|
140
125
|
) -> None:
|
|
141
126
|
"""Remove loose points
|
|
142
127
|
|
|
143
|
-
:type execution_context: int | str | None
|
|
144
|
-
:type undo: bool | None
|
|
145
128
|
:param limit: Limit, Number of points to consider stroke as loose
|
|
146
|
-
:type limit: int | None
|
|
147
129
|
"""
|
|
148
130
|
|
|
149
131
|
def convert_curve_type(
|
|
@@ -156,12 +138,8 @@ def convert_curve_type(
|
|
|
156
138
|
) -> None:
|
|
157
139
|
"""Convert type of selected curves
|
|
158
140
|
|
|
159
|
-
:type execution_context: int | str | None
|
|
160
|
-
:type undo: bool | None
|
|
161
141
|
:param type: Type
|
|
162
|
-
:type type: bpy.stub_internal.rna_enums.CurvesTypeItems | None
|
|
163
142
|
:param threshold: Threshold, The distance that the resulting points are allowed to be within
|
|
164
|
-
:type threshold: float | None
|
|
165
143
|
"""
|
|
166
144
|
|
|
167
145
|
def copy(
|
|
@@ -169,11 +147,7 @@ def copy(
|
|
|
169
147
|
undo: bool | None = None,
|
|
170
148
|
/,
|
|
171
149
|
) -> None:
|
|
172
|
-
"""Copy the selected Grease Pencil points or strokes to the internal clipboard
|
|
173
|
-
|
|
174
|
-
:type execution_context: int | str | None
|
|
175
|
-
:type undo: bool | None
|
|
176
|
-
"""
|
|
150
|
+
"""Copy the selected Grease Pencil points or strokes to the internal clipboard"""
|
|
177
151
|
|
|
178
152
|
def cyclical_set(
|
|
179
153
|
execution_context: int | str | None = None,
|
|
@@ -185,12 +159,8 @@ def cyclical_set(
|
|
|
185
159
|
) -> None:
|
|
186
160
|
"""Close or open the selected stroke adding a segment from last to first point
|
|
187
161
|
|
|
188
|
-
:type execution_context: int | str | None
|
|
189
|
-
:type undo: bool | None
|
|
190
162
|
:param type: Type
|
|
191
|
-
:type type: typing.Literal['CLOSE','OPEN','TOGGLE'] | None
|
|
192
163
|
:param subdivide_cyclic_segment: Match Point Density, Add point in the new segment to keep the same density
|
|
193
|
-
:type subdivide_cyclic_segment: bool | None
|
|
194
164
|
"""
|
|
195
165
|
|
|
196
166
|
def delete(
|
|
@@ -198,22 +168,14 @@ def delete(
|
|
|
198
168
|
undo: bool | None = None,
|
|
199
169
|
/,
|
|
200
170
|
) -> None:
|
|
201
|
-
"""Delete selected strokes or points
|
|
202
|
-
|
|
203
|
-
:type execution_context: int | str | None
|
|
204
|
-
:type undo: bool | None
|
|
205
|
-
"""
|
|
171
|
+
"""Delete selected strokes or points"""
|
|
206
172
|
|
|
207
173
|
def delete_breakdown(
|
|
208
174
|
execution_context: int | str | None = None,
|
|
209
175
|
undo: bool | None = None,
|
|
210
176
|
/,
|
|
211
177
|
) -> None:
|
|
212
|
-
"""Remove breakdown frames generated by interpolating between two Grease Pencil frames
|
|
213
|
-
|
|
214
|
-
:type execution_context: int | str | None
|
|
215
|
-
:type undo: bool | None
|
|
216
|
-
"""
|
|
178
|
+
"""Remove breakdown frames generated by interpolating between two Grease Pencil frames"""
|
|
217
179
|
|
|
218
180
|
def delete_frame(
|
|
219
181
|
execution_context: int | str | None = None,
|
|
@@ -224,8 +186,6 @@ def delete_frame(
|
|
|
224
186
|
) -> None:
|
|
225
187
|
"""Delete Grease Pencil Frame(s)
|
|
226
188
|
|
|
227
|
-
:type execution_context: int | str | None
|
|
228
|
-
:type undo: bool | None
|
|
229
189
|
:param type: Type, Method used for deleting Grease Pencil frames
|
|
230
190
|
|
|
231
191
|
ACTIVE_FRAME
|
|
@@ -233,7 +193,6 @@ def delete_frame(
|
|
|
233
193
|
|
|
234
194
|
ALL_FRAMES
|
|
235
195
|
All Active Frames -- Delete active frames for all layers.
|
|
236
|
-
:type type: typing.Literal['ACTIVE_FRAME','ALL_FRAMES'] | None
|
|
237
196
|
"""
|
|
238
197
|
|
|
239
198
|
def dissolve(
|
|
@@ -245,8 +204,6 @@ def dissolve(
|
|
|
245
204
|
) -> None:
|
|
246
205
|
"""Delete selected points without splitting strokes
|
|
247
206
|
|
|
248
|
-
:type execution_context: int | str | None
|
|
249
|
-
:type undo: bool | None
|
|
250
207
|
:param type: Type, Method used for dissolving stroke points
|
|
251
208
|
|
|
252
209
|
POINTS
|
|
@@ -257,7 +214,6 @@ def dissolve(
|
|
|
257
214
|
|
|
258
215
|
UNSELECT
|
|
259
216
|
Dissolve Unselect -- Dissolve all unselected points.
|
|
260
|
-
:type type: typing.Literal['POINTS','BETWEEN','UNSELECT'] | None
|
|
261
217
|
"""
|
|
262
218
|
|
|
263
219
|
def duplicate(
|
|
@@ -265,11 +221,7 @@ def duplicate(
|
|
|
265
221
|
undo: bool | None = None,
|
|
266
222
|
/,
|
|
267
223
|
) -> None:
|
|
268
|
-
"""Duplicate the selected points
|
|
269
|
-
|
|
270
|
-
:type execution_context: int | str | None
|
|
271
|
-
:type undo: bool | None
|
|
272
|
-
"""
|
|
224
|
+
"""Duplicate the selected points"""
|
|
273
225
|
|
|
274
226
|
def duplicate_move(
|
|
275
227
|
execution_context: int | str | None = None,
|
|
@@ -281,12 +233,8 @@ def duplicate_move(
|
|
|
281
233
|
) -> None:
|
|
282
234
|
"""Make copies of the selected Grease Pencil strokes and move them
|
|
283
235
|
|
|
284
|
-
:type execution_context: int | str | None
|
|
285
|
-
:type undo: bool | None
|
|
286
236
|
:param GREASE_PENCIL_OT_duplicate: Duplicate, Duplicate the selected points
|
|
287
|
-
:type GREASE_PENCIL_OT_duplicate: typing.Any | None
|
|
288
237
|
:param TRANSFORM_OT_translate: Move, Move selected items
|
|
289
|
-
:type TRANSFORM_OT_translate: bpy.ops.transform.translate | None
|
|
290
238
|
"""
|
|
291
239
|
|
|
292
240
|
def erase_box(
|
|
@@ -302,18 +250,11 @@ def erase_box(
|
|
|
302
250
|
) -> None:
|
|
303
251
|
"""Erase points in the box region
|
|
304
252
|
|
|
305
|
-
:type execution_context: int | str | None
|
|
306
|
-
:type undo: bool | None
|
|
307
253
|
:param xmin: X Min
|
|
308
|
-
:type xmin: int | None
|
|
309
254
|
:param xmax: X Max
|
|
310
|
-
:type xmax: int | None
|
|
311
255
|
:param ymin: Y Min
|
|
312
|
-
:type ymin: int | None
|
|
313
256
|
:param ymax: Y Max
|
|
314
|
-
:type ymax: int | None
|
|
315
257
|
:param wait_for_input: Wait for Input
|
|
316
|
-
:type wait_for_input: bool | None
|
|
317
258
|
"""
|
|
318
259
|
|
|
319
260
|
def erase_lasso(
|
|
@@ -328,16 +269,10 @@ def erase_lasso(
|
|
|
328
269
|
) -> None:
|
|
329
270
|
"""Erase points in the lasso region
|
|
330
271
|
|
|
331
|
-
:type execution_context: int | str | None
|
|
332
|
-
:type undo: bool | None
|
|
333
272
|
:param path: Path
|
|
334
|
-
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
335
273
|
:param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
|
|
336
|
-
:type use_smooth_stroke: bool | None
|
|
337
274
|
:param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
|
|
338
|
-
:type smooth_stroke_factor: float | None
|
|
339
275
|
:param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
|
|
340
|
-
:type smooth_stroke_radius: int | None
|
|
341
276
|
"""
|
|
342
277
|
|
|
343
278
|
def extrude(
|
|
@@ -345,11 +280,7 @@ def extrude(
|
|
|
345
280
|
undo: bool | None = None,
|
|
346
281
|
/,
|
|
347
282
|
) -> None:
|
|
348
|
-
"""Extrude the selected points
|
|
349
|
-
|
|
350
|
-
:type execution_context: int | str | None
|
|
351
|
-
:type undo: bool | None
|
|
352
|
-
"""
|
|
283
|
+
"""Extrude the selected points"""
|
|
353
284
|
|
|
354
285
|
def extrude_move(
|
|
355
286
|
execution_context: int | str | None = None,
|
|
@@ -361,12 +292,8 @@ def extrude_move(
|
|
|
361
292
|
) -> None:
|
|
362
293
|
"""Extrude selected points and move them
|
|
363
294
|
|
|
364
|
-
:type execution_context: int | str | None
|
|
365
|
-
:type undo: bool | None
|
|
366
295
|
:param GREASE_PENCIL_OT_extrude: Extrude Stroke Points, Extrude the selected points
|
|
367
|
-
:type GREASE_PENCIL_OT_extrude: typing.Any | None
|
|
368
296
|
:param TRANSFORM_OT_translate: Move, Move selected items
|
|
369
|
-
:type TRANSFORM_OT_translate: bpy.ops.transform.translate | None
|
|
370
297
|
"""
|
|
371
298
|
|
|
372
299
|
def fill(
|
|
@@ -379,12 +306,8 @@ def fill(
|
|
|
379
306
|
) -> None:
|
|
380
307
|
"""Fill with color the shape formed by strokes
|
|
381
308
|
|
|
382
|
-
:type execution_context: int | str | None
|
|
383
|
-
:type undo: bool | None
|
|
384
309
|
:param invert: Invert, Find boundary of unfilled instead of filled regions
|
|
385
|
-
:type invert: bool | None
|
|
386
310
|
:param precision: Precision, Use precision movement for extension lines
|
|
387
|
-
:type precision: bool | None
|
|
388
311
|
"""
|
|
389
312
|
|
|
390
313
|
def frame_clean_duplicate(
|
|
@@ -396,10 +319,7 @@ def frame_clean_duplicate(
|
|
|
396
319
|
) -> None:
|
|
397
320
|
"""Remove any keyframe that is a duplicate of the previous one
|
|
398
321
|
|
|
399
|
-
:type execution_context: int | str | None
|
|
400
|
-
:type undo: bool | None
|
|
401
322
|
:param selected: Selected, Only delete selected keyframes
|
|
402
|
-
:type selected: bool | None
|
|
403
323
|
"""
|
|
404
324
|
|
|
405
325
|
def frame_duplicate(
|
|
@@ -411,10 +331,7 @@ def frame_duplicate(
|
|
|
411
331
|
) -> None:
|
|
412
332
|
"""Make a copy of the active Grease Pencil frame(s)
|
|
413
333
|
|
|
414
|
-
:type execution_context: int | str | None
|
|
415
|
-
:type undo: bool | None
|
|
416
334
|
:param all: Duplicate all, Duplicate active keyframes of all layer
|
|
417
|
-
:type all: bool | None
|
|
418
335
|
"""
|
|
419
336
|
|
|
420
337
|
def insert_blank_frame(
|
|
@@ -427,12 +344,8 @@ def insert_blank_frame(
|
|
|
427
344
|
) -> None:
|
|
428
345
|
"""Insert a blank frame on the current scene frame
|
|
429
346
|
|
|
430
|
-
:type execution_context: int | str | None
|
|
431
|
-
:type undo: bool | None
|
|
432
347
|
:param all_layers: All Layers, Insert a blank frame in all editable layers
|
|
433
|
-
:type all_layers: bool | None
|
|
434
348
|
:param duration: Duration
|
|
435
|
-
:type duration: int | None
|
|
436
349
|
"""
|
|
437
350
|
|
|
438
351
|
def interpolate(
|
|
@@ -450,22 +363,13 @@ def interpolate(
|
|
|
450
363
|
) -> None:
|
|
451
364
|
"""Interpolate Grease Pencil strokes between frames
|
|
452
365
|
|
|
453
|
-
:type execution_context: int | str | None
|
|
454
|
-
:type undo: bool | None
|
|
455
366
|
:param shift: Shift, Bias factor for which frame has more influence on the interpolated strokes
|
|
456
|
-
:type shift: float | None
|
|
457
367
|
:param layers: Layer, Layers included in the interpolation
|
|
458
|
-
:type layers: typing.Literal['ACTIVE','ALL'] | None
|
|
459
368
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
460
|
-
:type exclude_breakdowns: bool | None
|
|
461
369
|
:param use_selection: Use Selection, Use only selected strokes for interpolating
|
|
462
|
-
:type use_selection: bool | None
|
|
463
370
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
464
|
-
:type flip: typing.Literal['NONE','FLIP','AUTO'] | None
|
|
465
371
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
466
|
-
:type smooth_steps: int | None
|
|
467
372
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
468
|
-
:type smooth_factor: float | None
|
|
469
373
|
"""
|
|
470
374
|
|
|
471
375
|
def interpolate_sequence(
|
|
@@ -503,22 +407,13 @@ def interpolate_sequence(
|
|
|
503
407
|
) -> None:
|
|
504
408
|
"""Generate in-betweens to smoothly interpolate between Grease Pencil frames
|
|
505
409
|
|
|
506
|
-
:type execution_context: int | str | None
|
|
507
|
-
:type undo: bool | None
|
|
508
410
|
:param step: Step, Number of frames between generated interpolated frames
|
|
509
|
-
:type step: int | None
|
|
510
411
|
:param layers: Layer, Layers included in the interpolation
|
|
511
|
-
:type layers: typing.Literal['ACTIVE','ALL'] | None
|
|
512
412
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
513
|
-
:type exclude_breakdowns: bool | None
|
|
514
413
|
:param use_selection: Use Selection, Use only selected strokes for interpolating
|
|
515
|
-
:type use_selection: bool | None
|
|
516
414
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
517
|
-
:type flip: typing.Literal['NONE','FLIP','AUTO'] | None
|
|
518
415
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
519
|
-
:type smooth_steps: int | None
|
|
520
416
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
521
|
-
:type smooth_factor: float | None
|
|
522
417
|
:param type: Type, Interpolation method to use the next time Interpolate Sequence is run
|
|
523
418
|
|
|
524
419
|
LINEAR
|
|
@@ -556,15 +451,10 @@ def interpolate_sequence(
|
|
|
556
451
|
|
|
557
452
|
ELASTIC
|
|
558
453
|
Elastic -- Exponentially decaying sine wave, like an elastic band.
|
|
559
|
-
:type type: typing.Literal['LINEAR','CUSTOM','SINE','QUAD','CUBIC','QUART','QUINT','EXPO','CIRC','BACK','BOUNCE','ELASTIC'] | None
|
|
560
454
|
:param easing: Easing, Which ends of the segment between the preceding and following Grease Pencil frames easing interpolation is applied to
|
|
561
|
-
:type easing: bpy.stub_internal.rna_enums.BeztripleInterpolationEasingItems | None
|
|
562
455
|
:param back: Back, Amount of overshoot for back easing
|
|
563
|
-
:type back: float | None
|
|
564
456
|
:param amplitude: Amplitude, Amount to boost elastic bounces for elastic easing
|
|
565
|
-
:type amplitude: float | None
|
|
566
457
|
:param period: Period, Time between bounces for elastic easing
|
|
567
|
-
:type period: float | None
|
|
568
458
|
"""
|
|
569
459
|
|
|
570
460
|
def join_selection(
|
|
@@ -576,8 +466,6 @@ def join_selection(
|
|
|
576
466
|
) -> None:
|
|
577
467
|
"""New stroke from selected points/strokes
|
|
578
468
|
|
|
579
|
-
:type execution_context: int | str | None
|
|
580
|
-
:type undo: bool | None
|
|
581
469
|
:param type: Type, Defines how the operator will behave on the selection in the active layer
|
|
582
470
|
|
|
583
471
|
JOINSTROKES
|
|
@@ -588,7 +476,6 @@ def join_selection(
|
|
|
588
476
|
|
|
589
477
|
SPLIT
|
|
590
478
|
Split -- Split the selected point to a new stroke.
|
|
591
|
-
:type type: typing.Literal['JOINSTROKES','SPLITCOPY','SPLIT'] | None
|
|
592
479
|
"""
|
|
593
480
|
|
|
594
481
|
def layer_active(
|
|
@@ -600,10 +487,7 @@ def layer_active(
|
|
|
600
487
|
) -> None:
|
|
601
488
|
"""Set the active Grease Pencil layer
|
|
602
489
|
|
|
603
|
-
:type execution_context: int | str | None
|
|
604
|
-
:type undo: bool | None
|
|
605
490
|
:param layer: Grease Pencil Layer
|
|
606
|
-
:type layer: int | None
|
|
607
491
|
"""
|
|
608
492
|
|
|
609
493
|
def layer_add(
|
|
@@ -615,10 +499,7 @@ def layer_add(
|
|
|
615
499
|
) -> None:
|
|
616
500
|
"""Add a new Grease Pencil layer in the active object
|
|
617
501
|
|
|
618
|
-
:type execution_context: int | str | None
|
|
619
|
-
:type undo: bool | None
|
|
620
502
|
:param new_layer_name: Name, Name of the new layer
|
|
621
|
-
:type new_layer_name: str
|
|
622
503
|
"""
|
|
623
504
|
|
|
624
505
|
def layer_duplicate(
|
|
@@ -630,10 +511,7 @@ def layer_duplicate(
|
|
|
630
511
|
) -> None:
|
|
631
512
|
"""Make a copy of the active Grease Pencil layer
|
|
632
513
|
|
|
633
|
-
:type execution_context: int | str | None
|
|
634
|
-
:type undo: bool | None
|
|
635
514
|
:param empty_keyframes: Empty Keyframes, Add Empty Keyframes
|
|
636
|
-
:type empty_keyframes: bool | None
|
|
637
515
|
"""
|
|
638
516
|
|
|
639
517
|
def layer_duplicate_object(
|
|
@@ -646,12 +524,8 @@ def layer_duplicate_object(
|
|
|
646
524
|
) -> None:
|
|
647
525
|
"""Make a copy of the active Grease Pencil layer to selected object
|
|
648
526
|
|
|
649
|
-
:type execution_context: int | str | None
|
|
650
|
-
:type undo: bool | None
|
|
651
527
|
:param only_active: Only Active, Copy only active Layer, uncheck to append all layers
|
|
652
|
-
:type only_active: bool | None
|
|
653
528
|
:param mode: Mode
|
|
654
|
-
:type mode: typing.Literal['ALL','ACTIVE'] | None
|
|
655
529
|
"""
|
|
656
530
|
|
|
657
531
|
def layer_group_add(
|
|
@@ -663,10 +537,7 @@ def layer_group_add(
|
|
|
663
537
|
) -> None:
|
|
664
538
|
"""Add a new Grease Pencil layer group in the active object
|
|
665
539
|
|
|
666
|
-
:type execution_context: int | str | None
|
|
667
|
-
:type undo: bool | None
|
|
668
540
|
:param new_layer_group_name: Name, Name of the new layer group
|
|
669
|
-
:type new_layer_group_name: str
|
|
670
541
|
"""
|
|
671
542
|
|
|
672
543
|
def layer_group_color_tag(
|
|
@@ -689,10 +560,7 @@ def layer_group_color_tag(
|
|
|
689
560
|
) -> None:
|
|
690
561
|
"""Change layer group icon
|
|
691
562
|
|
|
692
|
-
:type execution_context: int | str | None
|
|
693
|
-
:type undo: bool | None
|
|
694
563
|
:param color_tag: Color Tag
|
|
695
|
-
:type color_tag: typing.Literal['NONE','COLOR1','COLOR2','COLOR3','COLOR4','COLOR5','COLOR6','COLOR7','COLOR8'] | None
|
|
696
564
|
"""
|
|
697
565
|
|
|
698
566
|
def layer_group_remove(
|
|
@@ -704,10 +572,7 @@ def layer_group_remove(
|
|
|
704
572
|
) -> None:
|
|
705
573
|
"""Remove Grease Pencil layer group in the active object
|
|
706
574
|
|
|
707
|
-
:type execution_context: int | str | None
|
|
708
|
-
:type undo: bool | None
|
|
709
575
|
:param keep_children: Keep children nodes, Keep the children nodes of the group and only delete the group itself
|
|
710
|
-
:type keep_children: bool | None
|
|
711
576
|
"""
|
|
712
577
|
|
|
713
578
|
def layer_hide(
|
|
@@ -719,10 +584,7 @@ def layer_hide(
|
|
|
719
584
|
) -> None:
|
|
720
585
|
"""Hide selected/unselected Grease Pencil layers
|
|
721
586
|
|
|
722
|
-
:type execution_context: int | str | None
|
|
723
|
-
:type undo: bool | None
|
|
724
587
|
:param unselected: Unselected, Hide unselected rather than selected layers
|
|
725
|
-
:type unselected: bool | None
|
|
726
588
|
"""
|
|
727
589
|
|
|
728
590
|
def layer_isolate(
|
|
@@ -734,10 +596,7 @@ def layer_isolate(
|
|
|
734
596
|
) -> None:
|
|
735
597
|
"""Make only active layer visible/editable
|
|
736
598
|
|
|
737
|
-
:type execution_context: int | str | None
|
|
738
|
-
:type undo: bool | None
|
|
739
599
|
:param affect_visibility: Affect Visibility, Also affect the visibility
|
|
740
|
-
:type affect_visibility: bool | None
|
|
741
600
|
"""
|
|
742
601
|
|
|
743
602
|
def layer_lock_all(
|
|
@@ -749,10 +608,7 @@ def layer_lock_all(
|
|
|
749
608
|
) -> None:
|
|
750
609
|
"""Lock all Grease Pencil layers to prevent them from being accidentally modified
|
|
751
610
|
|
|
752
|
-
:type execution_context: int | str | None
|
|
753
|
-
:type undo: bool | None
|
|
754
611
|
:param lock: Lock Value, Lock/Unlock all layers
|
|
755
|
-
:type lock: bool | None
|
|
756
612
|
"""
|
|
757
613
|
|
|
758
614
|
def layer_mask_add(
|
|
@@ -764,10 +620,7 @@ def layer_mask_add(
|
|
|
764
620
|
) -> None:
|
|
765
621
|
"""Add new layer as masking
|
|
766
622
|
|
|
767
|
-
:type execution_context: int | str | None
|
|
768
|
-
:type undo: bool | None
|
|
769
623
|
:param name: Layer, Name of the layer
|
|
770
|
-
:type name: str
|
|
771
624
|
"""
|
|
772
625
|
|
|
773
626
|
def layer_mask_remove(
|
|
@@ -775,11 +628,7 @@ def layer_mask_remove(
|
|
|
775
628
|
undo: bool | None = None,
|
|
776
629
|
/,
|
|
777
630
|
) -> None:
|
|
778
|
-
"""Remove Layer Mask
|
|
779
|
-
|
|
780
|
-
:type execution_context: int | str | None
|
|
781
|
-
:type undo: bool | None
|
|
782
|
-
"""
|
|
631
|
+
"""Remove Layer Mask"""
|
|
783
632
|
|
|
784
633
|
def layer_mask_reorder(
|
|
785
634
|
execution_context: int | str | None = None,
|
|
@@ -790,10 +639,7 @@ def layer_mask_reorder(
|
|
|
790
639
|
) -> None:
|
|
791
640
|
"""Reorder the active Grease Pencil mask layer up/down in the list
|
|
792
641
|
|
|
793
|
-
:type execution_context: int | str | None
|
|
794
|
-
:type undo: bool | None
|
|
795
642
|
:param direction: Direction
|
|
796
|
-
:type direction: typing.Literal['UP','DOWN'] | None
|
|
797
643
|
"""
|
|
798
644
|
|
|
799
645
|
def layer_merge(
|
|
@@ -805,8 +651,6 @@ def layer_merge(
|
|
|
805
651
|
) -> None:
|
|
806
652
|
"""Combine layers based on the mode into one layer
|
|
807
653
|
|
|
808
|
-
:type execution_context: int | str | None
|
|
809
|
-
:type undo: bool | None
|
|
810
654
|
:param mode: Mode
|
|
811
655
|
|
|
812
656
|
ACTIVE
|
|
@@ -817,7 +661,6 @@ def layer_merge(
|
|
|
817
661
|
|
|
818
662
|
ALL
|
|
819
663
|
All -- Combine all layers into a single layer.
|
|
820
|
-
:type mode: typing.Literal['ACTIVE','GROUP','ALL'] | None
|
|
821
664
|
"""
|
|
822
665
|
|
|
823
666
|
def layer_move(
|
|
@@ -829,10 +672,7 @@ def layer_move(
|
|
|
829
672
|
) -> None:
|
|
830
673
|
"""Move the active Grease Pencil layer or Group
|
|
831
674
|
|
|
832
|
-
:type execution_context: int | str | None
|
|
833
|
-
:type undo: bool | None
|
|
834
675
|
:param direction: Direction
|
|
835
|
-
:type direction: typing.Literal['UP','DOWN'] | None
|
|
836
676
|
"""
|
|
837
677
|
|
|
838
678
|
def layer_remove(
|
|
@@ -840,22 +680,14 @@ def layer_remove(
|
|
|
840
680
|
undo: bool | None = None,
|
|
841
681
|
/,
|
|
842
682
|
) -> None:
|
|
843
|
-
"""Remove the active Grease Pencil layer
|
|
844
|
-
|
|
845
|
-
:type execution_context: int | str | None
|
|
846
|
-
:type undo: bool | None
|
|
847
|
-
"""
|
|
683
|
+
"""Remove the active Grease Pencil layer"""
|
|
848
684
|
|
|
849
685
|
def layer_reveal(
|
|
850
686
|
execution_context: int | str | None = None,
|
|
851
687
|
undo: bool | None = None,
|
|
852
688
|
/,
|
|
853
689
|
) -> None:
|
|
854
|
-
"""Show all Grease Pencil layers
|
|
855
|
-
|
|
856
|
-
:type execution_context: int | str | None
|
|
857
|
-
:type undo: bool | None
|
|
858
|
-
"""
|
|
690
|
+
"""Show all Grease Pencil layers"""
|
|
859
691
|
|
|
860
692
|
def material_copy_to_object(
|
|
861
693
|
execution_context: int | str | None = None,
|
|
@@ -866,10 +698,7 @@ def material_copy_to_object(
|
|
|
866
698
|
) -> None:
|
|
867
699
|
"""Append Materials of the active Grease Pencil to other object
|
|
868
700
|
|
|
869
|
-
:type execution_context: int | str | None
|
|
870
|
-
:type undo: bool | None
|
|
871
701
|
:param only_active: Only Active, Append only active material, uncheck to append all materials
|
|
872
|
-
:type only_active: bool | None
|
|
873
702
|
"""
|
|
874
703
|
|
|
875
704
|
def material_hide(
|
|
@@ -881,10 +710,7 @@ def material_hide(
|
|
|
881
710
|
) -> None:
|
|
882
711
|
"""Hide active/inactive Grease Pencil material(s)
|
|
883
712
|
|
|
884
|
-
:type execution_context: int | str | None
|
|
885
|
-
:type undo: bool | None
|
|
886
713
|
:param invert: Invert, Hide inactive materials instead of the active one
|
|
887
|
-
:type invert: bool | None
|
|
888
714
|
"""
|
|
889
715
|
|
|
890
716
|
def material_isolate(
|
|
@@ -896,10 +722,7 @@ def material_isolate(
|
|
|
896
722
|
) -> None:
|
|
897
723
|
"""Toggle whether the active material is the only one that is editable and/or visible
|
|
898
724
|
|
|
899
|
-
:type execution_context: int | str | None
|
|
900
|
-
:type undo: bool | None
|
|
901
725
|
:param affect_visibility: Affect Visibility, In addition to toggling the editability, also affect the visibility
|
|
902
|
-
:type affect_visibility: bool | None
|
|
903
726
|
"""
|
|
904
727
|
|
|
905
728
|
def material_lock_all(
|
|
@@ -907,44 +730,28 @@ def material_lock_all(
|
|
|
907
730
|
undo: bool | None = None,
|
|
908
731
|
/,
|
|
909
732
|
) -> None:
|
|
910
|
-
"""Lock all Grease Pencil materials to prevent them from being accidentally modified
|
|
911
|
-
|
|
912
|
-
:type execution_context: int | str | None
|
|
913
|
-
:type undo: bool | None
|
|
914
|
-
"""
|
|
733
|
+
"""Lock all Grease Pencil materials to prevent them from being accidentally modified"""
|
|
915
734
|
|
|
916
735
|
def material_lock_unselected(
|
|
917
736
|
execution_context: int | str | None = None,
|
|
918
737
|
undo: bool | None = None,
|
|
919
738
|
/,
|
|
920
739
|
) -> None:
|
|
921
|
-
"""Lock any material not used in any selected stroke
|
|
922
|
-
|
|
923
|
-
:type execution_context: int | str | None
|
|
924
|
-
:type undo: bool | None
|
|
925
|
-
"""
|
|
740
|
+
"""Lock any material not used in any selected stroke"""
|
|
926
741
|
|
|
927
742
|
def material_lock_unused(
|
|
928
743
|
execution_context: int | str | None = None,
|
|
929
744
|
undo: bool | None = None,
|
|
930
745
|
/,
|
|
931
746
|
) -> None:
|
|
932
|
-
"""Lock and hide any material not used
|
|
933
|
-
|
|
934
|
-
:type execution_context: int | str | None
|
|
935
|
-
:type undo: bool | None
|
|
936
|
-
"""
|
|
747
|
+
"""Lock and hide any material not used"""
|
|
937
748
|
|
|
938
749
|
def material_reveal(
|
|
939
750
|
execution_context: int | str | None = None,
|
|
940
751
|
undo: bool | None = None,
|
|
941
752
|
/,
|
|
942
753
|
) -> None:
|
|
943
|
-
"""Unhide all hidden Grease Pencil materials
|
|
944
|
-
|
|
945
|
-
:type execution_context: int | str | None
|
|
946
|
-
:type undo: bool | None
|
|
947
|
-
"""
|
|
754
|
+
"""Unhide all hidden Grease Pencil materials"""
|
|
948
755
|
|
|
949
756
|
def material_select(
|
|
950
757
|
execution_context: int | str | None = None,
|
|
@@ -955,10 +762,7 @@ def material_select(
|
|
|
955
762
|
) -> None:
|
|
956
763
|
"""Select/Deselect all Grease Pencil strokes using current material
|
|
957
764
|
|
|
958
|
-
:type execution_context: int | str | None
|
|
959
|
-
:type undo: bool | None
|
|
960
765
|
:param deselect: Deselect, Unselect strokes
|
|
961
|
-
:type deselect: bool | None
|
|
962
766
|
"""
|
|
963
767
|
|
|
964
768
|
def material_unlock_all(
|
|
@@ -966,11 +770,7 @@ def material_unlock_all(
|
|
|
966
770
|
undo: bool | None = None,
|
|
967
771
|
/,
|
|
968
772
|
) -> None:
|
|
969
|
-
"""Unlock all Grease Pencil materials so that they can be edited
|
|
970
|
-
|
|
971
|
-
:type execution_context: int | str | None
|
|
972
|
-
:type undo: bool | None
|
|
973
|
-
"""
|
|
773
|
+
"""Unlock all Grease Pencil materials so that they can be edited"""
|
|
974
774
|
|
|
975
775
|
def move_to_layer(
|
|
976
776
|
execution_context: int | str | None = None,
|
|
@@ -982,12 +782,8 @@ def move_to_layer(
|
|
|
982
782
|
) -> None:
|
|
983
783
|
"""Move selected strokes to another layer
|
|
984
784
|
|
|
985
|
-
:type execution_context: int | str | None
|
|
986
|
-
:type undo: bool | None
|
|
987
785
|
:param target_layer_name: Name, Target Grease Pencil Layer
|
|
988
|
-
:type target_layer_name: str
|
|
989
786
|
:param add_new_layer: New Layer, Move selection to a new layer
|
|
990
|
-
:type add_new_layer: bool | None
|
|
991
787
|
"""
|
|
992
788
|
|
|
993
789
|
def outline(
|
|
@@ -1003,16 +799,10 @@ def outline(
|
|
|
1003
799
|
) -> None:
|
|
1004
800
|
"""Convert selected strokes to perimeter
|
|
1005
801
|
|
|
1006
|
-
:type execution_context: int | str | None
|
|
1007
|
-
:type undo: bool | None
|
|
1008
802
|
:param type: Projection Mode
|
|
1009
|
-
:type type: typing.Literal['VIEW','FRONT','SIDE','TOP','CURSOR','CAMERA'] | None
|
|
1010
803
|
:param radius: Radius
|
|
1011
|
-
:type radius: float | None
|
|
1012
804
|
:param offset_factor: Offset Factor
|
|
1013
|
-
:type offset_factor: float | None
|
|
1014
805
|
:param corner_subdivisions: Corner Subdivisions
|
|
1015
|
-
:type corner_subdivisions: int | None
|
|
1016
806
|
"""
|
|
1017
807
|
|
|
1018
808
|
def paintmode_toggle(
|
|
@@ -1024,10 +814,7 @@ def paintmode_toggle(
|
|
|
1024
814
|
) -> None:
|
|
1025
815
|
"""Enter/Exit paint mode for Grease Pencil strokes
|
|
1026
816
|
|
|
1027
|
-
:type execution_context: int | str | None
|
|
1028
|
-
:type undo: bool | None
|
|
1029
817
|
:param back: Return to Previous Mode, Return to previous mode
|
|
1030
|
-
:type back: bool | None
|
|
1031
818
|
"""
|
|
1032
819
|
|
|
1033
820
|
def paste(
|
|
@@ -1041,14 +828,9 @@ def paste(
|
|
|
1041
828
|
) -> None:
|
|
1042
829
|
"""Paste Grease Pencil points or strokes from the internal clipboard to the active layer
|
|
1043
830
|
|
|
1044
|
-
:type execution_context: int | str | None
|
|
1045
|
-
:type undo: bool | None
|
|
1046
831
|
:param type: Type
|
|
1047
|
-
:type type: typing.Literal['ACTIVE','LAYER'] | None
|
|
1048
832
|
:param paste_back: Paste on Back, Add pasted strokes behind all strokes
|
|
1049
|
-
:type paste_back: bool | None
|
|
1050
833
|
:param keep_world_transform: Keep World Transform, Keep the world transform of strokes from the clipboard unchanged
|
|
1051
|
-
:type keep_world_transform: bool | None
|
|
1052
834
|
"""
|
|
1053
835
|
|
|
1054
836
|
def pen(
|
|
@@ -1069,40 +851,24 @@ def pen(
|
|
|
1069
851
|
select_point: bool | None = False,
|
|
1070
852
|
move_point: bool | None = False,
|
|
1071
853
|
cycle_handle_type: bool | None = False,
|
|
1072
|
-
|
|
854
|
+
size: float | None = 0.01,
|
|
1073
855
|
) -> None:
|
|
1074
856
|
"""Construct and edit splines
|
|
1075
857
|
|
|
1076
|
-
:type execution_context: int | str | None
|
|
1077
|
-
:type undo: bool | None
|
|
1078
858
|
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
1079
|
-
:type extend: bool | None
|
|
1080
859
|
:param deselect: Deselect, Remove from selection
|
|
1081
|
-
:type deselect: bool | None
|
|
1082
860
|
:param toggle: Toggle Selection, Toggle the selection
|
|
1083
|
-
:type toggle: bool | None
|
|
1084
861
|
:param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
|
|
1085
|
-
:type deselect_all: bool | None
|
|
1086
862
|
:param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
|
|
1087
|
-
:type select_passthrough: bool | None
|
|
1088
863
|
:param extrude_point: Extrude Point, Add a point connected to the last selected point
|
|
1089
|
-
:type extrude_point: bool | None
|
|
1090
864
|
:param extrude_handle: Extrude Handle Type, Type of the extruded handle
|
|
1091
|
-
:type extrude_handle: typing.Literal['AUTO','VECTOR'] | None
|
|
1092
865
|
:param delete_point: Delete Point, Delete an existing point
|
|
1093
|
-
:type delete_point: bool | None
|
|
1094
866
|
:param insert_point: Insert Point, Insert Point into a curve segment
|
|
1095
|
-
:type insert_point: bool | None
|
|
1096
867
|
:param move_segment: Move Segment, Delete an existing point
|
|
1097
|
-
:type move_segment: bool | None
|
|
1098
868
|
:param select_point: Select Point, Select a point or its handles
|
|
1099
|
-
:type select_point: bool | None
|
|
1100
869
|
:param move_point: Move Point, Move a point or its handles
|
|
1101
|
-
:type move_point: bool | None
|
|
1102
870
|
:param cycle_handle_type: Cycle Handle Type, Cycle between all four handle types
|
|
1103
|
-
:
|
|
1104
|
-
:param radius: Radius
|
|
1105
|
-
:type radius: float | None
|
|
871
|
+
:param size: Size, Diameter of new points
|
|
1106
872
|
"""
|
|
1107
873
|
|
|
1108
874
|
def primitive_arc(
|
|
@@ -1116,12 +882,8 @@ def primitive_arc(
|
|
|
1116
882
|
) -> None:
|
|
1117
883
|
"""Create predefined Grease Pencil stroke arcs
|
|
1118
884
|
|
|
1119
|
-
:type execution_context: int | str | None
|
|
1120
|
-
:type undo: bool | None
|
|
1121
885
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1122
|
-
:type subdivision: int | None
|
|
1123
886
|
:param type: Type, Type of shape
|
|
1124
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1125
887
|
"""
|
|
1126
888
|
|
|
1127
889
|
def primitive_box(
|
|
@@ -1135,12 +897,8 @@ def primitive_box(
|
|
|
1135
897
|
) -> None:
|
|
1136
898
|
"""Create predefined Grease Pencil stroke boxes
|
|
1137
899
|
|
|
1138
|
-
:type execution_context: int | str | None
|
|
1139
|
-
:type undo: bool | None
|
|
1140
900
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1141
|
-
:type subdivision: int | None
|
|
1142
901
|
:param type: Type, Type of shape
|
|
1143
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1144
902
|
"""
|
|
1145
903
|
|
|
1146
904
|
def primitive_circle(
|
|
@@ -1154,12 +912,8 @@ def primitive_circle(
|
|
|
1154
912
|
) -> None:
|
|
1155
913
|
"""Create predefined Grease Pencil stroke circles
|
|
1156
914
|
|
|
1157
|
-
:type execution_context: int | str | None
|
|
1158
|
-
:type undo: bool | None
|
|
1159
915
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1160
|
-
:type subdivision: int | None
|
|
1161
916
|
:param type: Type, Type of shape
|
|
1162
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1163
917
|
"""
|
|
1164
918
|
|
|
1165
919
|
def primitive_curve(
|
|
@@ -1173,12 +927,8 @@ def primitive_curve(
|
|
|
1173
927
|
) -> None:
|
|
1174
928
|
"""Create predefined Grease Pencil stroke curve shapes
|
|
1175
929
|
|
|
1176
|
-
:type execution_context: int | str | None
|
|
1177
|
-
:type undo: bool | None
|
|
1178
930
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1179
|
-
:type subdivision: int | None
|
|
1180
931
|
:param type: Type, Type of shape
|
|
1181
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1182
932
|
"""
|
|
1183
933
|
|
|
1184
934
|
def primitive_line(
|
|
@@ -1192,12 +942,8 @@ def primitive_line(
|
|
|
1192
942
|
) -> None:
|
|
1193
943
|
"""Create predefined Grease Pencil stroke lines
|
|
1194
944
|
|
|
1195
|
-
:type execution_context: int | str | None
|
|
1196
|
-
:type undo: bool | None
|
|
1197
945
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1198
|
-
:type subdivision: int | None
|
|
1199
946
|
:param type: Type, Type of shape
|
|
1200
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1201
947
|
"""
|
|
1202
948
|
|
|
1203
949
|
def primitive_polyline(
|
|
@@ -1211,12 +957,8 @@ def primitive_polyline(
|
|
|
1211
957
|
) -> None:
|
|
1212
958
|
"""Create predefined Grease Pencil stroke polylines
|
|
1213
959
|
|
|
1214
|
-
:type execution_context: int | str | None
|
|
1215
|
-
:type undo: bool | None
|
|
1216
960
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1217
|
-
:type subdivision: int | None
|
|
1218
961
|
:param type: Type, Type of shape
|
|
1219
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1220
962
|
"""
|
|
1221
963
|
|
|
1222
964
|
def relative_layer_mask_add(
|
|
@@ -1228,10 +970,7 @@ def relative_layer_mask_add(
|
|
|
1228
970
|
) -> None:
|
|
1229
971
|
"""Mask active layer with layer above or below
|
|
1230
972
|
|
|
1231
|
-
:type execution_context: int | str | None
|
|
1232
|
-
:type undo: bool | None
|
|
1233
973
|
:param mode: Mode, Which relative layer (above or below) to use as a mask
|
|
1234
|
-
:type mode: typing.Literal['ABOVE','BELOW'] | None
|
|
1235
974
|
"""
|
|
1236
975
|
|
|
1237
976
|
def remove_fill_guides(
|
|
@@ -1243,10 +982,7 @@ def remove_fill_guides(
|
|
|
1243
982
|
) -> None:
|
|
1244
983
|
"""Remove all the strokes that were created from the fill tool as guides
|
|
1245
984
|
|
|
1246
|
-
:type execution_context: int | str | None
|
|
1247
|
-
:type undo: bool | None
|
|
1248
985
|
:param mode: Mode
|
|
1249
|
-
:type mode: typing.Literal['ACTIVE_FRAME','ALL_FRAMES'] | None
|
|
1250
986
|
"""
|
|
1251
987
|
|
|
1252
988
|
def reorder(
|
|
@@ -1258,10 +994,7 @@ def reorder(
|
|
|
1258
994
|
) -> None:
|
|
1259
995
|
"""Change the display order of the selected strokes
|
|
1260
996
|
|
|
1261
|
-
:type execution_context: int | str | None
|
|
1262
|
-
:type undo: bool | None
|
|
1263
997
|
:param direction: Direction
|
|
1264
|
-
:type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
|
|
1265
998
|
"""
|
|
1266
999
|
|
|
1267
1000
|
def reproject(
|
|
@@ -1276,8 +1009,6 @@ def reproject(
|
|
|
1276
1009
|
) -> None:
|
|
1277
1010
|
"""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)
|
|
1278
1011
|
|
|
1279
|
-
:type execution_context: int | str | None
|
|
1280
|
-
:type undo: bool | None
|
|
1281
1012
|
:param type: Projection Type
|
|
1282
1013
|
|
|
1283
1014
|
FRONT
|
|
@@ -1297,11 +1028,8 @@ def reproject(
|
|
|
1297
1028
|
|
|
1298
1029
|
CURSOR
|
|
1299
1030
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
1300
|
-
:type type: typing.Literal['FRONT','SIDE','TOP','VIEW','SURFACE','CURSOR'] | None
|
|
1301
1031
|
:param keep_original: Keep Original, Keep original strokes and create a copy before reprojecting
|
|
1302
|
-
:type keep_original: bool | None
|
|
1303
1032
|
:param offset: Surface Offset
|
|
1304
|
-
:type offset: float | None
|
|
1305
1033
|
"""
|
|
1306
1034
|
|
|
1307
1035
|
def reset_uvs(
|
|
@@ -1309,11 +1037,7 @@ def reset_uvs(
|
|
|
1309
1037
|
undo: bool | None = None,
|
|
1310
1038
|
/,
|
|
1311
1039
|
) -> None:
|
|
1312
|
-
"""Reset UV transformation to default values
|
|
1313
|
-
|
|
1314
|
-
:type execution_context: int | str | None
|
|
1315
|
-
:type undo: bool | None
|
|
1316
|
-
"""
|
|
1040
|
+
"""Reset UV transformation to default values"""
|
|
1317
1041
|
|
|
1318
1042
|
def sculpt_paint(
|
|
1319
1043
|
execution_context: int | str | None = None,
|
|
@@ -1322,15 +1046,13 @@ def sculpt_paint(
|
|
|
1322
1046
|
*,
|
|
1323
1047
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
1324
1048
|
| None = None,
|
|
1325
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
1049
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
1050
|
+
| None = "NORMAL",
|
|
1326
1051
|
pen_flip: bool | None = False,
|
|
1327
1052
|
) -> None:
|
|
1328
1053
|
"""Sculpt strokes in the active Grease Pencil object
|
|
1329
1054
|
|
|
1330
|
-
:type execution_context: int | str | None
|
|
1331
|
-
:type undo: bool | None
|
|
1332
1055
|
:param stroke: Stroke
|
|
1333
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
1334
1056
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
1335
1057
|
|
|
1336
1058
|
NORMAL
|
|
@@ -1344,9 +1066,10 @@ def sculpt_paint(
|
|
|
1344
1066
|
|
|
1345
1067
|
ERASE
|
|
1346
1068
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
1347
|
-
|
|
1069
|
+
|
|
1070
|
+
MASK
|
|
1071
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
1348
1072
|
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
1349
|
-
:type pen_flip: bool | None
|
|
1350
1073
|
"""
|
|
1351
1074
|
|
|
1352
1075
|
def sculptmode_toggle(
|
|
@@ -1358,10 +1081,7 @@ def sculptmode_toggle(
|
|
|
1358
1081
|
) -> None:
|
|
1359
1082
|
"""Enter/Exit sculpt mode for Grease Pencil strokes
|
|
1360
1083
|
|
|
1361
|
-
:type execution_context: int | str | None
|
|
1362
|
-
:type undo: bool | None
|
|
1363
1084
|
:param back: Return to Previous Mode, Return to previous mode
|
|
1364
|
-
:type back: bool | None
|
|
1365
1085
|
"""
|
|
1366
1086
|
|
|
1367
1087
|
def select_all(
|
|
@@ -1373,8 +1093,6 @@ def select_all(
|
|
|
1373
1093
|
) -> None:
|
|
1374
1094
|
"""(De)select all visible strokes
|
|
1375
1095
|
|
|
1376
|
-
:type execution_context: int | str | None
|
|
1377
|
-
:type undo: bool | None
|
|
1378
1096
|
:param action: Action, Selection action to execute
|
|
1379
1097
|
|
|
1380
1098
|
TOGGLE
|
|
@@ -1388,7 +1106,6 @@ def select_all(
|
|
|
1388
1106
|
|
|
1389
1107
|
INVERT
|
|
1390
1108
|
Invert -- Invert selection of all elements.
|
|
1391
|
-
:type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
|
|
1392
1109
|
"""
|
|
1393
1110
|
|
|
1394
1111
|
def select_alternate(
|
|
@@ -1400,10 +1117,7 @@ def select_alternate(
|
|
|
1400
1117
|
) -> None:
|
|
1401
1118
|
"""Select alternated points in strokes with already selected points
|
|
1402
1119
|
|
|
1403
|
-
:type execution_context: int | str | None
|
|
1404
|
-
:type undo: bool | None
|
|
1405
1120
|
:param deselect_ends: Deselect Ends, (De)select the first and last point of each stroke
|
|
1406
|
-
:type deselect_ends: bool | None
|
|
1407
1121
|
"""
|
|
1408
1122
|
|
|
1409
1123
|
def select_ends(
|
|
@@ -1416,12 +1130,8 @@ def select_ends(
|
|
|
1416
1130
|
) -> None:
|
|
1417
1131
|
"""Select end points of strokes
|
|
1418
1132
|
|
|
1419
|
-
:type execution_context: int | str | None
|
|
1420
|
-
:type undo: bool | None
|
|
1421
1133
|
:param amount_start: Amount Start, Number of points to select from the start
|
|
1422
|
-
:type amount_start: int | None
|
|
1423
1134
|
:param amount_end: Amount End, Number of points to select from the end
|
|
1424
|
-
:type amount_end: int | None
|
|
1425
1135
|
"""
|
|
1426
1136
|
|
|
1427
1137
|
def select_less(
|
|
@@ -1429,33 +1139,21 @@ def select_less(
|
|
|
1429
1139
|
undo: bool | None = None,
|
|
1430
1140
|
/,
|
|
1431
1141
|
) -> None:
|
|
1432
|
-
"""Shrink the selection by one point
|
|
1433
|
-
|
|
1434
|
-
:type execution_context: int | str | None
|
|
1435
|
-
:type undo: bool | None
|
|
1436
|
-
"""
|
|
1142
|
+
"""Shrink the selection by one point"""
|
|
1437
1143
|
|
|
1438
1144
|
def select_linked(
|
|
1439
1145
|
execution_context: int | str | None = None,
|
|
1440
1146
|
undo: bool | None = None,
|
|
1441
1147
|
/,
|
|
1442
1148
|
) -> None:
|
|
1443
|
-
"""Select all points in curves with any point selection
|
|
1444
|
-
|
|
1445
|
-
:type execution_context: int | str | None
|
|
1446
|
-
:type undo: bool | None
|
|
1447
|
-
"""
|
|
1149
|
+
"""Select all points in curves with any point selection"""
|
|
1448
1150
|
|
|
1449
1151
|
def select_more(
|
|
1450
1152
|
execution_context: int | str | None = None,
|
|
1451
1153
|
undo: bool | None = None,
|
|
1452
1154
|
/,
|
|
1453
1155
|
) -> None:
|
|
1454
|
-
"""Grow the selection by one point
|
|
1455
|
-
|
|
1456
|
-
:type execution_context: int | str | None
|
|
1457
|
-
:type undo: bool | None
|
|
1458
|
-
"""
|
|
1156
|
+
"""Grow the selection by one point"""
|
|
1459
1157
|
|
|
1460
1158
|
def select_random(
|
|
1461
1159
|
execution_context: int | str | None = None,
|
|
@@ -1468,12 +1166,8 @@ def select_random(
|
|
|
1468
1166
|
) -> None:
|
|
1469
1167
|
"""Selects random points from the current strokes selection
|
|
1470
1168
|
|
|
1471
|
-
:type execution_context: int | str | None
|
|
1472
|
-
:type undo: bool | None
|
|
1473
1169
|
:param ratio: Ratio, Portion of items to select randomly
|
|
1474
|
-
:type ratio: float | None
|
|
1475
1170
|
:param seed: Random Seed, Seed for the random number generator
|
|
1476
|
-
:type seed: int | None
|
|
1477
1171
|
:param action: Action, Selection action to execute
|
|
1478
1172
|
|
|
1479
1173
|
SELECT
|
|
@@ -1481,7 +1175,6 @@ def select_random(
|
|
|
1481
1175
|
|
|
1482
1176
|
DESELECT
|
|
1483
1177
|
Deselect -- Deselect all elements.
|
|
1484
|
-
:type action: typing.Literal['SELECT','DESELECT'] | None
|
|
1485
1178
|
"""
|
|
1486
1179
|
|
|
1487
1180
|
def select_similar(
|
|
@@ -1495,12 +1188,8 @@ def select_similar(
|
|
|
1495
1188
|
) -> None:
|
|
1496
1189
|
"""Select all strokes with similar characteristics
|
|
1497
1190
|
|
|
1498
|
-
:type execution_context: int | str | None
|
|
1499
|
-
:type undo: bool | None
|
|
1500
1191
|
:param mode: Mode
|
|
1501
|
-
:type mode: typing.Literal['LAYER','MATERIAL','VERTEX_COLOR','RADIUS','OPACITY'] | None
|
|
1502
1192
|
:param threshold: Threshold
|
|
1503
|
-
:type threshold: float | None
|
|
1504
1193
|
"""
|
|
1505
1194
|
|
|
1506
1195
|
def separate(
|
|
@@ -1512,8 +1201,6 @@ def separate(
|
|
|
1512
1201
|
) -> None:
|
|
1513
1202
|
"""Separate the selected geometry into a new Grease Pencil object
|
|
1514
1203
|
|
|
1515
|
-
:type execution_context: int | str | None
|
|
1516
|
-
:type undo: bool | None
|
|
1517
1204
|
:param mode: Mode
|
|
1518
1205
|
|
|
1519
1206
|
SELECTED
|
|
@@ -1524,7 +1211,6 @@ def separate(
|
|
|
1524
1211
|
|
|
1525
1212
|
LAYER
|
|
1526
1213
|
By Layer -- Separate by layer.
|
|
1527
|
-
:type mode: typing.Literal['SELECTED','MATERIAL','LAYER'] | None
|
|
1528
1214
|
"""
|
|
1529
1215
|
|
|
1530
1216
|
def set_active_material(
|
|
@@ -1532,10 +1218,20 @@ def set_active_material(
|
|
|
1532
1218
|
undo: bool | None = None,
|
|
1533
1219
|
/,
|
|
1534
1220
|
) -> None:
|
|
1535
|
-
"""Set the selected stroke material as the active material
|
|
1221
|
+
"""Set the selected stroke material as the active material"""
|
|
1222
|
+
|
|
1223
|
+
def set_corner_type(
|
|
1224
|
+
execution_context: int | str | None = None,
|
|
1225
|
+
undo: bool | None = None,
|
|
1226
|
+
/,
|
|
1227
|
+
*,
|
|
1228
|
+
corner_type: typing.Literal["ROUND", "FLAT", "SHARP"] | None = "SHARP",
|
|
1229
|
+
miter_angle: float | None = 0.785398,
|
|
1230
|
+
) -> None:
|
|
1231
|
+
"""Set the corner type of the selected points
|
|
1536
1232
|
|
|
1537
|
-
:
|
|
1538
|
-
:
|
|
1233
|
+
:param corner_type: Corner Type
|
|
1234
|
+
:param miter_angle: Miter Cut Angle, All corners sharper than the Miter angle will be cut flat
|
|
1539
1235
|
"""
|
|
1540
1236
|
|
|
1541
1237
|
def set_curve_resolution(
|
|
@@ -1547,10 +1243,7 @@ def set_curve_resolution(
|
|
|
1547
1243
|
) -> None:
|
|
1548
1244
|
"""Set resolution of selected curves
|
|
1549
1245
|
|
|
1550
|
-
:type execution_context: int | str | None
|
|
1551
|
-
:type undo: bool | None
|
|
1552
1246
|
:param resolution: Resolution, The resolution to use for each curve segment
|
|
1553
|
-
:type resolution: int | None
|
|
1554
1247
|
"""
|
|
1555
1248
|
|
|
1556
1249
|
def set_curve_type(
|
|
@@ -1563,12 +1256,8 @@ def set_curve_type(
|
|
|
1563
1256
|
) -> None:
|
|
1564
1257
|
"""Set type of selected curves
|
|
1565
1258
|
|
|
1566
|
-
:type execution_context: int | str | None
|
|
1567
|
-
:type undo: bool | None
|
|
1568
1259
|
:param type: Type, Curve type
|
|
1569
|
-
:type type: bpy.stub_internal.rna_enums.CurvesTypeItems | None
|
|
1570
1260
|
:param use_handles: Handles, Take handle information into account in the conversion
|
|
1571
|
-
:type use_handles: bool | None
|
|
1572
1261
|
"""
|
|
1573
1262
|
|
|
1574
1263
|
def set_handle_type(
|
|
@@ -1579,10 +1268,8 @@ def set_handle_type(
|
|
|
1579
1268
|
type: typing.Literal["AUTO", "VECTOR", "ALIGN", "FREE_ALIGN", "TOGGLE_FREE_ALIGN"]
|
|
1580
1269
|
| None = "AUTO",
|
|
1581
1270
|
) -> None:
|
|
1582
|
-
"""Set the handle type for
|
|
1271
|
+
"""Set the handle type for Bézier curves
|
|
1583
1272
|
|
|
1584
|
-
:type execution_context: int | str | None
|
|
1585
|
-
:type undo: bool | None
|
|
1586
1273
|
:param type: Type
|
|
1587
1274
|
|
|
1588
1275
|
AUTO
|
|
@@ -1599,7 +1286,6 @@ def set_handle_type(
|
|
|
1599
1286
|
|
|
1600
1287
|
TOGGLE_FREE_ALIGN
|
|
1601
1288
|
Toggle Free/Align -- Replace Free handles with Align, and all Align with Free handles.
|
|
1602
|
-
:type type: typing.Literal['AUTO','VECTOR','ALIGN','FREE_ALIGN','TOGGLE_FREE_ALIGN'] | None
|
|
1603
1289
|
"""
|
|
1604
1290
|
|
|
1605
1291
|
def set_material(
|
|
@@ -1611,10 +1297,7 @@ def set_material(
|
|
|
1611
1297
|
) -> None:
|
|
1612
1298
|
"""Set active material
|
|
1613
1299
|
|
|
1614
|
-
:type execution_context: int | str | None
|
|
1615
|
-
:type undo: bool | None
|
|
1616
1300
|
:param slot: Material Slot
|
|
1617
|
-
:type slot: str | None
|
|
1618
1301
|
"""
|
|
1619
1302
|
|
|
1620
1303
|
def set_selection_mode(
|
|
@@ -1626,10 +1309,7 @@ def set_selection_mode(
|
|
|
1626
1309
|
) -> None:
|
|
1627
1310
|
"""Change the selection mode for Grease Pencil strokes
|
|
1628
1311
|
|
|
1629
|
-
:type execution_context: int | str | None
|
|
1630
|
-
:type undo: bool | None
|
|
1631
1312
|
:param mode: Mode
|
|
1632
|
-
:type mode: bpy.stub_internal.rna_enums.GreasePencilSelectmodeItems | None
|
|
1633
1313
|
"""
|
|
1634
1314
|
|
|
1635
1315
|
def set_start_point(
|
|
@@ -1637,11 +1317,7 @@ def set_start_point(
|
|
|
1637
1317
|
undo: bool | None = None,
|
|
1638
1318
|
/,
|
|
1639
1319
|
) -> None:
|
|
1640
|
-
"""Select which point is the beginning of the curve
|
|
1641
|
-
|
|
1642
|
-
:type execution_context: int | str | None
|
|
1643
|
-
:type undo: bool | None
|
|
1644
|
-
"""
|
|
1320
|
+
"""Select which point is the beginning of the curve"""
|
|
1645
1321
|
|
|
1646
1322
|
def set_uniform_opacity(
|
|
1647
1323
|
execution_context: int | str | None = None,
|
|
@@ -1653,12 +1329,8 @@ def set_uniform_opacity(
|
|
|
1653
1329
|
) -> None:
|
|
1654
1330
|
"""Set all stroke points to same opacity
|
|
1655
1331
|
|
|
1656
|
-
:type execution_context: int | str | None
|
|
1657
|
-
:type undo: bool | None
|
|
1658
1332
|
:param opacity_stroke: Stroke Opacity
|
|
1659
|
-
:type opacity_stroke: float | None
|
|
1660
1333
|
:param opacity_fill: Fill Opacity
|
|
1661
|
-
:type opacity_fill: float | None
|
|
1662
1334
|
"""
|
|
1663
1335
|
|
|
1664
1336
|
def set_uniform_thickness(
|
|
@@ -1670,10 +1342,7 @@ def set_uniform_thickness(
|
|
|
1670
1342
|
) -> None:
|
|
1671
1343
|
"""Set all stroke points to same thickness
|
|
1672
1344
|
|
|
1673
|
-
:type execution_context: int | str | None
|
|
1674
|
-
:type undo: bool | None
|
|
1675
1345
|
:param thickness: Thickness, Thickness
|
|
1676
|
-
:type thickness: float | None
|
|
1677
1346
|
"""
|
|
1678
1347
|
|
|
1679
1348
|
def snap_cursor_to_selected(
|
|
@@ -1681,11 +1350,7 @@ def snap_cursor_to_selected(
|
|
|
1681
1350
|
undo: bool | None = None,
|
|
1682
1351
|
/,
|
|
1683
1352
|
) -> None:
|
|
1684
|
-
"""Snap cursor to center of selected points
|
|
1685
|
-
|
|
1686
|
-
:type execution_context: int | str | None
|
|
1687
|
-
:type undo: bool | None
|
|
1688
|
-
"""
|
|
1353
|
+
"""Snap cursor to center of selected points"""
|
|
1689
1354
|
|
|
1690
1355
|
def snap_to_cursor(
|
|
1691
1356
|
execution_context: int | str | None = None,
|
|
@@ -1696,10 +1361,7 @@ def snap_to_cursor(
|
|
|
1696
1361
|
) -> None:
|
|
1697
1362
|
"""Snap selected points/strokes to the cursor
|
|
1698
1363
|
|
|
1699
|
-
:type execution_context: int | str | None
|
|
1700
|
-
:type undo: bool | None
|
|
1701
1364
|
:param use_offset: With Offset, Offset the entire stroke instead of selected points only
|
|
1702
|
-
:type use_offset: bool | None
|
|
1703
1365
|
"""
|
|
1704
1366
|
|
|
1705
1367
|
def snap_to_grid(
|
|
@@ -1707,11 +1369,7 @@ def snap_to_grid(
|
|
|
1707
1369
|
undo: bool | None = None,
|
|
1708
1370
|
/,
|
|
1709
1371
|
) -> None:
|
|
1710
|
-
"""Snap selected points to the nearest grid points
|
|
1711
|
-
|
|
1712
|
-
:type execution_context: int | str | None
|
|
1713
|
-
:type undo: bool | None
|
|
1714
|
-
"""
|
|
1372
|
+
"""Snap selected points to the nearest grid points"""
|
|
1715
1373
|
|
|
1716
1374
|
def stroke_material_set(
|
|
1717
1375
|
execution_context: int | str | None = None,
|
|
@@ -1722,10 +1380,7 @@ def stroke_material_set(
|
|
|
1722
1380
|
) -> None:
|
|
1723
1381
|
"""Assign the active material slot to the selected strokes
|
|
1724
1382
|
|
|
1725
|
-
:type execution_context: int | str | None
|
|
1726
|
-
:type undo: bool | None
|
|
1727
1383
|
:param material: Material, Name of the material
|
|
1728
|
-
:type material: str
|
|
1729
1384
|
"""
|
|
1730
1385
|
|
|
1731
1386
|
def stroke_merge_by_distance(
|
|
@@ -1738,12 +1393,8 @@ def stroke_merge_by_distance(
|
|
|
1738
1393
|
) -> None:
|
|
1739
1394
|
"""Merge points by distance
|
|
1740
1395
|
|
|
1741
|
-
:type execution_context: int | str | None
|
|
1742
|
-
:type undo: bool | None
|
|
1743
1396
|
:param threshold: Threshold
|
|
1744
|
-
:type threshold: float | None
|
|
1745
1397
|
:param use_unselected: Unselected, Use whole stroke, not only selected points
|
|
1746
|
-
:type use_unselected: bool | None
|
|
1747
1398
|
"""
|
|
1748
1399
|
|
|
1749
1400
|
def stroke_reset_vertex_color(
|
|
@@ -1755,10 +1406,7 @@ def stroke_reset_vertex_color(
|
|
|
1755
1406
|
) -> None:
|
|
1756
1407
|
"""Reset vertex color for all or selected strokes
|
|
1757
1408
|
|
|
1758
|
-
:type execution_context: int | str | None
|
|
1759
|
-
:type undo: bool | None
|
|
1760
1409
|
:param mode: Mode
|
|
1761
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
1762
1410
|
"""
|
|
1763
1411
|
|
|
1764
1412
|
def stroke_simplify(
|
|
@@ -1774,16 +1422,10 @@ def stroke_simplify(
|
|
|
1774
1422
|
) -> None:
|
|
1775
1423
|
"""Simplify selected strokes
|
|
1776
1424
|
|
|
1777
|
-
:type execution_context: int | str | None
|
|
1778
|
-
:type undo: bool | None
|
|
1779
1425
|
:param factor: Factor
|
|
1780
|
-
:type factor: float | None
|
|
1781
1426
|
:param length: Length
|
|
1782
|
-
:type length: float | None
|
|
1783
1427
|
:param distance: Distance
|
|
1784
|
-
:type distance: float | None
|
|
1785
1428
|
:param steps: Steps
|
|
1786
|
-
:type steps: int | None
|
|
1787
1429
|
:param mode: Mode, Method used for simplifying stroke points
|
|
1788
1430
|
|
|
1789
1431
|
FIXED
|
|
@@ -1797,7 +1439,6 @@ def stroke_simplify(
|
|
|
1797
1439
|
|
|
1798
1440
|
MERGE
|
|
1799
1441
|
Merge -- Simplify the stroke by merging vertices closer than a given distance.
|
|
1800
|
-
:type mode: typing.Literal['FIXED','ADAPTIVE','SAMPLE','MERGE'] | None
|
|
1801
1442
|
"""
|
|
1802
1443
|
|
|
1803
1444
|
def stroke_smooth(
|
|
@@ -1815,22 +1456,13 @@ def stroke_smooth(
|
|
|
1815
1456
|
) -> None:
|
|
1816
1457
|
"""Smooth selected strokes
|
|
1817
1458
|
|
|
1818
|
-
:type execution_context: int | str | None
|
|
1819
|
-
:type undo: bool | None
|
|
1820
1459
|
:param iterations: Iterations
|
|
1821
|
-
:type iterations: int | None
|
|
1822
1460
|
:param factor: Factor
|
|
1823
|
-
:type factor: float | None
|
|
1824
1461
|
:param smooth_ends: Smooth Endpoints
|
|
1825
|
-
:type smooth_ends: bool | None
|
|
1826
1462
|
:param keep_shape: Keep Shape
|
|
1827
|
-
:type keep_shape: bool | None
|
|
1828
1463
|
:param smooth_position: Position
|
|
1829
|
-
:type smooth_position: bool | None
|
|
1830
1464
|
:param smooth_radius: Radius
|
|
1831
|
-
:type smooth_radius: bool | None
|
|
1832
1465
|
:param smooth_opacity: Opacity
|
|
1833
|
-
:type smooth_opacity: bool | None
|
|
1834
1466
|
"""
|
|
1835
1467
|
|
|
1836
1468
|
def stroke_split(
|
|
@@ -1838,11 +1470,7 @@ def stroke_split(
|
|
|
1838
1470
|
undo: bool | None = None,
|
|
1839
1471
|
/,
|
|
1840
1472
|
) -> None:
|
|
1841
|
-
"""Split selected points to a new stroke
|
|
1842
|
-
|
|
1843
|
-
:type execution_context: int | str | None
|
|
1844
|
-
:type undo: bool | None
|
|
1845
|
-
"""
|
|
1473
|
+
"""Split selected points to a new stroke"""
|
|
1846
1474
|
|
|
1847
1475
|
def stroke_subdivide(
|
|
1848
1476
|
execution_context: int | str | None = None,
|
|
@@ -1854,12 +1482,8 @@ def stroke_subdivide(
|
|
|
1854
1482
|
) -> None:
|
|
1855
1483
|
"""Subdivide between continuous selected points of the stroke adding a point half way between them
|
|
1856
1484
|
|
|
1857
|
-
:type execution_context: int | str | None
|
|
1858
|
-
:type undo: bool | None
|
|
1859
1485
|
:param number_cuts: Number of Cuts
|
|
1860
|
-
:type number_cuts: int | None
|
|
1861
1486
|
:param only_selected: Selected Points, Smooth only selected points in the stroke
|
|
1862
|
-
:type only_selected: bool | None
|
|
1863
1487
|
"""
|
|
1864
1488
|
|
|
1865
1489
|
def stroke_subdivide_smooth(
|
|
@@ -1872,12 +1496,8 @@ def stroke_subdivide_smooth(
|
|
|
1872
1496
|
) -> None:
|
|
1873
1497
|
"""Subdivide strokes and smooth them
|
|
1874
1498
|
|
|
1875
|
-
:type execution_context: int | str | None
|
|
1876
|
-
:type undo: bool | None
|
|
1877
1499
|
:param GREASE_PENCIL_OT_stroke_subdivide: Subdivide Stroke, Subdivide between continuous selected points of the stroke adding a point half way between them
|
|
1878
|
-
:type GREASE_PENCIL_OT_stroke_subdivide: typing.Any | None
|
|
1879
1500
|
:param GREASE_PENCIL_OT_stroke_smooth: Smooth Stroke, Smooth selected strokes
|
|
1880
|
-
:type GREASE_PENCIL_OT_stroke_smooth: typing.Any | None
|
|
1881
1501
|
"""
|
|
1882
1502
|
|
|
1883
1503
|
def stroke_switch_direction(
|
|
@@ -1885,11 +1505,7 @@ def stroke_switch_direction(
|
|
|
1885
1505
|
undo: bool | None = None,
|
|
1886
1506
|
/,
|
|
1887
1507
|
) -> None:
|
|
1888
|
-
"""Change direction of the points of the selected strokes
|
|
1889
|
-
|
|
1890
|
-
:type execution_context: int | str | None
|
|
1891
|
-
:type undo: bool | None
|
|
1892
|
-
"""
|
|
1508
|
+
"""Change direction of the points of the selected strokes"""
|
|
1893
1509
|
|
|
1894
1510
|
def stroke_trim(
|
|
1895
1511
|
execution_context: int | str | None = None,
|
|
@@ -1903,16 +1519,10 @@ def stroke_trim(
|
|
|
1903
1519
|
) -> None:
|
|
1904
1520
|
"""Delete stroke points in between intersecting strokes
|
|
1905
1521
|
|
|
1906
|
-
:type execution_context: int | str | None
|
|
1907
|
-
:type undo: bool | None
|
|
1908
1522
|
:param path: Path
|
|
1909
|
-
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
1910
1523
|
:param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
|
|
1911
|
-
:type use_smooth_stroke: bool | None
|
|
1912
1524
|
:param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
|
|
1913
|
-
:type smooth_stroke_factor: float | None
|
|
1914
1525
|
:param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
|
|
1915
|
-
:type smooth_stroke_radius: int | None
|
|
1916
1526
|
"""
|
|
1917
1527
|
|
|
1918
1528
|
def texture_gradient(
|
|
@@ -1929,20 +1539,12 @@ def texture_gradient(
|
|
|
1929
1539
|
) -> None:
|
|
1930
1540
|
"""Draw a line to set the fill material gradient for the selected strokes
|
|
1931
1541
|
|
|
1932
|
-
:type execution_context: int | str | None
|
|
1933
|
-
:type undo: bool | None
|
|
1934
1542
|
:param xstart: X Start
|
|
1935
|
-
:type xstart: int | None
|
|
1936
1543
|
:param xend: X End
|
|
1937
|
-
:type xend: int | None
|
|
1938
1544
|
:param ystart: Y Start
|
|
1939
|
-
:type ystart: int | None
|
|
1940
1545
|
:param yend: Y End
|
|
1941
|
-
:type yend: int | None
|
|
1942
1546
|
:param flip: Flip
|
|
1943
|
-
:type flip: bool | None
|
|
1944
1547
|
:param cursor: Cursor, Mouse cursor style to use during the modal operator
|
|
1945
|
-
:type cursor: int | None
|
|
1946
1548
|
"""
|
|
1947
1549
|
|
|
1948
1550
|
def trace_image(
|
|
@@ -1963,14 +1565,9 @@ def trace_image(
|
|
|
1963
1565
|
) -> None:
|
|
1964
1566
|
"""Extract Grease Pencil strokes from image
|
|
1965
1567
|
|
|
1966
|
-
:type execution_context: int | str | None
|
|
1967
|
-
:type undo: bool | None
|
|
1968
1568
|
:param target: Target Object, Target Grease Pencil
|
|
1969
|
-
:type target: typing.Literal['NEW','SELECTED'] | None
|
|
1970
1569
|
:param radius: Radius
|
|
1971
|
-
:type radius: float | None
|
|
1972
1570
|
:param threshold: Color Threshold, Determine the lightness threshold above which strokes are generated
|
|
1973
|
-
:type threshold: float | None
|
|
1974
1571
|
:param turnpolicy: Turn Policy, Determines how to resolve ambiguities during decomposition of bitmaps into paths
|
|
1975
1572
|
|
|
1976
1573
|
FOREGROUND
|
|
@@ -1993,7 +1590,6 @@ def trace_image(
|
|
|
1993
1590
|
|
|
1994
1591
|
RANDOM
|
|
1995
1592
|
Random -- Choose pseudo-randomly.
|
|
1996
|
-
:type turnpolicy: typing.Literal['FOREGROUND','BACKGROUND','LEFT','RIGHT','MINORITY','MAJORITY','RANDOM'] | None
|
|
1997
1593
|
:param mode: Mode, Determines if trace simple image or full sequence
|
|
1998
1594
|
|
|
1999
1595
|
SINGLE
|
|
@@ -2001,11 +1597,8 @@ def trace_image(
|
|
|
2001
1597
|
|
|
2002
1598
|
SEQUENCE
|
|
2003
1599
|
Sequence -- Trace full sequence.
|
|
2004
|
-
:type mode: typing.Literal['SINGLE','SEQUENCE'] | None
|
|
2005
1600
|
:param use_current_frame: Start At Current Frame, Trace Image starting in current image frame
|
|
2006
|
-
:type use_current_frame: bool | None
|
|
2007
1601
|
:param frame_number: Trace Frame, Used to trace only one frame of the image sequence, set to zero to trace all
|
|
2008
|
-
:type frame_number: int | None
|
|
2009
1602
|
"""
|
|
2010
1603
|
|
|
2011
1604
|
def vertex_brush_stroke(
|
|
@@ -2015,15 +1608,13 @@ def vertex_brush_stroke(
|
|
|
2015
1608
|
*,
|
|
2016
1609
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
2017
1610
|
| None = None,
|
|
2018
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
1611
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
1612
|
+
| None = "NORMAL",
|
|
2019
1613
|
pen_flip: bool | None = False,
|
|
2020
1614
|
) -> None:
|
|
2021
1615
|
"""Draw on vertex colors in the active Grease Pencil object
|
|
2022
1616
|
|
|
2023
|
-
:type execution_context: int | str | None
|
|
2024
|
-
:type undo: bool | None
|
|
2025
1617
|
:param stroke: Stroke
|
|
2026
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
2027
1618
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
2028
1619
|
|
|
2029
1620
|
NORMAL
|
|
@@ -2037,9 +1628,10 @@ def vertex_brush_stroke(
|
|
|
2037
1628
|
|
|
2038
1629
|
ERASE
|
|
2039
1630
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
2040
|
-
|
|
1631
|
+
|
|
1632
|
+
MASK
|
|
1633
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
2041
1634
|
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
2042
|
-
:type pen_flip: bool | None
|
|
2043
1635
|
"""
|
|
2044
1636
|
|
|
2045
1637
|
def vertex_color_brightness_contrast(
|
|
@@ -2053,14 +1645,9 @@ def vertex_color_brightness_contrast(
|
|
|
2053
1645
|
) -> None:
|
|
2054
1646
|
"""Adjust vertex color brightness/contrast
|
|
2055
1647
|
|
|
2056
|
-
:type execution_context: int | str | None
|
|
2057
|
-
:type undo: bool | None
|
|
2058
1648
|
:param mode: Mode
|
|
2059
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2060
1649
|
:param brightness: Brightness
|
|
2061
|
-
:type brightness: float | None
|
|
2062
1650
|
:param contrast: Contrast
|
|
2063
|
-
:type contrast: float | None
|
|
2064
1651
|
"""
|
|
2065
1652
|
|
|
2066
1653
|
def vertex_color_hsv(
|
|
@@ -2075,16 +1662,10 @@ def vertex_color_hsv(
|
|
|
2075
1662
|
) -> None:
|
|
2076
1663
|
"""Adjust vertex color HSV values
|
|
2077
1664
|
|
|
2078
|
-
:type execution_context: int | str | None
|
|
2079
|
-
:type undo: bool | None
|
|
2080
1665
|
:param mode: Mode
|
|
2081
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2082
1666
|
:param h: Hue
|
|
2083
|
-
:type h: float | None
|
|
2084
1667
|
:param s: Saturation
|
|
2085
|
-
:type s: float | None
|
|
2086
1668
|
:param v: Value
|
|
2087
|
-
:type v: float | None
|
|
2088
1669
|
"""
|
|
2089
1670
|
|
|
2090
1671
|
def vertex_color_invert(
|
|
@@ -2096,10 +1677,7 @@ def vertex_color_invert(
|
|
|
2096
1677
|
) -> None:
|
|
2097
1678
|
"""Invert RGB values
|
|
2098
1679
|
|
|
2099
|
-
:type execution_context: int | str | None
|
|
2100
|
-
:type undo: bool | None
|
|
2101
1680
|
:param mode: Mode
|
|
2102
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2103
1681
|
"""
|
|
2104
1682
|
|
|
2105
1683
|
def vertex_color_levels(
|
|
@@ -2113,14 +1691,9 @@ def vertex_color_levels(
|
|
|
2113
1691
|
) -> None:
|
|
2114
1692
|
"""Adjust levels of vertex colors
|
|
2115
1693
|
|
|
2116
|
-
:type execution_context: int | str | None
|
|
2117
|
-
:type undo: bool | None
|
|
2118
1694
|
:param mode: Mode
|
|
2119
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2120
1695
|
:param offset: Offset, Value to add to colors
|
|
2121
|
-
:type offset: float | None
|
|
2122
1696
|
:param gain: Gain, Value to multiply colors by
|
|
2123
|
-
:type gain: float | None
|
|
2124
1697
|
"""
|
|
2125
1698
|
|
|
2126
1699
|
def vertex_color_set(
|
|
@@ -2133,12 +1706,8 @@ def vertex_color_set(
|
|
|
2133
1706
|
) -> None:
|
|
2134
1707
|
"""Set active color to all selected vertex
|
|
2135
1708
|
|
|
2136
|
-
:type execution_context: int | str | None
|
|
2137
|
-
:type undo: bool | None
|
|
2138
1709
|
:param mode: Mode
|
|
2139
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2140
1710
|
:param factor: Factor, Mix Factor
|
|
2141
|
-
:type factor: float | None
|
|
2142
1711
|
"""
|
|
2143
1712
|
|
|
2144
1713
|
def vertex_group_normalize(
|
|
@@ -2146,11 +1715,7 @@ def vertex_group_normalize(
|
|
|
2146
1715
|
undo: bool | None = None,
|
|
2147
1716
|
/,
|
|
2148
1717
|
) -> None:
|
|
2149
|
-
"""Normalize weights of the active vertex group
|
|
2150
|
-
|
|
2151
|
-
:type execution_context: int | str | None
|
|
2152
|
-
:type undo: bool | None
|
|
2153
|
-
"""
|
|
1718
|
+
"""Normalize weights of the active vertex group"""
|
|
2154
1719
|
|
|
2155
1720
|
def vertex_group_normalize_all(
|
|
2156
1721
|
execution_context: int | str | None = None,
|
|
@@ -2161,10 +1726,7 @@ def vertex_group_normalize_all(
|
|
|
2161
1726
|
) -> None:
|
|
2162
1727
|
"""Normalize the weights of all vertex groups, so that for each vertex, the sum of all weights is 1.0
|
|
2163
1728
|
|
|
2164
|
-
:type execution_context: int | str | None
|
|
2165
|
-
:type undo: bool | None
|
|
2166
1729
|
:param lock_active: Lock Active, Keep the values of the active group while normalizing others
|
|
2167
|
-
:type lock_active: bool | None
|
|
2168
1730
|
"""
|
|
2169
1731
|
|
|
2170
1732
|
def vertex_group_smooth(
|
|
@@ -2177,12 +1739,8 @@ def vertex_group_smooth(
|
|
|
2177
1739
|
) -> None:
|
|
2178
1740
|
"""Smooth the weights of the active vertex group
|
|
2179
1741
|
|
|
2180
|
-
:type execution_context: int | str | None
|
|
2181
|
-
:type undo: bool | None
|
|
2182
1742
|
:param factor: Factor
|
|
2183
|
-
:type factor: float | None
|
|
2184
1743
|
:param repeat: Iterations
|
|
2185
|
-
:type repeat: int | None
|
|
2186
1744
|
"""
|
|
2187
1745
|
|
|
2188
1746
|
def vertexmode_toggle(
|
|
@@ -2194,10 +1752,7 @@ def vertexmode_toggle(
|
|
|
2194
1752
|
) -> None:
|
|
2195
1753
|
"""Enter/Exit vertex paint mode for Grease Pencil strokes
|
|
2196
1754
|
|
|
2197
|
-
:type execution_context: int | str | None
|
|
2198
|
-
:type undo: bool | None
|
|
2199
1755
|
:param back: Return to Previous Mode, Return to previous mode
|
|
2200
|
-
:type back: bool | None
|
|
2201
1756
|
"""
|
|
2202
1757
|
|
|
2203
1758
|
def weight_brush_stroke(
|
|
@@ -2207,15 +1762,13 @@ def weight_brush_stroke(
|
|
|
2207
1762
|
*,
|
|
2208
1763
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
2209
1764
|
| None = None,
|
|
2210
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
1765
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
1766
|
+
| None = "NORMAL",
|
|
2211
1767
|
pen_flip: bool | None = False,
|
|
2212
1768
|
) -> None:
|
|
2213
1769
|
"""Draw weight on stroke points in the active Grease Pencil object
|
|
2214
1770
|
|
|
2215
|
-
:type execution_context: int | str | None
|
|
2216
|
-
:type undo: bool | None
|
|
2217
1771
|
:param stroke: Stroke
|
|
2218
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
2219
1772
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
2220
1773
|
|
|
2221
1774
|
NORMAL
|
|
@@ -2229,9 +1782,10 @@ def weight_brush_stroke(
|
|
|
2229
1782
|
|
|
2230
1783
|
ERASE
|
|
2231
1784
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
2232
|
-
|
|
1785
|
+
|
|
1786
|
+
MASK
|
|
1787
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
2233
1788
|
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
2234
|
-
:type pen_flip: bool | None
|
|
2235
1789
|
"""
|
|
2236
1790
|
|
|
2237
1791
|
def weight_invert(
|
|
@@ -2239,33 +1793,21 @@ def weight_invert(
|
|
|
2239
1793
|
undo: bool | None = None,
|
|
2240
1794
|
/,
|
|
2241
1795
|
) -> None:
|
|
2242
|
-
"""Invert the weight of active vertex group
|
|
2243
|
-
|
|
2244
|
-
:type execution_context: int | str | None
|
|
2245
|
-
:type undo: bool | None
|
|
2246
|
-
"""
|
|
1796
|
+
"""Invert the weight of active vertex group"""
|
|
2247
1797
|
|
|
2248
1798
|
def weight_sample(
|
|
2249
1799
|
execution_context: int | str | None = None,
|
|
2250
1800
|
undo: bool | None = None,
|
|
2251
1801
|
/,
|
|
2252
1802
|
) -> None:
|
|
2253
|
-
"""Set the weight of the Draw tool to the weight of the vertex under the mouse cursor
|
|
2254
|
-
|
|
2255
|
-
:type execution_context: int | str | None
|
|
2256
|
-
:type undo: bool | None
|
|
2257
|
-
"""
|
|
1803
|
+
"""Set the weight of the Draw tool to the weight of the vertex under the mouse cursor"""
|
|
2258
1804
|
|
|
2259
1805
|
def weight_toggle_direction(
|
|
2260
1806
|
execution_context: int | str | None = None,
|
|
2261
1807
|
undo: bool | None = None,
|
|
2262
1808
|
/,
|
|
2263
1809
|
) -> None:
|
|
2264
|
-
"""Toggle Add/Subtract for the weight paint draw tool
|
|
2265
|
-
|
|
2266
|
-
:type execution_context: int | str | None
|
|
2267
|
-
:type undo: bool | None
|
|
2268
|
-
"""
|
|
1810
|
+
"""Toggle Add/Subtract for the weight paint draw tool"""
|
|
2269
1811
|
|
|
2270
1812
|
def weightmode_toggle(
|
|
2271
1813
|
execution_context: int | str | None = None,
|
|
@@ -2276,8 +1818,5 @@ def weightmode_toggle(
|
|
|
2276
1818
|
) -> None:
|
|
2277
1819
|
"""Enter/Exit weight paint mode for Grease Pencil strokes
|
|
2278
1820
|
|
|
2279
|
-
:type execution_context: int | str | None
|
|
2280
|
-
:type undo: bool | None
|
|
2281
1821
|
:param back: Return to Previous Mode, Return to previous mode
|
|
2282
|
-
:type back: bool | None
|
|
2283
1822
|
"""
|