fake-bpy-module 20240524__py3-none-any.whl → 20240529__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of fake-bpy-module might be problematic. Click here for more details.
- bl_console_utils/autocomplete/complete_calltip/__init__.pyi +3 -3
- bl_operators/__init__.pyi +3 -0
- bl_operators/connect_to_output/__init__.pyi +325 -0
- bl_operators/image_as_planes/__init__.pyi +463 -0
- bl_operators/node_editor/__init__.pyi +6 -0
- bl_operators/node_editor/node_functions/__init__.pyi +23 -0
- bl_operators/presets/__init__.pyi +12 -12
- bl_operators/userpref/__init__.pyi +0 -214
- bl_operators/wm/__init__.pyi +24 -24
- bl_ui/__init__.pyi +12 -12
- bl_ui/anim/__init__.pyi +6 -6
- bl_ui/generic_ui_list/__init__.pyi +2 -2
- bl_ui/node_add_menu/__init__.pyi +6 -6
- bl_ui/node_add_menu_compositor/__init__.pyi +108 -108
- bl_ui/node_add_menu_geometry/__init__.pyi +288 -288
- bl_ui/node_add_menu_shader/__init__.pyi +60 -60
- bl_ui/node_add_menu_texture/__init__.pyi +54 -54
- bl_ui/properties_collection/__init__.pyi +6 -6
- bl_ui/properties_data_armature/__init__.pyi +12 -12
- bl_ui/properties_data_camera/__init__.pyi +12 -12
- bl_ui/properties_data_curves/__init__.pyi +6 -6
- bl_ui/properties_data_gpencil/__init__.pyi +12 -12
- bl_ui/properties_data_grease_pencil/__init__.pyi +18 -18
- bl_ui/properties_data_mesh/__init__.pyi +24 -24
- bl_ui/properties_data_modifier/__init__.pyi +42 -42
- bl_ui/properties_data_pointcloud/__init__.pyi +6 -6
- bl_ui/properties_freestyle/__init__.pyi +6 -6
- bl_ui/properties_grease_pencil_common/__init__.pyi +72 -72
- bl_ui/properties_mask_common/__init__.pyi +36 -36
- bl_ui/properties_material/__init__.pyi +6 -6
- bl_ui/properties_material_gpencil/__init__.pyi +12 -12
- bl_ui/properties_object/__init__.pyi +6 -6
- bl_ui/properties_output/__init__.pyi +18 -18
- bl_ui/properties_paint_common/__init__.pyi +6 -6
- bl_ui/properties_particle/__init__.pyi +12 -12
- bl_ui/properties_physics_cloth/__init__.pyi +6 -6
- bl_ui/properties_physics_fluid/__init__.pyi +6 -6
- bl_ui/properties_render/__init__.pyi +7 -7
- bl_ui/properties_texture/__init__.pyi +6 -6
- bl_ui/properties_view_layer/__init__.pyi +6 -6
- bl_ui/space_clip/__init__.pyi +186 -186
- bl_ui/space_console/__init__.pyi +30 -30
- bl_ui/space_dopesheet/__init__.pyi +84 -84
- bl_ui/space_filebrowser/__init__.pyi +78 -78
- bl_ui/space_graph/__init__.pyi +96 -96
- bl_ui/space_image/__init__.pyi +138 -138
- bl_ui/space_info/__init__.pyi +30 -30
- bl_ui/space_nla/__init__.pyi +78 -78
- bl_ui/space_node/__init__.pyi +72 -72
- bl_ui/space_outliner/__init__.pyi +72 -72
- bl_ui/space_sequencer/__init__.pyi +204 -204
- bl_ui/space_text/__init__.pyi +72 -72
- bl_ui/space_time/__init__.pyi +24 -24
- bl_ui/space_toolsystem_toolbar/__init__.pyi +4 -0
- bl_ui/space_topbar/__init__.pyi +114 -114
- bl_ui/space_userpref/__init__.pyi +36 -36
- bl_ui/space_view3d/__init__.pyi +1446 -1176
- bl_ui/space_view3d_toolbar/__init__.pyi +30 -30
- bl_ui/utils/__init__.pyi +6 -6
- bmesh/geometry/__init__.pyi +2 -2
- bmesh/ops/__init__.pyi +55 -54
- bmesh/types/__init__.pyi +43 -33
- bmesh/utils/__init__.pyi +2 -2
- bpy/app/__init__.pyi +5 -1
- bpy/app/handlers/__init__.pyi +37 -37
- bpy/app/icons/__init__.pyi +4 -4
- bpy/app/timers/__init__.pyi +6 -6
- bpy/ops/action/__init__.pyi +21 -0
- bpy/ops/anim/__init__.pyi +34 -0
- bpy/ops/armature/__init__.pyi +31 -0
- bpy/ops/asset/__init__.pyi +5 -0
- bpy/ops/bl_pkg/__init__.pyi +32 -21
- bpy/ops/boid/__init__.pyi +1 -0
- bpy/ops/brush/__init__.pyi +6 -0
- bpy/ops/buttons/__init__.pyi +2 -0
- bpy/ops/cachefile/__init__.pyi +3 -0
- bpy/ops/camera/__init__.pyi +2 -0
- bpy/ops/clip/__init__.pyi +49 -0
- bpy/ops/cloth/__init__.pyi +1 -0
- bpy/ops/collection/__init__.pyi +7 -0
- bpy/ops/console/__init__.pyi +11 -0
- bpy/ops/constraint/__init__.pyi +15 -0
- bpy/ops/curve/__init__.pyi +28 -0
- bpy/ops/curves/__init__.pyi +14 -0
- bpy/ops/cycles/__init__.pyi +2 -0
- bpy/ops/dpaint/__init__.pyi +2 -0
- bpy/ops/ed/__init__.pyi +3 -0
- bpy/ops/export_anim/__init__.pyi +1 -0
- bpy/ops/export_scene/__init__.pyi +20 -3
- bpy/ops/file/__init__.pyi +14 -0
- bpy/ops/fluid/__init__.pyi +1 -0
- bpy/ops/font/__init__.pyi +13 -0
- bpy/ops/geometry/__init__.pyi +7 -0
- bpy/ops/gizmogroup/__init__.pyi +1 -0
- bpy/ops/gpencil/__init__.pyi +106 -0
- bpy/ops/graph/__init__.pyi +47 -0
- bpy/ops/grease_pencil/__init__.pyi +52 -0
- bpy/ops/image/__init__.pyi +308 -0
- bpy/ops/import_anim/__init__.pyi +1 -0
- bpy/ops/import_curve/__init__.pyi +1 -0
- bpy/ops/import_scene/__init__.pyi +2 -0
- bpy/ops/info/__init__.pyi +3 -0
- bpy/ops/lattice/__init__.pyi +5 -0
- bpy/ops/marker/__init__.pyi +9 -0
- bpy/ops/mask/__init__.pyi +22 -0
- bpy/ops/mball/__init__.pyi +7 -0
- bpy/ops/mesh/__init__.pyi +134 -0
- bpy/ops/nla/__init__.pyi +20 -0
- bpy/ops/node/__init__.pyi +65 -0
- bpy/ops/object/__init__.pyi +174 -0
- bpy/ops/outliner/__init__.pyi +25 -0
- bpy/ops/paint/__init__.pyi +105 -0
- bpy/ops/paintcurve/__init__.pyi +4 -0
- bpy/ops/palette/__init__.pyi +4 -0
- bpy/ops/particle/__init__.pyi +17 -0
- bpy/ops/pose/__init__.pyi +24 -0
- bpy/ops/poselib/__init__.pyi +4 -0
- bpy/ops/preferences/__init__.pyi +28 -16
- bpy/ops/ptcache/__init__.pyi +2 -0
- bpy/ops/render/__init__.pyi +9 -0
- bpy/ops/rigidbody/__init__.pyi +7 -0
- bpy/ops/scene/__init__.pyi +16 -0
- bpy/ops/screen/__init__.pyi +21 -0
- bpy/ops/script/__init__.pyi +2 -0
- bpy/ops/sculpt/__init__.pyi +151 -0
- bpy/ops/sculpt_curves/__init__.pyi +3 -0
- bpy/ops/sequencer/__init__.pyi +57 -0
- bpy/ops/sound/__init__.pyi +4 -0
- bpy/ops/spreadsheet/__init__.pyi +2 -0
- bpy/ops/surface/__init__.pyi +6 -0
- bpy/ops/text/__init__.pyi +18 -0
- bpy/ops/text_editor/__init__.pyi +1 -0
- bpy/ops/texture/__init__.pyi +1 -0
- bpy/ops/transform/__init__.pyi +25 -0
- bpy/ops/ui/__init__.pyi +13 -0
- bpy/ops/uilist/__init__.pyi +3 -0
- bpy/ops/uv/__init__.pyi +40 -0
- bpy/ops/view2d/__init__.pyi +11 -0
- bpy/ops/view3d/__init__.pyi +30 -0
- bpy/ops/wm/__init__.pyi +114 -0
- bpy/ops/workspace/__init__.pyi +1 -0
- bpy/path/__init__.pyi +6 -6
- bpy/props/__init__.pyi +27 -15
- bpy/types/__init__.pyi +662 -388
- bpy/utils/__init__.pyi +12 -10
- bpy_extras/anim_utils/__init__.pyi +7 -7
- bpy_extras/io_utils/__init__.pyi +4 -4
- bpy_extras/mesh_utils/__init__.pyi +4 -4
- bpy_extras/object_utils/__init__.pyi +8 -8
- bpy_extras/view3d_utils/__init__.pyi +2 -0
- bpy_types/__init__.pyi +12 -12
- {fake_bpy_module-20240524.dist-info → fake_bpy_module-20240529.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240524.dist-info → fake_bpy_module-20240529.dist-info}/RECORD +167 -163
- freestyle/shaders/__init__.pyi +2 -2
- freestyle/types/__init__.pyi +64 -56
- gpu/matrix/__init__.pyi +6 -6
- gpu/types/__init__.pyi +14 -10
- gpu_extras/batch/__init__.pyi +1 -1
- gpu_extras/presets/__init__.pyi +1 -1
- imbuf/__init__.pyi +2 -2
- mathutils/__init__.pyi +176 -137
- mathutils/bvhtree/__init__.pyi +4 -4
- mathutils/geometry/__init__.pyi +139 -139
- mathutils/kdtree/__init__.pyi +14 -10
- mathutils/noise/__init__.pyi +26 -26
- {fake_bpy_module-20240524.dist-info → fake_bpy_module-20240529.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240524.dist-info → fake_bpy_module-20240529.dist-info}/top_level.txt +0 -0
bpy/utils/__init__.pyi
CHANGED
|
@@ -18,7 +18,7 @@ from . import units
|
|
|
18
18
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
19
19
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
20
20
|
|
|
21
|
-
def app_template_paths(path: str | None = None):
|
|
21
|
+
def app_template_paths(*, path: str | None = None):
|
|
22
22
|
"""Returns valid application template paths.
|
|
23
23
|
|
|
24
24
|
:param path: Optional subdir.
|
|
@@ -68,7 +68,7 @@ def escape_identifier(string: str | None) -> str:
|
|
|
68
68
|
|
|
69
69
|
...
|
|
70
70
|
|
|
71
|
-
def execfile(filepath: str | None, mod=None):
|
|
71
|
+
def execfile(filepath: str | None, *, mod=None):
|
|
72
72
|
"""Execute a file path as a Python script.
|
|
73
73
|
|
|
74
74
|
:param filepath: Path of the script to execute.
|
|
@@ -116,9 +116,10 @@ def is_path_builtin(path: str | None) -> bool:
|
|
|
116
116
|
|
|
117
117
|
def keyconfig_init(): ...
|
|
118
118
|
def keyconfig_init(): ...
|
|
119
|
-
def keyconfig_set(filepath, report=None): ...
|
|
119
|
+
def keyconfig_set(filepath, *, report=None): ...
|
|
120
120
|
def keyconfig_set(filepath, report=None): ...
|
|
121
121
|
def load_scripts(
|
|
122
|
+
*,
|
|
122
123
|
reload_scripts: bool | None = False,
|
|
123
124
|
refresh_scripts: bool | None = False,
|
|
124
125
|
extensions: bool | None = True,
|
|
@@ -252,7 +253,7 @@ def modules_from_path(path: str | None, loaded_modules: set | None) -> list:
|
|
|
252
253
|
|
|
253
254
|
...
|
|
254
255
|
|
|
255
|
-
def preset_find(name, preset_path, display_name=False, ext=".py"): ...
|
|
256
|
+
def preset_find(name, preset_path, *, display_name=False, ext=".py"): ...
|
|
256
257
|
def preset_find(name, preset_path, display_name=False, ext=".py"): ...
|
|
257
258
|
def preset_paths(subdir: str | None) -> list:
|
|
258
259
|
"""Returns a list of paths for a specific preset.
|
|
@@ -315,7 +316,7 @@ def register_classes_factory(classes):
|
|
|
315
316
|
|
|
316
317
|
...
|
|
317
318
|
|
|
318
|
-
def register_cli_command(id: str | None, execute:
|
|
319
|
+
def register_cli_command(id: str | None, execute: collections.abc.Callable | None):
|
|
319
320
|
"""Register a command, accessible via the (-c / --command) command-line argument.Custom CommandsRegistering commands makes it possible to conveniently expose command line
|
|
320
321
|
functionality via commands passed to (-c / --command).Using Python Argument ParsingThis example shows how the Python argparse module can be used with a custom command.Using argparse is generally recommended as it has many useful utilities and
|
|
321
322
|
generates a --help message for your command.
|
|
@@ -327,7 +328,7 @@ def register_cli_command(id: str | None, execute: typing.Callable | None):
|
|
|
327
328
|
:param execute: Callback, taking a single list of strings and returns an int.
|
|
328
329
|
The arguments are built from all command-line arguments following the command id.
|
|
329
330
|
The return value should be 0 for success, 1 on failure (specific error codes from the os module can also be used).
|
|
330
|
-
:type execute:
|
|
331
|
+
:type execute: collections.abc.Callable | None
|
|
331
332
|
:return: The command handle which can be passed to `unregister_cli_command`.
|
|
332
333
|
"""
|
|
333
334
|
|
|
@@ -368,7 +369,7 @@ def register_submodule_factory(
|
|
|
368
369
|
...
|
|
369
370
|
|
|
370
371
|
def register_tool(
|
|
371
|
-
tool_cls, after=None, separator: bool | None = False, group: bool | None = False
|
|
372
|
+
tool_cls, *, after=None, separator: bool | None = False, group: bool | None = False
|
|
372
373
|
):
|
|
373
374
|
"""Register a tool in the toolbar.
|
|
374
375
|
|
|
@@ -423,6 +424,7 @@ def script_path_user():
|
|
|
423
424
|
...
|
|
424
425
|
|
|
425
426
|
def script_paths(
|
|
427
|
+
*,
|
|
426
428
|
subdir: str | None = None,
|
|
427
429
|
user_pref: bool | None = True,
|
|
428
430
|
check_all: bool | None = False,
|
|
@@ -467,7 +469,7 @@ def script_paths_pref():
|
|
|
467
469
|
|
|
468
470
|
...
|
|
469
471
|
|
|
470
|
-
def smpte_from_frame(frame: int | None, fps=None, fps_base=None) -> str:
|
|
472
|
+
def smpte_from_frame(frame: int | None, *, fps=None, fps_base=None) -> str:
|
|
471
473
|
"""Returns an SMPTE formatted string from the frame:
|
|
472
474
|
HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
|
|
473
475
|
|
|
@@ -491,7 +493,7 @@ def smpte_from_frame(frame: int | None, fps=None, fps_base=None) -> str:
|
|
|
491
493
|
|
|
492
494
|
...
|
|
493
495
|
|
|
494
|
-
def smpte_from_seconds(time: int | float | None, fps=None, fps_base=None) -> str:
|
|
496
|
+
def smpte_from_seconds(time: int | float | None, *, fps=None, fps_base=None) -> str:
|
|
495
497
|
"""Returns an SMPTE formatted string from the time:
|
|
496
498
|
HH:MM:SS:FF.If fps and fps_base are not given the current scene is used.
|
|
497
499
|
|
|
@@ -571,7 +573,7 @@ def unregister_manual_map(manual_hook): ...
|
|
|
571
573
|
def unregister_tool(tool_cls): ...
|
|
572
574
|
def unregister_tool(tool_cls): ...
|
|
573
575
|
def user_resource(
|
|
574
|
-
resource_type, path: str | None = "", create: bool | None = False
|
|
576
|
+
resource_type, *, path: str | None = "", create: bool | None = False
|
|
575
577
|
) -> str:
|
|
576
578
|
"""Return a user resource path (normally from the users home directory).
|
|
577
579
|
|
|
@@ -74,7 +74,7 @@ class KeyframesCo:
|
|
|
74
74
|
...
|
|
75
75
|
|
|
76
76
|
def bake_action(
|
|
77
|
-
obj: bpy.types.Object, action: bpy.types.Action | None, frames, bake_options
|
|
77
|
+
obj: bpy.types.Object, *, action: bpy.types.Action | None, frames, bake_options
|
|
78
78
|
) -> bpy.types.Action:
|
|
79
79
|
"""
|
|
80
80
|
|
|
@@ -108,7 +108,7 @@ def bake_action(
|
|
|
108
108
|
...
|
|
109
109
|
|
|
110
110
|
def bake_action_iter(
|
|
111
|
-
obj: bpy.types.Object, action: bpy.types.Action | None, bake_options
|
|
111
|
+
obj: bpy.types.Object, *, action: bpy.types.Action | None, bake_options
|
|
112
112
|
) -> bpy.types.Action:
|
|
113
113
|
"""An coroutine that bakes action for a single object.
|
|
114
114
|
|
|
@@ -142,25 +142,25 @@ def bake_action_iter(
|
|
|
142
142
|
...
|
|
143
143
|
|
|
144
144
|
def bake_action_objects(
|
|
145
|
-
object_action_pairs, frames, bake_options
|
|
146
|
-
) ->
|
|
145
|
+
object_action_pairs, *, frames, bake_options
|
|
146
|
+
) -> collections.abc.Iterable[bpy.types.Action]:
|
|
147
147
|
"""A version of `bake_action_objects_iter` that takes frames and returns the output.
|
|
148
148
|
|
|
149
149
|
:param frames: Frames to bake.
|
|
150
150
|
:return: A sequence of Action or None types (aligned with object_action_pairs)
|
|
151
|
-
:rtype:
|
|
151
|
+
:rtype: collections.abc.Iterable[bpy.types.Action]
|
|
152
152
|
"""
|
|
153
153
|
|
|
154
154
|
...
|
|
155
155
|
|
|
156
156
|
def bake_action_objects(
|
|
157
157
|
object_action_pairs, frames, bake_options
|
|
158
|
-
) ->
|
|
158
|
+
) -> collections.abc.Iterable[bpy.types.Action]:
|
|
159
159
|
"""A version of `bake_action_objects_iter` that takes frames and returns the output.
|
|
160
160
|
|
|
161
161
|
:param frames: Frames to bake.
|
|
162
162
|
:return: A sequence of Action or None types (aligned with object_action_pairs)
|
|
163
|
-
:rtype:
|
|
163
|
+
:rtype: collections.abc.Iterable[bpy.types.Action]
|
|
164
164
|
"""
|
|
165
165
|
|
|
166
166
|
...
|
bpy_extras/io_utils/__init__.pyi
CHANGED
|
@@ -100,14 +100,14 @@ def axis_conversion_ensure(
|
|
|
100
100
|
...
|
|
101
101
|
|
|
102
102
|
def create_derived_objects(
|
|
103
|
-
depsgraph: bpy.types.Depsgraph, objects:
|
|
103
|
+
depsgraph: bpy.types.Depsgraph, objects: collections.abc.Iterable[bpy.types.Object]
|
|
104
104
|
) -> dict:
|
|
105
105
|
"""This function takes a sequence of objects, returning their instances.
|
|
106
106
|
|
|
107
107
|
:param depsgraph: The evaluated depsgraph.
|
|
108
108
|
:type depsgraph: bpy.types.Depsgraph
|
|
109
109
|
:param objects: A sequencer of objects.
|
|
110
|
-
:type objects:
|
|
110
|
+
:type objects: collections.abc.Iterable[bpy.types.Object]
|
|
111
111
|
:return: A dictionary where each key is an object from objects,
|
|
112
112
|
values are lists of (`bpy.types.Object`, `mathutils.Matrix`) tuples representing instances.
|
|
113
113
|
:rtype: dict
|
|
@@ -116,14 +116,14 @@ def create_derived_objects(
|
|
|
116
116
|
...
|
|
117
117
|
|
|
118
118
|
def create_derived_objects(
|
|
119
|
-
depsgraph: bpy.types.Depsgraph, objects:
|
|
119
|
+
depsgraph: bpy.types.Depsgraph, objects: collections.abc.Iterable[bpy.types.Object]
|
|
120
120
|
) -> dict:
|
|
121
121
|
"""This function takes a sequence of objects, returning their instances.
|
|
122
122
|
|
|
123
123
|
:param depsgraph: The evaluated depsgraph.
|
|
124
124
|
:type depsgraph: bpy.types.Depsgraph
|
|
125
125
|
:param objects: A sequencer of objects.
|
|
126
|
-
:type objects:
|
|
126
|
+
:type objects: collections.abc.Iterable[bpy.types.Object]
|
|
127
127
|
:return: A dictionary where each key is an object from objects,
|
|
128
128
|
values are lists of (`bpy.types.Object`, `mathutils.Matrix`) tuples representing instances.
|
|
129
129
|
:rtype: dict
|
|
@@ -154,13 +154,13 @@ def ngon_tessellate(
|
|
|
154
154
|
...
|
|
155
155
|
|
|
156
156
|
def triangle_random_points(
|
|
157
|
-
num_points, loop_triangles: bpy.types.MeshLoopTriangle |
|
|
157
|
+
num_points, loop_triangles: bpy.types.MeshLoopTriangle | collections.abc.Sequence
|
|
158
158
|
) -> list:
|
|
159
159
|
"""Generates a list of random points over mesh loop triangles.
|
|
160
160
|
|
|
161
161
|
:param num_points: the number of random points to generate on each triangle.
|
|
162
162
|
:param loop_triangles: list of the triangles to generate points on.
|
|
163
|
-
:type loop_triangles: bpy.types.MeshLoopTriangle |
|
|
163
|
+
:type loop_triangles: bpy.types.MeshLoopTriangle | collections.abc.Sequence
|
|
164
164
|
:return: list of random points over all triangles.
|
|
165
165
|
:rtype: list
|
|
166
166
|
"""
|
|
@@ -168,13 +168,13 @@ def triangle_random_points(
|
|
|
168
168
|
...
|
|
169
169
|
|
|
170
170
|
def triangle_random_points(
|
|
171
|
-
num_points, loop_triangles: bpy.types.MeshLoopTriangle |
|
|
171
|
+
num_points, loop_triangles: bpy.types.MeshLoopTriangle | collections.abc.Sequence
|
|
172
172
|
) -> list:
|
|
173
173
|
"""Generates a list of random points over mesh loop triangles.
|
|
174
174
|
|
|
175
175
|
:param num_points: the number of random points to generate on each triangle.
|
|
176
176
|
:param loop_triangles: list of the triangles to generate points on.
|
|
177
|
-
:type loop_triangles: bpy.types.MeshLoopTriangle |
|
|
177
|
+
:type loop_triangles: bpy.types.MeshLoopTriangle | collections.abc.Sequence
|
|
178
178
|
:return: list of random points over all triangles.
|
|
179
179
|
:rtype: list
|
|
180
180
|
"""
|
|
@@ -81,7 +81,7 @@ def object_data_add(
|
|
|
81
81
|
context: bpy.types.Context,
|
|
82
82
|
obdata,
|
|
83
83
|
operator: bpy.types.Operator = None,
|
|
84
|
-
name: str = None,
|
|
84
|
+
name: str | None = None,
|
|
85
85
|
) -> bpy.types.Object:
|
|
86
86
|
"""Add an object using the view context and preference to initialize the
|
|
87
87
|
location, rotation and layer.
|
|
@@ -92,7 +92,7 @@ def object_data_add(
|
|
|
92
92
|
:param operator: The operator, checked for location and rotation properties.
|
|
93
93
|
:type operator: bpy.types.Operator
|
|
94
94
|
:param name: Optional name
|
|
95
|
-
:type name: str
|
|
95
|
+
:type name: str | None
|
|
96
96
|
:return: the newly created object in the scene.
|
|
97
97
|
:rtype: bpy.types.Object
|
|
98
98
|
"""
|
|
@@ -103,7 +103,7 @@ def object_data_add(
|
|
|
103
103
|
context: bpy.types.Context,
|
|
104
104
|
obdata,
|
|
105
105
|
operator: bpy.types.Operator = None,
|
|
106
|
-
name: str = None,
|
|
106
|
+
name: str | None = None,
|
|
107
107
|
) -> bpy.types.Object:
|
|
108
108
|
"""Add an object using the view context and preference to initialize the
|
|
109
109
|
location, rotation and layer.
|
|
@@ -114,7 +114,7 @@ def object_data_add(
|
|
|
114
114
|
:param operator: The operator, checked for location and rotation properties.
|
|
115
115
|
:type operator: bpy.types.Operator
|
|
116
116
|
:param name: Optional name
|
|
117
|
-
:type name: str
|
|
117
|
+
:type name: str | None
|
|
118
118
|
:return: the newly created object in the scene.
|
|
119
119
|
:rtype: bpy.types.Object
|
|
120
120
|
"""
|
|
@@ -152,7 +152,7 @@ def object_report_if_active_shape_key_is_locked(
|
|
|
152
152
|
def world_to_camera_view(
|
|
153
153
|
scene: bpy.types.Scene,
|
|
154
154
|
obj: bpy.types.Object,
|
|
155
|
-
coord:
|
|
155
|
+
coord: collections.abc.Sequence[float] | mathutils.Vector,
|
|
156
156
|
) -> mathutils.Vector:
|
|
157
157
|
"""Returns the camera space coords for a 3d point.
|
|
158
158
|
(also known as: normalized device coordinates - NDC).Where (0, 0) is the bottom left and (1, 1)
|
|
@@ -166,7 +166,7 @@ def world_to_camera_view(
|
|
|
166
166
|
:param obj: Camera object.
|
|
167
167
|
:type obj: bpy.types.Object
|
|
168
168
|
:param coord: World space location.
|
|
169
|
-
:type coord:
|
|
169
|
+
:type coord: collections.abc.Sequence[float] | mathutils.Vector
|
|
170
170
|
:return: a vector where X and Y map to the view plane and
|
|
171
171
|
Z is the depth on the view axis.
|
|
172
172
|
:rtype: mathutils.Vector
|
|
@@ -177,7 +177,7 @@ def world_to_camera_view(
|
|
|
177
177
|
def world_to_camera_view(
|
|
178
178
|
scene: bpy.types.Scene,
|
|
179
179
|
obj: bpy.types.Object,
|
|
180
|
-
coord:
|
|
180
|
+
coord: collections.abc.Sequence[float] | mathutils.Vector,
|
|
181
181
|
) -> mathutils.Vector:
|
|
182
182
|
"""Returns the camera space coords for a 3d point.
|
|
183
183
|
(also known as: normalized device coordinates - NDC).Where (0, 0) is the bottom left and (1, 1)
|
|
@@ -191,7 +191,7 @@ def world_to_camera_view(
|
|
|
191
191
|
:param obj: Camera object.
|
|
192
192
|
:type obj: bpy.types.Object
|
|
193
193
|
:param coord: World space location.
|
|
194
|
-
:type coord:
|
|
194
|
+
:type coord: collections.abc.Sequence[float] | mathutils.Vector
|
|
195
195
|
:return: a vector where X and Y map to the view plane and
|
|
196
196
|
Z is the depth on the view axis.
|
|
197
197
|
:rtype: mathutils.Vector
|
|
@@ -10,6 +10,7 @@ def location_3d_to_region_2d(
|
|
|
10
10
|
region: bpy.types.Region,
|
|
11
11
|
rv3d: bpy.types.RegionView3D,
|
|
12
12
|
coord: mathutils.Vector,
|
|
13
|
+
*,
|
|
13
14
|
default=None,
|
|
14
15
|
) -> mathutils.Vector:
|
|
15
16
|
"""Return the region relative 2d location of a 3d position.
|
|
@@ -104,6 +105,7 @@ def region_2d_to_origin_3d(
|
|
|
104
105
|
region: bpy.types.Region,
|
|
105
106
|
rv3d: bpy.types.RegionView3D,
|
|
106
107
|
coord: mathutils.Vector,
|
|
108
|
+
*,
|
|
107
109
|
clamp: float | None = None,
|
|
108
110
|
) -> mathutils.Vector:
|
|
109
111
|
"""Return the 3d view origin from the region relative 2d coords.
|
bpy_types/__init__.pyi
CHANGED
|
@@ -925,13 +925,13 @@ class Context:
|
|
|
925
925
|
"""
|
|
926
926
|
...
|
|
927
927
|
|
|
928
|
-
def path_resolve(self, path: str, coerce: bool = True):
|
|
928
|
+
def path_resolve(self, path: str, coerce: bool | None = True):
|
|
929
929
|
"""Returns the property from the path, raise an exception when not found.
|
|
930
930
|
|
|
931
931
|
:param path: patch which this property resolves.
|
|
932
932
|
:type path: str
|
|
933
933
|
:param coerce: optional argument, when True, the property will be converted into its Python representation.
|
|
934
|
-
:type coerce: bool
|
|
934
|
+
:type coerce: bool | None
|
|
935
935
|
"""
|
|
936
936
|
...
|
|
937
937
|
|
|
@@ -1191,14 +1191,14 @@ class Gizmo:
|
|
|
1191
1191
|
def draw_custom_shape(
|
|
1192
1192
|
self,
|
|
1193
1193
|
shape,
|
|
1194
|
-
matrix:
|
|
1194
|
+
matrix: collections.abc.Sequence[float] | mathutils.Matrix = None,
|
|
1195
1195
|
select_id=None,
|
|
1196
1196
|
):
|
|
1197
1197
|
"""Draw a shape created form `Gizmo.draw_custom_shape`.
|
|
1198
1198
|
|
|
1199
1199
|
:param shape: The cached shape to draw.
|
|
1200
1200
|
:param matrix: 4x4 matrix, when not given `Gizmo.matrix_world` is used.
|
|
1201
|
-
:type matrix:
|
|
1201
|
+
:type matrix: collections.abc.Sequence[float] | mathutils.Matrix
|
|
1202
1202
|
:param select_id: The selection id.
|
|
1203
1203
|
Only use when drawing within `Gizmo.draw_select`.
|
|
1204
1204
|
"""
|
|
@@ -4074,7 +4074,7 @@ class EditBone(_GenericBone):
|
|
|
4074
4074
|
|
|
4075
4075
|
def transform(
|
|
4076
4076
|
self,
|
|
4077
|
-
matrix:
|
|
4077
|
+
matrix: collections.abc.Sequence[float] | mathutils.Matrix,
|
|
4078
4078
|
scale: bool = True,
|
|
4079
4079
|
roll: bool = True,
|
|
4080
4080
|
):
|
|
@@ -4082,7 +4082,7 @@ class EditBone(_GenericBone):
|
|
|
4082
4082
|
(when the matrix has a scale component).
|
|
4083
4083
|
|
|
4084
4084
|
:param matrix: 3x3 or 4x4 transformation matrix.
|
|
4085
|
-
:type matrix:
|
|
4085
|
+
:type matrix: collections.abc.Sequence[float] | mathutils.Matrix
|
|
4086
4086
|
:param scale: Scale the bone envelope by the matrix.
|
|
4087
4087
|
:type scale: bool
|
|
4088
4088
|
:param roll: Correct the roll to point in the same relative
|
|
@@ -4904,10 +4904,10 @@ class Menu(_GenericUI):
|
|
|
4904
4904
|
searchpaths: list[str],
|
|
4905
4905
|
operator: str,
|
|
4906
4906
|
props_default: dict = None,
|
|
4907
|
-
prop_filepath: str = "filepath",
|
|
4908
|
-
filter_ext:
|
|
4907
|
+
prop_filepath: str | None = "filepath",
|
|
4908
|
+
filter_ext: collections.abc.Callable | None = None,
|
|
4909
4909
|
filter_path=None,
|
|
4910
|
-
display_name:
|
|
4910
|
+
display_name: collections.abc.Callable | None = None,
|
|
4911
4911
|
add_operator=None,
|
|
4912
4912
|
add_operator_props=None,
|
|
4913
4913
|
):
|
|
@@ -4920,14 +4920,14 @@ class Menu(_GenericUI):
|
|
|
4920
4920
|
:param props_default: Properties to assign to each operator.
|
|
4921
4921
|
:type props_default: dict
|
|
4922
4922
|
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
4923
|
-
:type prop_filepath: str
|
|
4923
|
+
:type prop_filepath: str | None
|
|
4924
4924
|
:param filter_ext: Optional callback that takes the file extensions.
|
|
4925
4925
|
|
|
4926
4926
|
Returning false excludes the file from the list.
|
|
4927
|
-
:type filter_ext:
|
|
4927
|
+
:type filter_ext: collections.abc.Callable | None
|
|
4928
4928
|
:param filter_path:
|
|
4929
4929
|
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
4930
|
-
:type display_name:
|
|
4930
|
+
:type display_name: collections.abc.Callable | None
|
|
4931
4931
|
:param add_operator:
|
|
4932
4932
|
:param add_operator_props:
|
|
4933
4933
|
"""
|