fake-bpy-module 20250612__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 +3 -1
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +4 -4
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- _blendfile_header/__init__.pyi +48 -0
- _bpy_internal/__init__.pyi +4 -1
- _bpy_internal/assets/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/blender_asset_library_openapi/__init__.pyi +13 -0
- _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/extensions/wheel_manager/__init__.pyi +1 -1
- _bpy_internal/filesystem/__init__.pyi +5 -0
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/grease_pencil/stroke/__init__.pyi +2 -2
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_types/__init__.pyi +1592 -0
- {keyingsets_utils → _keyingsets_utils}/__init__.pyi +2 -0
- {rna_info → _rna_info}/__init__.pyi +4 -2
- addon_utils/__init__.pyi +0 -13
- aud/__init__.pyi +122 -145
- 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 +3 -13
- bl_operators/__init__.pyi +1 -0
- bl_operators/add_mesh_torus/__init__.pyi +2 -3
- bl_operators/anim/__init__.pyi +62 -38
- bl_operators/assets/__init__.pyi +4 -9
- bl_operators/bone_selection_sets/__init__.pyi +15 -42
- bl_operators/clip/__init__.pyi +12 -31
- bl_operators/connect_to_output/__init__.pyi +2 -3
- bl_operators/console/__init__.pyi +6 -15
- bl_operators/constraint/__init__.pyi +6 -13
- bl_operators/copy_global_transform/__init__.pyi +261 -0
- bl_operators/file/__init__.pyi +6 -11
- bl_operators/freestyle/__init__.pyi +5 -12
- bl_operators/geometry_nodes/__init__.pyi +5 -12
- bl_operators/grease_pencil/__init__.pyi +2 -3
- bl_operators/image/__init__.pyi +6 -15
- bl_operators/image_as_planes/__init__.pyi +3 -10
- bl_operators/mesh/__init__.pyi +3 -49
- bl_operators/node/__init__.pyi +294 -73
- bl_operators/object/__init__.pyi +17 -53
- bl_operators/object_align/__init__.pyi +2 -3
- bl_operators/object_quick_effects/__init__.pyi +5 -12
- bl_operators/object_randomize_transform/__init__.pyi +2 -3
- bl_operators/presets/__init__.pyi +27 -76
- bl_operators/rigidbody/__init__.pyi +4 -9
- bl_operators/screen_play_rendered_anim/__init__.pyi +2 -3
- bl_operators/sequencer/__init__.pyi +12 -27
- bl_operators/spreadsheet/__init__.pyi +2 -3
- bl_operators/userpref/__init__.pyi +26 -75
- bl_operators/uvcalc_follow_active/__init__.pyi +3 -4
- bl_operators/uvcalc_lightmap/__init__.pyi +3 -4
- bl_operators/uvcalc_transform/__init__.pyi +26 -16
- bl_operators/vertexpaint_dirt/__init__.pyi +2 -3
- bl_operators/view3d/__init__.pyi +9 -24
- bl_operators/wm/__init__.pyi +48 -139
- bl_operators/world/__init__.pyi +3 -4
- bl_ui/__init__.pyi +7 -7
- bl_ui/anim/__init__.pyi +2 -3
- bl_ui/asset_shelf/__init__.pyi +2 -3
- bl_ui/generic_ui_list/__init__.pyi +4 -19
- bl_ui/node_add_menu/__init__.pyi +263 -7
- bl_ui/node_add_menu_compositor/__init__.pyi +96 -79
- bl_ui/node_add_menu_geometry/__init__.pyi +309 -270
- bl_ui/node_add_menu_shader/__init__.pyi +49 -49
- bl_ui/node_add_menu_texture/__init__.pyi +17 -62
- bl_ui/properties_collection/__init__.pyi +9 -22
- bl_ui/properties_constraint/__init__.pyi +129 -282
- bl_ui/properties_data_armature/__init__.pyi +22 -57
- bl_ui/properties_data_bone/__init__.pyi +12 -31
- bl_ui/properties_data_camera/__init__.pyi +18 -47
- bl_ui/properties_data_curve/__init__.pyi +18 -47
- bl_ui/properties_data_curves/__init__.pyi +11 -26
- bl_ui/properties_data_empty/__init__.pyi +3 -6
- bl_ui/properties_data_grease_pencil/__init__.pyi +23 -62
- bl_ui/properties_data_lattice/__init__.pyi +7 -14
- bl_ui/properties_data_light/__init__.pyi +13 -32
- bl_ui/properties_data_lightprobe/__init__.pyi +16 -43
- bl_ui/properties_data_mesh/__init__.pyi +47 -62
- bl_ui/properties_data_metaball/__init__.pyi +9 -20
- bl_ui/properties_data_modifier/__init__.pyi +22 -28
- bl_ui/properties_data_pointcloud/__init__.pyi +8 -19
- bl_ui/properties_data_shaderfx/__init__.pyi +2 -3
- bl_ui/properties_data_speaker/__init__.pyi +9 -20
- bl_ui/properties_data_volume/__init__.pyi +12 -29
- bl_ui/properties_freestyle/__init__.pyi +27 -76
- bl_ui/properties_grease_pencil_common/__init__.pyi +10 -168
- bl_ui/properties_mask_common/__init__.pyi +8 -21
- bl_ui/properties_material/__init__.pyi +26 -86
- bl_ui/properties_material_gpencil/__init__.pyi +36 -57
- bl_ui/properties_object/__init__.pyi +59 -65
- bl_ui/properties_output/__init__.pyi +21 -60
- bl_ui/properties_paint_common/__init__.pyi +30 -22
- bl_ui/properties_particle/__init__.pyi +58 -161
- bl_ui/properties_physics_cloth/__init__.pyi +15 -42
- bl_ui/properties_physics_common/__init__.pyi +2 -3
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +23 -66
- bl_ui/properties_physics_field/__init__.pyi +11 -30
- bl_ui/properties_physics_fluid/__init__.pyi +29 -84
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +2 -3
- bl_ui/properties_physics_rigidbody/__init__.pyi +9 -24
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +14 -39
- bl_ui/properties_physics_softbody/__init__.pyi +16 -45
- bl_ui/properties_render/__init__.pyi +139 -197
- bl_ui/properties_scene/__init__.pyi +46 -50
- bl_ui/properties_strip/__init__.pyi +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +30 -83
- bl_ui/properties_view_layer/__init__.pyi +84 -39
- bl_ui/properties_workspace/__init__.pyi +6 -13
- bl_ui/properties_world/__init__.pyi +14 -35
- bl_ui/space_clip/__init__.pyi +150 -231
- bl_ui/space_console/__init__.pyi +7 -18
- bl_ui/space_dopesheet/__init__.pyi +143 -100
- bl_ui/space_filebrowser/__init__.pyi +33 -90
- bl_ui/space_graph/__init__.pyi +48 -85
- bl_ui/space_image/__init__.pyi +111 -229
- bl_ui/space_info/__init__.pyi +7 -18
- bl_ui/space_nla/__init__.pyi +44 -73
- bl_ui/space_node/__init__.pyi +161 -123
- bl_ui/space_outliner/__init__.pyi +16 -45
- bl_ui/space_properties/__init__.pyi +34 -10
- bl_ui/space_sequencer/__init__.pyi +164 -901
- bl_ui/space_spreadsheet/__init__.pyi +4 -9
- bl_ui/space_statusbar/__init__.pyi +2 -3
- bl_ui/space_text/__init__.pyi +17 -48
- bl_ui/space_time/__init__.pyi +25 -71
- bl_ui/space_toolsystem_common/__init__.pyi +2 -2
- bl_ui/space_toolsystem_toolbar/__init__.pyi +30 -7
- bl_ui/space_topbar/__init__.pyi +35 -79
- bl_ui/space_userpref/__init__.pyi +185 -321
- bl_ui/space_view3d/__init__.pyi +337 -817
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +110 -880
- bl_ui/utils/__init__.pyi +0 -17
- blend_render_info/__init__.pyi +1 -0
- blf/__init__.pyi +8 -54
- bmesh/__init__.pyi +2 -9
- bmesh/geometry/__init__.pyi +1 -4
- bmesh/ops/__init__.pyi +125 -508
- bmesh/types/__init__.pyi +318 -664
- bmesh/utils/__init__.pyi +17 -43
- bpy/__init__.pyi +1 -1
- bpy/app/__init__.pyi +93 -88
- bpy/app/handlers/__init__.pyi +19 -19
- bpy/app/icons/__init__.pyi +0 -6
- bpy/app/timers/__init__.pyi +2 -7
- bpy/app/translations/__init__.pyi +8 -23
- bpy/msgbus/__init__.pyi +4 -6
- bpy/ops/action/__init__.pyi +68 -199
- bpy/ops/anim/__init__.pyi +142 -299
- bpy/ops/armature/__init__.pyi +78 -209
- bpy/ops/asset/__init__.pyi +46 -108
- bpy/ops/boid/__init__.pyi +28 -45
- bpy/ops/brush/__init__.pyi +13 -108
- bpy/ops/buttons/__init__.pyi +16 -75
- bpy/ops/cachefile/__init__.pyi +8 -65
- bpy/ops/camera/__init__.pyi +0 -11
- bpy/ops/clip/__init__.pyi +173 -471
- bpy/ops/cloth/__init__.pyi +0 -5
- bpy/ops/collection/__init__.pyi +23 -36
- bpy/ops/console/__init__.pyi +40 -98
- bpy/ops/constraint/__init__.pyi +14 -85
- bpy/ops/curve/__init__.pyi +94 -277
- bpy/ops/curves/__init__.pyi +119 -166
- bpy/ops/cycles/__init__.pyi +4 -15
- bpy/ops/dpaint/__init__.pyi +14 -24
- bpy/ops/ed/__init__.pyi +44 -92
- bpy/ops/export_anim/__init__.pyi +2 -10
- bpy/ops/export_scene/__init__.pyi +16 -170
- bpy/ops/extensions/__init__.pyi +60 -165
- bpy/ops/file/__init__.pyi +110 -246
- bpy/ops/fluid/__init__.pyi +52 -83
- bpy/ops/font/__init__.pyi +40 -144
- bpy/ops/geometry/__init__.pyi +12 -127
- bpy/ops/gizmogroup/__init__.pyi +4 -13
- bpy/ops/gpencil/__init__.pyi +22 -54
- bpy/ops/graph/__init__.pyi +92 -343
- bpy/ops/grease_pencil/__init__.pyi +218 -550
- bpy/ops/image/__init__.pyi +85 -435
- bpy/ops/import_anim/__init__.pyi +3 -17
- bpy/ops/import_curve/__init__.pyi +2 -5
- bpy/ops/import_scene/__init__.pyi +15 -49
- bpy/ops/info/__init__.pyi +16 -39
- bpy/ops/lattice/__init__.pyi +12 -36
- bpy/ops/marker/__init__.pyi +12 -51
- bpy/ops/mask/__init__.pyi +68 -193
- bpy/ops/material/__init__.pyi +18 -18
- bpy/ops/mball/__init__.pyi +4 -31
- bpy/ops/mesh/__init__.pyi +140 -967
- bpy/ops/nla/__init__.pyi +87 -206
- bpy/ops/node/__init__.pyi +714 -744
- bpy/ops/object/__init__.pyi +461 -1341
- bpy/ops/outliner/__init__.pyi +192 -376
- bpy/ops/paint/__init__.pyi +94 -319
- bpy/ops/paintcurve/__init__.pyi +20 -40
- bpy/ops/palette/__init__.pyi +14 -30
- bpy/ops/particle/__init__.pyi +86 -184
- bpy/ops/pointcloud/__init__.pyi +12 -38
- bpy/ops/pose/__init__.pyi +108 -261
- bpy/ops/poselib/__init__.pyi +32 -67
- bpy/ops/preferences/__init__.pyi +37 -187
- bpy/ops/ptcache/__init__.pyi +22 -36
- bpy/ops/render/__init__.pyi +20 -72
- bpy/ops/rigidbody/__init__.pyi +25 -63
- bpy/ops/scene/__init__.pyi +122 -181
- bpy/ops/screen/__init__.pyi +93 -221
- bpy/ops/script/__init__.pyi +4 -13
- bpy/ops/sculpt/__init__.pyi +69 -324
- bpy/ops/sculpt_curves/__init__.pyi +10 -23
- bpy/ops/sequencer/__init__.pyi +410 -730
- bpy/ops/sound/__init__.pyi +16 -114
- bpy/ops/spreadsheet/__init__.pyi +20 -37
- bpy/ops/surface/__init__.pyi +0 -48
- bpy/ops/text/__init__.pyi +112 -250
- bpy/ops/text_editor/__init__.pyi +0 -5
- bpy/ops/texture/__init__.pyi +14 -21
- bpy/ops/transform/__init__.pyi +18 -386
- bpy/ops/ui/__init__.pyi +117 -188
- bpy/ops/uilist/__init__.pyi +0 -13
- bpy/ops/uv/__init__.pyi +238 -305
- bpy/ops/view2d/__init__.pyi +16 -76
- bpy/ops/view3d/__init__.pyi +153 -377
- bpy/ops/wm/__init__.pyi +277 -1397
- bpy/ops/workspace/__init__.pyi +32 -39
- bpy/ops/world/__init__.pyi +10 -12
- bpy/path/__init__.pyi +1 -35
- bpy/props/__init__.pyi +347 -218
- bpy/stub_internal/rna_enums/__init__.pyi +142 -108
- bpy/types/__init__.pyi +77367 -101305
- bpy/utils/__init__.pyi +11 -82
- bpy/utils/previews/__init__.pyi +2 -11
- bpy/utils/units/__init__.pyi +5 -15
- 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 +2 -11
- bpy_extras/io_utils/__init__.pyi +8 -27
- bpy_extras/keyconfig_utils/__init__.pyi +1 -1
- bpy_extras/mesh_utils/__init__.pyi +0 -12
- bpy_extras/node_shader_utils/__init__.pyi +1 -9
- bpy_extras/object_utils/__init__.pyi +1 -15
- bpy_extras/view3d_utils/__init__.pyi +0 -18
- bpy_extras/wm_utils/progress_report/__init__.pyi +1 -1
- {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/METADATA +4 -1
- fake_bpy_module-20260118.dist-info/RECORD +385 -0
- {fake_bpy_module-20250612.dist-info → fake_bpy_module-20260118.dist-info}/top_level.txt +17 -16
- freestyle/chainingiterators/__init__.pyi +5 -27
- freestyle/functions/__init__.pyi +0 -139
- freestyle/predicates/__init__.pyi +2 -53
- freestyle/shaders/__init__.pyi +15 -81
- freestyle/types/__init__.pyi +159 -799
- freestyle/utils/ContextFunctions/__init__.pyi +0 -23
- freestyle/utils/__init__.pyi +5 -11
- gpu/capabilities/__init__.pyi +0 -21
- gpu/matrix/__init__.pyi +1 -10
- gpu/platform/__init__.pyi +2 -7
- gpu/shader/__init__.pyi +26 -9
- gpu/state/__init__.pyi +60 -39
- gpu/texture/__init__.pyi +3 -5
- gpu/types/__init__.pyi +116 -184
- gpu_extras/batch/__init__.pyi +1 -5
- gpu_extras/presets/__init__.pyi +6 -8
- idprop/types/__init__.pyi +6 -6
- imbuf/__init__.pyi +3 -10
- imbuf/types/__init__.pyi +7 -21
- keyingsets_builtins/__init__.pyi +24 -67
- mathutils/__init__.pyi +241 -2207
- mathutils/bvhtree/__init__.pyi +18 -26
- mathutils/geometry/__init__.pyi +82 -132
- mathutils/interpolate/__init__.pyi +6 -5
- mathutils/kdtree/__init__.pyi +1 -11
- mathutils/noise/__init__.pyi +61 -106
- rna_prop_ui/__init__.pyi +1 -1
- bgl/__init__.pyi +0 -4256
- bpy_types/__init__.pyi +0 -30
- fake_bpy_module-20250612.dist-info/RECORD +0 -367
- {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
- {bgl → _bl_console_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +0 -0
- {bl_console_utils → _bl_i18n_utils}/py.typed +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_i18n_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_previews_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_rna_utils → _bl_text_utils}/py.typed +0 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +0 -0
- {bl_text_utils → _bl_ui_utils}/py.typed +0 -0
- {bl_ui_utils → _blendfile_header}/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
- {bpy_types → _bpy_types}/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}/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-20250612.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
|
|
@@ -63,11 +53,10 @@ def bake_grease_pencil_animation(
|
|
|
63
53
|
Top -- Reproject the strokes using the X-Y plane.
|
|
64
54
|
|
|
65
55
|
VIEW
|
|
66
|
-
View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using
|
|
56
|
+
View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using Cursor Stroke Placement.
|
|
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
|
-
|
|
103
|
-
|
|
104
|
-
|
|
89
|
+
|
|
90
|
+
MASK
|
|
91
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
92
|
+
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
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,20 +138,16 @@ 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
|
-
def copy(
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
"""
|
|
145
|
+
def copy(
|
|
146
|
+
execution_context: int | str | None = None,
|
|
147
|
+
undo: bool | None = None,
|
|
148
|
+
/,
|
|
149
|
+
) -> None:
|
|
150
|
+
"""Copy the selected Grease Pencil points or strokes to the internal clipboard"""
|
|
173
151
|
|
|
174
152
|
def cyclical_set(
|
|
175
153
|
execution_context: int | str | None = None,
|
|
@@ -181,31 +159,23 @@ def cyclical_set(
|
|
|
181
159
|
) -> None:
|
|
182
160
|
"""Close or open the selected stroke adding a segment from last to first point
|
|
183
161
|
|
|
184
|
-
:type execution_context: int | str | None
|
|
185
|
-
:type undo: bool | None
|
|
186
162
|
:param type: Type
|
|
187
|
-
:type type: typing.Literal['CLOSE','OPEN','TOGGLE'] | None
|
|
188
163
|
:param subdivide_cyclic_segment: Match Point Density, Add point in the new segment to keep the same density
|
|
189
|
-
:type subdivide_cyclic_segment: bool | None
|
|
190
164
|
"""
|
|
191
165
|
|
|
192
166
|
def delete(
|
|
193
|
-
execution_context: int | str | None = None,
|
|
167
|
+
execution_context: int | str | None = None,
|
|
168
|
+
undo: bool | None = None,
|
|
169
|
+
/,
|
|
194
170
|
) -> None:
|
|
195
|
-
"""Delete selected strokes or points
|
|
196
|
-
|
|
197
|
-
:type execution_context: int | str | None
|
|
198
|
-
:type undo: bool | None
|
|
199
|
-
"""
|
|
171
|
+
"""Delete selected strokes or points"""
|
|
200
172
|
|
|
201
173
|
def delete_breakdown(
|
|
202
|
-
execution_context: int | str | None = None,
|
|
174
|
+
execution_context: int | str | None = None,
|
|
175
|
+
undo: bool | None = None,
|
|
176
|
+
/,
|
|
203
177
|
) -> None:
|
|
204
|
-
"""Remove breakdown frames generated by interpolating between two Grease Pencil frames
|
|
205
|
-
|
|
206
|
-
:type execution_context: int | str | None
|
|
207
|
-
:type undo: bool | None
|
|
208
|
-
"""
|
|
178
|
+
"""Remove breakdown frames generated by interpolating between two Grease Pencil frames"""
|
|
209
179
|
|
|
210
180
|
def delete_frame(
|
|
211
181
|
execution_context: int | str | None = None,
|
|
@@ -216,8 +186,6 @@ def delete_frame(
|
|
|
216
186
|
) -> None:
|
|
217
187
|
"""Delete Grease Pencil Frame(s)
|
|
218
188
|
|
|
219
|
-
:type execution_context: int | str | None
|
|
220
|
-
:type undo: bool | None
|
|
221
189
|
:param type: Type, Method used for deleting Grease Pencil frames
|
|
222
190
|
|
|
223
191
|
ACTIVE_FRAME
|
|
@@ -225,7 +193,6 @@ def delete_frame(
|
|
|
225
193
|
|
|
226
194
|
ALL_FRAMES
|
|
227
195
|
All Active Frames -- Delete active frames for all layers.
|
|
228
|
-
:type type: typing.Literal['ACTIVE_FRAME','ALL_FRAMES'] | None
|
|
229
196
|
"""
|
|
230
197
|
|
|
231
198
|
def dissolve(
|
|
@@ -237,8 +204,6 @@ def dissolve(
|
|
|
237
204
|
) -> None:
|
|
238
205
|
"""Delete selected points without splitting strokes
|
|
239
206
|
|
|
240
|
-
:type execution_context: int | str | None
|
|
241
|
-
:type undo: bool | None
|
|
242
207
|
:param type: Type, Method used for dissolving stroke points
|
|
243
208
|
|
|
244
209
|
POINTS
|
|
@@ -249,17 +214,14 @@ def dissolve(
|
|
|
249
214
|
|
|
250
215
|
UNSELECT
|
|
251
216
|
Dissolve Unselect -- Dissolve all unselected points.
|
|
252
|
-
:type type: typing.Literal['POINTS','BETWEEN','UNSELECT'] | None
|
|
253
217
|
"""
|
|
254
218
|
|
|
255
219
|
def duplicate(
|
|
256
|
-
execution_context: int | str | None = None,
|
|
220
|
+
execution_context: int | str | None = None,
|
|
221
|
+
undo: bool | None = None,
|
|
222
|
+
/,
|
|
257
223
|
) -> None:
|
|
258
|
-
"""Duplicate the selected points
|
|
259
|
-
|
|
260
|
-
:type execution_context: int | str | None
|
|
261
|
-
:type undo: bool | None
|
|
262
|
-
"""
|
|
224
|
+
"""Duplicate the selected points"""
|
|
263
225
|
|
|
264
226
|
def duplicate_move(
|
|
265
227
|
execution_context: int | str | None = None,
|
|
@@ -271,12 +233,8 @@ def duplicate_move(
|
|
|
271
233
|
) -> None:
|
|
272
234
|
"""Make copies of the selected Grease Pencil strokes and move them
|
|
273
235
|
|
|
274
|
-
:type execution_context: int | str | None
|
|
275
|
-
:type undo: bool | None
|
|
276
236
|
:param GREASE_PENCIL_OT_duplicate: Duplicate, Duplicate the selected points
|
|
277
|
-
:type GREASE_PENCIL_OT_duplicate: typing.Any | None
|
|
278
237
|
:param TRANSFORM_OT_translate: Move, Move selected items
|
|
279
|
-
:type TRANSFORM_OT_translate: bpy.ops.transform.translate | None
|
|
280
238
|
"""
|
|
281
239
|
|
|
282
240
|
def erase_box(
|
|
@@ -292,18 +250,11 @@ def erase_box(
|
|
|
292
250
|
) -> None:
|
|
293
251
|
"""Erase points in the box region
|
|
294
252
|
|
|
295
|
-
:type execution_context: int | str | None
|
|
296
|
-
:type undo: bool | None
|
|
297
253
|
:param xmin: X Min
|
|
298
|
-
:type xmin: int | None
|
|
299
254
|
:param xmax: X Max
|
|
300
|
-
:type xmax: int | None
|
|
301
255
|
:param ymin: Y Min
|
|
302
|
-
:type ymin: int | None
|
|
303
256
|
:param ymax: Y Max
|
|
304
|
-
:type ymax: int | None
|
|
305
257
|
:param wait_for_input: Wait for Input
|
|
306
|
-
:type wait_for_input: bool | None
|
|
307
258
|
"""
|
|
308
259
|
|
|
309
260
|
def erase_lasso(
|
|
@@ -318,26 +269,18 @@ def erase_lasso(
|
|
|
318
269
|
) -> None:
|
|
319
270
|
"""Erase points in the lasso region
|
|
320
271
|
|
|
321
|
-
:type execution_context: int | str | None
|
|
322
|
-
:type undo: bool | None
|
|
323
272
|
:param path: Path
|
|
324
|
-
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
325
273
|
:param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
|
|
326
|
-
:type use_smooth_stroke: bool | None
|
|
327
274
|
:param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
|
|
328
|
-
:type smooth_stroke_factor: float | None
|
|
329
275
|
:param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
|
|
330
|
-
:type smooth_stroke_radius: int | None
|
|
331
276
|
"""
|
|
332
277
|
|
|
333
278
|
def extrude(
|
|
334
|
-
execution_context: int | str | None = None,
|
|
279
|
+
execution_context: int | str | None = None,
|
|
280
|
+
undo: bool | None = None,
|
|
281
|
+
/,
|
|
335
282
|
) -> None:
|
|
336
|
-
"""Extrude the selected points
|
|
337
|
-
|
|
338
|
-
:type execution_context: int | str | None
|
|
339
|
-
:type undo: bool | None
|
|
340
|
-
"""
|
|
283
|
+
"""Extrude the selected points"""
|
|
341
284
|
|
|
342
285
|
def extrude_move(
|
|
343
286
|
execution_context: int | str | None = None,
|
|
@@ -349,12 +292,8 @@ def extrude_move(
|
|
|
349
292
|
) -> None:
|
|
350
293
|
"""Extrude selected points and move them
|
|
351
294
|
|
|
352
|
-
:type execution_context: int | str | None
|
|
353
|
-
:type undo: bool | None
|
|
354
295
|
:param GREASE_PENCIL_OT_extrude: Extrude Stroke Points, Extrude the selected points
|
|
355
|
-
:type GREASE_PENCIL_OT_extrude: typing.Any | None
|
|
356
296
|
:param TRANSFORM_OT_translate: Move, Move selected items
|
|
357
|
-
:type TRANSFORM_OT_translate: bpy.ops.transform.translate | None
|
|
358
297
|
"""
|
|
359
298
|
|
|
360
299
|
def fill(
|
|
@@ -367,12 +306,8 @@ def fill(
|
|
|
367
306
|
) -> None:
|
|
368
307
|
"""Fill with color the shape formed by strokes
|
|
369
308
|
|
|
370
|
-
:type execution_context: int | str | None
|
|
371
|
-
:type undo: bool | None
|
|
372
309
|
:param invert: Invert, Find boundary of unfilled instead of filled regions
|
|
373
|
-
:type invert: bool | None
|
|
374
310
|
:param precision: Precision, Use precision movement for extension lines
|
|
375
|
-
:type precision: bool | None
|
|
376
311
|
"""
|
|
377
312
|
|
|
378
313
|
def frame_clean_duplicate(
|
|
@@ -384,10 +319,7 @@ def frame_clean_duplicate(
|
|
|
384
319
|
) -> None:
|
|
385
320
|
"""Remove any keyframe that is a duplicate of the previous one
|
|
386
321
|
|
|
387
|
-
:type execution_context: int | str | None
|
|
388
|
-
:type undo: bool | None
|
|
389
322
|
:param selected: Selected, Only delete selected keyframes
|
|
390
|
-
:type selected: bool | None
|
|
391
323
|
"""
|
|
392
324
|
|
|
393
325
|
def frame_duplicate(
|
|
@@ -399,10 +331,7 @@ def frame_duplicate(
|
|
|
399
331
|
) -> None:
|
|
400
332
|
"""Make a copy of the active Grease Pencil frame(s)
|
|
401
333
|
|
|
402
|
-
:type execution_context: int | str | None
|
|
403
|
-
:type undo: bool | None
|
|
404
334
|
:param all: Duplicate all, Duplicate active keyframes of all layer
|
|
405
|
-
:type all: bool | None
|
|
406
335
|
"""
|
|
407
336
|
|
|
408
337
|
def insert_blank_frame(
|
|
@@ -415,12 +344,8 @@ def insert_blank_frame(
|
|
|
415
344
|
) -> None:
|
|
416
345
|
"""Insert a blank frame on the current scene frame
|
|
417
346
|
|
|
418
|
-
:type execution_context: int | str | None
|
|
419
|
-
:type undo: bool | None
|
|
420
347
|
:param all_layers: All Layers, Insert a blank frame in all editable layers
|
|
421
|
-
:type all_layers: bool | None
|
|
422
348
|
:param duration: Duration
|
|
423
|
-
:type duration: int | None
|
|
424
349
|
"""
|
|
425
350
|
|
|
426
351
|
def interpolate(
|
|
@@ -438,22 +363,13 @@ def interpolate(
|
|
|
438
363
|
) -> None:
|
|
439
364
|
"""Interpolate Grease Pencil strokes between frames
|
|
440
365
|
|
|
441
|
-
:type execution_context: int | str | None
|
|
442
|
-
:type undo: bool | None
|
|
443
366
|
:param shift: Shift, Bias factor for which frame has more influence on the interpolated strokes
|
|
444
|
-
:type shift: float | None
|
|
445
367
|
:param layers: Layer, Layers included in the interpolation
|
|
446
|
-
:type layers: typing.Literal['ACTIVE','ALL'] | None
|
|
447
368
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
448
|
-
:type exclude_breakdowns: bool | None
|
|
449
369
|
:param use_selection: Use Selection, Use only selected strokes for interpolating
|
|
450
|
-
:type use_selection: bool | None
|
|
451
370
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
452
|
-
:type flip: typing.Literal['NONE','FLIP','AUTO'] | None
|
|
453
371
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
454
|
-
:type smooth_steps: int | None
|
|
455
372
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
456
|
-
:type smooth_factor: float | None
|
|
457
373
|
"""
|
|
458
374
|
|
|
459
375
|
def interpolate_sequence(
|
|
@@ -489,25 +405,16 @@ def interpolate_sequence(
|
|
|
489
405
|
amplitude: float | None = 0.15,
|
|
490
406
|
period: float | None = 0.15,
|
|
491
407
|
) -> None:
|
|
492
|
-
"""Generate
|
|
408
|
+
"""Generate in-betweens to smoothly interpolate between Grease Pencil frames
|
|
493
409
|
|
|
494
|
-
:type execution_context: int | str | None
|
|
495
|
-
:type undo: bool | None
|
|
496
410
|
:param step: Step, Number of frames between generated interpolated frames
|
|
497
|
-
:type step: int | None
|
|
498
411
|
:param layers: Layer, Layers included in the interpolation
|
|
499
|
-
:type layers: typing.Literal['ACTIVE','ALL'] | None
|
|
500
412
|
:param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
|
|
501
|
-
:type exclude_breakdowns: bool | None
|
|
502
413
|
:param use_selection: Use Selection, Use only selected strokes for interpolating
|
|
503
|
-
:type use_selection: bool | None
|
|
504
414
|
:param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
|
|
505
|
-
:type flip: typing.Literal['NONE','FLIP','AUTO'] | None
|
|
506
415
|
:param smooth_steps: Iterations, Number of times to smooth newly created strokes
|
|
507
|
-
:type smooth_steps: int | None
|
|
508
416
|
:param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
|
|
509
|
-
:type
|
|
510
|
-
:param type: Type, Interpolation method to use the next time 'Interpolate Sequence' is run
|
|
417
|
+
:param type: Type, Interpolation method to use the next time Interpolate Sequence is run
|
|
511
418
|
|
|
512
419
|
LINEAR
|
|
513
420
|
Linear -- Straight-line interpolation between A and B (i.e. no ease in/out).
|
|
@@ -544,15 +451,10 @@ def interpolate_sequence(
|
|
|
544
451
|
|
|
545
452
|
ELASTIC
|
|
546
453
|
Elastic -- Exponentially decaying sine wave, like an elastic band.
|
|
547
|
-
:type type: typing.Literal['LINEAR','CUSTOM','SINE','QUAD','CUBIC','QUART','QUINT','EXPO','CIRC','BACK','BOUNCE','ELASTIC'] | None
|
|
548
454
|
:param easing: Easing, Which ends of the segment between the preceding and following Grease Pencil frames easing interpolation is applied to
|
|
549
|
-
:
|
|
550
|
-
:param
|
|
551
|
-
:type back: float | None
|
|
552
|
-
:param amplitude: Amplitude, Amount to boost elastic bounces for 'elastic' easing
|
|
553
|
-
:type amplitude: float | None
|
|
455
|
+
:param back: Back, Amount of overshoot for back easing
|
|
456
|
+
:param amplitude: Amplitude, Amount to boost elastic bounces for elastic easing
|
|
554
457
|
:param period: Period, Time between bounces for elastic easing
|
|
555
|
-
:type period: float | None
|
|
556
458
|
"""
|
|
557
459
|
|
|
558
460
|
def join_selection(
|
|
@@ -560,20 +462,20 @@ def join_selection(
|
|
|
560
462
|
undo: bool | None = None,
|
|
561
463
|
/,
|
|
562
464
|
*,
|
|
563
|
-
type: typing.Literal["
|
|
465
|
+
type: typing.Literal["JOINSTROKES", "SPLITCOPY", "SPLIT"] | None = "JOINSTROKES",
|
|
564
466
|
) -> None:
|
|
565
467
|
"""New stroke from selected points/strokes
|
|
566
468
|
|
|
567
|
-
:type execution_context: int | str | None
|
|
568
|
-
:type undo: bool | None
|
|
569
469
|
:param type: Type, Defines how the operator will behave on the selection in the active layer
|
|
570
470
|
|
|
571
|
-
|
|
572
|
-
Join
|
|
471
|
+
JOINSTROKES
|
|
472
|
+
Join Strokes -- Join the selected strokes into one stroke.
|
|
473
|
+
|
|
474
|
+
SPLITCOPY
|
|
475
|
+
Split and Copy -- Copy the selected points to a new stroke.
|
|
573
476
|
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
:type type: typing.Literal['JOINCOPY','JOIN'] | None
|
|
477
|
+
SPLIT
|
|
478
|
+
Split -- Split the selected point to a new stroke.
|
|
577
479
|
"""
|
|
578
480
|
|
|
579
481
|
def layer_active(
|
|
@@ -585,10 +487,7 @@ def layer_active(
|
|
|
585
487
|
) -> None:
|
|
586
488
|
"""Set the active Grease Pencil layer
|
|
587
489
|
|
|
588
|
-
:type execution_context: int | str | None
|
|
589
|
-
:type undo: bool | None
|
|
590
490
|
:param layer: Grease Pencil Layer
|
|
591
|
-
:type layer: int | None
|
|
592
491
|
"""
|
|
593
492
|
|
|
594
493
|
def layer_add(
|
|
@@ -600,10 +499,7 @@ def layer_add(
|
|
|
600
499
|
) -> None:
|
|
601
500
|
"""Add a new Grease Pencil layer in the active object
|
|
602
501
|
|
|
603
|
-
:type execution_context: int | str | None
|
|
604
|
-
:type undo: bool | None
|
|
605
502
|
:param new_layer_name: Name, Name of the new layer
|
|
606
|
-
:type new_layer_name: str
|
|
607
503
|
"""
|
|
608
504
|
|
|
609
505
|
def layer_duplicate(
|
|
@@ -615,10 +511,7 @@ def layer_duplicate(
|
|
|
615
511
|
) -> None:
|
|
616
512
|
"""Make a copy of the active Grease Pencil layer
|
|
617
513
|
|
|
618
|
-
:type execution_context: int | str | None
|
|
619
|
-
:type undo: bool | None
|
|
620
514
|
:param empty_keyframes: Empty Keyframes, Add Empty Keyframes
|
|
621
|
-
:type empty_keyframes: bool | None
|
|
622
515
|
"""
|
|
623
516
|
|
|
624
517
|
def layer_duplicate_object(
|
|
@@ -631,12 +524,8 @@ def layer_duplicate_object(
|
|
|
631
524
|
) -> None:
|
|
632
525
|
"""Make a copy of the active Grease Pencil layer to selected object
|
|
633
526
|
|
|
634
|
-
:type execution_context: int | str | None
|
|
635
|
-
:type undo: bool | None
|
|
636
527
|
:param only_active: Only Active, Copy only active Layer, uncheck to append all layers
|
|
637
|
-
:type only_active: bool | None
|
|
638
528
|
:param mode: Mode
|
|
639
|
-
:type mode: typing.Literal['ALL','ACTIVE'] | None
|
|
640
529
|
"""
|
|
641
530
|
|
|
642
531
|
def layer_group_add(
|
|
@@ -648,10 +537,7 @@ def layer_group_add(
|
|
|
648
537
|
) -> None:
|
|
649
538
|
"""Add a new Grease Pencil layer group in the active object
|
|
650
539
|
|
|
651
|
-
:type execution_context: int | str | None
|
|
652
|
-
:type undo: bool | None
|
|
653
540
|
:param new_layer_group_name: Name, Name of the new layer group
|
|
654
|
-
:type new_layer_group_name: str
|
|
655
541
|
"""
|
|
656
542
|
|
|
657
543
|
def layer_group_color_tag(
|
|
@@ -674,10 +560,7 @@ def layer_group_color_tag(
|
|
|
674
560
|
) -> None:
|
|
675
561
|
"""Change layer group icon
|
|
676
562
|
|
|
677
|
-
:type execution_context: int | str | None
|
|
678
|
-
:type undo: bool | None
|
|
679
563
|
:param color_tag: Color Tag
|
|
680
|
-
:type color_tag: typing.Literal['NONE','COLOR1','COLOR2','COLOR3','COLOR4','COLOR5','COLOR6','COLOR7','COLOR8'] | None
|
|
681
564
|
"""
|
|
682
565
|
|
|
683
566
|
def layer_group_remove(
|
|
@@ -689,10 +572,7 @@ def layer_group_remove(
|
|
|
689
572
|
) -> None:
|
|
690
573
|
"""Remove Grease Pencil layer group in the active object
|
|
691
574
|
|
|
692
|
-
:type execution_context: int | str | None
|
|
693
|
-
:type undo: bool | None
|
|
694
575
|
:param keep_children: Keep children nodes, Keep the children nodes of the group and only delete the group itself
|
|
695
|
-
:type keep_children: bool | None
|
|
696
576
|
"""
|
|
697
577
|
|
|
698
578
|
def layer_hide(
|
|
@@ -704,10 +584,7 @@ def layer_hide(
|
|
|
704
584
|
) -> None:
|
|
705
585
|
"""Hide selected/unselected Grease Pencil layers
|
|
706
586
|
|
|
707
|
-
:type execution_context: int | str | None
|
|
708
|
-
:type undo: bool | None
|
|
709
587
|
:param unselected: Unselected, Hide unselected rather than selected layers
|
|
710
|
-
:type unselected: bool | None
|
|
711
588
|
"""
|
|
712
589
|
|
|
713
590
|
def layer_isolate(
|
|
@@ -719,10 +596,7 @@ def layer_isolate(
|
|
|
719
596
|
) -> None:
|
|
720
597
|
"""Make only active layer visible/editable
|
|
721
598
|
|
|
722
|
-
:type execution_context: int | str | None
|
|
723
|
-
:type undo: bool | None
|
|
724
599
|
:param affect_visibility: Affect Visibility, Also affect the visibility
|
|
725
|
-
:type affect_visibility: bool | None
|
|
726
600
|
"""
|
|
727
601
|
|
|
728
602
|
def layer_lock_all(
|
|
@@ -734,10 +608,7 @@ def layer_lock_all(
|
|
|
734
608
|
) -> None:
|
|
735
609
|
"""Lock all Grease Pencil layers to prevent them from being accidentally modified
|
|
736
610
|
|
|
737
|
-
:type execution_context: int | str | None
|
|
738
|
-
:type undo: bool | None
|
|
739
611
|
:param lock: Lock Value, Lock/Unlock all layers
|
|
740
|
-
:type lock: bool | None
|
|
741
612
|
"""
|
|
742
613
|
|
|
743
614
|
def layer_mask_add(
|
|
@@ -749,20 +620,15 @@ def layer_mask_add(
|
|
|
749
620
|
) -> None:
|
|
750
621
|
"""Add new layer as masking
|
|
751
622
|
|
|
752
|
-
:type execution_context: int | str | None
|
|
753
|
-
:type undo: bool | None
|
|
754
623
|
:param name: Layer, Name of the layer
|
|
755
|
-
:type name: str
|
|
756
624
|
"""
|
|
757
625
|
|
|
758
626
|
def layer_mask_remove(
|
|
759
|
-
execution_context: int | str | None = None,
|
|
627
|
+
execution_context: int | str | None = None,
|
|
628
|
+
undo: bool | None = None,
|
|
629
|
+
/,
|
|
760
630
|
) -> None:
|
|
761
|
-
"""Remove Layer Mask
|
|
762
|
-
|
|
763
|
-
:type execution_context: int | str | None
|
|
764
|
-
:type undo: bool | None
|
|
765
|
-
"""
|
|
631
|
+
"""Remove Layer Mask"""
|
|
766
632
|
|
|
767
633
|
def layer_mask_reorder(
|
|
768
634
|
execution_context: int | str | None = None,
|
|
@@ -773,10 +639,7 @@ def layer_mask_reorder(
|
|
|
773
639
|
) -> None:
|
|
774
640
|
"""Reorder the active Grease Pencil mask layer up/down in the list
|
|
775
641
|
|
|
776
|
-
:type execution_context: int | str | None
|
|
777
|
-
:type undo: bool | None
|
|
778
642
|
:param direction: Direction
|
|
779
|
-
:type direction: typing.Literal['UP','DOWN'] | None
|
|
780
643
|
"""
|
|
781
644
|
|
|
782
645
|
def layer_merge(
|
|
@@ -788,8 +651,6 @@ def layer_merge(
|
|
|
788
651
|
) -> None:
|
|
789
652
|
"""Combine layers based on the mode into one layer
|
|
790
653
|
|
|
791
|
-
:type execution_context: int | str | None
|
|
792
|
-
:type undo: bool | None
|
|
793
654
|
:param mode: Mode
|
|
794
655
|
|
|
795
656
|
ACTIVE
|
|
@@ -800,7 +661,6 @@ def layer_merge(
|
|
|
800
661
|
|
|
801
662
|
ALL
|
|
802
663
|
All -- Combine all layers into a single layer.
|
|
803
|
-
:type mode: typing.Literal['ACTIVE','GROUP','ALL'] | None
|
|
804
664
|
"""
|
|
805
665
|
|
|
806
666
|
def layer_move(
|
|
@@ -812,29 +672,22 @@ def layer_move(
|
|
|
812
672
|
) -> None:
|
|
813
673
|
"""Move the active Grease Pencil layer or Group
|
|
814
674
|
|
|
815
|
-
:type execution_context: int | str | None
|
|
816
|
-
:type undo: bool | None
|
|
817
675
|
:param direction: Direction
|
|
818
|
-
:type direction: typing.Literal['UP','DOWN'] | None
|
|
819
676
|
"""
|
|
820
677
|
|
|
821
678
|
def layer_remove(
|
|
822
|
-
execution_context: int | str | None = None,
|
|
679
|
+
execution_context: int | str | None = None,
|
|
680
|
+
undo: bool | None = None,
|
|
681
|
+
/,
|
|
823
682
|
) -> None:
|
|
824
|
-
"""Remove the active Grease Pencil layer
|
|
825
|
-
|
|
826
|
-
:type execution_context: int | str | None
|
|
827
|
-
:type undo: bool | None
|
|
828
|
-
"""
|
|
683
|
+
"""Remove the active Grease Pencil layer"""
|
|
829
684
|
|
|
830
685
|
def layer_reveal(
|
|
831
|
-
execution_context: int | str | None = None,
|
|
686
|
+
execution_context: int | str | None = None,
|
|
687
|
+
undo: bool | None = None,
|
|
688
|
+
/,
|
|
832
689
|
) -> None:
|
|
833
|
-
"""Show all Grease Pencil layers
|
|
834
|
-
|
|
835
|
-
:type execution_context: int | str | None
|
|
836
|
-
:type undo: bool | None
|
|
837
|
-
"""
|
|
690
|
+
"""Show all Grease Pencil layers"""
|
|
838
691
|
|
|
839
692
|
def material_copy_to_object(
|
|
840
693
|
execution_context: int | str | None = None,
|
|
@@ -845,10 +698,7 @@ def material_copy_to_object(
|
|
|
845
698
|
) -> None:
|
|
846
699
|
"""Append Materials of the active Grease Pencil to other object
|
|
847
700
|
|
|
848
|
-
:type execution_context: int | str | None
|
|
849
|
-
:type undo: bool | None
|
|
850
701
|
:param only_active: Only Active, Append only active material, uncheck to append all materials
|
|
851
|
-
:type only_active: bool | None
|
|
852
702
|
"""
|
|
853
703
|
|
|
854
704
|
def material_hide(
|
|
@@ -860,10 +710,7 @@ def material_hide(
|
|
|
860
710
|
) -> None:
|
|
861
711
|
"""Hide active/inactive Grease Pencil material(s)
|
|
862
712
|
|
|
863
|
-
:type execution_context: int | str | None
|
|
864
|
-
:type undo: bool | None
|
|
865
713
|
:param invert: Invert, Hide inactive materials instead of the active one
|
|
866
|
-
:type invert: bool | None
|
|
867
714
|
"""
|
|
868
715
|
|
|
869
716
|
def material_isolate(
|
|
@@ -875,47 +722,36 @@ def material_isolate(
|
|
|
875
722
|
) -> None:
|
|
876
723
|
"""Toggle whether the active material is the only one that is editable and/or visible
|
|
877
724
|
|
|
878
|
-
:type execution_context: int | str | None
|
|
879
|
-
:type undo: bool | None
|
|
880
725
|
:param affect_visibility: Affect Visibility, In addition to toggling the editability, also affect the visibility
|
|
881
|
-
:type affect_visibility: bool | None
|
|
882
726
|
"""
|
|
883
727
|
|
|
884
728
|
def material_lock_all(
|
|
885
|
-
execution_context: int | str | None = None,
|
|
729
|
+
execution_context: int | str | None = None,
|
|
730
|
+
undo: bool | None = None,
|
|
731
|
+
/,
|
|
886
732
|
) -> None:
|
|
887
|
-
"""Lock all Grease Pencil materials to prevent them from being accidentally modified
|
|
888
|
-
|
|
889
|
-
:type execution_context: int | str | None
|
|
890
|
-
:type undo: bool | None
|
|
891
|
-
"""
|
|
733
|
+
"""Lock all Grease Pencil materials to prevent them from being accidentally modified"""
|
|
892
734
|
|
|
893
735
|
def material_lock_unselected(
|
|
894
|
-
execution_context: int | str | None = None,
|
|
736
|
+
execution_context: int | str | None = None,
|
|
737
|
+
undo: bool | None = None,
|
|
738
|
+
/,
|
|
895
739
|
) -> None:
|
|
896
|
-
"""Lock any material not used in any selected stroke
|
|
897
|
-
|
|
898
|
-
:type execution_context: int | str | None
|
|
899
|
-
:type undo: bool | None
|
|
900
|
-
"""
|
|
740
|
+
"""Lock any material not used in any selected stroke"""
|
|
901
741
|
|
|
902
742
|
def material_lock_unused(
|
|
903
|
-
execution_context: int | str | None = None,
|
|
743
|
+
execution_context: int | str | None = None,
|
|
744
|
+
undo: bool | None = None,
|
|
745
|
+
/,
|
|
904
746
|
) -> None:
|
|
905
|
-
"""Lock and hide any material not used
|
|
906
|
-
|
|
907
|
-
:type execution_context: int | str | None
|
|
908
|
-
:type undo: bool | None
|
|
909
|
-
"""
|
|
747
|
+
"""Lock and hide any material not used"""
|
|
910
748
|
|
|
911
749
|
def material_reveal(
|
|
912
|
-
execution_context: int | str | None = None,
|
|
750
|
+
execution_context: int | str | None = None,
|
|
751
|
+
undo: bool | None = None,
|
|
752
|
+
/,
|
|
913
753
|
) -> None:
|
|
914
|
-
"""Unhide all hidden Grease Pencil materials
|
|
915
|
-
|
|
916
|
-
:type execution_context: int | str | None
|
|
917
|
-
:type undo: bool | None
|
|
918
|
-
"""
|
|
754
|
+
"""Unhide all hidden Grease Pencil materials"""
|
|
919
755
|
|
|
920
756
|
def material_select(
|
|
921
757
|
execution_context: int | str | None = None,
|
|
@@ -926,20 +762,15 @@ def material_select(
|
|
|
926
762
|
) -> None:
|
|
927
763
|
"""Select/Deselect all Grease Pencil strokes using current material
|
|
928
764
|
|
|
929
|
-
:type execution_context: int | str | None
|
|
930
|
-
:type undo: bool | None
|
|
931
765
|
:param deselect: Deselect, Unselect strokes
|
|
932
|
-
:type deselect: bool | None
|
|
933
766
|
"""
|
|
934
767
|
|
|
935
768
|
def material_unlock_all(
|
|
936
|
-
execution_context: int | str | None = None,
|
|
769
|
+
execution_context: int | str | None = None,
|
|
770
|
+
undo: bool | None = None,
|
|
771
|
+
/,
|
|
937
772
|
) -> None:
|
|
938
|
-
"""Unlock all Grease Pencil materials so that they can be edited
|
|
939
|
-
|
|
940
|
-
:type execution_context: int | str | None
|
|
941
|
-
:type undo: bool | None
|
|
942
|
-
"""
|
|
773
|
+
"""Unlock all Grease Pencil materials so that they can be edited"""
|
|
943
774
|
|
|
944
775
|
def move_to_layer(
|
|
945
776
|
execution_context: int | str | None = None,
|
|
@@ -951,12 +782,8 @@ def move_to_layer(
|
|
|
951
782
|
) -> None:
|
|
952
783
|
"""Move selected strokes to another layer
|
|
953
784
|
|
|
954
|
-
:type execution_context: int | str | None
|
|
955
|
-
:type undo: bool | None
|
|
956
785
|
:param target_layer_name: Name, Target Grease Pencil Layer
|
|
957
|
-
:type target_layer_name: str
|
|
958
786
|
:param add_new_layer: New Layer, Move selection to a new layer
|
|
959
|
-
:type add_new_layer: bool | None
|
|
960
787
|
"""
|
|
961
788
|
|
|
962
789
|
def outline(
|
|
@@ -972,16 +799,10 @@ def outline(
|
|
|
972
799
|
) -> None:
|
|
973
800
|
"""Convert selected strokes to perimeter
|
|
974
801
|
|
|
975
|
-
:type execution_context: int | str | None
|
|
976
|
-
:type undo: bool | None
|
|
977
802
|
:param type: Projection Mode
|
|
978
|
-
:type type: typing.Literal['VIEW','FRONT','SIDE','TOP','CURSOR','CAMERA'] | None
|
|
979
803
|
:param radius: Radius
|
|
980
|
-
:type radius: float | None
|
|
981
804
|
:param offset_factor: Offset Factor
|
|
982
|
-
:type offset_factor: float | None
|
|
983
805
|
:param corner_subdivisions: Corner Subdivisions
|
|
984
|
-
:type corner_subdivisions: int | None
|
|
985
806
|
"""
|
|
986
807
|
|
|
987
808
|
def paintmode_toggle(
|
|
@@ -993,10 +814,7 @@ def paintmode_toggle(
|
|
|
993
814
|
) -> None:
|
|
994
815
|
"""Enter/Exit paint mode for Grease Pencil strokes
|
|
995
816
|
|
|
996
|
-
:type execution_context: int | str | None
|
|
997
|
-
:type undo: bool | None
|
|
998
817
|
:param back: Return to Previous Mode, Return to previous mode
|
|
999
|
-
:type back: bool | None
|
|
1000
818
|
"""
|
|
1001
819
|
|
|
1002
820
|
def paste(
|
|
@@ -1010,14 +828,47 @@ def paste(
|
|
|
1010
828
|
) -> None:
|
|
1011
829
|
"""Paste Grease Pencil points or strokes from the internal clipboard to the active layer
|
|
1012
830
|
|
|
1013
|
-
:type execution_context: int | str | None
|
|
1014
|
-
:type undo: bool | None
|
|
1015
831
|
:param type: Type
|
|
1016
|
-
:type type: typing.Literal['ACTIVE','LAYER'] | None
|
|
1017
832
|
:param paste_back: Paste on Back, Add pasted strokes behind all strokes
|
|
1018
|
-
:type paste_back: bool | None
|
|
1019
833
|
:param keep_world_transform: Keep World Transform, Keep the world transform of strokes from the clipboard unchanged
|
|
1020
|
-
|
|
834
|
+
"""
|
|
835
|
+
|
|
836
|
+
def pen(
|
|
837
|
+
execution_context: int | str | None = None,
|
|
838
|
+
undo: bool | None = None,
|
|
839
|
+
/,
|
|
840
|
+
*,
|
|
841
|
+
extend: bool | None = False,
|
|
842
|
+
deselect: bool | None = False,
|
|
843
|
+
toggle: bool | None = False,
|
|
844
|
+
deselect_all: bool | None = False,
|
|
845
|
+
select_passthrough: bool | None = False,
|
|
846
|
+
extrude_point: bool | None = False,
|
|
847
|
+
extrude_handle: typing.Literal["AUTO", "VECTOR"] | None = "VECTOR",
|
|
848
|
+
delete_point: bool | None = False,
|
|
849
|
+
insert_point: bool | None = False,
|
|
850
|
+
move_segment: bool | None = False,
|
|
851
|
+
select_point: bool | None = False,
|
|
852
|
+
move_point: bool | None = False,
|
|
853
|
+
cycle_handle_type: bool | None = False,
|
|
854
|
+
size: float | None = 0.01,
|
|
855
|
+
) -> None:
|
|
856
|
+
"""Construct and edit splines
|
|
857
|
+
|
|
858
|
+
:param extend: Extend, Extend selection instead of deselecting everything first
|
|
859
|
+
:param deselect: Deselect, Remove from selection
|
|
860
|
+
:param toggle: Toggle Selection, Toggle the selection
|
|
861
|
+
:param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
|
|
862
|
+
:param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
|
|
863
|
+
:param extrude_point: Extrude Point, Add a point connected to the last selected point
|
|
864
|
+
:param extrude_handle: Extrude Handle Type, Type of the extruded handle
|
|
865
|
+
:param delete_point: Delete Point, Delete an existing point
|
|
866
|
+
:param insert_point: Insert Point, Insert Point into a curve segment
|
|
867
|
+
:param move_segment: Move Segment, Delete an existing point
|
|
868
|
+
:param select_point: Select Point, Select a point or its handles
|
|
869
|
+
:param move_point: Move Point, Move a point or its handles
|
|
870
|
+
:param cycle_handle_type: Cycle Handle Type, Cycle between all four handle types
|
|
871
|
+
:param size: Size, Diameter of new points
|
|
1021
872
|
"""
|
|
1022
873
|
|
|
1023
874
|
def primitive_arc(
|
|
@@ -1031,12 +882,8 @@ def primitive_arc(
|
|
|
1031
882
|
) -> None:
|
|
1032
883
|
"""Create predefined Grease Pencil stroke arcs
|
|
1033
884
|
|
|
1034
|
-
:type execution_context: int | str | None
|
|
1035
|
-
:type undo: bool | None
|
|
1036
885
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1037
|
-
:type subdivision: int | None
|
|
1038
886
|
:param type: Type, Type of shape
|
|
1039
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1040
887
|
"""
|
|
1041
888
|
|
|
1042
889
|
def primitive_box(
|
|
@@ -1050,12 +897,8 @@ def primitive_box(
|
|
|
1050
897
|
) -> None:
|
|
1051
898
|
"""Create predefined Grease Pencil stroke boxes
|
|
1052
899
|
|
|
1053
|
-
:type execution_context: int | str | None
|
|
1054
|
-
:type undo: bool | None
|
|
1055
900
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1056
|
-
:type subdivision: int | None
|
|
1057
901
|
:param type: Type, Type of shape
|
|
1058
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1059
902
|
"""
|
|
1060
903
|
|
|
1061
904
|
def primitive_circle(
|
|
@@ -1069,12 +912,8 @@ def primitive_circle(
|
|
|
1069
912
|
) -> None:
|
|
1070
913
|
"""Create predefined Grease Pencil stroke circles
|
|
1071
914
|
|
|
1072
|
-
:type execution_context: int | str | None
|
|
1073
|
-
:type undo: bool | None
|
|
1074
915
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1075
|
-
:type subdivision: int | None
|
|
1076
916
|
:param type: Type, Type of shape
|
|
1077
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1078
917
|
"""
|
|
1079
918
|
|
|
1080
919
|
def primitive_curve(
|
|
@@ -1088,12 +927,8 @@ def primitive_curve(
|
|
|
1088
927
|
) -> None:
|
|
1089
928
|
"""Create predefined Grease Pencil stroke curve shapes
|
|
1090
929
|
|
|
1091
|
-
:type execution_context: int | str | None
|
|
1092
|
-
:type undo: bool | None
|
|
1093
930
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1094
|
-
:type subdivision: int | None
|
|
1095
931
|
:param type: Type, Type of shape
|
|
1096
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1097
932
|
"""
|
|
1098
933
|
|
|
1099
934
|
def primitive_line(
|
|
@@ -1107,12 +942,8 @@ def primitive_line(
|
|
|
1107
942
|
) -> None:
|
|
1108
943
|
"""Create predefined Grease Pencil stroke lines
|
|
1109
944
|
|
|
1110
|
-
:type execution_context: int | str | None
|
|
1111
|
-
:type undo: bool | None
|
|
1112
945
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1113
|
-
:type subdivision: int | None
|
|
1114
946
|
:param type: Type, Type of shape
|
|
1115
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1116
947
|
"""
|
|
1117
948
|
|
|
1118
949
|
def primitive_polyline(
|
|
@@ -1126,12 +957,8 @@ def primitive_polyline(
|
|
|
1126
957
|
) -> None:
|
|
1127
958
|
"""Create predefined Grease Pencil stroke polylines
|
|
1128
959
|
|
|
1129
|
-
:type execution_context: int | str | None
|
|
1130
|
-
:type undo: bool | None
|
|
1131
960
|
:param subdivision: Subdivisions, Number of subdivisions per segment
|
|
1132
|
-
:type subdivision: int | None
|
|
1133
961
|
:param type: Type, Type of shape
|
|
1134
|
-
:type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
|
|
1135
962
|
"""
|
|
1136
963
|
|
|
1137
964
|
def relative_layer_mask_add(
|
|
@@ -1143,10 +970,7 @@ def relative_layer_mask_add(
|
|
|
1143
970
|
) -> None:
|
|
1144
971
|
"""Mask active layer with layer above or below
|
|
1145
972
|
|
|
1146
|
-
:type execution_context: int | str | None
|
|
1147
|
-
:type undo: bool | None
|
|
1148
973
|
:param mode: Mode, Which relative layer (above or below) to use as a mask
|
|
1149
|
-
:type mode: typing.Literal['ABOVE','BELOW'] | None
|
|
1150
974
|
"""
|
|
1151
975
|
|
|
1152
976
|
def remove_fill_guides(
|
|
@@ -1158,10 +982,7 @@ def remove_fill_guides(
|
|
|
1158
982
|
) -> None:
|
|
1159
983
|
"""Remove all the strokes that were created from the fill tool as guides
|
|
1160
984
|
|
|
1161
|
-
:type execution_context: int | str | None
|
|
1162
|
-
:type undo: bool | None
|
|
1163
985
|
:param mode: Mode
|
|
1164
|
-
:type mode: typing.Literal['ACTIVE_FRAME','ALL_FRAMES'] | None
|
|
1165
986
|
"""
|
|
1166
987
|
|
|
1167
988
|
def reorder(
|
|
@@ -1173,10 +994,7 @@ def reorder(
|
|
|
1173
994
|
) -> None:
|
|
1174
995
|
"""Change the display order of the selected strokes
|
|
1175
996
|
|
|
1176
|
-
:type execution_context: int | str | None
|
|
1177
|
-
:type undo: bool | None
|
|
1178
997
|
:param direction: Direction
|
|
1179
|
-
:type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
|
|
1180
998
|
"""
|
|
1181
999
|
|
|
1182
1000
|
def reproject(
|
|
@@ -1191,8 +1009,6 @@ def reproject(
|
|
|
1191
1009
|
) -> None:
|
|
1192
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)
|
|
1193
1011
|
|
|
1194
|
-
:type execution_context: int | str | None
|
|
1195
|
-
:type undo: bool | None
|
|
1196
1012
|
:param type: Projection Type
|
|
1197
1013
|
|
|
1198
1014
|
FRONT
|
|
@@ -1205,28 +1021,23 @@ def reproject(
|
|
|
1205
1021
|
Top -- Reproject the strokes using the X-Y plane.
|
|
1206
1022
|
|
|
1207
1023
|
VIEW
|
|
1208
|
-
View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using
|
|
1024
|
+
View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using Cursor Stroke Placement.
|
|
1209
1025
|
|
|
1210
1026
|
SURFACE
|
|
1211
|
-
Surface -- Reproject the strokes on to the scene geometry, as if drawn using
|
|
1027
|
+
Surface -- Reproject the strokes on to the scene geometry, as if drawn using Surface placement.
|
|
1212
1028
|
|
|
1213
1029
|
CURSOR
|
|
1214
1030
|
Cursor -- Reproject the strokes using the orientation of 3D cursor.
|
|
1215
|
-
:type type: typing.Literal['FRONT','SIDE','TOP','VIEW','SURFACE','CURSOR'] | None
|
|
1216
1031
|
:param keep_original: Keep Original, Keep original strokes and create a copy before reprojecting
|
|
1217
|
-
:type keep_original: bool | None
|
|
1218
1032
|
:param offset: Surface Offset
|
|
1219
|
-
:type offset: float | None
|
|
1220
1033
|
"""
|
|
1221
1034
|
|
|
1222
1035
|
def reset_uvs(
|
|
1223
|
-
execution_context: int | str | None = None,
|
|
1036
|
+
execution_context: int | str | None = None,
|
|
1037
|
+
undo: bool | None = None,
|
|
1038
|
+
/,
|
|
1224
1039
|
) -> None:
|
|
1225
|
-
"""Reset UV transformation to default values
|
|
1226
|
-
|
|
1227
|
-
:type execution_context: int | str | None
|
|
1228
|
-
:type undo: bool | None
|
|
1229
|
-
"""
|
|
1040
|
+
"""Reset UV transformation to default values"""
|
|
1230
1041
|
|
|
1231
1042
|
def sculpt_paint(
|
|
1232
1043
|
execution_context: int | str | None = None,
|
|
@@ -1235,15 +1046,13 @@ def sculpt_paint(
|
|
|
1235
1046
|
*,
|
|
1236
1047
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
1237
1048
|
| None = None,
|
|
1238
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
1049
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
1050
|
+
| None = "NORMAL",
|
|
1239
1051
|
pen_flip: bool | None = False,
|
|
1240
1052
|
) -> None:
|
|
1241
1053
|
"""Sculpt strokes in the active Grease Pencil object
|
|
1242
1054
|
|
|
1243
|
-
:type execution_context: int | str | None
|
|
1244
|
-
:type undo: bool | None
|
|
1245
1055
|
:param stroke: Stroke
|
|
1246
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
1247
1056
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
1248
1057
|
|
|
1249
1058
|
NORMAL
|
|
@@ -1257,9 +1066,10 @@ def sculpt_paint(
|
|
|
1257
1066
|
|
|
1258
1067
|
ERASE
|
|
1259
1068
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1069
|
+
|
|
1070
|
+
MASK
|
|
1071
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
1072
|
+
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
1263
1073
|
"""
|
|
1264
1074
|
|
|
1265
1075
|
def sculptmode_toggle(
|
|
@@ -1271,10 +1081,7 @@ def sculptmode_toggle(
|
|
|
1271
1081
|
) -> None:
|
|
1272
1082
|
"""Enter/Exit sculpt mode for Grease Pencil strokes
|
|
1273
1083
|
|
|
1274
|
-
:type execution_context: int | str | None
|
|
1275
|
-
:type undo: bool | None
|
|
1276
1084
|
:param back: Return to Previous Mode, Return to previous mode
|
|
1277
|
-
:type back: bool | None
|
|
1278
1085
|
"""
|
|
1279
1086
|
|
|
1280
1087
|
def select_all(
|
|
@@ -1286,8 +1093,6 @@ def select_all(
|
|
|
1286
1093
|
) -> None:
|
|
1287
1094
|
"""(De)select all visible strokes
|
|
1288
1095
|
|
|
1289
|
-
:type execution_context: int | str | None
|
|
1290
|
-
:type undo: bool | None
|
|
1291
1096
|
:param action: Action, Selection action to execute
|
|
1292
1097
|
|
|
1293
1098
|
TOGGLE
|
|
@@ -1301,7 +1106,6 @@ def select_all(
|
|
|
1301
1106
|
|
|
1302
1107
|
INVERT
|
|
1303
1108
|
Invert -- Invert selection of all elements.
|
|
1304
|
-
:type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
|
|
1305
1109
|
"""
|
|
1306
1110
|
|
|
1307
1111
|
def select_alternate(
|
|
@@ -1313,10 +1117,7 @@ def select_alternate(
|
|
|
1313
1117
|
) -> None:
|
|
1314
1118
|
"""Select alternated points in strokes with already selected points
|
|
1315
1119
|
|
|
1316
|
-
:type execution_context: int | str | None
|
|
1317
|
-
:type undo: bool | None
|
|
1318
1120
|
:param deselect_ends: Deselect Ends, (De)select the first and last point of each stroke
|
|
1319
|
-
:type deselect_ends: bool | None
|
|
1320
1121
|
"""
|
|
1321
1122
|
|
|
1322
1123
|
def select_ends(
|
|
@@ -1329,40 +1130,30 @@ def select_ends(
|
|
|
1329
1130
|
) -> None:
|
|
1330
1131
|
"""Select end points of strokes
|
|
1331
1132
|
|
|
1332
|
-
:type execution_context: int | str | None
|
|
1333
|
-
:type undo: bool | None
|
|
1334
1133
|
:param amount_start: Amount Start, Number of points to select from the start
|
|
1335
|
-
:type amount_start: int | None
|
|
1336
1134
|
:param amount_end: Amount End, Number of points to select from the end
|
|
1337
|
-
:type amount_end: int | None
|
|
1338
1135
|
"""
|
|
1339
1136
|
|
|
1340
1137
|
def select_less(
|
|
1341
|
-
execution_context: int | str | None = None,
|
|
1138
|
+
execution_context: int | str | None = None,
|
|
1139
|
+
undo: bool | None = None,
|
|
1140
|
+
/,
|
|
1342
1141
|
) -> None:
|
|
1343
|
-
"""Shrink the selection by one point
|
|
1344
|
-
|
|
1345
|
-
:type execution_context: int | str | None
|
|
1346
|
-
:type undo: bool | None
|
|
1347
|
-
"""
|
|
1142
|
+
"""Shrink the selection by one point"""
|
|
1348
1143
|
|
|
1349
1144
|
def select_linked(
|
|
1350
|
-
execution_context: int | str | None = None,
|
|
1145
|
+
execution_context: int | str | None = None,
|
|
1146
|
+
undo: bool | None = None,
|
|
1147
|
+
/,
|
|
1351
1148
|
) -> None:
|
|
1352
|
-
"""Select all points in curves with any point selection
|
|
1353
|
-
|
|
1354
|
-
:type execution_context: int | str | None
|
|
1355
|
-
:type undo: bool | None
|
|
1356
|
-
"""
|
|
1149
|
+
"""Select all points in curves with any point selection"""
|
|
1357
1150
|
|
|
1358
1151
|
def select_more(
|
|
1359
|
-
execution_context: int | str | None = None,
|
|
1152
|
+
execution_context: int | str | None = None,
|
|
1153
|
+
undo: bool | None = None,
|
|
1154
|
+
/,
|
|
1360
1155
|
) -> None:
|
|
1361
|
-
"""Grow the selection by one point
|
|
1362
|
-
|
|
1363
|
-
:type execution_context: int | str | None
|
|
1364
|
-
:type undo: bool | None
|
|
1365
|
-
"""
|
|
1156
|
+
"""Grow the selection by one point"""
|
|
1366
1157
|
|
|
1367
1158
|
def select_random(
|
|
1368
1159
|
execution_context: int | str | None = None,
|
|
@@ -1375,12 +1166,8 @@ def select_random(
|
|
|
1375
1166
|
) -> None:
|
|
1376
1167
|
"""Selects random points from the current strokes selection
|
|
1377
1168
|
|
|
1378
|
-
:type execution_context: int | str | None
|
|
1379
|
-
:type undo: bool | None
|
|
1380
1169
|
:param ratio: Ratio, Portion of items to select randomly
|
|
1381
|
-
:type ratio: float | None
|
|
1382
1170
|
:param seed: Random Seed, Seed for the random number generator
|
|
1383
|
-
:type seed: int | None
|
|
1384
1171
|
:param action: Action, Selection action to execute
|
|
1385
1172
|
|
|
1386
1173
|
SELECT
|
|
@@ -1388,7 +1175,6 @@ def select_random(
|
|
|
1388
1175
|
|
|
1389
1176
|
DESELECT
|
|
1390
1177
|
Deselect -- Deselect all elements.
|
|
1391
|
-
:type action: typing.Literal['SELECT','DESELECT'] | None
|
|
1392
1178
|
"""
|
|
1393
1179
|
|
|
1394
1180
|
def select_similar(
|
|
@@ -1402,12 +1188,8 @@ def select_similar(
|
|
|
1402
1188
|
) -> None:
|
|
1403
1189
|
"""Select all strokes with similar characteristics
|
|
1404
1190
|
|
|
1405
|
-
:type execution_context: int | str | None
|
|
1406
|
-
:type undo: bool | None
|
|
1407
1191
|
:param mode: Mode
|
|
1408
|
-
:type mode: typing.Literal['LAYER','MATERIAL','VERTEX_COLOR','RADIUS','OPACITY'] | None
|
|
1409
1192
|
:param threshold: Threshold
|
|
1410
|
-
:type threshold: float | None
|
|
1411
1193
|
"""
|
|
1412
1194
|
|
|
1413
1195
|
def separate(
|
|
@@ -1419,8 +1201,6 @@ def separate(
|
|
|
1419
1201
|
) -> None:
|
|
1420
1202
|
"""Separate the selected geometry into a new Grease Pencil object
|
|
1421
1203
|
|
|
1422
|
-
:type execution_context: int | str | None
|
|
1423
|
-
:type undo: bool | None
|
|
1424
1204
|
:param mode: Mode
|
|
1425
1205
|
|
|
1426
1206
|
SELECTED
|
|
@@ -1431,16 +1211,27 @@ def separate(
|
|
|
1431
1211
|
|
|
1432
1212
|
LAYER
|
|
1433
1213
|
By Layer -- Separate by layer.
|
|
1434
|
-
:type mode: typing.Literal['SELECTED','MATERIAL','LAYER'] | None
|
|
1435
1214
|
"""
|
|
1436
1215
|
|
|
1437
1216
|
def set_active_material(
|
|
1438
|
-
execution_context: int | str | None = None,
|
|
1217
|
+
execution_context: int | str | None = None,
|
|
1218
|
+
undo: bool | None = None,
|
|
1219
|
+
/,
|
|
1220
|
+
) -> None:
|
|
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,
|
|
1439
1230
|
) -> None:
|
|
1440
|
-
"""Set the
|
|
1231
|
+
"""Set the corner type of the selected points
|
|
1441
1232
|
|
|
1442
|
-
:
|
|
1443
|
-
:
|
|
1233
|
+
:param corner_type: Corner Type
|
|
1234
|
+
:param miter_angle: Miter Cut Angle, All corners sharper than the Miter angle will be cut flat
|
|
1444
1235
|
"""
|
|
1445
1236
|
|
|
1446
1237
|
def set_curve_resolution(
|
|
@@ -1452,10 +1243,7 @@ def set_curve_resolution(
|
|
|
1452
1243
|
) -> None:
|
|
1453
1244
|
"""Set resolution of selected curves
|
|
1454
1245
|
|
|
1455
|
-
:type execution_context: int | str | None
|
|
1456
|
-
:type undo: bool | None
|
|
1457
1246
|
:param resolution: Resolution, The resolution to use for each curve segment
|
|
1458
|
-
:type resolution: int | None
|
|
1459
1247
|
"""
|
|
1460
1248
|
|
|
1461
1249
|
def set_curve_type(
|
|
@@ -1468,12 +1256,8 @@ def set_curve_type(
|
|
|
1468
1256
|
) -> None:
|
|
1469
1257
|
"""Set type of selected curves
|
|
1470
1258
|
|
|
1471
|
-
:type execution_context: int | str | None
|
|
1472
|
-
:type undo: bool | None
|
|
1473
1259
|
:param type: Type, Curve type
|
|
1474
|
-
:type type: bpy.stub_internal.rna_enums.CurvesTypeItems | None
|
|
1475
1260
|
:param use_handles: Handles, Take handle information into account in the conversion
|
|
1476
|
-
:type use_handles: bool | None
|
|
1477
1261
|
"""
|
|
1478
1262
|
|
|
1479
1263
|
def set_handle_type(
|
|
@@ -1481,14 +1265,27 @@ def set_handle_type(
|
|
|
1481
1265
|
undo: bool | None = None,
|
|
1482
1266
|
/,
|
|
1483
1267
|
*,
|
|
1484
|
-
type:
|
|
1268
|
+
type: typing.Literal["AUTO", "VECTOR", "ALIGN", "FREE_ALIGN", "TOGGLE_FREE_ALIGN"]
|
|
1269
|
+
| None = "AUTO",
|
|
1485
1270
|
) -> None:
|
|
1486
|
-
"""Set the handle type for
|
|
1271
|
+
"""Set the handle type for Bézier curves
|
|
1487
1272
|
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1273
|
+
:param type: Type
|
|
1274
|
+
|
|
1275
|
+
AUTO
|
|
1276
|
+
Auto -- The location is automatically calculated to be smooth.
|
|
1277
|
+
|
|
1278
|
+
VECTOR
|
|
1279
|
+
Vector -- The location is calculated to point to the next/previous control point.
|
|
1280
|
+
|
|
1281
|
+
ALIGN
|
|
1282
|
+
Align -- The location is constrained to point in the opposite direction as the other handle.
|
|
1283
|
+
|
|
1284
|
+
FREE_ALIGN
|
|
1285
|
+
Free -- The handle can be moved anywhere, and does not influence the points other handle.
|
|
1286
|
+
|
|
1287
|
+
TOGGLE_FREE_ALIGN
|
|
1288
|
+
Toggle Free/Align -- Replace Free handles with Align, and all Align with Free handles.
|
|
1492
1289
|
"""
|
|
1493
1290
|
|
|
1494
1291
|
def set_material(
|
|
@@ -1500,10 +1297,7 @@ def set_material(
|
|
|
1500
1297
|
) -> None:
|
|
1501
1298
|
"""Set active material
|
|
1502
1299
|
|
|
1503
|
-
:type execution_context: int | str | None
|
|
1504
|
-
:type undo: bool | None
|
|
1505
1300
|
:param slot: Material Slot
|
|
1506
|
-
:type slot: str | None
|
|
1507
1301
|
"""
|
|
1508
1302
|
|
|
1509
1303
|
def set_selection_mode(
|
|
@@ -1515,20 +1309,15 @@ def set_selection_mode(
|
|
|
1515
1309
|
) -> None:
|
|
1516
1310
|
"""Change the selection mode for Grease Pencil strokes
|
|
1517
1311
|
|
|
1518
|
-
:type execution_context: int | str | None
|
|
1519
|
-
:type undo: bool | None
|
|
1520
1312
|
:param mode: Mode
|
|
1521
|
-
:type mode: bpy.stub_internal.rna_enums.GreasePencilSelectmodeItems | None
|
|
1522
1313
|
"""
|
|
1523
1314
|
|
|
1524
1315
|
def set_start_point(
|
|
1525
|
-
execution_context: int | str | None = None,
|
|
1316
|
+
execution_context: int | str | None = None,
|
|
1317
|
+
undo: bool | None = None,
|
|
1318
|
+
/,
|
|
1526
1319
|
) -> None:
|
|
1527
|
-
"""Select which point is the beginning of the curve
|
|
1528
|
-
|
|
1529
|
-
:type execution_context: int | str | None
|
|
1530
|
-
:type undo: bool | None
|
|
1531
|
-
"""
|
|
1320
|
+
"""Select which point is the beginning of the curve"""
|
|
1532
1321
|
|
|
1533
1322
|
def set_uniform_opacity(
|
|
1534
1323
|
execution_context: int | str | None = None,
|
|
@@ -1540,12 +1329,8 @@ def set_uniform_opacity(
|
|
|
1540
1329
|
) -> None:
|
|
1541
1330
|
"""Set all stroke points to same opacity
|
|
1542
1331
|
|
|
1543
|
-
:type execution_context: int | str | None
|
|
1544
|
-
:type undo: bool | None
|
|
1545
1332
|
:param opacity_stroke: Stroke Opacity
|
|
1546
|
-
:type opacity_stroke: float | None
|
|
1547
1333
|
:param opacity_fill: Fill Opacity
|
|
1548
|
-
:type opacity_fill: float | None
|
|
1549
1334
|
"""
|
|
1550
1335
|
|
|
1551
1336
|
def set_uniform_thickness(
|
|
@@ -1557,20 +1342,15 @@ def set_uniform_thickness(
|
|
|
1557
1342
|
) -> None:
|
|
1558
1343
|
"""Set all stroke points to same thickness
|
|
1559
1344
|
|
|
1560
|
-
:type execution_context: int | str | None
|
|
1561
|
-
:type undo: bool | None
|
|
1562
1345
|
:param thickness: Thickness, Thickness
|
|
1563
|
-
:type thickness: float | None
|
|
1564
1346
|
"""
|
|
1565
1347
|
|
|
1566
1348
|
def snap_cursor_to_selected(
|
|
1567
|
-
execution_context: int | str | None = None,
|
|
1349
|
+
execution_context: int | str | None = None,
|
|
1350
|
+
undo: bool | None = None,
|
|
1351
|
+
/,
|
|
1568
1352
|
) -> None:
|
|
1569
|
-
"""Snap cursor to center of selected points
|
|
1570
|
-
|
|
1571
|
-
:type execution_context: int | str | None
|
|
1572
|
-
:type undo: bool | None
|
|
1573
|
-
"""
|
|
1353
|
+
"""Snap cursor to center of selected points"""
|
|
1574
1354
|
|
|
1575
1355
|
def snap_to_cursor(
|
|
1576
1356
|
execution_context: int | str | None = None,
|
|
@@ -1581,20 +1361,15 @@ def snap_to_cursor(
|
|
|
1581
1361
|
) -> None:
|
|
1582
1362
|
"""Snap selected points/strokes to the cursor
|
|
1583
1363
|
|
|
1584
|
-
:type execution_context: int | str | None
|
|
1585
|
-
:type undo: bool | None
|
|
1586
1364
|
:param use_offset: With Offset, Offset the entire stroke instead of selected points only
|
|
1587
|
-
:type use_offset: bool | None
|
|
1588
1365
|
"""
|
|
1589
1366
|
|
|
1590
1367
|
def snap_to_grid(
|
|
1591
|
-
execution_context: int | str | None = None,
|
|
1368
|
+
execution_context: int | str | None = None,
|
|
1369
|
+
undo: bool | None = None,
|
|
1370
|
+
/,
|
|
1592
1371
|
) -> None:
|
|
1593
|
-
"""Snap selected points to the nearest grid points
|
|
1594
|
-
|
|
1595
|
-
:type execution_context: int | str | None
|
|
1596
|
-
:type undo: bool | None
|
|
1597
|
-
"""
|
|
1372
|
+
"""Snap selected points to the nearest grid points"""
|
|
1598
1373
|
|
|
1599
1374
|
def stroke_material_set(
|
|
1600
1375
|
execution_context: int | str | None = None,
|
|
@@ -1605,10 +1380,7 @@ def stroke_material_set(
|
|
|
1605
1380
|
) -> None:
|
|
1606
1381
|
"""Assign the active material slot to the selected strokes
|
|
1607
1382
|
|
|
1608
|
-
:type execution_context: int | str | None
|
|
1609
|
-
:type undo: bool | None
|
|
1610
1383
|
:param material: Material, Name of the material
|
|
1611
|
-
:type material: str
|
|
1612
1384
|
"""
|
|
1613
1385
|
|
|
1614
1386
|
def stroke_merge_by_distance(
|
|
@@ -1621,12 +1393,8 @@ def stroke_merge_by_distance(
|
|
|
1621
1393
|
) -> None:
|
|
1622
1394
|
"""Merge points by distance
|
|
1623
1395
|
|
|
1624
|
-
:type execution_context: int | str | None
|
|
1625
|
-
:type undo: bool | None
|
|
1626
1396
|
:param threshold: Threshold
|
|
1627
|
-
:type threshold: float | None
|
|
1628
1397
|
:param use_unselected: Unselected, Use whole stroke, not only selected points
|
|
1629
|
-
:type use_unselected: bool | None
|
|
1630
1398
|
"""
|
|
1631
1399
|
|
|
1632
1400
|
def stroke_reset_vertex_color(
|
|
@@ -1638,10 +1406,7 @@ def stroke_reset_vertex_color(
|
|
|
1638
1406
|
) -> None:
|
|
1639
1407
|
"""Reset vertex color for all or selected strokes
|
|
1640
1408
|
|
|
1641
|
-
:type execution_context: int | str | None
|
|
1642
|
-
:type undo: bool | None
|
|
1643
1409
|
:param mode: Mode
|
|
1644
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
1645
1410
|
"""
|
|
1646
1411
|
|
|
1647
1412
|
def stroke_simplify(
|
|
@@ -1657,16 +1422,10 @@ def stroke_simplify(
|
|
|
1657
1422
|
) -> None:
|
|
1658
1423
|
"""Simplify selected strokes
|
|
1659
1424
|
|
|
1660
|
-
:type execution_context: int | str | None
|
|
1661
|
-
:type undo: bool | None
|
|
1662
1425
|
:param factor: Factor
|
|
1663
|
-
:type factor: float | None
|
|
1664
1426
|
:param length: Length
|
|
1665
|
-
:type length: float | None
|
|
1666
1427
|
:param distance: Distance
|
|
1667
|
-
:type distance: float | None
|
|
1668
1428
|
:param steps: Steps
|
|
1669
|
-
:type steps: int | None
|
|
1670
1429
|
:param mode: Mode, Method used for simplifying stroke points
|
|
1671
1430
|
|
|
1672
1431
|
FIXED
|
|
@@ -1680,7 +1439,6 @@ def stroke_simplify(
|
|
|
1680
1439
|
|
|
1681
1440
|
MERGE
|
|
1682
1441
|
Merge -- Simplify the stroke by merging vertices closer than a given distance.
|
|
1683
|
-
:type mode: typing.Literal['FIXED','ADAPTIVE','SAMPLE','MERGE'] | None
|
|
1684
1442
|
"""
|
|
1685
1443
|
|
|
1686
1444
|
def stroke_smooth(
|
|
@@ -1698,32 +1456,21 @@ def stroke_smooth(
|
|
|
1698
1456
|
) -> None:
|
|
1699
1457
|
"""Smooth selected strokes
|
|
1700
1458
|
|
|
1701
|
-
:type execution_context: int | str | None
|
|
1702
|
-
:type undo: bool | None
|
|
1703
1459
|
:param iterations: Iterations
|
|
1704
|
-
:type iterations: int | None
|
|
1705
1460
|
:param factor: Factor
|
|
1706
|
-
:type factor: float | None
|
|
1707
1461
|
:param smooth_ends: Smooth Endpoints
|
|
1708
|
-
:type smooth_ends: bool | None
|
|
1709
1462
|
:param keep_shape: Keep Shape
|
|
1710
|
-
:type keep_shape: bool | None
|
|
1711
1463
|
:param smooth_position: Position
|
|
1712
|
-
:type smooth_position: bool | None
|
|
1713
1464
|
:param smooth_radius: Radius
|
|
1714
|
-
:type smooth_radius: bool | None
|
|
1715
1465
|
:param smooth_opacity: Opacity
|
|
1716
|
-
:type smooth_opacity: bool | None
|
|
1717
1466
|
"""
|
|
1718
1467
|
|
|
1719
1468
|
def stroke_split(
|
|
1720
|
-
execution_context: int | str | None = None,
|
|
1469
|
+
execution_context: int | str | None = None,
|
|
1470
|
+
undo: bool | None = None,
|
|
1471
|
+
/,
|
|
1721
1472
|
) -> None:
|
|
1722
|
-
"""Split selected points to a new stroke
|
|
1723
|
-
|
|
1724
|
-
:type execution_context: int | str | None
|
|
1725
|
-
:type undo: bool | None
|
|
1726
|
-
"""
|
|
1473
|
+
"""Split selected points to a new stroke"""
|
|
1727
1474
|
|
|
1728
1475
|
def stroke_subdivide(
|
|
1729
1476
|
execution_context: int | str | None = None,
|
|
@@ -1735,12 +1482,8 @@ def stroke_subdivide(
|
|
|
1735
1482
|
) -> None:
|
|
1736
1483
|
"""Subdivide between continuous selected points of the stroke adding a point half way between them
|
|
1737
1484
|
|
|
1738
|
-
:type execution_context: int | str | None
|
|
1739
|
-
:type undo: bool | None
|
|
1740
1485
|
:param number_cuts: Number of Cuts
|
|
1741
|
-
:type number_cuts: int | None
|
|
1742
1486
|
:param only_selected: Selected Points, Smooth only selected points in the stroke
|
|
1743
|
-
:type only_selected: bool | None
|
|
1744
1487
|
"""
|
|
1745
1488
|
|
|
1746
1489
|
def stroke_subdivide_smooth(
|
|
@@ -1753,22 +1496,16 @@ def stroke_subdivide_smooth(
|
|
|
1753
1496
|
) -> None:
|
|
1754
1497
|
"""Subdivide strokes and smooth them
|
|
1755
1498
|
|
|
1756
|
-
:type execution_context: int | str | None
|
|
1757
|
-
:type undo: bool | None
|
|
1758
1499
|
:param GREASE_PENCIL_OT_stroke_subdivide: Subdivide Stroke, Subdivide between continuous selected points of the stroke adding a point half way between them
|
|
1759
|
-
:type GREASE_PENCIL_OT_stroke_subdivide: typing.Any | None
|
|
1760
1500
|
:param GREASE_PENCIL_OT_stroke_smooth: Smooth Stroke, Smooth selected strokes
|
|
1761
|
-
:type GREASE_PENCIL_OT_stroke_smooth: typing.Any | None
|
|
1762
1501
|
"""
|
|
1763
1502
|
|
|
1764
1503
|
def stroke_switch_direction(
|
|
1765
|
-
execution_context: int | str | None = None,
|
|
1504
|
+
execution_context: int | str | None = None,
|
|
1505
|
+
undo: bool | None = None,
|
|
1506
|
+
/,
|
|
1766
1507
|
) -> None:
|
|
1767
|
-
"""Change direction of the points of the selected strokes
|
|
1768
|
-
|
|
1769
|
-
:type execution_context: int | str | None
|
|
1770
|
-
:type undo: bool | None
|
|
1771
|
-
"""
|
|
1508
|
+
"""Change direction of the points of the selected strokes"""
|
|
1772
1509
|
|
|
1773
1510
|
def stroke_trim(
|
|
1774
1511
|
execution_context: int | str | None = None,
|
|
@@ -1782,16 +1519,10 @@ def stroke_trim(
|
|
|
1782
1519
|
) -> None:
|
|
1783
1520
|
"""Delete stroke points in between intersecting strokes
|
|
1784
1521
|
|
|
1785
|
-
:type execution_context: int | str | None
|
|
1786
|
-
:type undo: bool | None
|
|
1787
1522
|
:param path: Path
|
|
1788
|
-
:type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
|
|
1789
1523
|
:param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
|
|
1790
|
-
:type use_smooth_stroke: bool | None
|
|
1791
1524
|
:param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
|
|
1792
|
-
:type smooth_stroke_factor: float | None
|
|
1793
1525
|
:param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
|
|
1794
|
-
:type smooth_stroke_radius: int | None
|
|
1795
1526
|
"""
|
|
1796
1527
|
|
|
1797
1528
|
def texture_gradient(
|
|
@@ -1808,20 +1539,12 @@ def texture_gradient(
|
|
|
1808
1539
|
) -> None:
|
|
1809
1540
|
"""Draw a line to set the fill material gradient for the selected strokes
|
|
1810
1541
|
|
|
1811
|
-
:type execution_context: int | str | None
|
|
1812
|
-
:type undo: bool | None
|
|
1813
1542
|
:param xstart: X Start
|
|
1814
|
-
:type xstart: int | None
|
|
1815
1543
|
:param xend: X End
|
|
1816
|
-
:type xend: int | None
|
|
1817
1544
|
:param ystart: Y Start
|
|
1818
|
-
:type ystart: int | None
|
|
1819
1545
|
:param yend: Y End
|
|
1820
|
-
:type yend: int | None
|
|
1821
1546
|
:param flip: Flip
|
|
1822
|
-
:type flip: bool | None
|
|
1823
1547
|
:param cursor: Cursor, Mouse cursor style to use during the modal operator
|
|
1824
|
-
:type cursor: int | None
|
|
1825
1548
|
"""
|
|
1826
1549
|
|
|
1827
1550
|
def trace_image(
|
|
@@ -1842,14 +1565,9 @@ def trace_image(
|
|
|
1842
1565
|
) -> None:
|
|
1843
1566
|
"""Extract Grease Pencil strokes from image
|
|
1844
1567
|
|
|
1845
|
-
:type execution_context: int | str | None
|
|
1846
|
-
:type undo: bool | None
|
|
1847
1568
|
:param target: Target Object, Target Grease Pencil
|
|
1848
|
-
:type target: typing.Literal['NEW','SELECTED'] | None
|
|
1849
1569
|
:param radius: Radius
|
|
1850
|
-
:type radius: float | None
|
|
1851
1570
|
:param threshold: Color Threshold, Determine the lightness threshold above which strokes are generated
|
|
1852
|
-
:type threshold: float | None
|
|
1853
1571
|
:param turnpolicy: Turn Policy, Determines how to resolve ambiguities during decomposition of bitmaps into paths
|
|
1854
1572
|
|
|
1855
1573
|
FOREGROUND
|
|
@@ -1872,7 +1590,6 @@ def trace_image(
|
|
|
1872
1590
|
|
|
1873
1591
|
RANDOM
|
|
1874
1592
|
Random -- Choose pseudo-randomly.
|
|
1875
|
-
:type turnpolicy: typing.Literal['FOREGROUND','BACKGROUND','LEFT','RIGHT','MINORITY','MAJORITY','RANDOM'] | None
|
|
1876
1593
|
:param mode: Mode, Determines if trace simple image or full sequence
|
|
1877
1594
|
|
|
1878
1595
|
SINGLE
|
|
@@ -1880,11 +1597,8 @@ def trace_image(
|
|
|
1880
1597
|
|
|
1881
1598
|
SEQUENCE
|
|
1882
1599
|
Sequence -- Trace full sequence.
|
|
1883
|
-
:type mode: typing.Literal['SINGLE','SEQUENCE'] | None
|
|
1884
1600
|
:param use_current_frame: Start At Current Frame, Trace Image starting in current image frame
|
|
1885
|
-
:type use_current_frame: bool | None
|
|
1886
1601
|
:param frame_number: Trace Frame, Used to trace only one frame of the image sequence, set to zero to trace all
|
|
1887
|
-
:type frame_number: int | None
|
|
1888
1602
|
"""
|
|
1889
1603
|
|
|
1890
1604
|
def vertex_brush_stroke(
|
|
@@ -1894,15 +1608,13 @@ def vertex_brush_stroke(
|
|
|
1894
1608
|
*,
|
|
1895
1609
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
1896
1610
|
| None = None,
|
|
1897
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
1611
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
1612
|
+
| None = "NORMAL",
|
|
1898
1613
|
pen_flip: bool | None = False,
|
|
1899
1614
|
) -> None:
|
|
1900
1615
|
"""Draw on vertex colors in the active Grease Pencil object
|
|
1901
1616
|
|
|
1902
|
-
:type execution_context: int | str | None
|
|
1903
|
-
:type undo: bool | None
|
|
1904
1617
|
:param stroke: Stroke
|
|
1905
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
1906
1618
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
1907
1619
|
|
|
1908
1620
|
NORMAL
|
|
@@ -1916,9 +1628,10 @@ def vertex_brush_stroke(
|
|
|
1916
1628
|
|
|
1917
1629
|
ERASE
|
|
1918
1630
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
|
|
1631
|
+
|
|
1632
|
+
MASK
|
|
1633
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
1634
|
+
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
1922
1635
|
"""
|
|
1923
1636
|
|
|
1924
1637
|
def vertex_color_brightness_contrast(
|
|
@@ -1932,14 +1645,9 @@ def vertex_color_brightness_contrast(
|
|
|
1932
1645
|
) -> None:
|
|
1933
1646
|
"""Adjust vertex color brightness/contrast
|
|
1934
1647
|
|
|
1935
|
-
:type execution_context: int | str | None
|
|
1936
|
-
:type undo: bool | None
|
|
1937
1648
|
:param mode: Mode
|
|
1938
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
1939
1649
|
:param brightness: Brightness
|
|
1940
|
-
:type brightness: float | None
|
|
1941
1650
|
:param contrast: Contrast
|
|
1942
|
-
:type contrast: float | None
|
|
1943
1651
|
"""
|
|
1944
1652
|
|
|
1945
1653
|
def vertex_color_hsv(
|
|
@@ -1954,16 +1662,10 @@ def vertex_color_hsv(
|
|
|
1954
1662
|
) -> None:
|
|
1955
1663
|
"""Adjust vertex color HSV values
|
|
1956
1664
|
|
|
1957
|
-
:type execution_context: int | str | None
|
|
1958
|
-
:type undo: bool | None
|
|
1959
1665
|
:param mode: Mode
|
|
1960
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
1961
1666
|
:param h: Hue
|
|
1962
|
-
:type h: float | None
|
|
1963
1667
|
:param s: Saturation
|
|
1964
|
-
:type s: float | None
|
|
1965
1668
|
:param v: Value
|
|
1966
|
-
:type v: float | None
|
|
1967
1669
|
"""
|
|
1968
1670
|
|
|
1969
1671
|
def vertex_color_invert(
|
|
@@ -1975,10 +1677,7 @@ def vertex_color_invert(
|
|
|
1975
1677
|
) -> None:
|
|
1976
1678
|
"""Invert RGB values
|
|
1977
1679
|
|
|
1978
|
-
:type execution_context: int | str | None
|
|
1979
|
-
:type undo: bool | None
|
|
1980
1680
|
:param mode: Mode
|
|
1981
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
1982
1681
|
"""
|
|
1983
1682
|
|
|
1984
1683
|
def vertex_color_levels(
|
|
@@ -1992,14 +1691,9 @@ def vertex_color_levels(
|
|
|
1992
1691
|
) -> None:
|
|
1993
1692
|
"""Adjust levels of vertex colors
|
|
1994
1693
|
|
|
1995
|
-
:type execution_context: int | str | None
|
|
1996
|
-
:type undo: bool | None
|
|
1997
1694
|
:param mode: Mode
|
|
1998
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
1999
1695
|
:param offset: Offset, Value to add to colors
|
|
2000
|
-
:type offset: float | None
|
|
2001
1696
|
:param gain: Gain, Value to multiply colors by
|
|
2002
|
-
:type gain: float | None
|
|
2003
1697
|
"""
|
|
2004
1698
|
|
|
2005
1699
|
def vertex_color_set(
|
|
@@ -2012,22 +1706,16 @@ def vertex_color_set(
|
|
|
2012
1706
|
) -> None:
|
|
2013
1707
|
"""Set active color to all selected vertex
|
|
2014
1708
|
|
|
2015
|
-
:type execution_context: int | str | None
|
|
2016
|
-
:type undo: bool | None
|
|
2017
1709
|
:param mode: Mode
|
|
2018
|
-
:type mode: typing.Literal['STROKE','FILL','BOTH'] | None
|
|
2019
1710
|
:param factor: Factor, Mix Factor
|
|
2020
|
-
:type factor: float | None
|
|
2021
1711
|
"""
|
|
2022
1712
|
|
|
2023
1713
|
def vertex_group_normalize(
|
|
2024
|
-
execution_context: int | str | None = None,
|
|
1714
|
+
execution_context: int | str | None = None,
|
|
1715
|
+
undo: bool | None = None,
|
|
1716
|
+
/,
|
|
2025
1717
|
) -> None:
|
|
2026
|
-
"""Normalize weights of the active vertex group
|
|
2027
|
-
|
|
2028
|
-
:type execution_context: int | str | None
|
|
2029
|
-
:type undo: bool | None
|
|
2030
|
-
"""
|
|
1718
|
+
"""Normalize weights of the active vertex group"""
|
|
2031
1719
|
|
|
2032
1720
|
def vertex_group_normalize_all(
|
|
2033
1721
|
execution_context: int | str | None = None,
|
|
@@ -2038,10 +1726,7 @@ def vertex_group_normalize_all(
|
|
|
2038
1726
|
) -> None:
|
|
2039
1727
|
"""Normalize the weights of all vertex groups, so that for each vertex, the sum of all weights is 1.0
|
|
2040
1728
|
|
|
2041
|
-
:type execution_context: int | str | None
|
|
2042
|
-
:type undo: bool | None
|
|
2043
1729
|
:param lock_active: Lock Active, Keep the values of the active group while normalizing others
|
|
2044
|
-
:type lock_active: bool | None
|
|
2045
1730
|
"""
|
|
2046
1731
|
|
|
2047
1732
|
def vertex_group_smooth(
|
|
@@ -2054,12 +1739,8 @@ def vertex_group_smooth(
|
|
|
2054
1739
|
) -> None:
|
|
2055
1740
|
"""Smooth the weights of the active vertex group
|
|
2056
1741
|
|
|
2057
|
-
:type execution_context: int | str | None
|
|
2058
|
-
:type undo: bool | None
|
|
2059
1742
|
:param factor: Factor
|
|
2060
|
-
:type factor: float | None
|
|
2061
1743
|
:param repeat: Iterations
|
|
2062
|
-
:type repeat: int | None
|
|
2063
1744
|
"""
|
|
2064
1745
|
|
|
2065
1746
|
def vertexmode_toggle(
|
|
@@ -2071,10 +1752,7 @@ def vertexmode_toggle(
|
|
|
2071
1752
|
) -> None:
|
|
2072
1753
|
"""Enter/Exit vertex paint mode for Grease Pencil strokes
|
|
2073
1754
|
|
|
2074
|
-
:type execution_context: int | str | None
|
|
2075
|
-
:type undo: bool | None
|
|
2076
1755
|
:param back: Return to Previous Mode, Return to previous mode
|
|
2077
|
-
:type back: bool | None
|
|
2078
1756
|
"""
|
|
2079
1757
|
|
|
2080
1758
|
def weight_brush_stroke(
|
|
@@ -2084,15 +1762,13 @@ def weight_brush_stroke(
|
|
|
2084
1762
|
*,
|
|
2085
1763
|
stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
|
|
2086
1764
|
| None = None,
|
|
2087
|
-
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"
|
|
1765
|
+
mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE", "MASK"]
|
|
1766
|
+
| None = "NORMAL",
|
|
2088
1767
|
pen_flip: bool | None = False,
|
|
2089
1768
|
) -> None:
|
|
2090
1769
|
"""Draw weight on stroke points in the active Grease Pencil object
|
|
2091
1770
|
|
|
2092
|
-
:type execution_context: int | str | None
|
|
2093
|
-
:type undo: bool | None
|
|
2094
1771
|
:param stroke: Stroke
|
|
2095
|
-
:type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
|
|
2096
1772
|
:param mode: Stroke Mode, Action taken when a paint stroke is made
|
|
2097
1773
|
|
|
2098
1774
|
NORMAL
|
|
@@ -2106,37 +1782,32 @@ def weight_brush_stroke(
|
|
|
2106
1782
|
|
|
2107
1783
|
ERASE
|
|
2108
1784
|
Erase -- Switch brush to erase mode for duration of stroke.
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
1785
|
+
|
|
1786
|
+
MASK
|
|
1787
|
+
Mask -- Switch brush to mask mode for duration of stroke.
|
|
1788
|
+
:param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
|
|
2112
1789
|
"""
|
|
2113
1790
|
|
|
2114
1791
|
def weight_invert(
|
|
2115
|
-
execution_context: int | str | None = None,
|
|
1792
|
+
execution_context: int | str | None = None,
|
|
1793
|
+
undo: bool | None = None,
|
|
1794
|
+
/,
|
|
2116
1795
|
) -> None:
|
|
2117
|
-
"""Invert the weight of active vertex group
|
|
2118
|
-
|
|
2119
|
-
:type execution_context: int | str | None
|
|
2120
|
-
:type undo: bool | None
|
|
2121
|
-
"""
|
|
1796
|
+
"""Invert the weight of active vertex group"""
|
|
2122
1797
|
|
|
2123
1798
|
def weight_sample(
|
|
2124
|
-
execution_context: int | str | None = None,
|
|
1799
|
+
execution_context: int | str | None = None,
|
|
1800
|
+
undo: bool | None = None,
|
|
1801
|
+
/,
|
|
2125
1802
|
) -> None:
|
|
2126
|
-
"""Set the weight of the Draw tool to the weight of the vertex under the mouse cursor
|
|
2127
|
-
|
|
2128
|
-
:type execution_context: int | str | None
|
|
2129
|
-
:type undo: bool | None
|
|
2130
|
-
"""
|
|
1803
|
+
"""Set the weight of the Draw tool to the weight of the vertex under the mouse cursor"""
|
|
2131
1804
|
|
|
2132
1805
|
def weight_toggle_direction(
|
|
2133
|
-
execution_context: int | str | None = None,
|
|
1806
|
+
execution_context: int | str | None = None,
|
|
1807
|
+
undo: bool | None = None,
|
|
1808
|
+
/,
|
|
2134
1809
|
) -> None:
|
|
2135
|
-
"""Toggle Add/Subtract for the weight paint draw tool
|
|
2136
|
-
|
|
2137
|
-
:type execution_context: int | str | None
|
|
2138
|
-
:type undo: bool | None
|
|
2139
|
-
"""
|
|
1810
|
+
"""Toggle Add/Subtract for the weight paint draw tool"""
|
|
2140
1811
|
|
|
2141
1812
|
def weightmode_toggle(
|
|
2142
1813
|
execution_context: int | str | None = None,
|
|
@@ -2147,8 +1818,5 @@ def weightmode_toggle(
|
|
|
2147
1818
|
) -> None:
|
|
2148
1819
|
"""Enter/Exit weight paint mode for Grease Pencil strokes
|
|
2149
1820
|
|
|
2150
|
-
:type execution_context: int | str | None
|
|
2151
|
-
:type undo: bool | None
|
|
2152
1821
|
:param back: Return to Previous Mode, Return to previous mode
|
|
2153
|
-
:type back: bool | None
|
|
2154
1822
|
"""
|