fake-bpy-module 20240718__py3-none-any.whl → 20240720__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_operators/add_mesh_torus/__init__.pyi +1 -190
- bl_operators/anim/__init__.pyi +104 -1504
- bl_operators/assets/__init__.pyi +3 -535
- bl_operators/bone_selection_sets/__init__.pyi +187 -2680
- bl_operators/clip/__init__.pyi +144 -1894
- bl_operators/connect_to_output/__init__.pyi +3 -176
- bl_operators/console/__init__.pyi +5 -880
- bl_operators/constraint/__init__.pyi +4 -704
- bl_operators/file/__init__.pyi +3 -528
- bl_operators/freestyle/__init__.pyi +4 -704
- bl_operators/geometry_nodes/__init__.pyi +4 -704
- bl_operators/image/__init__.pyi +5 -869
- bl_operators/image_as_planes/__init__.pyi +4 -424
- bl_operators/mesh/__init__.pyi +3 -528
- bl_operators/node/__init__.pyi +159 -2065
- bl_operators/object/__init__.pyi +217 -2842
- bl_operators/object_align/__init__.pyi +1 -176
- bl_operators/object_quick_effects/__init__.pyi +4 -725
- bl_operators/object_randomize_transform/__init__.pyi +1 -176
- bl_operators/presets/__init__.pyi +405 -5487
- bl_operators/rigidbody/__init__.pyi +3 -528
- bl_operators/screen_play_rendered_anim/__init__.pyi +1 -176
- bl_operators/sequencer/__init__.pyi +119 -1507
- bl_operators/spreadsheet/__init__.pyi +1 -176
- bl_operators/userpref/__init__.pyi +383 -4757
- bl_operators/uvcalc_follow_active/__init__.pyi +1 -176
- bl_operators/uvcalc_lightmap/__init__.pyi +1 -176
- bl_operators/uvcalc_transform/__init__.pyi +2 -352
- bl_operators/vertexpaint_dirt/__init__.pyi +1 -176
- bl_operators/view3d/__init__.pyi +101 -1468
- bl_operators/wm/__init__.pyi +723 -8894
- bl_operators/world/__init__.pyi +1 -176
- bl_ui/__init__.pyi +3 -534
- bl_ui/anim/__init__.pyi +1 -244
- bl_ui/asset_shelf/__init__.pyi +1 -189
- bl_ui/generic_ui_list/__init__.pyi +3 -594
- bl_ui/node_add_menu/__init__.pyi +1 -244
- bl_ui/node_add_menu_compositor/__init__.pyi +226 -4600
- bl_ui/node_add_menu_geometry/__init__.pyi +654 -12802
- bl_ui/node_add_menu_shader/__init__.pyi +94 -2531
- bl_ui/node_add_menu_texture/__init__.pyi +81 -2268
- bl_ui/properties_collection/__init__.pyi +58 -1272
- bl_ui/properties_constraint/__init__.pyi +1508 -32656
- bl_ui/properties_data_armature/__init__.pyi +278 -3804
- bl_ui/properties_data_bone/__init__.pyi +151 -2062
- bl_ui/properties_data_camera/__init__.pyi +216 -3034
- bl_ui/properties_data_curve/__init__.pyi +214 -3117
- bl_ui/properties_data_curves/__init__.pyi +57 -1273
- bl_ui/properties_data_empty/__init__.pyi +2 -385
- bl_ui/properties_data_gpencil/__init__.pyi +285 -3922
- bl_ui/properties_data_grease_pencil/__init__.pyi +198 -3081
- bl_ui/properties_data_lattice/__init__.pyi +3 -595
- bl_ui/properties_data_light/__init__.pyi +200 -2502
- bl_ui/properties_data_lightprobe/__init__.pyi +212 -2704
- bl_ui/properties_data_mesh/__init__.pyi +323 -4380
- bl_ui/properties_data_metaball/__init__.pyi +38 -1011
- bl_ui/properties_data_modifier/__init__.pyi +157 -2451
- bl_ui/properties_data_pointcloud/__init__.pyi +68 -1087
- bl_ui/properties_data_shaderfx/__init__.pyi +1 -189
- bl_ui/properties_data_speaker/__init__.pyi +36 -1018
- bl_ui/properties_data_volume/__init__.pyi +104 -1660
- bl_ui/properties_freestyle/__init__.pyi +438 -5136
- bl_ui/properties_grease_pencil_common/__init__.pyi +197 -3852
- bl_ui/properties_mask_common/__init__.pyi +59 -1705
- bl_ui/properties_material/__init__.pyi +227 -3334
- bl_ui/properties_material_gpencil/__init__.pyi +187 -2221
- bl_ui/properties_object/__init__.pyi +197 -2908
- bl_ui/properties_output/__init__.pyi +286 -3895
- bl_ui/properties_paint_common/__init__.pyi +40 -923
- bl_ui/properties_particle/__init__.pyi +954 -10839
- bl_ui/properties_physics_cloth/__init__.pyi +219 -2979
- bl_ui/properties_physics_common/__init__.pyi +1 -196
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +429 -5411
- bl_ui/properties_physics_field/__init__.pyi +160 -2166
- bl_ui/properties_physics_fluid/__init__.pyi +541 -7352
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +1 -189
- bl_ui/properties_physics_rigidbody/__init__.pyi +125 -1623
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +196 -2640
- bl_ui/properties_physics_softbody/__init__.pyi +238 -3135
- bl_ui/properties_render/__init__.pyi +1065 -11565
- bl_ui/properties_scene/__init__.pyi +209 -3090
- bl_ui/properties_texture/__init__.pyi +426 -5475
- bl_ui/properties_view_layer/__init__.pyi +264 -3827
- bl_ui/properties_workspace/__init__.pyi +7 -770
- bl_ui/properties_world/__init__.pyi +147 -2056
- bl_ui/space_clip/__init__.pyi +1013 -16279
- bl_ui/space_console/__init__.pyi +39 -1442
- bl_ui/space_dopesheet/__init__.pyi +450 -7213
- bl_ui/space_filebrowser/__init__.pyi +406 -6708
- bl_ui/space_graph/__init__.pyi +223 -4886
- bl_ui/space_image/__init__.pyi +1091 -16394
- bl_ui/space_info/__init__.pyi +39 -1442
- bl_ui/space_nla/__init__.pyi +216 -4157
- bl_ui/space_node/__init__.pyi +394 -6344
- bl_ui/space_outliner/__init__.pyi +156 -3448
- bl_ui/space_properties/__init__.pyi +3 -567
- bl_ui/space_sequencer/__init__.pyi +1224 -18036
- bl_ui/space_spreadsheet/__init__.pyi +1 -189
- bl_ui/space_statusbar/__init__.pyi +1 -189
- bl_ui/space_text/__init__.pyi +183 -3851
- bl_ui/space_time/__init__.pyi +69 -1622
- bl_ui/space_toolsystem_common/__init__.pyi +2 -118
- bl_ui/space_toolsystem_toolbar/__init__.pyi +13 -476
- bl_ui/space_topbar/__init__.pyi +322 -6269
- bl_ui/space_userpref/__init__.pyi +1758 -19735
- bl_ui/space_view3d/__init__.pyi +3853 -67593
- bl_ui/space_view3d_toolbar/__init__.pyi +1948 -23558
- bl_ui/temp_anim_layers/__init__.pyi +1 -189
- bl_ui/utils/__init__.pyi +0 -35
- bpy/ops/outliner/__init__.pyi +0 -1
- bpy/ops/sound/__init__.pyi +37 -7
- bpy/types/__init__.pyi +65 -8
- bpy_extras/node_shader_utils/__init__.pyi +0 -8
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/RECORD +120 -120
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/WHEEL +1 -1
- freestyle/utils/__init__.pyi +1 -1
- keyingsets_builtins/__init__.pyi +268 -4448
- nodeitems_builtins/__init__.pyi +1 -7
- {fake_bpy_module-20240718.dist-info → fake_bpy_module-20240720.dist-info}/top_level.txt +0 -0
bl_ui/space_info/__init__.pyi
CHANGED
|
@@ -7,27 +7,11 @@ import bpy_types
|
|
|
7
7
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
8
8
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
9
9
|
|
|
10
|
-
class INFO_HT_header(bpy_types._GenericUI):
|
|
10
|
+
class INFO_HT_header(bpy.types.Header, bpy_types._GenericUI):
|
|
11
11
|
bl_rna: typing.Any
|
|
12
12
|
bl_space_type: typing.Any
|
|
13
13
|
id_data: typing.Any
|
|
14
14
|
|
|
15
|
-
def append(self, draw_func):
|
|
16
|
-
"""Append a draw function to this menu,
|
|
17
|
-
takes the same arguments as the menus draw function
|
|
18
|
-
|
|
19
|
-
:param draw_func:
|
|
20
|
-
"""
|
|
21
|
-
...
|
|
22
|
-
|
|
23
|
-
def as_pointer(self) -> int:
|
|
24
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
25
|
-
|
|
26
|
-
:return: int (memory address).
|
|
27
|
-
:rtype: int
|
|
28
|
-
"""
|
|
29
|
-
...
|
|
30
|
-
|
|
31
15
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
32
16
|
"""
|
|
33
17
|
|
|
@@ -51,200 +35,12 @@ class INFO_HT_header(bpy_types._GenericUI):
|
|
|
51
35
|
"""
|
|
52
36
|
...
|
|
53
37
|
|
|
54
|
-
|
|
55
|
-
"""Adds driver(s) to the given property
|
|
56
|
-
|
|
57
|
-
:return: The driver(s) added.
|
|
58
|
-
:rtype: bpy.types.FCurve
|
|
59
|
-
"""
|
|
60
|
-
...
|
|
61
|
-
|
|
62
|
-
def driver_remove(self) -> bool:
|
|
63
|
-
"""Remove driver(s) from the given property
|
|
64
|
-
|
|
65
|
-
:return: Success of driver removal.
|
|
66
|
-
:rtype: bool
|
|
67
|
-
"""
|
|
68
|
-
...
|
|
69
|
-
|
|
70
|
-
def get(self):
|
|
71
|
-
"""Returns the value of the custom property assigned to key or default
|
|
72
|
-
when not found (matches Python's dictionary function of the same name).
|
|
73
|
-
|
|
74
|
-
"""
|
|
75
|
-
...
|
|
76
|
-
|
|
77
|
-
def id_properties_clear(self):
|
|
78
|
-
"""
|
|
79
|
-
|
|
80
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
81
|
-
"""
|
|
82
|
-
...
|
|
83
|
-
|
|
84
|
-
def id_properties_ensure(self):
|
|
85
|
-
"""
|
|
86
|
-
|
|
87
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
88
|
-
"""
|
|
89
|
-
...
|
|
90
|
-
|
|
91
|
-
def id_properties_ui(self):
|
|
92
|
-
"""
|
|
93
|
-
|
|
94
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
95
|
-
"""
|
|
96
|
-
...
|
|
97
|
-
|
|
98
|
-
def is_extended(self): ...
|
|
99
|
-
def is_property_hidden(self) -> bool:
|
|
100
|
-
"""Check if a property is hidden.
|
|
101
|
-
|
|
102
|
-
:return: True when the property is hidden.
|
|
103
|
-
:rtype: bool
|
|
104
|
-
"""
|
|
105
|
-
...
|
|
106
|
-
|
|
107
|
-
def is_property_overridable_library(self) -> bool:
|
|
108
|
-
"""Check if a property is overridable.
|
|
109
|
-
|
|
110
|
-
:return: True when the property is overridable.
|
|
111
|
-
:rtype: bool
|
|
112
|
-
"""
|
|
113
|
-
...
|
|
114
|
-
|
|
115
|
-
def is_property_readonly(self) -> bool:
|
|
116
|
-
"""Check if a property is readonly.
|
|
117
|
-
|
|
118
|
-
:return: True when the property is readonly (not writable).
|
|
119
|
-
:rtype: bool
|
|
120
|
-
"""
|
|
121
|
-
...
|
|
122
|
-
|
|
123
|
-
def is_property_set(self) -> bool:
|
|
124
|
-
"""Check if a property is set, use for testing operator properties.
|
|
125
|
-
|
|
126
|
-
:return: True when the property has been set.
|
|
127
|
-
:rtype: bool
|
|
128
|
-
"""
|
|
129
|
-
...
|
|
130
|
-
|
|
131
|
-
def items(self):
|
|
132
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
133
|
-
dictionary function of the same name).
|
|
134
|
-
|
|
135
|
-
:return: custom property key, value pairs.
|
|
136
|
-
"""
|
|
137
|
-
...
|
|
138
|
-
|
|
139
|
-
def keyframe_delete(self) -> bool:
|
|
140
|
-
"""Remove a keyframe from this properties fcurve.
|
|
141
|
-
|
|
142
|
-
:return: Success of keyframe deletion.
|
|
143
|
-
:rtype: bool
|
|
144
|
-
"""
|
|
145
|
-
...
|
|
146
|
-
|
|
147
|
-
def keyframe_insert(self) -> bool:
|
|
148
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
149
|
-
|
|
150
|
-
:return: Success of keyframe insertion.
|
|
151
|
-
:rtype: bool
|
|
152
|
-
"""
|
|
153
|
-
...
|
|
154
|
-
|
|
155
|
-
def keys(self):
|
|
156
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
157
|
-
dictionary function of the same name).
|
|
158
|
-
|
|
159
|
-
:return: custom property keys.
|
|
160
|
-
"""
|
|
161
|
-
...
|
|
162
|
-
|
|
163
|
-
def path_from_id(self) -> str:
|
|
164
|
-
"""Returns the data path from the ID to this object (string).
|
|
165
|
-
|
|
166
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
167
|
-
to this struct and property (when given).
|
|
168
|
-
:rtype: str
|
|
169
|
-
"""
|
|
170
|
-
...
|
|
171
|
-
|
|
172
|
-
def path_resolve(self):
|
|
173
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
174
|
-
...
|
|
175
|
-
|
|
176
|
-
def pop(self):
|
|
177
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
178
|
-
when not found (matches Python's dictionary function of the same name).
|
|
179
|
-
|
|
180
|
-
"""
|
|
181
|
-
...
|
|
182
|
-
|
|
183
|
-
def prepend(self, draw_func):
|
|
184
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
185
|
-
the menus draw function
|
|
186
|
-
|
|
187
|
-
:param draw_func:
|
|
188
|
-
"""
|
|
189
|
-
...
|
|
190
|
-
|
|
191
|
-
def property_overridable_library_set(self) -> bool:
|
|
192
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
193
|
-
|
|
194
|
-
:return: True when the overridable status of the property was successfully set.
|
|
195
|
-
:rtype: bool
|
|
196
|
-
"""
|
|
197
|
-
...
|
|
198
|
-
|
|
199
|
-
def property_unset(self):
|
|
200
|
-
"""Unset a property, will use default value afterward."""
|
|
201
|
-
...
|
|
202
|
-
|
|
203
|
-
def remove(self, draw_func):
|
|
204
|
-
"""Remove a draw function that has been added to this menu
|
|
205
|
-
|
|
206
|
-
:param draw_func:
|
|
207
|
-
"""
|
|
208
|
-
...
|
|
209
|
-
|
|
210
|
-
def type_recast(self):
|
|
211
|
-
"""Return a new instance, this is needed because types
|
|
212
|
-
such as textures can be changed at runtime.
|
|
213
|
-
|
|
214
|
-
:return: a new instance of this object with the type initialized again.
|
|
215
|
-
"""
|
|
216
|
-
...
|
|
217
|
-
|
|
218
|
-
def values(self):
|
|
219
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
220
|
-
dictionary function of the same name).
|
|
221
|
-
|
|
222
|
-
:return: custom property values.
|
|
223
|
-
"""
|
|
224
|
-
...
|
|
225
|
-
|
|
226
|
-
class INFO_MT_area(bpy_types._GenericUI):
|
|
38
|
+
class INFO_MT_area(bpy.types.Menu, bpy_types._GenericUI):
|
|
227
39
|
bl_label: typing.Any
|
|
228
40
|
bl_rna: typing.Any
|
|
229
41
|
bl_translation_context: typing.Any
|
|
230
42
|
id_data: typing.Any
|
|
231
43
|
|
|
232
|
-
def append(self, draw_func):
|
|
233
|
-
"""Append a draw function to this menu,
|
|
234
|
-
takes the same arguments as the menus draw function
|
|
235
|
-
|
|
236
|
-
:param draw_func:
|
|
237
|
-
"""
|
|
238
|
-
...
|
|
239
|
-
|
|
240
|
-
def as_pointer(self) -> int:
|
|
241
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
242
|
-
|
|
243
|
-
:return: int (memory address).
|
|
244
|
-
:rtype: int
|
|
245
|
-
"""
|
|
246
|
-
...
|
|
247
|
-
|
|
248
44
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
249
45
|
"""
|
|
250
46
|
|
|
@@ -268,254 +64,68 @@ class INFO_MT_area(bpy_types._GenericUI):
|
|
|
268
64
|
"""
|
|
269
65
|
...
|
|
270
66
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
:param layout:
|
|
276
|
-
"""
|
|
277
|
-
...
|
|
278
|
-
|
|
279
|
-
def draw_preset(self, _context):
|
|
280
|
-
"""Define these on the subclass:
|
|
281
|
-
- preset_operator (string)
|
|
282
|
-
- preset_subdir (string)Optionally:
|
|
283
|
-
- preset_add_operator (string)
|
|
284
|
-
- preset_extensions (set of strings)
|
|
285
|
-
- preset_operator_defaults (dict of keyword args)
|
|
286
|
-
|
|
287
|
-
:param _context:
|
|
288
|
-
"""
|
|
289
|
-
...
|
|
290
|
-
|
|
291
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
292
|
-
"""Adds driver(s) to the given property
|
|
293
|
-
|
|
294
|
-
:return: The driver(s) added.
|
|
295
|
-
:rtype: bpy.types.FCurve
|
|
296
|
-
"""
|
|
297
|
-
...
|
|
298
|
-
|
|
299
|
-
def driver_remove(self) -> bool:
|
|
300
|
-
"""Remove driver(s) from the given property
|
|
301
|
-
|
|
302
|
-
:return: Success of driver removal.
|
|
303
|
-
:rtype: bool
|
|
304
|
-
"""
|
|
305
|
-
...
|
|
306
|
-
|
|
307
|
-
def get(self):
|
|
308
|
-
"""Returns the value of the custom property assigned to key or default
|
|
309
|
-
when not found (matches Python's dictionary function of the same name).
|
|
310
|
-
|
|
311
|
-
"""
|
|
312
|
-
...
|
|
313
|
-
|
|
314
|
-
def id_properties_clear(self):
|
|
315
|
-
"""
|
|
316
|
-
|
|
317
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
318
|
-
"""
|
|
319
|
-
...
|
|
320
|
-
|
|
321
|
-
def id_properties_ensure(self):
|
|
322
|
-
"""
|
|
323
|
-
|
|
324
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
325
|
-
"""
|
|
326
|
-
...
|
|
327
|
-
|
|
328
|
-
def id_properties_ui(self):
|
|
329
|
-
"""
|
|
330
|
-
|
|
331
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
332
|
-
"""
|
|
333
|
-
...
|
|
334
|
-
|
|
335
|
-
def is_extended(self): ...
|
|
336
|
-
def is_property_hidden(self) -> bool:
|
|
337
|
-
"""Check if a property is hidden.
|
|
338
|
-
|
|
339
|
-
:return: True when the property is hidden.
|
|
340
|
-
:rtype: bool
|
|
341
|
-
"""
|
|
342
|
-
...
|
|
343
|
-
|
|
344
|
-
def is_property_overridable_library(self) -> bool:
|
|
345
|
-
"""Check if a property is overridable.
|
|
346
|
-
|
|
347
|
-
:return: True when the property is overridable.
|
|
348
|
-
:rtype: bool
|
|
349
|
-
"""
|
|
350
|
-
...
|
|
351
|
-
|
|
352
|
-
def is_property_readonly(self) -> bool:
|
|
353
|
-
"""Check if a property is readonly.
|
|
354
|
-
|
|
355
|
-
:return: True when the property is readonly (not writable).
|
|
356
|
-
:rtype: bool
|
|
357
|
-
"""
|
|
358
|
-
...
|
|
359
|
-
|
|
360
|
-
def is_property_set(self) -> bool:
|
|
361
|
-
"""Check if a property is set, use for testing operator properties.
|
|
362
|
-
|
|
363
|
-
:return: True when the property has been set.
|
|
364
|
-
:rtype: bool
|
|
365
|
-
"""
|
|
366
|
-
...
|
|
367
|
-
|
|
368
|
-
def items(self):
|
|
369
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
370
|
-
dictionary function of the same name).
|
|
67
|
+
class INFO_MT_context_menu(bpy.types.Menu, bpy_types._GenericUI):
|
|
68
|
+
bl_label: typing.Any
|
|
69
|
+
bl_rna: typing.Any
|
|
70
|
+
id_data: typing.Any
|
|
371
71
|
|
|
372
|
-
|
|
72
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
373
73
|
"""
|
|
374
|
-
...
|
|
375
|
-
|
|
376
|
-
def keyframe_delete(self) -> bool:
|
|
377
|
-
"""Remove a keyframe from this properties fcurve.
|
|
378
74
|
|
|
379
|
-
:return:
|
|
380
|
-
:rtype:
|
|
75
|
+
:return: The RNA type or default when not found.
|
|
76
|
+
:rtype: bpy.types.Struct
|
|
381
77
|
"""
|
|
382
78
|
...
|
|
383
79
|
|
|
384
|
-
def
|
|
385
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
386
|
-
|
|
387
|
-
:return: Success of keyframe insertion.
|
|
388
|
-
:rtype: bool
|
|
80
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
389
81
|
"""
|
|
390
|
-
...
|
|
391
|
-
|
|
392
|
-
def keys(self):
|
|
393
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
394
|
-
dictionary function of the same name).
|
|
395
82
|
|
|
396
|
-
|
|
83
|
+
:return: The class or default when not found.
|
|
84
|
+
:rtype: typing.Any
|
|
397
85
|
"""
|
|
398
86
|
...
|
|
399
87
|
|
|
400
|
-
def
|
|
401
|
-
"""Returns the data path from the ID to this object (string).
|
|
402
|
-
|
|
403
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
404
|
-
to this struct and property (when given).
|
|
405
|
-
:rtype: str
|
|
88
|
+
def draw(self, _context):
|
|
406
89
|
"""
|
|
407
|
-
...
|
|
408
|
-
|
|
409
|
-
def path_menu(
|
|
410
|
-
self,
|
|
411
|
-
searchpaths: list[str],
|
|
412
|
-
operator: str,
|
|
413
|
-
*,
|
|
414
|
-
props_default: dict = None,
|
|
415
|
-
prop_filepath: str | None = "filepath",
|
|
416
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
417
|
-
filter_path=None,
|
|
418
|
-
display_name: collections.abc.Callable | None = None,
|
|
419
|
-
add_operator=None,
|
|
420
|
-
add_operator_props=None,
|
|
421
|
-
):
|
|
422
|
-
"""Populate a menu from a list of paths.
|
|
423
90
|
|
|
424
|
-
|
|
425
|
-
:type searchpaths: list[str]
|
|
426
|
-
:param operator: The operator id to use with each file.
|
|
427
|
-
:type operator: str
|
|
428
|
-
:param props_default: Properties to assign to each operator.
|
|
429
|
-
:type props_default: dict
|
|
430
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
431
|
-
:type prop_filepath: str | None
|
|
432
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
433
|
-
|
|
434
|
-
Returning false excludes the file from the list.
|
|
435
|
-
:type filter_ext: collections.abc.Callable | None
|
|
436
|
-
:param filter_path:
|
|
437
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
438
|
-
:type display_name: collections.abc.Callable | None
|
|
439
|
-
:param add_operator:
|
|
440
|
-
:param add_operator_props:
|
|
91
|
+
:param _context:
|
|
441
92
|
"""
|
|
442
93
|
...
|
|
443
94
|
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
450
|
-
when not found (matches Python's dictionary function of the same name).
|
|
95
|
+
class INFO_MT_editor_menus(bpy.types.Menu, bpy_types._GenericUI):
|
|
96
|
+
bl_idname: typing.Any
|
|
97
|
+
bl_label: typing.Any
|
|
98
|
+
bl_rna: typing.Any
|
|
99
|
+
id_data: typing.Any
|
|
451
100
|
|
|
101
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
452
102
|
"""
|
|
453
|
-
...
|
|
454
103
|
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
the menus draw function
|
|
458
|
-
|
|
459
|
-
:param draw_func:
|
|
104
|
+
:return: The RNA type or default when not found.
|
|
105
|
+
:rtype: bpy.types.Struct
|
|
460
106
|
"""
|
|
461
107
|
...
|
|
462
108
|
|
|
463
|
-
def
|
|
464
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
465
|
-
|
|
466
|
-
:return: True when the overridable status of the property was successfully set.
|
|
467
|
-
:rtype: bool
|
|
109
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
468
110
|
"""
|
|
469
|
-
...
|
|
470
|
-
|
|
471
|
-
def property_unset(self):
|
|
472
|
-
"""Unset a property, will use default value afterward."""
|
|
473
|
-
...
|
|
474
111
|
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
:param draw_func:
|
|
112
|
+
:return: The class or default when not found.
|
|
113
|
+
:rtype: typing.Any
|
|
479
114
|
"""
|
|
480
115
|
...
|
|
481
116
|
|
|
482
|
-
def
|
|
483
|
-
"""Return a new instance, this is needed because types
|
|
484
|
-
such as textures can be changed at runtime.
|
|
485
|
-
|
|
486
|
-
:return: a new instance of this object with the type initialized again.
|
|
117
|
+
def draw(self, _context):
|
|
487
118
|
"""
|
|
488
|
-
...
|
|
489
119
|
|
|
490
|
-
|
|
491
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
492
|
-
dictionary function of the same name).
|
|
493
|
-
|
|
494
|
-
:return: custom property values.
|
|
120
|
+
:param _context:
|
|
495
121
|
"""
|
|
496
122
|
...
|
|
497
123
|
|
|
498
|
-
class
|
|
124
|
+
class INFO_MT_info(bpy.types.Menu, bpy_types._GenericUI):
|
|
499
125
|
bl_label: typing.Any
|
|
500
126
|
bl_rna: typing.Any
|
|
501
127
|
id_data: typing.Any
|
|
502
128
|
|
|
503
|
-
def append(self, draw_func):
|
|
504
|
-
"""Append a draw function to this menu,
|
|
505
|
-
takes the same arguments as the menus draw function
|
|
506
|
-
|
|
507
|
-
:param draw_func:
|
|
508
|
-
"""
|
|
509
|
-
...
|
|
510
|
-
|
|
511
|
-
def as_pointer(self) -> int:
|
|
512
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
513
|
-
|
|
514
|
-
:return: int (memory address).
|
|
515
|
-
:rtype: int
|
|
516
|
-
"""
|
|
517
|
-
...
|
|
518
|
-
|
|
519
129
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
520
130
|
"""
|
|
521
131
|
|
|
@@ -539,1043 +149,30 @@ class INFO_MT_context_menu(bpy_types._GenericUI):
|
|
|
539
149
|
"""
|
|
540
150
|
...
|
|
541
151
|
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
:param layout:
|
|
547
|
-
"""
|
|
548
|
-
...
|
|
549
|
-
|
|
550
|
-
def draw_preset(self, _context):
|
|
551
|
-
"""Define these on the subclass:
|
|
552
|
-
- preset_operator (string)
|
|
553
|
-
- preset_subdir (string)Optionally:
|
|
554
|
-
- preset_add_operator (string)
|
|
555
|
-
- preset_extensions (set of strings)
|
|
556
|
-
- preset_operator_defaults (dict of keyword args)
|
|
557
|
-
|
|
558
|
-
:param _context:
|
|
559
|
-
"""
|
|
560
|
-
...
|
|
561
|
-
|
|
562
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
563
|
-
"""Adds driver(s) to the given property
|
|
564
|
-
|
|
565
|
-
:return: The driver(s) added.
|
|
566
|
-
:rtype: bpy.types.FCurve
|
|
567
|
-
"""
|
|
568
|
-
...
|
|
569
|
-
|
|
570
|
-
def driver_remove(self) -> bool:
|
|
571
|
-
"""Remove driver(s) from the given property
|
|
572
|
-
|
|
573
|
-
:return: Success of driver removal.
|
|
574
|
-
:rtype: bool
|
|
575
|
-
"""
|
|
576
|
-
...
|
|
577
|
-
|
|
578
|
-
def get(self):
|
|
579
|
-
"""Returns the value of the custom property assigned to key or default
|
|
580
|
-
when not found (matches Python's dictionary function of the same name).
|
|
581
|
-
|
|
582
|
-
"""
|
|
583
|
-
...
|
|
584
|
-
|
|
585
|
-
def id_properties_clear(self):
|
|
586
|
-
"""
|
|
587
|
-
|
|
588
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
589
|
-
"""
|
|
590
|
-
...
|
|
152
|
+
class INFO_MT_view(bpy.types.Menu, bpy_types._GenericUI):
|
|
153
|
+
bl_label: typing.Any
|
|
154
|
+
bl_rna: typing.Any
|
|
155
|
+
id_data: typing.Any
|
|
591
156
|
|
|
592
|
-
def
|
|
157
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
593
158
|
"""
|
|
594
159
|
|
|
595
|
-
:return:
|
|
160
|
+
:return: The RNA type or default when not found.
|
|
161
|
+
:rtype: bpy.types.Struct
|
|
596
162
|
"""
|
|
597
163
|
...
|
|
598
164
|
|
|
599
|
-
def
|
|
600
|
-
"""
|
|
601
|
-
|
|
602
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
165
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
603
166
|
"""
|
|
604
|
-
...
|
|
605
167
|
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
"""Check if a property is hidden.
|
|
609
|
-
|
|
610
|
-
:return: True when the property is hidden.
|
|
611
|
-
:rtype: bool
|
|
168
|
+
:return: The class or default when not found.
|
|
169
|
+
:rtype: typing.Any
|
|
612
170
|
"""
|
|
613
171
|
...
|
|
614
172
|
|
|
615
|
-
def
|
|
616
|
-
"""Check if a property is overridable.
|
|
617
|
-
|
|
618
|
-
:return: True when the property is overridable.
|
|
619
|
-
:rtype: bool
|
|
620
|
-
"""
|
|
621
|
-
...
|
|
622
|
-
|
|
623
|
-
def is_property_readonly(self) -> bool:
|
|
624
|
-
"""Check if a property is readonly.
|
|
625
|
-
|
|
626
|
-
:return: True when the property is readonly (not writable).
|
|
627
|
-
:rtype: bool
|
|
628
|
-
"""
|
|
629
|
-
...
|
|
630
|
-
|
|
631
|
-
def is_property_set(self) -> bool:
|
|
632
|
-
"""Check if a property is set, use for testing operator properties.
|
|
633
|
-
|
|
634
|
-
:return: True when the property has been set.
|
|
635
|
-
:rtype: bool
|
|
636
|
-
"""
|
|
637
|
-
...
|
|
638
|
-
|
|
639
|
-
def items(self):
|
|
640
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
641
|
-
dictionary function of the same name).
|
|
642
|
-
|
|
643
|
-
:return: custom property key, value pairs.
|
|
644
|
-
"""
|
|
645
|
-
...
|
|
646
|
-
|
|
647
|
-
def keyframe_delete(self) -> bool:
|
|
648
|
-
"""Remove a keyframe from this properties fcurve.
|
|
649
|
-
|
|
650
|
-
:return: Success of keyframe deletion.
|
|
651
|
-
:rtype: bool
|
|
652
|
-
"""
|
|
653
|
-
...
|
|
654
|
-
|
|
655
|
-
def keyframe_insert(self) -> bool:
|
|
656
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
657
|
-
|
|
658
|
-
:return: Success of keyframe insertion.
|
|
659
|
-
:rtype: bool
|
|
660
|
-
"""
|
|
661
|
-
...
|
|
662
|
-
|
|
663
|
-
def keys(self):
|
|
664
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
665
|
-
dictionary function of the same name).
|
|
666
|
-
|
|
667
|
-
:return: custom property keys.
|
|
668
|
-
"""
|
|
669
|
-
...
|
|
670
|
-
|
|
671
|
-
def path_from_id(self) -> str:
|
|
672
|
-
"""Returns the data path from the ID to this object (string).
|
|
673
|
-
|
|
674
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
675
|
-
to this struct and property (when given).
|
|
676
|
-
:rtype: str
|
|
677
|
-
"""
|
|
678
|
-
...
|
|
679
|
-
|
|
680
|
-
def path_menu(
|
|
681
|
-
self,
|
|
682
|
-
searchpaths: list[str],
|
|
683
|
-
operator: str,
|
|
684
|
-
*,
|
|
685
|
-
props_default: dict = None,
|
|
686
|
-
prop_filepath: str | None = "filepath",
|
|
687
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
688
|
-
filter_path=None,
|
|
689
|
-
display_name: collections.abc.Callable | None = None,
|
|
690
|
-
add_operator=None,
|
|
691
|
-
add_operator_props=None,
|
|
692
|
-
):
|
|
693
|
-
"""Populate a menu from a list of paths.
|
|
694
|
-
|
|
695
|
-
:param searchpaths: Paths to scan.
|
|
696
|
-
:type searchpaths: list[str]
|
|
697
|
-
:param operator: The operator id to use with each file.
|
|
698
|
-
:type operator: str
|
|
699
|
-
:param props_default: Properties to assign to each operator.
|
|
700
|
-
:type props_default: dict
|
|
701
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
702
|
-
:type prop_filepath: str | None
|
|
703
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
704
|
-
|
|
705
|
-
Returning false excludes the file from the list.
|
|
706
|
-
:type filter_ext: collections.abc.Callable | None
|
|
707
|
-
:param filter_path:
|
|
708
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
709
|
-
:type display_name: collections.abc.Callable | None
|
|
710
|
-
:param add_operator:
|
|
711
|
-
:param add_operator_props:
|
|
712
|
-
"""
|
|
713
|
-
...
|
|
714
|
-
|
|
715
|
-
def path_resolve(self):
|
|
716
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
717
|
-
...
|
|
718
|
-
|
|
719
|
-
def pop(self):
|
|
720
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
721
|
-
when not found (matches Python's dictionary function of the same name).
|
|
722
|
-
|
|
723
|
-
"""
|
|
724
|
-
...
|
|
725
|
-
|
|
726
|
-
def prepend(self, draw_func):
|
|
727
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
728
|
-
the menus draw function
|
|
729
|
-
|
|
730
|
-
:param draw_func:
|
|
731
|
-
"""
|
|
732
|
-
...
|
|
733
|
-
|
|
734
|
-
def property_overridable_library_set(self) -> bool:
|
|
735
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
736
|
-
|
|
737
|
-
:return: True when the overridable status of the property was successfully set.
|
|
738
|
-
:rtype: bool
|
|
739
|
-
"""
|
|
740
|
-
...
|
|
741
|
-
|
|
742
|
-
def property_unset(self):
|
|
743
|
-
"""Unset a property, will use default value afterward."""
|
|
744
|
-
...
|
|
745
|
-
|
|
746
|
-
def remove(self, draw_func):
|
|
747
|
-
"""Remove a draw function that has been added to this menu
|
|
748
|
-
|
|
749
|
-
:param draw_func:
|
|
750
|
-
"""
|
|
751
|
-
...
|
|
752
|
-
|
|
753
|
-
def type_recast(self):
|
|
754
|
-
"""Return a new instance, this is needed because types
|
|
755
|
-
such as textures can be changed at runtime.
|
|
756
|
-
|
|
757
|
-
:return: a new instance of this object with the type initialized again.
|
|
758
|
-
"""
|
|
759
|
-
...
|
|
760
|
-
|
|
761
|
-
def values(self):
|
|
762
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
763
|
-
dictionary function of the same name).
|
|
764
|
-
|
|
765
|
-
:return: custom property values.
|
|
766
|
-
"""
|
|
767
|
-
...
|
|
768
|
-
|
|
769
|
-
class INFO_MT_editor_menus(bpy_types._GenericUI):
|
|
770
|
-
bl_idname: typing.Any
|
|
771
|
-
bl_label: typing.Any
|
|
772
|
-
bl_rna: typing.Any
|
|
773
|
-
id_data: typing.Any
|
|
774
|
-
|
|
775
|
-
def append(self, draw_func):
|
|
776
|
-
"""Append a draw function to this menu,
|
|
777
|
-
takes the same arguments as the menus draw function
|
|
778
|
-
|
|
779
|
-
:param draw_func:
|
|
780
|
-
"""
|
|
781
|
-
...
|
|
782
|
-
|
|
783
|
-
def as_pointer(self) -> int:
|
|
784
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
785
|
-
|
|
786
|
-
:return: int (memory address).
|
|
787
|
-
:rtype: int
|
|
788
|
-
"""
|
|
789
|
-
...
|
|
790
|
-
|
|
791
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
792
|
-
"""
|
|
793
|
-
|
|
794
|
-
:return: The RNA type or default when not found.
|
|
795
|
-
:rtype: bpy.types.Struct
|
|
796
|
-
"""
|
|
797
|
-
...
|
|
798
|
-
|
|
799
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
800
|
-
"""
|
|
801
|
-
|
|
802
|
-
:return: The class or default when not found.
|
|
803
|
-
:rtype: typing.Any
|
|
804
|
-
"""
|
|
805
|
-
...
|
|
806
|
-
|
|
807
|
-
def draw(self, _context):
|
|
808
|
-
"""
|
|
809
|
-
|
|
810
|
-
:param _context:
|
|
811
|
-
"""
|
|
812
|
-
...
|
|
813
|
-
|
|
814
|
-
def draw_collapsible(self, context, layout):
|
|
815
|
-
"""
|
|
816
|
-
|
|
817
|
-
:param context:
|
|
818
|
-
:param layout:
|
|
819
|
-
"""
|
|
820
|
-
...
|
|
821
|
-
|
|
822
|
-
def draw_preset(self, _context):
|
|
823
|
-
"""Define these on the subclass:
|
|
824
|
-
- preset_operator (string)
|
|
825
|
-
- preset_subdir (string)Optionally:
|
|
826
|
-
- preset_add_operator (string)
|
|
827
|
-
- preset_extensions (set of strings)
|
|
828
|
-
- preset_operator_defaults (dict of keyword args)
|
|
829
|
-
|
|
830
|
-
:param _context:
|
|
831
|
-
"""
|
|
832
|
-
...
|
|
833
|
-
|
|
834
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
835
|
-
"""Adds driver(s) to the given property
|
|
836
|
-
|
|
837
|
-
:return: The driver(s) added.
|
|
838
|
-
:rtype: bpy.types.FCurve
|
|
839
|
-
"""
|
|
840
|
-
...
|
|
841
|
-
|
|
842
|
-
def driver_remove(self) -> bool:
|
|
843
|
-
"""Remove driver(s) from the given property
|
|
844
|
-
|
|
845
|
-
:return: Success of driver removal.
|
|
846
|
-
:rtype: bool
|
|
847
|
-
"""
|
|
848
|
-
...
|
|
849
|
-
|
|
850
|
-
def get(self):
|
|
851
|
-
"""Returns the value of the custom property assigned to key or default
|
|
852
|
-
when not found (matches Python's dictionary function of the same name).
|
|
853
|
-
|
|
854
|
-
"""
|
|
855
|
-
...
|
|
856
|
-
|
|
857
|
-
def id_properties_clear(self):
|
|
858
|
-
"""
|
|
859
|
-
|
|
860
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
861
|
-
"""
|
|
862
|
-
...
|
|
863
|
-
|
|
864
|
-
def id_properties_ensure(self):
|
|
865
|
-
"""
|
|
866
|
-
|
|
867
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
868
|
-
"""
|
|
869
|
-
...
|
|
870
|
-
|
|
871
|
-
def id_properties_ui(self):
|
|
872
|
-
"""
|
|
873
|
-
|
|
874
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
875
|
-
"""
|
|
876
|
-
...
|
|
877
|
-
|
|
878
|
-
def is_extended(self): ...
|
|
879
|
-
def is_property_hidden(self) -> bool:
|
|
880
|
-
"""Check if a property is hidden.
|
|
881
|
-
|
|
882
|
-
:return: True when the property is hidden.
|
|
883
|
-
:rtype: bool
|
|
884
|
-
"""
|
|
885
|
-
...
|
|
886
|
-
|
|
887
|
-
def is_property_overridable_library(self) -> bool:
|
|
888
|
-
"""Check if a property is overridable.
|
|
889
|
-
|
|
890
|
-
:return: True when the property is overridable.
|
|
891
|
-
:rtype: bool
|
|
892
|
-
"""
|
|
893
|
-
...
|
|
894
|
-
|
|
895
|
-
def is_property_readonly(self) -> bool:
|
|
896
|
-
"""Check if a property is readonly.
|
|
897
|
-
|
|
898
|
-
:return: True when the property is readonly (not writable).
|
|
899
|
-
:rtype: bool
|
|
900
|
-
"""
|
|
901
|
-
...
|
|
902
|
-
|
|
903
|
-
def is_property_set(self) -> bool:
|
|
904
|
-
"""Check if a property is set, use for testing operator properties.
|
|
905
|
-
|
|
906
|
-
:return: True when the property has been set.
|
|
907
|
-
:rtype: bool
|
|
908
|
-
"""
|
|
909
|
-
...
|
|
910
|
-
|
|
911
|
-
def items(self):
|
|
912
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
913
|
-
dictionary function of the same name).
|
|
914
|
-
|
|
915
|
-
:return: custom property key, value pairs.
|
|
916
|
-
"""
|
|
917
|
-
...
|
|
918
|
-
|
|
919
|
-
def keyframe_delete(self) -> bool:
|
|
920
|
-
"""Remove a keyframe from this properties fcurve.
|
|
921
|
-
|
|
922
|
-
:return: Success of keyframe deletion.
|
|
923
|
-
:rtype: bool
|
|
924
|
-
"""
|
|
925
|
-
...
|
|
926
|
-
|
|
927
|
-
def keyframe_insert(self) -> bool:
|
|
928
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
929
|
-
|
|
930
|
-
:return: Success of keyframe insertion.
|
|
931
|
-
:rtype: bool
|
|
932
|
-
"""
|
|
933
|
-
...
|
|
934
|
-
|
|
935
|
-
def keys(self):
|
|
936
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
937
|
-
dictionary function of the same name).
|
|
938
|
-
|
|
939
|
-
:return: custom property keys.
|
|
940
|
-
"""
|
|
941
|
-
...
|
|
942
|
-
|
|
943
|
-
def path_from_id(self) -> str:
|
|
944
|
-
"""Returns the data path from the ID to this object (string).
|
|
945
|
-
|
|
946
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
947
|
-
to this struct and property (when given).
|
|
948
|
-
:rtype: str
|
|
949
|
-
"""
|
|
950
|
-
...
|
|
951
|
-
|
|
952
|
-
def path_menu(
|
|
953
|
-
self,
|
|
954
|
-
searchpaths: list[str],
|
|
955
|
-
operator: str,
|
|
956
|
-
*,
|
|
957
|
-
props_default: dict = None,
|
|
958
|
-
prop_filepath: str | None = "filepath",
|
|
959
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
960
|
-
filter_path=None,
|
|
961
|
-
display_name: collections.abc.Callable | None = None,
|
|
962
|
-
add_operator=None,
|
|
963
|
-
add_operator_props=None,
|
|
964
|
-
):
|
|
965
|
-
"""Populate a menu from a list of paths.
|
|
966
|
-
|
|
967
|
-
:param searchpaths: Paths to scan.
|
|
968
|
-
:type searchpaths: list[str]
|
|
969
|
-
:param operator: The operator id to use with each file.
|
|
970
|
-
:type operator: str
|
|
971
|
-
:param props_default: Properties to assign to each operator.
|
|
972
|
-
:type props_default: dict
|
|
973
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
974
|
-
:type prop_filepath: str | None
|
|
975
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
976
|
-
|
|
977
|
-
Returning false excludes the file from the list.
|
|
978
|
-
:type filter_ext: collections.abc.Callable | None
|
|
979
|
-
:param filter_path:
|
|
980
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
981
|
-
:type display_name: collections.abc.Callable | None
|
|
982
|
-
:param add_operator:
|
|
983
|
-
:param add_operator_props:
|
|
984
|
-
"""
|
|
985
|
-
...
|
|
986
|
-
|
|
987
|
-
def path_resolve(self):
|
|
988
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
989
|
-
...
|
|
990
|
-
|
|
991
|
-
def pop(self):
|
|
992
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
993
|
-
when not found (matches Python's dictionary function of the same name).
|
|
994
|
-
|
|
995
|
-
"""
|
|
996
|
-
...
|
|
997
|
-
|
|
998
|
-
def prepend(self, draw_func):
|
|
999
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1000
|
-
the menus draw function
|
|
1001
|
-
|
|
1002
|
-
:param draw_func:
|
|
1003
|
-
"""
|
|
1004
|
-
...
|
|
1005
|
-
|
|
1006
|
-
def property_overridable_library_set(self) -> bool:
|
|
1007
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1008
|
-
|
|
1009
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1010
|
-
:rtype: bool
|
|
1011
|
-
"""
|
|
1012
|
-
...
|
|
1013
|
-
|
|
1014
|
-
def property_unset(self):
|
|
1015
|
-
"""Unset a property, will use default value afterward."""
|
|
1016
|
-
...
|
|
1017
|
-
|
|
1018
|
-
def remove(self, draw_func):
|
|
1019
|
-
"""Remove a draw function that has been added to this menu
|
|
1020
|
-
|
|
1021
|
-
:param draw_func:
|
|
1022
|
-
"""
|
|
1023
|
-
...
|
|
1024
|
-
|
|
1025
|
-
def type_recast(self):
|
|
1026
|
-
"""Return a new instance, this is needed because types
|
|
1027
|
-
such as textures can be changed at runtime.
|
|
1028
|
-
|
|
1029
|
-
:return: a new instance of this object with the type initialized again.
|
|
1030
|
-
"""
|
|
1031
|
-
...
|
|
1032
|
-
|
|
1033
|
-
def values(self):
|
|
1034
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1035
|
-
dictionary function of the same name).
|
|
1036
|
-
|
|
1037
|
-
:return: custom property values.
|
|
1038
|
-
"""
|
|
1039
|
-
...
|
|
1040
|
-
|
|
1041
|
-
class INFO_MT_info(bpy_types._GenericUI):
|
|
1042
|
-
bl_label: typing.Any
|
|
1043
|
-
bl_rna: typing.Any
|
|
1044
|
-
id_data: typing.Any
|
|
1045
|
-
|
|
1046
|
-
def append(self, draw_func):
|
|
1047
|
-
"""Append a draw function to this menu,
|
|
1048
|
-
takes the same arguments as the menus draw function
|
|
1049
|
-
|
|
1050
|
-
:param draw_func:
|
|
1051
|
-
"""
|
|
1052
|
-
...
|
|
1053
|
-
|
|
1054
|
-
def as_pointer(self) -> int:
|
|
1055
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1056
|
-
|
|
1057
|
-
:return: int (memory address).
|
|
1058
|
-
:rtype: int
|
|
1059
|
-
"""
|
|
1060
|
-
...
|
|
1061
|
-
|
|
1062
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1063
|
-
"""
|
|
1064
|
-
|
|
1065
|
-
:return: The RNA type or default when not found.
|
|
1066
|
-
:rtype: bpy.types.Struct
|
|
1067
|
-
"""
|
|
1068
|
-
...
|
|
1069
|
-
|
|
1070
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1071
|
-
"""
|
|
1072
|
-
|
|
1073
|
-
:return: The class or default when not found.
|
|
1074
|
-
:rtype: typing.Any
|
|
1075
|
-
"""
|
|
1076
|
-
...
|
|
1077
|
-
|
|
1078
|
-
def draw(self, _context):
|
|
173
|
+
def draw(self, _context):
|
|
1079
174
|
"""
|
|
1080
175
|
|
|
1081
176
|
:param _context:
|
|
1082
177
|
"""
|
|
1083
178
|
...
|
|
1084
|
-
|
|
1085
|
-
def draw_collapsible(self, context, layout):
|
|
1086
|
-
"""
|
|
1087
|
-
|
|
1088
|
-
:param context:
|
|
1089
|
-
:param layout:
|
|
1090
|
-
"""
|
|
1091
|
-
...
|
|
1092
|
-
|
|
1093
|
-
def draw_preset(self, _context):
|
|
1094
|
-
"""Define these on the subclass:
|
|
1095
|
-
- preset_operator (string)
|
|
1096
|
-
- preset_subdir (string)Optionally:
|
|
1097
|
-
- preset_add_operator (string)
|
|
1098
|
-
- preset_extensions (set of strings)
|
|
1099
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1100
|
-
|
|
1101
|
-
:param _context:
|
|
1102
|
-
"""
|
|
1103
|
-
...
|
|
1104
|
-
|
|
1105
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1106
|
-
"""Adds driver(s) to the given property
|
|
1107
|
-
|
|
1108
|
-
:return: The driver(s) added.
|
|
1109
|
-
:rtype: bpy.types.FCurve
|
|
1110
|
-
"""
|
|
1111
|
-
...
|
|
1112
|
-
|
|
1113
|
-
def driver_remove(self) -> bool:
|
|
1114
|
-
"""Remove driver(s) from the given property
|
|
1115
|
-
|
|
1116
|
-
:return: Success of driver removal.
|
|
1117
|
-
:rtype: bool
|
|
1118
|
-
"""
|
|
1119
|
-
...
|
|
1120
|
-
|
|
1121
|
-
def get(self):
|
|
1122
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1123
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1124
|
-
|
|
1125
|
-
"""
|
|
1126
|
-
...
|
|
1127
|
-
|
|
1128
|
-
def id_properties_clear(self):
|
|
1129
|
-
"""
|
|
1130
|
-
|
|
1131
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1132
|
-
"""
|
|
1133
|
-
...
|
|
1134
|
-
|
|
1135
|
-
def id_properties_ensure(self):
|
|
1136
|
-
"""
|
|
1137
|
-
|
|
1138
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1139
|
-
"""
|
|
1140
|
-
...
|
|
1141
|
-
|
|
1142
|
-
def id_properties_ui(self):
|
|
1143
|
-
"""
|
|
1144
|
-
|
|
1145
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1146
|
-
"""
|
|
1147
|
-
...
|
|
1148
|
-
|
|
1149
|
-
def is_extended(self): ...
|
|
1150
|
-
def is_property_hidden(self) -> bool:
|
|
1151
|
-
"""Check if a property is hidden.
|
|
1152
|
-
|
|
1153
|
-
:return: True when the property is hidden.
|
|
1154
|
-
:rtype: bool
|
|
1155
|
-
"""
|
|
1156
|
-
...
|
|
1157
|
-
|
|
1158
|
-
def is_property_overridable_library(self) -> bool:
|
|
1159
|
-
"""Check if a property is overridable.
|
|
1160
|
-
|
|
1161
|
-
:return: True when the property is overridable.
|
|
1162
|
-
:rtype: bool
|
|
1163
|
-
"""
|
|
1164
|
-
...
|
|
1165
|
-
|
|
1166
|
-
def is_property_readonly(self) -> bool:
|
|
1167
|
-
"""Check if a property is readonly.
|
|
1168
|
-
|
|
1169
|
-
:return: True when the property is readonly (not writable).
|
|
1170
|
-
:rtype: bool
|
|
1171
|
-
"""
|
|
1172
|
-
...
|
|
1173
|
-
|
|
1174
|
-
def is_property_set(self) -> bool:
|
|
1175
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1176
|
-
|
|
1177
|
-
:return: True when the property has been set.
|
|
1178
|
-
:rtype: bool
|
|
1179
|
-
"""
|
|
1180
|
-
...
|
|
1181
|
-
|
|
1182
|
-
def items(self):
|
|
1183
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1184
|
-
dictionary function of the same name).
|
|
1185
|
-
|
|
1186
|
-
:return: custom property key, value pairs.
|
|
1187
|
-
"""
|
|
1188
|
-
...
|
|
1189
|
-
|
|
1190
|
-
def keyframe_delete(self) -> bool:
|
|
1191
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1192
|
-
|
|
1193
|
-
:return: Success of keyframe deletion.
|
|
1194
|
-
:rtype: bool
|
|
1195
|
-
"""
|
|
1196
|
-
...
|
|
1197
|
-
|
|
1198
|
-
def keyframe_insert(self) -> bool:
|
|
1199
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1200
|
-
|
|
1201
|
-
:return: Success of keyframe insertion.
|
|
1202
|
-
:rtype: bool
|
|
1203
|
-
"""
|
|
1204
|
-
...
|
|
1205
|
-
|
|
1206
|
-
def keys(self):
|
|
1207
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1208
|
-
dictionary function of the same name).
|
|
1209
|
-
|
|
1210
|
-
:return: custom property keys.
|
|
1211
|
-
"""
|
|
1212
|
-
...
|
|
1213
|
-
|
|
1214
|
-
def path_from_id(self) -> str:
|
|
1215
|
-
"""Returns the data path from the ID to this object (string).
|
|
1216
|
-
|
|
1217
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1218
|
-
to this struct and property (when given).
|
|
1219
|
-
:rtype: str
|
|
1220
|
-
"""
|
|
1221
|
-
...
|
|
1222
|
-
|
|
1223
|
-
def path_menu(
|
|
1224
|
-
self,
|
|
1225
|
-
searchpaths: list[str],
|
|
1226
|
-
operator: str,
|
|
1227
|
-
*,
|
|
1228
|
-
props_default: dict = None,
|
|
1229
|
-
prop_filepath: str | None = "filepath",
|
|
1230
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1231
|
-
filter_path=None,
|
|
1232
|
-
display_name: collections.abc.Callable | None = None,
|
|
1233
|
-
add_operator=None,
|
|
1234
|
-
add_operator_props=None,
|
|
1235
|
-
):
|
|
1236
|
-
"""Populate a menu from a list of paths.
|
|
1237
|
-
|
|
1238
|
-
:param searchpaths: Paths to scan.
|
|
1239
|
-
:type searchpaths: list[str]
|
|
1240
|
-
:param operator: The operator id to use with each file.
|
|
1241
|
-
:type operator: str
|
|
1242
|
-
:param props_default: Properties to assign to each operator.
|
|
1243
|
-
:type props_default: dict
|
|
1244
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1245
|
-
:type prop_filepath: str | None
|
|
1246
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1247
|
-
|
|
1248
|
-
Returning false excludes the file from the list.
|
|
1249
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1250
|
-
:param filter_path:
|
|
1251
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1252
|
-
:type display_name: collections.abc.Callable | None
|
|
1253
|
-
:param add_operator:
|
|
1254
|
-
:param add_operator_props:
|
|
1255
|
-
"""
|
|
1256
|
-
...
|
|
1257
|
-
|
|
1258
|
-
def path_resolve(self):
|
|
1259
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1260
|
-
...
|
|
1261
|
-
|
|
1262
|
-
def pop(self):
|
|
1263
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1264
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1265
|
-
|
|
1266
|
-
"""
|
|
1267
|
-
...
|
|
1268
|
-
|
|
1269
|
-
def prepend(self, draw_func):
|
|
1270
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1271
|
-
the menus draw function
|
|
1272
|
-
|
|
1273
|
-
:param draw_func:
|
|
1274
|
-
"""
|
|
1275
|
-
...
|
|
1276
|
-
|
|
1277
|
-
def property_overridable_library_set(self) -> bool:
|
|
1278
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1279
|
-
|
|
1280
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1281
|
-
:rtype: bool
|
|
1282
|
-
"""
|
|
1283
|
-
...
|
|
1284
|
-
|
|
1285
|
-
def property_unset(self):
|
|
1286
|
-
"""Unset a property, will use default value afterward."""
|
|
1287
|
-
...
|
|
1288
|
-
|
|
1289
|
-
def remove(self, draw_func):
|
|
1290
|
-
"""Remove a draw function that has been added to this menu
|
|
1291
|
-
|
|
1292
|
-
:param draw_func:
|
|
1293
|
-
"""
|
|
1294
|
-
...
|
|
1295
|
-
|
|
1296
|
-
def type_recast(self):
|
|
1297
|
-
"""Return a new instance, this is needed because types
|
|
1298
|
-
such as textures can be changed at runtime.
|
|
1299
|
-
|
|
1300
|
-
:return: a new instance of this object with the type initialized again.
|
|
1301
|
-
"""
|
|
1302
|
-
...
|
|
1303
|
-
|
|
1304
|
-
def values(self):
|
|
1305
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1306
|
-
dictionary function of the same name).
|
|
1307
|
-
|
|
1308
|
-
:return: custom property values.
|
|
1309
|
-
"""
|
|
1310
|
-
...
|
|
1311
|
-
|
|
1312
|
-
class INFO_MT_view(bpy_types._GenericUI):
|
|
1313
|
-
bl_label: typing.Any
|
|
1314
|
-
bl_rna: typing.Any
|
|
1315
|
-
id_data: typing.Any
|
|
1316
|
-
|
|
1317
|
-
def append(self, draw_func):
|
|
1318
|
-
"""Append a draw function to this menu,
|
|
1319
|
-
takes the same arguments as the menus draw function
|
|
1320
|
-
|
|
1321
|
-
:param draw_func:
|
|
1322
|
-
"""
|
|
1323
|
-
...
|
|
1324
|
-
|
|
1325
|
-
def as_pointer(self) -> int:
|
|
1326
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1327
|
-
|
|
1328
|
-
:return: int (memory address).
|
|
1329
|
-
:rtype: int
|
|
1330
|
-
"""
|
|
1331
|
-
...
|
|
1332
|
-
|
|
1333
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1334
|
-
"""
|
|
1335
|
-
|
|
1336
|
-
:return: The RNA type or default when not found.
|
|
1337
|
-
:rtype: bpy.types.Struct
|
|
1338
|
-
"""
|
|
1339
|
-
...
|
|
1340
|
-
|
|
1341
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1342
|
-
"""
|
|
1343
|
-
|
|
1344
|
-
:return: The class or default when not found.
|
|
1345
|
-
:rtype: typing.Any
|
|
1346
|
-
"""
|
|
1347
|
-
...
|
|
1348
|
-
|
|
1349
|
-
def draw(self, _context):
|
|
1350
|
-
"""
|
|
1351
|
-
|
|
1352
|
-
:param _context:
|
|
1353
|
-
"""
|
|
1354
|
-
...
|
|
1355
|
-
|
|
1356
|
-
def draw_collapsible(self, context, layout):
|
|
1357
|
-
"""
|
|
1358
|
-
|
|
1359
|
-
:param context:
|
|
1360
|
-
:param layout:
|
|
1361
|
-
"""
|
|
1362
|
-
...
|
|
1363
|
-
|
|
1364
|
-
def draw_preset(self, _context):
|
|
1365
|
-
"""Define these on the subclass:
|
|
1366
|
-
- preset_operator (string)
|
|
1367
|
-
- preset_subdir (string)Optionally:
|
|
1368
|
-
- preset_add_operator (string)
|
|
1369
|
-
- preset_extensions (set of strings)
|
|
1370
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1371
|
-
|
|
1372
|
-
:param _context:
|
|
1373
|
-
"""
|
|
1374
|
-
...
|
|
1375
|
-
|
|
1376
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1377
|
-
"""Adds driver(s) to the given property
|
|
1378
|
-
|
|
1379
|
-
:return: The driver(s) added.
|
|
1380
|
-
:rtype: bpy.types.FCurve
|
|
1381
|
-
"""
|
|
1382
|
-
...
|
|
1383
|
-
|
|
1384
|
-
def driver_remove(self) -> bool:
|
|
1385
|
-
"""Remove driver(s) from the given property
|
|
1386
|
-
|
|
1387
|
-
:return: Success of driver removal.
|
|
1388
|
-
:rtype: bool
|
|
1389
|
-
"""
|
|
1390
|
-
...
|
|
1391
|
-
|
|
1392
|
-
def get(self):
|
|
1393
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1394
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1395
|
-
|
|
1396
|
-
"""
|
|
1397
|
-
...
|
|
1398
|
-
|
|
1399
|
-
def id_properties_clear(self):
|
|
1400
|
-
"""
|
|
1401
|
-
|
|
1402
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1403
|
-
"""
|
|
1404
|
-
...
|
|
1405
|
-
|
|
1406
|
-
def id_properties_ensure(self):
|
|
1407
|
-
"""
|
|
1408
|
-
|
|
1409
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1410
|
-
"""
|
|
1411
|
-
...
|
|
1412
|
-
|
|
1413
|
-
def id_properties_ui(self):
|
|
1414
|
-
"""
|
|
1415
|
-
|
|
1416
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1417
|
-
"""
|
|
1418
|
-
...
|
|
1419
|
-
|
|
1420
|
-
def is_extended(self): ...
|
|
1421
|
-
def is_property_hidden(self) -> bool:
|
|
1422
|
-
"""Check if a property is hidden.
|
|
1423
|
-
|
|
1424
|
-
:return: True when the property is hidden.
|
|
1425
|
-
:rtype: bool
|
|
1426
|
-
"""
|
|
1427
|
-
...
|
|
1428
|
-
|
|
1429
|
-
def is_property_overridable_library(self) -> bool:
|
|
1430
|
-
"""Check if a property is overridable.
|
|
1431
|
-
|
|
1432
|
-
:return: True when the property is overridable.
|
|
1433
|
-
:rtype: bool
|
|
1434
|
-
"""
|
|
1435
|
-
...
|
|
1436
|
-
|
|
1437
|
-
def is_property_readonly(self) -> bool:
|
|
1438
|
-
"""Check if a property is readonly.
|
|
1439
|
-
|
|
1440
|
-
:return: True when the property is readonly (not writable).
|
|
1441
|
-
:rtype: bool
|
|
1442
|
-
"""
|
|
1443
|
-
...
|
|
1444
|
-
|
|
1445
|
-
def is_property_set(self) -> bool:
|
|
1446
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1447
|
-
|
|
1448
|
-
:return: True when the property has been set.
|
|
1449
|
-
:rtype: bool
|
|
1450
|
-
"""
|
|
1451
|
-
...
|
|
1452
|
-
|
|
1453
|
-
def items(self):
|
|
1454
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1455
|
-
dictionary function of the same name).
|
|
1456
|
-
|
|
1457
|
-
:return: custom property key, value pairs.
|
|
1458
|
-
"""
|
|
1459
|
-
...
|
|
1460
|
-
|
|
1461
|
-
def keyframe_delete(self) -> bool:
|
|
1462
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1463
|
-
|
|
1464
|
-
:return: Success of keyframe deletion.
|
|
1465
|
-
:rtype: bool
|
|
1466
|
-
"""
|
|
1467
|
-
...
|
|
1468
|
-
|
|
1469
|
-
def keyframe_insert(self) -> bool:
|
|
1470
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1471
|
-
|
|
1472
|
-
:return: Success of keyframe insertion.
|
|
1473
|
-
:rtype: bool
|
|
1474
|
-
"""
|
|
1475
|
-
...
|
|
1476
|
-
|
|
1477
|
-
def keys(self):
|
|
1478
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1479
|
-
dictionary function of the same name).
|
|
1480
|
-
|
|
1481
|
-
:return: custom property keys.
|
|
1482
|
-
"""
|
|
1483
|
-
...
|
|
1484
|
-
|
|
1485
|
-
def path_from_id(self) -> str:
|
|
1486
|
-
"""Returns the data path from the ID to this object (string).
|
|
1487
|
-
|
|
1488
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1489
|
-
to this struct and property (when given).
|
|
1490
|
-
:rtype: str
|
|
1491
|
-
"""
|
|
1492
|
-
...
|
|
1493
|
-
|
|
1494
|
-
def path_menu(
|
|
1495
|
-
self,
|
|
1496
|
-
searchpaths: list[str],
|
|
1497
|
-
operator: str,
|
|
1498
|
-
*,
|
|
1499
|
-
props_default: dict = None,
|
|
1500
|
-
prop_filepath: str | None = "filepath",
|
|
1501
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1502
|
-
filter_path=None,
|
|
1503
|
-
display_name: collections.abc.Callable | None = None,
|
|
1504
|
-
add_operator=None,
|
|
1505
|
-
add_operator_props=None,
|
|
1506
|
-
):
|
|
1507
|
-
"""Populate a menu from a list of paths.
|
|
1508
|
-
|
|
1509
|
-
:param searchpaths: Paths to scan.
|
|
1510
|
-
:type searchpaths: list[str]
|
|
1511
|
-
:param operator: The operator id to use with each file.
|
|
1512
|
-
:type operator: str
|
|
1513
|
-
:param props_default: Properties to assign to each operator.
|
|
1514
|
-
:type props_default: dict
|
|
1515
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1516
|
-
:type prop_filepath: str | None
|
|
1517
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1518
|
-
|
|
1519
|
-
Returning false excludes the file from the list.
|
|
1520
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1521
|
-
:param filter_path:
|
|
1522
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1523
|
-
:type display_name: collections.abc.Callable | None
|
|
1524
|
-
:param add_operator:
|
|
1525
|
-
:param add_operator_props:
|
|
1526
|
-
"""
|
|
1527
|
-
...
|
|
1528
|
-
|
|
1529
|
-
def path_resolve(self):
|
|
1530
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1531
|
-
...
|
|
1532
|
-
|
|
1533
|
-
def pop(self):
|
|
1534
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1535
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1536
|
-
|
|
1537
|
-
"""
|
|
1538
|
-
...
|
|
1539
|
-
|
|
1540
|
-
def prepend(self, draw_func):
|
|
1541
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1542
|
-
the menus draw function
|
|
1543
|
-
|
|
1544
|
-
:param draw_func:
|
|
1545
|
-
"""
|
|
1546
|
-
...
|
|
1547
|
-
|
|
1548
|
-
def property_overridable_library_set(self) -> bool:
|
|
1549
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1550
|
-
|
|
1551
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1552
|
-
:rtype: bool
|
|
1553
|
-
"""
|
|
1554
|
-
...
|
|
1555
|
-
|
|
1556
|
-
def property_unset(self):
|
|
1557
|
-
"""Unset a property, will use default value afterward."""
|
|
1558
|
-
...
|
|
1559
|
-
|
|
1560
|
-
def remove(self, draw_func):
|
|
1561
|
-
"""Remove a draw function that has been added to this menu
|
|
1562
|
-
|
|
1563
|
-
:param draw_func:
|
|
1564
|
-
"""
|
|
1565
|
-
...
|
|
1566
|
-
|
|
1567
|
-
def type_recast(self):
|
|
1568
|
-
"""Return a new instance, this is needed because types
|
|
1569
|
-
such as textures can be changed at runtime.
|
|
1570
|
-
|
|
1571
|
-
:return: a new instance of this object with the type initialized again.
|
|
1572
|
-
"""
|
|
1573
|
-
...
|
|
1574
|
-
|
|
1575
|
-
def values(self):
|
|
1576
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1577
|
-
dictionary function of the same name).
|
|
1578
|
-
|
|
1579
|
-
:return: custom property values.
|
|
1580
|
-
"""
|
|
1581
|
-
...
|