fake-bpy-module 20240605__py3-none-any.whl → 20240607__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_i18n_utils/utils/__init__.pyi +7 -7
- bl_operators/connect_to_output/__init__.pyi +8 -8
- bl_operators/image_as_planes/__init__.pyi +295 -49
- bl_operators/node_editor/node_functions/__init__.pyi +0 -1
- bl_operators/view3d/__init__.pyi +195 -0
- bl_operators/wm/__init__.pyi +1 -1
- bmesh/ops/__init__.pyi +2 -2
- bmesh/types/__init__.pyi +5 -5
- bpy/app/handlers/__init__.pyi +40 -36
- bpy/msgbus/__init__.pyi +1 -1
- bpy/ops/export_scene/__init__.pyi +3 -0
- bpy/ops/extensions/__init__.pyi +3 -0
- bpy/ops/image/__init__.pyi +237 -105
- bpy/ops/import_scene/__init__.pyi +6 -0
- bpy/ops/object/__init__.pyi +0 -15
- bpy/ops/wm/__init__.pyi +11 -1
- bpy/props/__init__.pyi +20 -20
- bpy/types/__init__.pyi +21028 -20921
- bpy/utils/__init__.pyi +17 -2
- bpy_extras/asset_utils/__init__.pyi +0 -7
- bpy_extras/io_utils/__init__.pyi +1 -1
- {fake_bpy_module-20240605.dist-info → fake_bpy_module-20240607.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240605.dist-info → fake_bpy_module-20240607.dist-info}/RECORD +29 -29
- freestyle/utils/__init__.pyi +1 -1
- gpu/types/__init__.pyi +2 -2
- mathutils/__init__.pyi +3 -2
- rna_xml/__init__.pyi +1 -1
- {fake_bpy_module-20240605.dist-info → fake_bpy_module-20240607.dist-info}/WHEEL +0 -0
- {fake_bpy_module-20240605.dist-info → fake_bpy_module-20240607.dist-info}/top_level.txt +0 -0
bmesh/ops/__init__.pyi
CHANGED
|
@@ -767,7 +767,7 @@ def dissolve_limit(
|
|
|
767
767
|
use_dissolve_boundaries: bool = False,
|
|
768
768
|
verts: list[bmesh.types.BMVert] = [],
|
|
769
769
|
edges: list[bmesh.types.BMEdge] = [],
|
|
770
|
-
delimit=
|
|
770
|
+
delimit=set(),
|
|
771
771
|
) -> dict[str, typing.Any]:
|
|
772
772
|
"""Limited Dissolve.Dissolve planar faces and co-linear edges.
|
|
773
773
|
|
|
@@ -987,7 +987,7 @@ def extrude_face_region(
|
|
|
987
987
|
geom: list[bmesh.types.BMEdge]
|
|
988
988
|
| list[bmesh.types.BMFace]
|
|
989
989
|
| list[bmesh.types.BMVert] = [],
|
|
990
|
-
edges_exclude=
|
|
990
|
+
edges_exclude=set(),
|
|
991
991
|
use_keep_orig: bool = False,
|
|
992
992
|
use_normal_flip: bool = False,
|
|
993
993
|
use_normal_from_adjacent: bool = False,
|
bmesh/types/__init__.pyi
CHANGED
|
@@ -318,7 +318,7 @@ class BMEdgeSeq:
|
|
|
318
318
|
|
|
319
319
|
def sort(self, key=None, reverse: bool = False):
|
|
320
320
|
"""Sort the elements of this sequence, using an optional custom sort key.
|
|
321
|
-
Indices of elements are not changed,
|
|
321
|
+
Indices of elements are not changed, `BMElemSeq.index_update` can be used for that.
|
|
322
322
|
|
|
323
323
|
:param key: The key that sets the ordering of the elements.
|
|
324
324
|
:param reverse: Reverse the order of the elements
|
|
@@ -655,10 +655,10 @@ class BMFace:
|
|
|
655
655
|
...
|
|
656
656
|
|
|
657
657
|
class BMFaceSeq:
|
|
658
|
-
active: BMFace
|
|
658
|
+
active: BMFace | None
|
|
659
659
|
""" active face.
|
|
660
660
|
|
|
661
|
-
:type: BMFace
|
|
661
|
+
:type: BMFace | None
|
|
662
662
|
"""
|
|
663
663
|
|
|
664
664
|
layers: BMLayerAccessFace
|
|
@@ -708,7 +708,7 @@ class BMFaceSeq:
|
|
|
708
708
|
|
|
709
709
|
def sort(self, key=None, reverse: bool = False):
|
|
710
710
|
"""Sort the elements of this sequence, using an optional custom sort key.
|
|
711
|
-
Indices of elements are not changed,
|
|
711
|
+
Indices of elements are not changed, `BMElemSeq.index_update` can be used for that.
|
|
712
712
|
|
|
713
713
|
:param key: The key that sets the ordering of the elements.
|
|
714
714
|
:param reverse: Reverse the order of the elements
|
|
@@ -1459,7 +1459,7 @@ class BMVertSeq:
|
|
|
1459
1459
|
|
|
1460
1460
|
def sort(self, key=None, reverse: bool = False):
|
|
1461
1461
|
"""Sort the elements of this sequence, using an optional custom sort key.
|
|
1462
|
-
Indices of elements are not changed,
|
|
1462
|
+
Indices of elements are not changed, `BMElemSeq.index_update` can be used for that.
|
|
1463
1463
|
|
|
1464
1464
|
:param key: The key that sets the ordering of the elements.
|
|
1465
1465
|
:param reverse: Reverse the order of the elements
|
bpy/app/handlers/__init__.pyi
CHANGED
|
@@ -45,79 +45,83 @@ import bpy.types
|
|
|
45
45
|
|
|
46
46
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
47
47
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
48
|
-
animation_playback_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
48
|
+
animation_playback_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
49
49
|
""" on ending animation playback
|
|
50
50
|
"""
|
|
51
51
|
|
|
52
|
-
animation_playback_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
52
|
+
animation_playback_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
53
53
|
""" on starting animation playback
|
|
54
54
|
"""
|
|
55
55
|
|
|
56
|
-
annotation_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
56
|
+
annotation_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
57
57
|
""" on drawing an annotation (after)
|
|
58
58
|
"""
|
|
59
59
|
|
|
60
|
-
annotation_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
60
|
+
annotation_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
61
61
|
""" on drawing an annotation (before)
|
|
62
62
|
"""
|
|
63
63
|
|
|
64
|
-
composite_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
64
|
+
composite_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
65
65
|
""" on a compositing background job (cancel)
|
|
66
66
|
"""
|
|
67
67
|
|
|
68
|
-
composite_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
68
|
+
composite_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
69
69
|
""" on a compositing background job (after)
|
|
70
70
|
"""
|
|
71
71
|
|
|
72
|
-
composite_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
72
|
+
composite_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
73
73
|
""" on a compositing background job (before)
|
|
74
74
|
"""
|
|
75
75
|
|
|
76
|
-
depsgraph_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
76
|
+
depsgraph_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
77
77
|
""" on depsgraph update (post)
|
|
78
78
|
"""
|
|
79
79
|
|
|
80
|
-
depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
80
|
+
depsgraph_update_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
81
81
|
""" on depsgraph update (pre)
|
|
82
82
|
"""
|
|
83
83
|
|
|
84
|
-
frame_change_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
84
|
+
frame_change_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
85
85
|
""" Called after frame change for playback and rendering, after the data has been evaluated for the new frame.
|
|
86
86
|
"""
|
|
87
87
|
|
|
88
|
-
frame_change_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
88
|
+
frame_change_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
89
89
|
""" Called after frame change for playback and rendering, before any data is evaluated for the new frame. This makes it possible to change data and relations (for example swap an object to another mesh) for the new frame. Note that this handler is not to be used as 'before the frame changes' event. The dependency graph is not available in this handler, as data and relations may have been altered and the dependency graph has not yet been updated for that.
|
|
90
90
|
"""
|
|
91
91
|
|
|
92
|
-
load_factory_preferences_post: list[
|
|
92
|
+
load_factory_preferences_post: list[
|
|
93
|
+
collections.abc.Callable[[bpy.types.Scene], None]
|
|
94
|
+
] | None
|
|
93
95
|
""" on loading factory preferences (after)
|
|
94
96
|
"""
|
|
95
97
|
|
|
96
|
-
load_factory_startup_post: list[
|
|
98
|
+
load_factory_startup_post: list[
|
|
99
|
+
collections.abc.Callable[[bpy.types.Scene], None]
|
|
100
|
+
] | None
|
|
97
101
|
""" on loading factory startup (after)
|
|
98
102
|
"""
|
|
99
103
|
|
|
100
|
-
load_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
104
|
+
load_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
101
105
|
""" on loading a new blend file (after). Accepts one argument: the file being loaded, an empty string for the startup-file.
|
|
102
106
|
"""
|
|
103
107
|
|
|
104
|
-
load_post_fail: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
108
|
+
load_post_fail: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
105
109
|
""" on failure to load a new blend file (after). Accepts one argument: the file being loaded, an empty string for the startup-file.
|
|
106
110
|
"""
|
|
107
111
|
|
|
108
|
-
load_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
112
|
+
load_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
109
113
|
""" on loading a new blend file (before).Accepts one argument: the file being loaded, an empty string for the startup-file.
|
|
110
114
|
"""
|
|
111
115
|
|
|
112
|
-
object_bake_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
116
|
+
object_bake_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
113
117
|
""" on canceling a bake job; will be called in the main thread
|
|
114
118
|
"""
|
|
115
119
|
|
|
116
|
-
object_bake_complete: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
120
|
+
object_bake_complete: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
117
121
|
""" on completing a bake job; will be called in the main thread
|
|
118
122
|
"""
|
|
119
123
|
|
|
120
|
-
object_bake_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
124
|
+
object_bake_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
121
125
|
""" before starting a bake job
|
|
122
126
|
"""
|
|
123
127
|
|
|
@@ -125,70 +129,70 @@ persistent: typing.Any
|
|
|
125
129
|
""" Function decorator for callback functions not to be removed when loading new files
|
|
126
130
|
"""
|
|
127
131
|
|
|
128
|
-
redo_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
132
|
+
redo_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
129
133
|
""" on loading a redo step (after)
|
|
130
134
|
"""
|
|
131
135
|
|
|
132
|
-
redo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
136
|
+
redo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
133
137
|
""" on loading a redo step (before)
|
|
134
138
|
"""
|
|
135
139
|
|
|
136
|
-
render_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
140
|
+
render_cancel: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
137
141
|
""" on canceling a render job
|
|
138
142
|
"""
|
|
139
143
|
|
|
140
|
-
render_complete: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
144
|
+
render_complete: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
141
145
|
""" on completion of render job
|
|
142
146
|
"""
|
|
143
147
|
|
|
144
|
-
render_init: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
148
|
+
render_init: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
145
149
|
""" on initialization of a render job
|
|
146
150
|
"""
|
|
147
151
|
|
|
148
|
-
render_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
152
|
+
render_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
149
153
|
""" on render (after)
|
|
150
154
|
"""
|
|
151
155
|
|
|
152
|
-
render_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
156
|
+
render_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
153
157
|
""" on render (before)
|
|
154
158
|
"""
|
|
155
159
|
|
|
156
|
-
render_stats: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
160
|
+
render_stats: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
157
161
|
""" on printing render statistics. Accepts one argument: the render stats (render/saving time plus in background mode frame/used [peak] memory).
|
|
158
162
|
"""
|
|
159
163
|
|
|
160
|
-
render_write: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
164
|
+
render_write: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
161
165
|
""" on writing a render frame (directly after the frame is written)
|
|
162
166
|
"""
|
|
163
167
|
|
|
164
|
-
save_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
168
|
+
save_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
165
169
|
""" on saving a blend file (after). Accepts one argument: the file being saved, an empty string for the startup-file.
|
|
166
170
|
"""
|
|
167
171
|
|
|
168
|
-
save_post_fail: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
172
|
+
save_post_fail: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
169
173
|
""" on failure to save a blend file (after). Accepts one argument: the file being saved, an empty string for the startup-file.
|
|
170
174
|
"""
|
|
171
175
|
|
|
172
|
-
save_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
176
|
+
save_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
173
177
|
""" on saving a blend file (before). Accepts one argument: the file being saved, an empty string for the startup-file.
|
|
174
178
|
"""
|
|
175
179
|
|
|
176
|
-
translation_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
180
|
+
translation_update_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
177
181
|
""" on translation settings update
|
|
178
182
|
"""
|
|
179
183
|
|
|
180
|
-
undo_post: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
184
|
+
undo_post: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
181
185
|
""" on loading an undo step (after)
|
|
182
186
|
"""
|
|
183
187
|
|
|
184
|
-
undo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
188
|
+
undo_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
185
189
|
""" on loading an undo step (before)
|
|
186
190
|
"""
|
|
187
191
|
|
|
188
|
-
version_update: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
192
|
+
version_update: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
189
193
|
""" on ending the versioning code
|
|
190
194
|
"""
|
|
191
195
|
|
|
192
|
-
xr_session_start_pre: list[collections.abc.Callable[[bpy.types.Scene], None]]
|
|
196
|
+
xr_session_start_pre: list[collections.abc.Callable[[bpy.types.Scene], None]] | None
|
|
193
197
|
""" on starting an xr session (before)
|
|
194
198
|
"""
|
bpy/msgbus/__init__.pyi
CHANGED
|
@@ -70,7 +70,7 @@ def publish_rna(key):
|
|
|
70
70
|
|
|
71
71
|
...
|
|
72
72
|
|
|
73
|
-
def subscribe_rna(key, owner: typing.Any | None, args, notify, options=
|
|
73
|
+
def subscribe_rna(key, owner: typing.Any | None, args, notify, options=set()):
|
|
74
74
|
"""Register a message bus subscription. It will be cleared when another blend file is
|
|
75
75
|
loaded, or can be cleared explicitly via `bpy.msgbus.clear_by_owner`.
|
|
76
76
|
|
|
@@ -302,6 +302,7 @@ def gltf(
|
|
|
302
302
|
use_active_collection: bool | typing.Any | None = False,
|
|
303
303
|
use_active_scene: bool | typing.Any | None = False,
|
|
304
304
|
collection: str | typing.Any = "",
|
|
305
|
+
at_collection_center: bool | typing.Any | None = False,
|
|
305
306
|
export_extras: bool | typing.Any | None = False,
|
|
306
307
|
export_yup: bool | typing.Any | None = True,
|
|
307
308
|
export_apply: bool | typing.Any | None = False,
|
|
@@ -524,6 +525,8 @@ def gltf(
|
|
|
524
525
|
:type use_active_scene: bool | typing.Any | None
|
|
525
526
|
:param collection: Source Collection, Export only objects from this collection (and its children)
|
|
526
527
|
:type collection: str | typing.Any
|
|
528
|
+
:param at_collection_center: Export at Collection Center, Export at Collection center of mass of root objects of the collection
|
|
529
|
+
:type at_collection_center: bool | typing.Any | None
|
|
527
530
|
:param export_extras: Custom Properties, Export custom properties as glTF extras
|
|
528
531
|
:type export_extras: bool | typing.Any | None
|
|
529
532
|
:param export_yup: +Y Up, Export using glTF convention, +Y up
|
bpy/ops/extensions/__init__.pyi
CHANGED
|
@@ -57,6 +57,7 @@ def package_install(
|
|
|
57
57
|
pkg_id: str | typing.Any = "",
|
|
58
58
|
enable_on_install: bool | typing.Any | None = True,
|
|
59
59
|
url: str | typing.Any = "",
|
|
60
|
+
do_legacy_replace: bool | typing.Any | None = False,
|
|
60
61
|
):
|
|
61
62
|
"""Download and install the extension
|
|
62
63
|
|
|
@@ -73,6 +74,8 @@ def package_install(
|
|
|
73
74
|
:type enable_on_install: bool | typing.Any | None
|
|
74
75
|
:param url: URL
|
|
75
76
|
:type url: str | typing.Any
|
|
77
|
+
:param do_legacy_replace: Do Legacy Replace
|
|
78
|
+
:type do_legacy_replace: bool | typing.Any | None
|
|
76
79
|
"""
|
|
77
80
|
|
|
78
81
|
...
|
bpy/ops/image/__init__.pyi
CHANGED
|
@@ -93,6 +93,138 @@ def clipboard_paste(
|
|
|
93
93
|
|
|
94
94
|
...
|
|
95
95
|
|
|
96
|
+
def convert_to_mesh_plane(
|
|
97
|
+
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
98
|
+
execution_context: int | str | None = None,
|
|
99
|
+
undo: bool | None = None,
|
|
100
|
+
*,
|
|
101
|
+
interpolation: str | None = "Linear",
|
|
102
|
+
extension: str | None = "CLIP",
|
|
103
|
+
alpha_mode: str | None = "STRAIGHT",
|
|
104
|
+
use_auto_refresh: bool | typing.Any | None = True,
|
|
105
|
+
relative: bool | typing.Any | None = True,
|
|
106
|
+
shader: str | None = "PRINCIPLED",
|
|
107
|
+
emit_strength: typing.Any | None = 1.0,
|
|
108
|
+
use_transparency: bool | typing.Any | None = True,
|
|
109
|
+
blend_method: str | None = "BLEND",
|
|
110
|
+
shadow_method: str | None = "CLIP",
|
|
111
|
+
use_backface_culling: bool | typing.Any | None = False,
|
|
112
|
+
show_transparent_back: bool | typing.Any | None = True,
|
|
113
|
+
overwrite_material: bool | typing.Any | None = True,
|
|
114
|
+
name_from: str | None = "OBJECT",
|
|
115
|
+
delete_ref: bool | typing.Any | None = True,
|
|
116
|
+
):
|
|
117
|
+
"""Convert selected reference images to textured mesh plane
|
|
118
|
+
|
|
119
|
+
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
120
|
+
:type execution_context: int | str | None
|
|
121
|
+
:type undo: bool | None
|
|
122
|
+
:param interpolation: Interpolation, Texture interpolation
|
|
123
|
+
|
|
124
|
+
Linear
|
|
125
|
+
Linear -- Linear interpolation.
|
|
126
|
+
|
|
127
|
+
Closest
|
|
128
|
+
Closest -- No interpolation (sample closest texel).
|
|
129
|
+
|
|
130
|
+
Cubic
|
|
131
|
+
Cubic -- Cubic interpolation.
|
|
132
|
+
|
|
133
|
+
Smart
|
|
134
|
+
Smart -- Bicubic when magnifying, else bilinear (OSL only).
|
|
135
|
+
:type interpolation: str | None
|
|
136
|
+
:param extension: Extension, How the image is extrapolated past its original bounds
|
|
137
|
+
|
|
138
|
+
CLIP
|
|
139
|
+
Clip -- Clip to image size and set exterior pixels as transparent.
|
|
140
|
+
|
|
141
|
+
EXTEND
|
|
142
|
+
Extend -- Extend by repeating edge pixels of the image.
|
|
143
|
+
|
|
144
|
+
REPEAT
|
|
145
|
+
Repeat -- Cause the image to repeat horizontally and vertically.
|
|
146
|
+
:type extension: str | None
|
|
147
|
+
:param alpha_mode: Alpha Mode, Representation of alpha in the image file, to convert to and from when saving and loading the image
|
|
148
|
+
|
|
149
|
+
STRAIGHT
|
|
150
|
+
Straight -- Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha. Commonly used by image editing applications and file formats like PNG.
|
|
151
|
+
|
|
152
|
+
PREMUL
|
|
153
|
+
Premultiplied -- Store RGB channels with alpha multiplied in, also known as associated alpha. The natural format for renders and used by file formats like OpenEXR.
|
|
154
|
+
|
|
155
|
+
CHANNEL_PACKED
|
|
156
|
+
Channel Packed -- Different images are packed in the RGB and alpha channels, and they should not affect each other. Channel packing is commonly used by game engines to save memory.
|
|
157
|
+
|
|
158
|
+
NONE
|
|
159
|
+
None -- Ignore alpha channel from the file and make image fully opaque.
|
|
160
|
+
:type alpha_mode: str | None
|
|
161
|
+
:param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
|
|
162
|
+
:type use_auto_refresh: bool | typing.Any | None
|
|
163
|
+
:param relative: Relative Paths, Use relative file paths
|
|
164
|
+
:type relative: bool | typing.Any | None
|
|
165
|
+
:param shader: Shader, Node shader to use
|
|
166
|
+
|
|
167
|
+
PRINCIPLED
|
|
168
|
+
Principled -- Principled shader.
|
|
169
|
+
|
|
170
|
+
SHADELESS
|
|
171
|
+
Shadeless -- Only visible to camera and reflections.
|
|
172
|
+
|
|
173
|
+
EMISSION
|
|
174
|
+
Emission -- Emission shader.
|
|
175
|
+
:type shader: str | None
|
|
176
|
+
:param emit_strength: Emission Strength, Strength of emission
|
|
177
|
+
:type emit_strength: typing.Any | None
|
|
178
|
+
:param use_transparency: Use Alpha, Use alpha channel for transparency
|
|
179
|
+
:type use_transparency: bool | typing.Any | None
|
|
180
|
+
:param blend_method: Blend Mode, Blend Mode for Transparent Faces
|
|
181
|
+
|
|
182
|
+
BLEND
|
|
183
|
+
Blend -- Render polygon transparent, depending on alpha channel of the texture.
|
|
184
|
+
|
|
185
|
+
CLIP
|
|
186
|
+
Clip -- Use the alpha threshold to clip the visibility (binary visibility).
|
|
187
|
+
|
|
188
|
+
HASHED
|
|
189
|
+
Hashed -- Use noise to dither the binary visibility (works well with multi-samples).
|
|
190
|
+
|
|
191
|
+
OPAQUE
|
|
192
|
+
Opaque -- Render surface without transparency.
|
|
193
|
+
:type blend_method: str | None
|
|
194
|
+
:param shadow_method: Shadow Mode, Shadow mapping method
|
|
195
|
+
|
|
196
|
+
CLIP
|
|
197
|
+
Clip -- Use the alpha threshold to clip the visibility (binary visibility).
|
|
198
|
+
|
|
199
|
+
HASHED
|
|
200
|
+
Hashed -- Use noise to dither the binary visibility (works well with multi-samples).
|
|
201
|
+
|
|
202
|
+
OPAQUE
|
|
203
|
+
Opaque -- Material will cast shadows without transparency.
|
|
204
|
+
|
|
205
|
+
NONE
|
|
206
|
+
None -- Material will cast no shadow.
|
|
207
|
+
:type shadow_method: str | None
|
|
208
|
+
:param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
|
|
209
|
+
:type use_backface_culling: bool | typing.Any | None
|
|
210
|
+
:param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
|
|
211
|
+
:type show_transparent_back: bool | typing.Any | None
|
|
212
|
+
:param overwrite_material: Overwrite Material, Overwrite existing material with the same name
|
|
213
|
+
:type overwrite_material: bool | typing.Any | None
|
|
214
|
+
:param name_from: Name After, Name for new mesh object and material
|
|
215
|
+
|
|
216
|
+
OBJECT
|
|
217
|
+
Source Object -- Name after object source with a suffix.
|
|
218
|
+
|
|
219
|
+
IMAGE
|
|
220
|
+
Source Image -- name from laoded image.
|
|
221
|
+
:type name_from: str | None
|
|
222
|
+
:param delete_ref: Delete Reference Object, Delete empty image object once mesh plane is created
|
|
223
|
+
:type delete_ref: bool | typing.Any | None
|
|
224
|
+
"""
|
|
225
|
+
|
|
226
|
+
...
|
|
227
|
+
|
|
96
228
|
def curves_point_set(
|
|
97
229
|
override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
|
|
98
230
|
execution_context: int | str | None = None,
|
|
@@ -281,6 +413,19 @@ def import_as_mesh_planes(
|
|
|
281
413
|
execution_context: int | str | None = None,
|
|
282
414
|
undo: bool | None = None,
|
|
283
415
|
*,
|
|
416
|
+
interpolation: str | None = "Linear",
|
|
417
|
+
extension: str | None = "CLIP",
|
|
418
|
+
alpha_mode: str | None = "STRAIGHT",
|
|
419
|
+
use_auto_refresh: bool | typing.Any | None = True,
|
|
420
|
+
relative: bool | typing.Any | None = True,
|
|
421
|
+
shader: str | None = "PRINCIPLED",
|
|
422
|
+
emit_strength: typing.Any | None = 1.0,
|
|
423
|
+
use_transparency: bool | typing.Any | None = True,
|
|
424
|
+
blend_method: str | None = "BLEND",
|
|
425
|
+
shadow_method: str | None = "CLIP",
|
|
426
|
+
use_backface_culling: bool | typing.Any | None = False,
|
|
427
|
+
show_transparent_back: bool | typing.Any | None = True,
|
|
428
|
+
overwrite_material: bool | typing.Any | None = True,
|
|
284
429
|
filepath: str | typing.Any = "",
|
|
285
430
|
align: str | None = "WORLD",
|
|
286
431
|
location: typing.Any | None = (0.0, 0.0, 0.0),
|
|
@@ -303,25 +448,104 @@ def import_as_mesh_planes(
|
|
|
303
448
|
fill_mode: str | None = "FILL",
|
|
304
449
|
height: typing.Any | None = 1.0,
|
|
305
450
|
factor: typing.Any | None = 600.0,
|
|
306
|
-
shader: str | None = "PRINCIPLED",
|
|
307
|
-
emit_strength: typing.Any | None = 1.0,
|
|
308
|
-
use_transparency: bool | typing.Any | None = True,
|
|
309
|
-
blend_method: str | None = "BLEND",
|
|
310
|
-
shadow_method: str | None = "CLIP",
|
|
311
|
-
use_backface_culling: bool | typing.Any | None = False,
|
|
312
|
-
show_transparent_back: bool | typing.Any | None = True,
|
|
313
|
-
overwrite_material: bool | typing.Any | None = True,
|
|
314
|
-
interpolation: str | None = "Linear",
|
|
315
|
-
extension: str | None = "CLIP",
|
|
316
|
-
alpha_mode: str | None = "STRAIGHT",
|
|
317
|
-
use_auto_refresh: bool | typing.Any | None = True,
|
|
318
|
-
relative: bool | typing.Any | None = True,
|
|
319
451
|
):
|
|
320
452
|
"""Create mesh plane(s) from image files with the appropriate aspect ratio
|
|
321
453
|
|
|
322
454
|
:type override_context: bpy.types.Context | dict[str, typing.Any] | None
|
|
323
455
|
:type execution_context: int | str | None
|
|
324
456
|
:type undo: bool | None
|
|
457
|
+
:param interpolation: Interpolation, Texture interpolation
|
|
458
|
+
|
|
459
|
+
Linear
|
|
460
|
+
Linear -- Linear interpolation.
|
|
461
|
+
|
|
462
|
+
Closest
|
|
463
|
+
Closest -- No interpolation (sample closest texel).
|
|
464
|
+
|
|
465
|
+
Cubic
|
|
466
|
+
Cubic -- Cubic interpolation.
|
|
467
|
+
|
|
468
|
+
Smart
|
|
469
|
+
Smart -- Bicubic when magnifying, else bilinear (OSL only).
|
|
470
|
+
:type interpolation: str | None
|
|
471
|
+
:param extension: Extension, How the image is extrapolated past its original bounds
|
|
472
|
+
|
|
473
|
+
CLIP
|
|
474
|
+
Clip -- Clip to image size and set exterior pixels as transparent.
|
|
475
|
+
|
|
476
|
+
EXTEND
|
|
477
|
+
Extend -- Extend by repeating edge pixels of the image.
|
|
478
|
+
|
|
479
|
+
REPEAT
|
|
480
|
+
Repeat -- Cause the image to repeat horizontally and vertically.
|
|
481
|
+
:type extension: str | None
|
|
482
|
+
:param alpha_mode: Alpha Mode, Representation of alpha in the image file, to convert to and from when saving and loading the image
|
|
483
|
+
|
|
484
|
+
STRAIGHT
|
|
485
|
+
Straight -- Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha. Commonly used by image editing applications and file formats like PNG.
|
|
486
|
+
|
|
487
|
+
PREMUL
|
|
488
|
+
Premultiplied -- Store RGB channels with alpha multiplied in, also known as associated alpha. The natural format for renders and used by file formats like OpenEXR.
|
|
489
|
+
|
|
490
|
+
CHANNEL_PACKED
|
|
491
|
+
Channel Packed -- Different images are packed in the RGB and alpha channels, and they should not affect each other. Channel packing is commonly used by game engines to save memory.
|
|
492
|
+
|
|
493
|
+
NONE
|
|
494
|
+
None -- Ignore alpha channel from the file and make image fully opaque.
|
|
495
|
+
:type alpha_mode: str | None
|
|
496
|
+
:param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
|
|
497
|
+
:type use_auto_refresh: bool | typing.Any | None
|
|
498
|
+
:param relative: Relative Paths, Use relative file paths
|
|
499
|
+
:type relative: bool | typing.Any | None
|
|
500
|
+
:param shader: Shader, Node shader to use
|
|
501
|
+
|
|
502
|
+
PRINCIPLED
|
|
503
|
+
Principled -- Principled shader.
|
|
504
|
+
|
|
505
|
+
SHADELESS
|
|
506
|
+
Shadeless -- Only visible to camera and reflections.
|
|
507
|
+
|
|
508
|
+
EMISSION
|
|
509
|
+
Emission -- Emission shader.
|
|
510
|
+
:type shader: str | None
|
|
511
|
+
:param emit_strength: Emission Strength, Strength of emission
|
|
512
|
+
:type emit_strength: typing.Any | None
|
|
513
|
+
:param use_transparency: Use Alpha, Use alpha channel for transparency
|
|
514
|
+
:type use_transparency: bool | typing.Any | None
|
|
515
|
+
:param blend_method: Blend Mode, Blend Mode for Transparent Faces
|
|
516
|
+
|
|
517
|
+
BLEND
|
|
518
|
+
Blend -- Render polygon transparent, depending on alpha channel of the texture.
|
|
519
|
+
|
|
520
|
+
CLIP
|
|
521
|
+
Clip -- Use the alpha threshold to clip the visibility (binary visibility).
|
|
522
|
+
|
|
523
|
+
HASHED
|
|
524
|
+
Hashed -- Use noise to dither the binary visibility (works well with multi-samples).
|
|
525
|
+
|
|
526
|
+
OPAQUE
|
|
527
|
+
Opaque -- Render surface without transparency.
|
|
528
|
+
:type blend_method: str | None
|
|
529
|
+
:param shadow_method: Shadow Mode, Shadow mapping method
|
|
530
|
+
|
|
531
|
+
CLIP
|
|
532
|
+
Clip -- Use the alpha threshold to clip the visibility (binary visibility).
|
|
533
|
+
|
|
534
|
+
HASHED
|
|
535
|
+
Hashed -- Use noise to dither the binary visibility (works well with multi-samples).
|
|
536
|
+
|
|
537
|
+
OPAQUE
|
|
538
|
+
Opaque -- Material will cast shadows without transparency.
|
|
539
|
+
|
|
540
|
+
NONE
|
|
541
|
+
None -- Material will cast no shadow.
|
|
542
|
+
:type shadow_method: str | None
|
|
543
|
+
:param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
|
|
544
|
+
:type use_backface_culling: bool | typing.Any | None
|
|
545
|
+
:param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
|
|
546
|
+
:type show_transparent_back: bool | typing.Any | None
|
|
547
|
+
:param overwrite_material: Overwrite Material, Overwrite existing material with the same name
|
|
548
|
+
:type overwrite_material: bool | typing.Any | None
|
|
325
549
|
:param filepath: File Path, Filepath used for importing the file
|
|
326
550
|
:type filepath: str | typing.Any
|
|
327
551
|
:param align: Align
|
|
@@ -460,98 +684,6 @@ def import_as_mesh_planes(
|
|
|
460
684
|
:type height: typing.Any | None
|
|
461
685
|
:param factor: Definition, Number of pixels per inch or Blender Unit
|
|
462
686
|
:type factor: typing.Any | None
|
|
463
|
-
:param shader: Shader, Node shader to use
|
|
464
|
-
|
|
465
|
-
PRINCIPLED
|
|
466
|
-
Principled -- Principled Shader.
|
|
467
|
-
|
|
468
|
-
SHADELESS
|
|
469
|
-
Shadeless -- Only visible to camera and reflections.
|
|
470
|
-
|
|
471
|
-
EMISSION
|
|
472
|
-
Emit -- Emission Shader.
|
|
473
|
-
:type shader: str | None
|
|
474
|
-
:param emit_strength: Emission Strength, Strength of emission
|
|
475
|
-
:type emit_strength: typing.Any | None
|
|
476
|
-
:param use_transparency: Use Alpha, Use alpha channel for transparency
|
|
477
|
-
:type use_transparency: bool | typing.Any | None
|
|
478
|
-
:param blend_method: Blend Mode, Blend Mode for Transparent Faces
|
|
479
|
-
|
|
480
|
-
BLEND
|
|
481
|
-
Blend -- Render polygon transparent, depending on alpha channel of the texture.
|
|
482
|
-
|
|
483
|
-
CLIP
|
|
484
|
-
Clip -- Use the alpha threshold to clip the visibility (binary visibility).
|
|
485
|
-
|
|
486
|
-
HASHED
|
|
487
|
-
Hashed -- Use noise to dither the binary visibility (works well with multi-samples).
|
|
488
|
-
|
|
489
|
-
OPAQUE
|
|
490
|
-
Opaque -- Render surface without transparency.
|
|
491
|
-
:type blend_method: str | None
|
|
492
|
-
:param shadow_method: Shadow Mode, Shadow mapping method
|
|
493
|
-
|
|
494
|
-
CLIP
|
|
495
|
-
Clip -- Use the alpha threshold to clip the visibility (binary visibility).
|
|
496
|
-
|
|
497
|
-
HASHED
|
|
498
|
-
Hashed -- Use noise to dither the binary visibility (works well with multi-samples).
|
|
499
|
-
|
|
500
|
-
OPAQUE
|
|
501
|
-
Opaque -- Material will cast shadows without transparency.
|
|
502
|
-
|
|
503
|
-
NONE
|
|
504
|
-
None -- Material will cast no shadow.
|
|
505
|
-
:type shadow_method: str | None
|
|
506
|
-
:param use_backface_culling: Backface Culling, Use backface culling to hide the back side of faces
|
|
507
|
-
:type use_backface_culling: bool | typing.Any | None
|
|
508
|
-
:param show_transparent_back: Show Backface, Render multiple transparent layers (may introduce transparency sorting problems)
|
|
509
|
-
:type show_transparent_back: bool | typing.Any | None
|
|
510
|
-
:param overwrite_material: Overwrite Material, Overwrite existing material with the same name
|
|
511
|
-
:type overwrite_material: bool | typing.Any | None
|
|
512
|
-
:param interpolation: Interpolation, Texture interpolation
|
|
513
|
-
|
|
514
|
-
Linear
|
|
515
|
-
Linear -- Linear interpolation.
|
|
516
|
-
|
|
517
|
-
Closest
|
|
518
|
-
Closest -- No interpolation (sample closest texel).
|
|
519
|
-
|
|
520
|
-
Cubic
|
|
521
|
-
Cubic -- Cubic interpolation.
|
|
522
|
-
|
|
523
|
-
Smart
|
|
524
|
-
Smart -- Bicubic when magnifying, else bilinear (OSL only).
|
|
525
|
-
:type interpolation: str | None
|
|
526
|
-
:param extension: Extension, How the image is extrapolated past its original bounds
|
|
527
|
-
|
|
528
|
-
CLIP
|
|
529
|
-
Clip -- Clip to image size and set exterior pixels as transparent.
|
|
530
|
-
|
|
531
|
-
EXTEND
|
|
532
|
-
Extend -- Extend by repeating edge pixels of the image.
|
|
533
|
-
|
|
534
|
-
REPEAT
|
|
535
|
-
Repeat -- Cause the image to repeat horizontally and vertically.
|
|
536
|
-
:type extension: str | None
|
|
537
|
-
:param alpha_mode: Alpha Mode, Representation of alpha in the image file, to convert to and from when saving and loading the image
|
|
538
|
-
|
|
539
|
-
STRAIGHT
|
|
540
|
-
Straight -- Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha. Commonly used by image editing applications and file formats like PNG.
|
|
541
|
-
|
|
542
|
-
PREMUL
|
|
543
|
-
Premultiplied -- Store RGB channels with alpha multiplied in, also known as associated alpha. The natural format for renders and used by file formats like OpenEXR.
|
|
544
|
-
|
|
545
|
-
CHANNEL_PACKED
|
|
546
|
-
Channel Packed -- Different images are packed in the RGB and alpha channels, and they should not affect each other. Channel packing is commonly used by game engines to save memory.
|
|
547
|
-
|
|
548
|
-
NONE
|
|
549
|
-
None -- Ignore alpha channel from the file and make image fully opaque.
|
|
550
|
-
:type alpha_mode: str | None
|
|
551
|
-
:param use_auto_refresh: Auto Refresh, Always refresh image on frame changes
|
|
552
|
-
:type use_auto_refresh: bool | typing.Any | None
|
|
553
|
-
:param relative: Relative Paths, Use relative file paths
|
|
554
|
-
:type relative: bool | typing.Any | None
|
|
555
687
|
"""
|
|
556
688
|
|
|
557
689
|
...
|