fake-bpy-module 20240717__py3-none-any.whl → 20240719__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/screen/__init__.pyi +6 -3
- bpy/types/__init__.pyi +77 -5
- bpy_extras/node_shader_utils/__init__.pyi +0 -8
- {fake_bpy_module-20240717.dist-info → fake_bpy_module-20240719.dist-info}/METADATA +1 -1
- {fake_bpy_module-20240717.dist-info → fake_bpy_module-20240719.dist-info}/RECORD +119 -119
- {fake_bpy_module-20240717.dist-info → fake_bpy_module-20240719.dist-info}/WHEEL +1 -1
- keyingsets_builtins/__init__.pyi +268 -4448
- nodeitems_builtins/__init__.pyi +1 -7
- {fake_bpy_module-20240717.dist-info → fake_bpy_module-20240719.dist-info}/top_level.txt +0 -0
|
@@ -7,1384 +7,41 @@ import bpy_types
|
|
|
7
7
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
8
8
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
9
9
|
|
|
10
|
-
class MASK_MT_add(bpy_types._GenericUI):
|
|
10
|
+
class MASK_MT_add(bpy.types.Menu, bpy_types._GenericUI):
|
|
11
11
|
bl_idname: typing.Any
|
|
12
12
|
bl_label: typing.Any
|
|
13
13
|
bl_rna: typing.Any
|
|
14
14
|
bl_translation_context: typing.Any
|
|
15
15
|
id_data: typing.Any
|
|
16
16
|
|
|
17
|
-
def
|
|
18
|
-
"""Append a draw function to this menu,
|
|
19
|
-
takes the same arguments as the menus draw function
|
|
20
|
-
|
|
21
|
-
:param draw_func:
|
|
22
|
-
"""
|
|
23
|
-
...
|
|
24
|
-
|
|
25
|
-
def as_pointer(self) -> int:
|
|
26
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
27
|
-
|
|
28
|
-
:return: int (memory address).
|
|
29
|
-
:rtype: int
|
|
30
|
-
"""
|
|
31
|
-
...
|
|
32
|
-
|
|
33
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
34
|
-
"""
|
|
35
|
-
|
|
36
|
-
:return: The RNA type or default when not found.
|
|
37
|
-
:rtype: bpy.types.Struct
|
|
38
|
-
"""
|
|
39
|
-
...
|
|
40
|
-
|
|
41
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
42
|
-
"""
|
|
43
|
-
|
|
44
|
-
:return: The class or default when not found.
|
|
45
|
-
:rtype: typing.Any
|
|
46
|
-
"""
|
|
47
|
-
...
|
|
48
|
-
|
|
49
|
-
def draw(self, _context):
|
|
50
|
-
"""
|
|
51
|
-
|
|
52
|
-
:param _context:
|
|
53
|
-
"""
|
|
54
|
-
...
|
|
55
|
-
|
|
56
|
-
def draw_collapsible(self, context, layout):
|
|
57
|
-
"""
|
|
58
|
-
|
|
59
|
-
:param context:
|
|
60
|
-
:param layout:
|
|
61
|
-
"""
|
|
62
|
-
...
|
|
63
|
-
|
|
64
|
-
def draw_preset(self, _context):
|
|
65
|
-
"""Define these on the subclass:
|
|
66
|
-
- preset_operator (string)
|
|
67
|
-
- preset_subdir (string)Optionally:
|
|
68
|
-
- preset_add_operator (string)
|
|
69
|
-
- preset_extensions (set of strings)
|
|
70
|
-
- preset_operator_defaults (dict of keyword args)
|
|
71
|
-
|
|
72
|
-
:param _context:
|
|
73
|
-
"""
|
|
74
|
-
...
|
|
75
|
-
|
|
76
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
77
|
-
"""Adds driver(s) to the given property
|
|
78
|
-
|
|
79
|
-
:return: The driver(s) added.
|
|
80
|
-
:rtype: bpy.types.FCurve
|
|
81
|
-
"""
|
|
82
|
-
...
|
|
83
|
-
|
|
84
|
-
def driver_remove(self) -> bool:
|
|
85
|
-
"""Remove driver(s) from the given property
|
|
86
|
-
|
|
87
|
-
:return: Success of driver removal.
|
|
88
|
-
:rtype: bool
|
|
89
|
-
"""
|
|
90
|
-
...
|
|
91
|
-
|
|
92
|
-
def get(self):
|
|
93
|
-
"""Returns the value of the custom property assigned to key or default
|
|
94
|
-
when not found (matches Python's dictionary function of the same name).
|
|
95
|
-
|
|
96
|
-
"""
|
|
97
|
-
...
|
|
98
|
-
|
|
99
|
-
def id_properties_clear(self):
|
|
100
|
-
"""
|
|
101
|
-
|
|
102
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
103
|
-
"""
|
|
104
|
-
...
|
|
105
|
-
|
|
106
|
-
def id_properties_ensure(self):
|
|
107
|
-
"""
|
|
108
|
-
|
|
109
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
110
|
-
"""
|
|
111
|
-
...
|
|
112
|
-
|
|
113
|
-
def id_properties_ui(self):
|
|
114
|
-
"""
|
|
115
|
-
|
|
116
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
117
|
-
"""
|
|
118
|
-
...
|
|
119
|
-
|
|
120
|
-
def is_extended(self): ...
|
|
121
|
-
def is_property_hidden(self) -> bool:
|
|
122
|
-
"""Check if a property is hidden.
|
|
123
|
-
|
|
124
|
-
:return: True when the property is hidden.
|
|
125
|
-
:rtype: bool
|
|
126
|
-
"""
|
|
127
|
-
...
|
|
128
|
-
|
|
129
|
-
def is_property_overridable_library(self) -> bool:
|
|
130
|
-
"""Check if a property is overridable.
|
|
131
|
-
|
|
132
|
-
:return: True when the property is overridable.
|
|
133
|
-
:rtype: bool
|
|
134
|
-
"""
|
|
135
|
-
...
|
|
136
|
-
|
|
137
|
-
def is_property_readonly(self) -> bool:
|
|
138
|
-
"""Check if a property is readonly.
|
|
139
|
-
|
|
140
|
-
:return: True when the property is readonly (not writable).
|
|
141
|
-
:rtype: bool
|
|
142
|
-
"""
|
|
143
|
-
...
|
|
144
|
-
|
|
145
|
-
def is_property_set(self) -> bool:
|
|
146
|
-
"""Check if a property is set, use for testing operator properties.
|
|
147
|
-
|
|
148
|
-
:return: True when the property has been set.
|
|
149
|
-
:rtype: bool
|
|
150
|
-
"""
|
|
151
|
-
...
|
|
152
|
-
|
|
153
|
-
def items(self):
|
|
154
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
155
|
-
dictionary function of the same name).
|
|
156
|
-
|
|
157
|
-
:return: custom property key, value pairs.
|
|
158
|
-
"""
|
|
159
|
-
...
|
|
160
|
-
|
|
161
|
-
def keyframe_delete(self) -> bool:
|
|
162
|
-
"""Remove a keyframe from this properties fcurve.
|
|
163
|
-
|
|
164
|
-
:return: Success of keyframe deletion.
|
|
165
|
-
:rtype: bool
|
|
166
|
-
"""
|
|
167
|
-
...
|
|
168
|
-
|
|
169
|
-
def keyframe_insert(self) -> bool:
|
|
170
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
171
|
-
|
|
172
|
-
:return: Success of keyframe insertion.
|
|
173
|
-
:rtype: bool
|
|
174
|
-
"""
|
|
175
|
-
...
|
|
176
|
-
|
|
177
|
-
def keys(self):
|
|
178
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
179
|
-
dictionary function of the same name).
|
|
180
|
-
|
|
181
|
-
:return: custom property keys.
|
|
182
|
-
"""
|
|
183
|
-
...
|
|
184
|
-
|
|
185
|
-
def path_from_id(self) -> str:
|
|
186
|
-
"""Returns the data path from the ID to this object (string).
|
|
187
|
-
|
|
188
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
189
|
-
to this struct and property (when given).
|
|
190
|
-
:rtype: str
|
|
191
|
-
"""
|
|
192
|
-
...
|
|
193
|
-
|
|
194
|
-
def path_menu(
|
|
195
|
-
self,
|
|
196
|
-
searchpaths: list[str],
|
|
197
|
-
operator: str,
|
|
198
|
-
*,
|
|
199
|
-
props_default: dict = None,
|
|
200
|
-
prop_filepath: str | None = "filepath",
|
|
201
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
202
|
-
filter_path=None,
|
|
203
|
-
display_name: collections.abc.Callable | None = None,
|
|
204
|
-
add_operator=None,
|
|
205
|
-
add_operator_props=None,
|
|
206
|
-
):
|
|
207
|
-
"""Populate a menu from a list of paths.
|
|
208
|
-
|
|
209
|
-
:param searchpaths: Paths to scan.
|
|
210
|
-
:type searchpaths: list[str]
|
|
211
|
-
:param operator: The operator id to use with each file.
|
|
212
|
-
:type operator: str
|
|
213
|
-
:param props_default: Properties to assign to each operator.
|
|
214
|
-
:type props_default: dict
|
|
215
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
216
|
-
:type prop_filepath: str | None
|
|
217
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
218
|
-
|
|
219
|
-
Returning false excludes the file from the list.
|
|
220
|
-
:type filter_ext: collections.abc.Callable | None
|
|
221
|
-
:param filter_path:
|
|
222
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
223
|
-
:type display_name: collections.abc.Callable | None
|
|
224
|
-
:param add_operator:
|
|
225
|
-
:param add_operator_props:
|
|
226
|
-
"""
|
|
227
|
-
...
|
|
228
|
-
|
|
229
|
-
def path_resolve(self):
|
|
230
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
231
|
-
...
|
|
232
|
-
|
|
233
|
-
def pop(self):
|
|
234
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
235
|
-
when not found (matches Python's dictionary function of the same name).
|
|
236
|
-
|
|
237
|
-
"""
|
|
238
|
-
...
|
|
239
|
-
|
|
240
|
-
def prepend(self, draw_func):
|
|
241
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
242
|
-
the menus draw function
|
|
243
|
-
|
|
244
|
-
:param draw_func:
|
|
245
|
-
"""
|
|
246
|
-
...
|
|
247
|
-
|
|
248
|
-
def property_overridable_library_set(self) -> bool:
|
|
249
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
250
|
-
|
|
251
|
-
:return: True when the overridable status of the property was successfully set.
|
|
252
|
-
:rtype: bool
|
|
253
|
-
"""
|
|
254
|
-
...
|
|
255
|
-
|
|
256
|
-
def property_unset(self):
|
|
257
|
-
"""Unset a property, will use default value afterward."""
|
|
258
|
-
...
|
|
259
|
-
|
|
260
|
-
def remove(self, draw_func):
|
|
261
|
-
"""Remove a draw function that has been added to this menu
|
|
262
|
-
|
|
263
|
-
:param draw_func:
|
|
264
|
-
"""
|
|
265
|
-
...
|
|
266
|
-
|
|
267
|
-
def type_recast(self):
|
|
268
|
-
"""Return a new instance, this is needed because types
|
|
269
|
-
such as textures can be changed at runtime.
|
|
270
|
-
|
|
271
|
-
:return: a new instance of this object with the type initialized again.
|
|
272
|
-
"""
|
|
273
|
-
...
|
|
274
|
-
|
|
275
|
-
def values(self):
|
|
276
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
277
|
-
dictionary function of the same name).
|
|
278
|
-
|
|
279
|
-
:return: custom property values.
|
|
280
|
-
"""
|
|
281
|
-
...
|
|
282
|
-
|
|
283
|
-
class MASK_MT_animation(bpy_types._GenericUI):
|
|
284
|
-
bl_label: typing.Any
|
|
285
|
-
bl_rna: typing.Any
|
|
286
|
-
id_data: typing.Any
|
|
287
|
-
|
|
288
|
-
def append(self, draw_func):
|
|
289
|
-
"""Append a draw function to this menu,
|
|
290
|
-
takes the same arguments as the menus draw function
|
|
291
|
-
|
|
292
|
-
:param draw_func:
|
|
293
|
-
"""
|
|
294
|
-
...
|
|
295
|
-
|
|
296
|
-
def as_pointer(self) -> int:
|
|
297
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
298
|
-
|
|
299
|
-
:return: int (memory address).
|
|
300
|
-
:rtype: int
|
|
301
|
-
"""
|
|
302
|
-
...
|
|
303
|
-
|
|
304
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
305
|
-
"""
|
|
306
|
-
|
|
307
|
-
:return: The RNA type or default when not found.
|
|
308
|
-
:rtype: bpy.types.Struct
|
|
309
|
-
"""
|
|
310
|
-
...
|
|
311
|
-
|
|
312
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
313
|
-
"""
|
|
314
|
-
|
|
315
|
-
:return: The class or default when not found.
|
|
316
|
-
:rtype: typing.Any
|
|
317
|
-
"""
|
|
318
|
-
...
|
|
319
|
-
|
|
320
|
-
def draw(self, _context):
|
|
321
|
-
"""
|
|
322
|
-
|
|
323
|
-
:param _context:
|
|
324
|
-
"""
|
|
325
|
-
...
|
|
326
|
-
|
|
327
|
-
def draw_collapsible(self, context, layout):
|
|
328
|
-
"""
|
|
329
|
-
|
|
330
|
-
:param context:
|
|
331
|
-
:param layout:
|
|
332
|
-
"""
|
|
333
|
-
...
|
|
334
|
-
|
|
335
|
-
def draw_preset(self, _context):
|
|
336
|
-
"""Define these on the subclass:
|
|
337
|
-
- preset_operator (string)
|
|
338
|
-
- preset_subdir (string)Optionally:
|
|
339
|
-
- preset_add_operator (string)
|
|
340
|
-
- preset_extensions (set of strings)
|
|
341
|
-
- preset_operator_defaults (dict of keyword args)
|
|
342
|
-
|
|
343
|
-
:param _context:
|
|
344
|
-
"""
|
|
345
|
-
...
|
|
346
|
-
|
|
347
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
348
|
-
"""Adds driver(s) to the given property
|
|
349
|
-
|
|
350
|
-
:return: The driver(s) added.
|
|
351
|
-
:rtype: bpy.types.FCurve
|
|
352
|
-
"""
|
|
353
|
-
...
|
|
354
|
-
|
|
355
|
-
def driver_remove(self) -> bool:
|
|
356
|
-
"""Remove driver(s) from the given property
|
|
357
|
-
|
|
358
|
-
:return: Success of driver removal.
|
|
359
|
-
:rtype: bool
|
|
360
|
-
"""
|
|
361
|
-
...
|
|
362
|
-
|
|
363
|
-
def get(self):
|
|
364
|
-
"""Returns the value of the custom property assigned to key or default
|
|
365
|
-
when not found (matches Python's dictionary function of the same name).
|
|
366
|
-
|
|
367
|
-
"""
|
|
368
|
-
...
|
|
369
|
-
|
|
370
|
-
def id_properties_clear(self):
|
|
371
|
-
"""
|
|
372
|
-
|
|
373
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
374
|
-
"""
|
|
375
|
-
...
|
|
376
|
-
|
|
377
|
-
def id_properties_ensure(self):
|
|
378
|
-
"""
|
|
379
|
-
|
|
380
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
381
|
-
"""
|
|
382
|
-
...
|
|
383
|
-
|
|
384
|
-
def id_properties_ui(self):
|
|
385
|
-
"""
|
|
386
|
-
|
|
387
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
388
|
-
"""
|
|
389
|
-
...
|
|
390
|
-
|
|
391
|
-
def is_extended(self): ...
|
|
392
|
-
def is_property_hidden(self) -> bool:
|
|
393
|
-
"""Check if a property is hidden.
|
|
394
|
-
|
|
395
|
-
:return: True when the property is hidden.
|
|
396
|
-
:rtype: bool
|
|
397
|
-
"""
|
|
398
|
-
...
|
|
399
|
-
|
|
400
|
-
def is_property_overridable_library(self) -> bool:
|
|
401
|
-
"""Check if a property is overridable.
|
|
402
|
-
|
|
403
|
-
:return: True when the property is overridable.
|
|
404
|
-
:rtype: bool
|
|
405
|
-
"""
|
|
406
|
-
...
|
|
407
|
-
|
|
408
|
-
def is_property_readonly(self) -> bool:
|
|
409
|
-
"""Check if a property is readonly.
|
|
410
|
-
|
|
411
|
-
:return: True when the property is readonly (not writable).
|
|
412
|
-
:rtype: bool
|
|
413
|
-
"""
|
|
414
|
-
...
|
|
415
|
-
|
|
416
|
-
def is_property_set(self) -> bool:
|
|
417
|
-
"""Check if a property is set, use for testing operator properties.
|
|
418
|
-
|
|
419
|
-
:return: True when the property has been set.
|
|
420
|
-
:rtype: bool
|
|
421
|
-
"""
|
|
422
|
-
...
|
|
423
|
-
|
|
424
|
-
def items(self):
|
|
425
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
426
|
-
dictionary function of the same name).
|
|
427
|
-
|
|
428
|
-
:return: custom property key, value pairs.
|
|
429
|
-
"""
|
|
430
|
-
...
|
|
431
|
-
|
|
432
|
-
def keyframe_delete(self) -> bool:
|
|
433
|
-
"""Remove a keyframe from this properties fcurve.
|
|
434
|
-
|
|
435
|
-
:return: Success of keyframe deletion.
|
|
436
|
-
:rtype: bool
|
|
437
|
-
"""
|
|
438
|
-
...
|
|
439
|
-
|
|
440
|
-
def keyframe_insert(self) -> bool:
|
|
441
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
442
|
-
|
|
443
|
-
:return: Success of keyframe insertion.
|
|
444
|
-
:rtype: bool
|
|
445
|
-
"""
|
|
446
|
-
...
|
|
447
|
-
|
|
448
|
-
def keys(self):
|
|
449
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
450
|
-
dictionary function of the same name).
|
|
451
|
-
|
|
452
|
-
:return: custom property keys.
|
|
453
|
-
"""
|
|
454
|
-
...
|
|
455
|
-
|
|
456
|
-
def path_from_id(self) -> str:
|
|
457
|
-
"""Returns the data path from the ID to this object (string).
|
|
458
|
-
|
|
459
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
460
|
-
to this struct and property (when given).
|
|
461
|
-
:rtype: str
|
|
462
|
-
"""
|
|
463
|
-
...
|
|
464
|
-
|
|
465
|
-
def path_menu(
|
|
466
|
-
self,
|
|
467
|
-
searchpaths: list[str],
|
|
468
|
-
operator: str,
|
|
469
|
-
*,
|
|
470
|
-
props_default: dict = None,
|
|
471
|
-
prop_filepath: str | None = "filepath",
|
|
472
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
473
|
-
filter_path=None,
|
|
474
|
-
display_name: collections.abc.Callable | None = None,
|
|
475
|
-
add_operator=None,
|
|
476
|
-
add_operator_props=None,
|
|
477
|
-
):
|
|
478
|
-
"""Populate a menu from a list of paths.
|
|
479
|
-
|
|
480
|
-
:param searchpaths: Paths to scan.
|
|
481
|
-
:type searchpaths: list[str]
|
|
482
|
-
:param operator: The operator id to use with each file.
|
|
483
|
-
:type operator: str
|
|
484
|
-
:param props_default: Properties to assign to each operator.
|
|
485
|
-
:type props_default: dict
|
|
486
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
487
|
-
:type prop_filepath: str | None
|
|
488
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
489
|
-
|
|
490
|
-
Returning false excludes the file from the list.
|
|
491
|
-
:type filter_ext: collections.abc.Callable | None
|
|
492
|
-
:param filter_path:
|
|
493
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
494
|
-
:type display_name: collections.abc.Callable | None
|
|
495
|
-
:param add_operator:
|
|
496
|
-
:param add_operator_props:
|
|
497
|
-
"""
|
|
498
|
-
...
|
|
499
|
-
|
|
500
|
-
def path_resolve(self):
|
|
501
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
502
|
-
...
|
|
503
|
-
|
|
504
|
-
def pop(self):
|
|
505
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
506
|
-
when not found (matches Python's dictionary function of the same name).
|
|
507
|
-
|
|
508
|
-
"""
|
|
509
|
-
...
|
|
510
|
-
|
|
511
|
-
def prepend(self, draw_func):
|
|
512
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
513
|
-
the menus draw function
|
|
514
|
-
|
|
515
|
-
:param draw_func:
|
|
516
|
-
"""
|
|
517
|
-
...
|
|
518
|
-
|
|
519
|
-
def property_overridable_library_set(self) -> bool:
|
|
520
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
521
|
-
|
|
522
|
-
:return: True when the overridable status of the property was successfully set.
|
|
523
|
-
:rtype: bool
|
|
524
|
-
"""
|
|
525
|
-
...
|
|
526
|
-
|
|
527
|
-
def property_unset(self):
|
|
528
|
-
"""Unset a property, will use default value afterward."""
|
|
529
|
-
...
|
|
530
|
-
|
|
531
|
-
def remove(self, draw_func):
|
|
532
|
-
"""Remove a draw function that has been added to this menu
|
|
533
|
-
|
|
534
|
-
:param draw_func:
|
|
535
|
-
"""
|
|
536
|
-
...
|
|
537
|
-
|
|
538
|
-
def type_recast(self):
|
|
539
|
-
"""Return a new instance, this is needed because types
|
|
540
|
-
such as textures can be changed at runtime.
|
|
541
|
-
|
|
542
|
-
:return: a new instance of this object with the type initialized again.
|
|
543
|
-
"""
|
|
544
|
-
...
|
|
545
|
-
|
|
546
|
-
def values(self):
|
|
547
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
548
|
-
dictionary function of the same name).
|
|
549
|
-
|
|
550
|
-
:return: custom property values.
|
|
551
|
-
"""
|
|
552
|
-
...
|
|
553
|
-
|
|
554
|
-
class MASK_MT_mask(bpy_types._GenericUI):
|
|
555
|
-
bl_label: typing.Any
|
|
556
|
-
bl_rna: typing.Any
|
|
557
|
-
id_data: typing.Any
|
|
558
|
-
|
|
559
|
-
def append(self, draw_func):
|
|
560
|
-
"""Append a draw function to this menu,
|
|
561
|
-
takes the same arguments as the menus draw function
|
|
562
|
-
|
|
563
|
-
:param draw_func:
|
|
564
|
-
"""
|
|
565
|
-
...
|
|
566
|
-
|
|
567
|
-
def as_pointer(self) -> int:
|
|
568
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
569
|
-
|
|
570
|
-
:return: int (memory address).
|
|
571
|
-
:rtype: int
|
|
572
|
-
"""
|
|
573
|
-
...
|
|
574
|
-
|
|
575
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
576
|
-
"""
|
|
577
|
-
|
|
578
|
-
:return: The RNA type or default when not found.
|
|
579
|
-
:rtype: bpy.types.Struct
|
|
580
|
-
"""
|
|
581
|
-
...
|
|
582
|
-
|
|
583
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
584
|
-
"""
|
|
585
|
-
|
|
586
|
-
:return: The class or default when not found.
|
|
587
|
-
:rtype: typing.Any
|
|
588
|
-
"""
|
|
589
|
-
...
|
|
590
|
-
|
|
591
|
-
def draw(self, _context):
|
|
592
|
-
"""
|
|
593
|
-
|
|
594
|
-
:param _context:
|
|
595
|
-
"""
|
|
596
|
-
...
|
|
597
|
-
|
|
598
|
-
def draw_collapsible(self, context, layout):
|
|
599
|
-
"""
|
|
600
|
-
|
|
601
|
-
:param context:
|
|
602
|
-
:param layout:
|
|
603
|
-
"""
|
|
604
|
-
...
|
|
605
|
-
|
|
606
|
-
def draw_preset(self, _context):
|
|
607
|
-
"""Define these on the subclass:
|
|
608
|
-
- preset_operator (string)
|
|
609
|
-
- preset_subdir (string)Optionally:
|
|
610
|
-
- preset_add_operator (string)
|
|
611
|
-
- preset_extensions (set of strings)
|
|
612
|
-
- preset_operator_defaults (dict of keyword args)
|
|
613
|
-
|
|
614
|
-
:param _context:
|
|
615
|
-
"""
|
|
616
|
-
...
|
|
617
|
-
|
|
618
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
619
|
-
"""Adds driver(s) to the given property
|
|
620
|
-
|
|
621
|
-
:return: The driver(s) added.
|
|
622
|
-
:rtype: bpy.types.FCurve
|
|
623
|
-
"""
|
|
624
|
-
...
|
|
625
|
-
|
|
626
|
-
def driver_remove(self) -> bool:
|
|
627
|
-
"""Remove driver(s) from the given property
|
|
628
|
-
|
|
629
|
-
:return: Success of driver removal.
|
|
630
|
-
:rtype: bool
|
|
631
|
-
"""
|
|
632
|
-
...
|
|
633
|
-
|
|
634
|
-
def get(self):
|
|
635
|
-
"""Returns the value of the custom property assigned to key or default
|
|
636
|
-
when not found (matches Python's dictionary function of the same name).
|
|
637
|
-
|
|
638
|
-
"""
|
|
639
|
-
...
|
|
640
|
-
|
|
641
|
-
def id_properties_clear(self):
|
|
642
|
-
"""
|
|
643
|
-
|
|
644
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
645
|
-
"""
|
|
646
|
-
...
|
|
647
|
-
|
|
648
|
-
def id_properties_ensure(self):
|
|
649
|
-
"""
|
|
650
|
-
|
|
651
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
652
|
-
"""
|
|
653
|
-
...
|
|
654
|
-
|
|
655
|
-
def id_properties_ui(self):
|
|
656
|
-
"""
|
|
657
|
-
|
|
658
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
659
|
-
"""
|
|
660
|
-
...
|
|
661
|
-
|
|
662
|
-
def is_extended(self): ...
|
|
663
|
-
def is_property_hidden(self) -> bool:
|
|
664
|
-
"""Check if a property is hidden.
|
|
665
|
-
|
|
666
|
-
:return: True when the property is hidden.
|
|
667
|
-
:rtype: bool
|
|
668
|
-
"""
|
|
669
|
-
...
|
|
670
|
-
|
|
671
|
-
def is_property_overridable_library(self) -> bool:
|
|
672
|
-
"""Check if a property is overridable.
|
|
673
|
-
|
|
674
|
-
:return: True when the property is overridable.
|
|
675
|
-
:rtype: bool
|
|
676
|
-
"""
|
|
677
|
-
...
|
|
678
|
-
|
|
679
|
-
def is_property_readonly(self) -> bool:
|
|
680
|
-
"""Check if a property is readonly.
|
|
681
|
-
|
|
682
|
-
:return: True when the property is readonly (not writable).
|
|
683
|
-
:rtype: bool
|
|
684
|
-
"""
|
|
685
|
-
...
|
|
686
|
-
|
|
687
|
-
def is_property_set(self) -> bool:
|
|
688
|
-
"""Check if a property is set, use for testing operator properties.
|
|
689
|
-
|
|
690
|
-
:return: True when the property has been set.
|
|
691
|
-
:rtype: bool
|
|
692
|
-
"""
|
|
693
|
-
...
|
|
694
|
-
|
|
695
|
-
def items(self):
|
|
696
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
697
|
-
dictionary function of the same name).
|
|
698
|
-
|
|
699
|
-
:return: custom property key, value pairs.
|
|
700
|
-
"""
|
|
701
|
-
...
|
|
702
|
-
|
|
703
|
-
def keyframe_delete(self) -> bool:
|
|
704
|
-
"""Remove a keyframe from this properties fcurve.
|
|
705
|
-
|
|
706
|
-
:return: Success of keyframe deletion.
|
|
707
|
-
:rtype: bool
|
|
708
|
-
"""
|
|
709
|
-
...
|
|
710
|
-
|
|
711
|
-
def keyframe_insert(self) -> bool:
|
|
712
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
713
|
-
|
|
714
|
-
:return: Success of keyframe insertion.
|
|
715
|
-
:rtype: bool
|
|
716
|
-
"""
|
|
717
|
-
...
|
|
718
|
-
|
|
719
|
-
def keys(self):
|
|
720
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
721
|
-
dictionary function of the same name).
|
|
722
|
-
|
|
723
|
-
:return: custom property keys.
|
|
724
|
-
"""
|
|
725
|
-
...
|
|
726
|
-
|
|
727
|
-
def path_from_id(self) -> str:
|
|
728
|
-
"""Returns the data path from the ID to this object (string).
|
|
729
|
-
|
|
730
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
731
|
-
to this struct and property (when given).
|
|
732
|
-
:rtype: str
|
|
733
|
-
"""
|
|
734
|
-
...
|
|
735
|
-
|
|
736
|
-
def path_menu(
|
|
737
|
-
self,
|
|
738
|
-
searchpaths: list[str],
|
|
739
|
-
operator: str,
|
|
740
|
-
*,
|
|
741
|
-
props_default: dict = None,
|
|
742
|
-
prop_filepath: str | None = "filepath",
|
|
743
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
744
|
-
filter_path=None,
|
|
745
|
-
display_name: collections.abc.Callable | None = None,
|
|
746
|
-
add_operator=None,
|
|
747
|
-
add_operator_props=None,
|
|
748
|
-
):
|
|
749
|
-
"""Populate a menu from a list of paths.
|
|
750
|
-
|
|
751
|
-
:param searchpaths: Paths to scan.
|
|
752
|
-
:type searchpaths: list[str]
|
|
753
|
-
:param operator: The operator id to use with each file.
|
|
754
|
-
:type operator: str
|
|
755
|
-
:param props_default: Properties to assign to each operator.
|
|
756
|
-
:type props_default: dict
|
|
757
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
758
|
-
:type prop_filepath: str | None
|
|
759
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
760
|
-
|
|
761
|
-
Returning false excludes the file from the list.
|
|
762
|
-
:type filter_ext: collections.abc.Callable | None
|
|
763
|
-
:param filter_path:
|
|
764
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
765
|
-
:type display_name: collections.abc.Callable | None
|
|
766
|
-
:param add_operator:
|
|
767
|
-
:param add_operator_props:
|
|
768
|
-
"""
|
|
769
|
-
...
|
|
770
|
-
|
|
771
|
-
def path_resolve(self):
|
|
772
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
773
|
-
...
|
|
774
|
-
|
|
775
|
-
def pop(self):
|
|
776
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
777
|
-
when not found (matches Python's dictionary function of the same name).
|
|
778
|
-
|
|
779
|
-
"""
|
|
780
|
-
...
|
|
781
|
-
|
|
782
|
-
def prepend(self, draw_func):
|
|
783
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
784
|
-
the menus draw function
|
|
785
|
-
|
|
786
|
-
:param draw_func:
|
|
787
|
-
"""
|
|
788
|
-
...
|
|
789
|
-
|
|
790
|
-
def property_overridable_library_set(self) -> bool:
|
|
791
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
792
|
-
|
|
793
|
-
:return: True when the overridable status of the property was successfully set.
|
|
794
|
-
:rtype: bool
|
|
795
|
-
"""
|
|
796
|
-
...
|
|
797
|
-
|
|
798
|
-
def property_unset(self):
|
|
799
|
-
"""Unset a property, will use default value afterward."""
|
|
800
|
-
...
|
|
801
|
-
|
|
802
|
-
def remove(self, draw_func):
|
|
803
|
-
"""Remove a draw function that has been added to this menu
|
|
804
|
-
|
|
805
|
-
:param draw_func:
|
|
806
|
-
"""
|
|
807
|
-
...
|
|
808
|
-
|
|
809
|
-
def type_recast(self):
|
|
810
|
-
"""Return a new instance, this is needed because types
|
|
811
|
-
such as textures can be changed at runtime.
|
|
812
|
-
|
|
813
|
-
:return: a new instance of this object with the type initialized again.
|
|
814
|
-
"""
|
|
815
|
-
...
|
|
816
|
-
|
|
817
|
-
def values(self):
|
|
818
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
819
|
-
dictionary function of the same name).
|
|
820
|
-
|
|
821
|
-
:return: custom property values.
|
|
822
|
-
"""
|
|
823
|
-
...
|
|
824
|
-
|
|
825
|
-
class MASK_MT_select(bpy_types._GenericUI):
|
|
826
|
-
bl_label: typing.Any
|
|
827
|
-
bl_rna: typing.Any
|
|
828
|
-
id_data: typing.Any
|
|
829
|
-
|
|
830
|
-
def append(self, draw_func):
|
|
831
|
-
"""Append a draw function to this menu,
|
|
832
|
-
takes the same arguments as the menus draw function
|
|
833
|
-
|
|
834
|
-
:param draw_func:
|
|
835
|
-
"""
|
|
836
|
-
...
|
|
837
|
-
|
|
838
|
-
def as_pointer(self) -> int:
|
|
839
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
840
|
-
|
|
841
|
-
:return: int (memory address).
|
|
842
|
-
:rtype: int
|
|
843
|
-
"""
|
|
844
|
-
...
|
|
845
|
-
|
|
846
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
847
|
-
"""
|
|
848
|
-
|
|
849
|
-
:return: The RNA type or default when not found.
|
|
850
|
-
:rtype: bpy.types.Struct
|
|
851
|
-
"""
|
|
852
|
-
...
|
|
853
|
-
|
|
854
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
855
|
-
"""
|
|
856
|
-
|
|
857
|
-
:return: The class or default when not found.
|
|
858
|
-
:rtype: typing.Any
|
|
859
|
-
"""
|
|
860
|
-
...
|
|
861
|
-
|
|
862
|
-
def draw(self, _context):
|
|
863
|
-
"""
|
|
864
|
-
|
|
865
|
-
:param _context:
|
|
866
|
-
"""
|
|
867
|
-
...
|
|
868
|
-
|
|
869
|
-
def draw_collapsible(self, context, layout):
|
|
870
|
-
"""
|
|
871
|
-
|
|
872
|
-
:param context:
|
|
873
|
-
:param layout:
|
|
874
|
-
"""
|
|
875
|
-
...
|
|
876
|
-
|
|
877
|
-
def draw_preset(self, _context):
|
|
878
|
-
"""Define these on the subclass:
|
|
879
|
-
- preset_operator (string)
|
|
880
|
-
- preset_subdir (string)Optionally:
|
|
881
|
-
- preset_add_operator (string)
|
|
882
|
-
- preset_extensions (set of strings)
|
|
883
|
-
- preset_operator_defaults (dict of keyword args)
|
|
884
|
-
|
|
885
|
-
:param _context:
|
|
886
|
-
"""
|
|
887
|
-
...
|
|
888
|
-
|
|
889
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
890
|
-
"""Adds driver(s) to the given property
|
|
891
|
-
|
|
892
|
-
:return: The driver(s) added.
|
|
893
|
-
:rtype: bpy.types.FCurve
|
|
894
|
-
"""
|
|
895
|
-
...
|
|
896
|
-
|
|
897
|
-
def driver_remove(self) -> bool:
|
|
898
|
-
"""Remove driver(s) from the given property
|
|
899
|
-
|
|
900
|
-
:return: Success of driver removal.
|
|
901
|
-
:rtype: bool
|
|
902
|
-
"""
|
|
903
|
-
...
|
|
904
|
-
|
|
905
|
-
def get(self):
|
|
906
|
-
"""Returns the value of the custom property assigned to key or default
|
|
907
|
-
when not found (matches Python's dictionary function of the same name).
|
|
908
|
-
|
|
909
|
-
"""
|
|
910
|
-
...
|
|
911
|
-
|
|
912
|
-
def id_properties_clear(self):
|
|
913
|
-
"""
|
|
914
|
-
|
|
915
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
916
|
-
"""
|
|
917
|
-
...
|
|
918
|
-
|
|
919
|
-
def id_properties_ensure(self):
|
|
920
|
-
"""
|
|
921
|
-
|
|
922
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
923
|
-
"""
|
|
924
|
-
...
|
|
925
|
-
|
|
926
|
-
def id_properties_ui(self):
|
|
927
|
-
"""
|
|
928
|
-
|
|
929
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
930
|
-
"""
|
|
931
|
-
...
|
|
932
|
-
|
|
933
|
-
def is_extended(self): ...
|
|
934
|
-
def is_property_hidden(self) -> bool:
|
|
935
|
-
"""Check if a property is hidden.
|
|
936
|
-
|
|
937
|
-
:return: True when the property is hidden.
|
|
938
|
-
:rtype: bool
|
|
939
|
-
"""
|
|
940
|
-
...
|
|
941
|
-
|
|
942
|
-
def is_property_overridable_library(self) -> bool:
|
|
943
|
-
"""Check if a property is overridable.
|
|
944
|
-
|
|
945
|
-
:return: True when the property is overridable.
|
|
946
|
-
:rtype: bool
|
|
947
|
-
"""
|
|
948
|
-
...
|
|
949
|
-
|
|
950
|
-
def is_property_readonly(self) -> bool:
|
|
951
|
-
"""Check if a property is readonly.
|
|
952
|
-
|
|
953
|
-
:return: True when the property is readonly (not writable).
|
|
954
|
-
:rtype: bool
|
|
955
|
-
"""
|
|
956
|
-
...
|
|
957
|
-
|
|
958
|
-
def is_property_set(self) -> bool:
|
|
959
|
-
"""Check if a property is set, use for testing operator properties.
|
|
960
|
-
|
|
961
|
-
:return: True when the property has been set.
|
|
962
|
-
:rtype: bool
|
|
963
|
-
"""
|
|
964
|
-
...
|
|
965
|
-
|
|
966
|
-
def items(self):
|
|
967
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
968
|
-
dictionary function of the same name).
|
|
969
|
-
|
|
970
|
-
:return: custom property key, value pairs.
|
|
971
|
-
"""
|
|
972
|
-
...
|
|
973
|
-
|
|
974
|
-
def keyframe_delete(self) -> bool:
|
|
975
|
-
"""Remove a keyframe from this properties fcurve.
|
|
976
|
-
|
|
977
|
-
:return: Success of keyframe deletion.
|
|
978
|
-
:rtype: bool
|
|
979
|
-
"""
|
|
980
|
-
...
|
|
981
|
-
|
|
982
|
-
def keyframe_insert(self) -> bool:
|
|
983
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
984
|
-
|
|
985
|
-
:return: Success of keyframe insertion.
|
|
986
|
-
:rtype: bool
|
|
987
|
-
"""
|
|
988
|
-
...
|
|
989
|
-
|
|
990
|
-
def keys(self):
|
|
991
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
992
|
-
dictionary function of the same name).
|
|
993
|
-
|
|
994
|
-
:return: custom property keys.
|
|
995
|
-
"""
|
|
996
|
-
...
|
|
997
|
-
|
|
998
|
-
def path_from_id(self) -> str:
|
|
999
|
-
"""Returns the data path from the ID to this object (string).
|
|
1000
|
-
|
|
1001
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1002
|
-
to this struct and property (when given).
|
|
1003
|
-
:rtype: str
|
|
1004
|
-
"""
|
|
1005
|
-
...
|
|
1006
|
-
|
|
1007
|
-
def path_menu(
|
|
1008
|
-
self,
|
|
1009
|
-
searchpaths: list[str],
|
|
1010
|
-
operator: str,
|
|
1011
|
-
*,
|
|
1012
|
-
props_default: dict = None,
|
|
1013
|
-
prop_filepath: str | None = "filepath",
|
|
1014
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1015
|
-
filter_path=None,
|
|
1016
|
-
display_name: collections.abc.Callable | None = None,
|
|
1017
|
-
add_operator=None,
|
|
1018
|
-
add_operator_props=None,
|
|
1019
|
-
):
|
|
1020
|
-
"""Populate a menu from a list of paths.
|
|
1021
|
-
|
|
1022
|
-
:param searchpaths: Paths to scan.
|
|
1023
|
-
:type searchpaths: list[str]
|
|
1024
|
-
:param operator: The operator id to use with each file.
|
|
1025
|
-
:type operator: str
|
|
1026
|
-
:param props_default: Properties to assign to each operator.
|
|
1027
|
-
:type props_default: dict
|
|
1028
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1029
|
-
:type prop_filepath: str | None
|
|
1030
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1031
|
-
|
|
1032
|
-
Returning false excludes the file from the list.
|
|
1033
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1034
|
-
:param filter_path:
|
|
1035
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1036
|
-
:type display_name: collections.abc.Callable | None
|
|
1037
|
-
:param add_operator:
|
|
1038
|
-
:param add_operator_props:
|
|
1039
|
-
"""
|
|
1040
|
-
...
|
|
1041
|
-
|
|
1042
|
-
def path_resolve(self):
|
|
1043
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1044
|
-
...
|
|
1045
|
-
|
|
1046
|
-
def pop(self):
|
|
1047
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1048
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1049
|
-
|
|
1050
|
-
"""
|
|
1051
|
-
...
|
|
1052
|
-
|
|
1053
|
-
def prepend(self, draw_func):
|
|
1054
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1055
|
-
the menus draw function
|
|
1056
|
-
|
|
1057
|
-
:param draw_func:
|
|
1058
|
-
"""
|
|
1059
|
-
...
|
|
1060
|
-
|
|
1061
|
-
def property_overridable_library_set(self) -> bool:
|
|
1062
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1063
|
-
|
|
1064
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1065
|
-
:rtype: bool
|
|
1066
|
-
"""
|
|
1067
|
-
...
|
|
1068
|
-
|
|
1069
|
-
def property_unset(self):
|
|
1070
|
-
"""Unset a property, will use default value afterward."""
|
|
1071
|
-
...
|
|
1072
|
-
|
|
1073
|
-
def remove(self, draw_func):
|
|
1074
|
-
"""Remove a draw function that has been added to this menu
|
|
1075
|
-
|
|
1076
|
-
:param draw_func:
|
|
1077
|
-
"""
|
|
1078
|
-
...
|
|
1079
|
-
|
|
1080
|
-
def type_recast(self):
|
|
1081
|
-
"""Return a new instance, this is needed because types
|
|
1082
|
-
such as textures can be changed at runtime.
|
|
1083
|
-
|
|
1084
|
-
:return: a new instance of this object with the type initialized again.
|
|
1085
|
-
"""
|
|
1086
|
-
...
|
|
1087
|
-
|
|
1088
|
-
def values(self):
|
|
1089
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1090
|
-
dictionary function of the same name).
|
|
1091
|
-
|
|
1092
|
-
:return: custom property values.
|
|
1093
|
-
"""
|
|
1094
|
-
...
|
|
1095
|
-
|
|
1096
|
-
class MASK_MT_transform(bpy_types._GenericUI):
|
|
1097
|
-
bl_label: typing.Any
|
|
1098
|
-
bl_rna: typing.Any
|
|
1099
|
-
id_data: typing.Any
|
|
1100
|
-
|
|
1101
|
-
def append(self, draw_func):
|
|
1102
|
-
"""Append a draw function to this menu,
|
|
1103
|
-
takes the same arguments as the menus draw function
|
|
1104
|
-
|
|
1105
|
-
:param draw_func:
|
|
1106
|
-
"""
|
|
1107
|
-
...
|
|
1108
|
-
|
|
1109
|
-
def as_pointer(self) -> int:
|
|
1110
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1111
|
-
|
|
1112
|
-
:return: int (memory address).
|
|
1113
|
-
:rtype: int
|
|
1114
|
-
"""
|
|
1115
|
-
...
|
|
1116
|
-
|
|
1117
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1118
|
-
"""
|
|
1119
|
-
|
|
1120
|
-
:return: The RNA type or default when not found.
|
|
1121
|
-
:rtype: bpy.types.Struct
|
|
1122
|
-
"""
|
|
1123
|
-
...
|
|
1124
|
-
|
|
1125
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1126
|
-
"""
|
|
1127
|
-
|
|
1128
|
-
:return: The class or default when not found.
|
|
1129
|
-
:rtype: typing.Any
|
|
1130
|
-
"""
|
|
1131
|
-
...
|
|
1132
|
-
|
|
1133
|
-
def draw(self, _context):
|
|
1134
|
-
"""
|
|
1135
|
-
|
|
1136
|
-
:param _context:
|
|
1137
|
-
"""
|
|
1138
|
-
...
|
|
1139
|
-
|
|
1140
|
-
def draw_collapsible(self, context, layout):
|
|
1141
|
-
"""
|
|
1142
|
-
|
|
1143
|
-
:param context:
|
|
1144
|
-
:param layout:
|
|
1145
|
-
"""
|
|
1146
|
-
...
|
|
1147
|
-
|
|
1148
|
-
def draw_preset(self, _context):
|
|
1149
|
-
"""Define these on the subclass:
|
|
1150
|
-
- preset_operator (string)
|
|
1151
|
-
- preset_subdir (string)Optionally:
|
|
1152
|
-
- preset_add_operator (string)
|
|
1153
|
-
- preset_extensions (set of strings)
|
|
1154
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1155
|
-
|
|
1156
|
-
:param _context:
|
|
1157
|
-
"""
|
|
1158
|
-
...
|
|
1159
|
-
|
|
1160
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1161
|
-
"""Adds driver(s) to the given property
|
|
1162
|
-
|
|
1163
|
-
:return: The driver(s) added.
|
|
1164
|
-
:rtype: bpy.types.FCurve
|
|
1165
|
-
"""
|
|
1166
|
-
...
|
|
1167
|
-
|
|
1168
|
-
def driver_remove(self) -> bool:
|
|
1169
|
-
"""Remove driver(s) from the given property
|
|
1170
|
-
|
|
1171
|
-
:return: Success of driver removal.
|
|
1172
|
-
:rtype: bool
|
|
1173
|
-
"""
|
|
1174
|
-
...
|
|
1175
|
-
|
|
1176
|
-
def get(self):
|
|
1177
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1178
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1179
|
-
|
|
1180
|
-
"""
|
|
1181
|
-
...
|
|
1182
|
-
|
|
1183
|
-
def id_properties_clear(self):
|
|
1184
|
-
"""
|
|
1185
|
-
|
|
1186
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1187
|
-
"""
|
|
1188
|
-
...
|
|
1189
|
-
|
|
1190
|
-
def id_properties_ensure(self):
|
|
1191
|
-
"""
|
|
1192
|
-
|
|
1193
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1194
|
-
"""
|
|
1195
|
-
...
|
|
1196
|
-
|
|
1197
|
-
def id_properties_ui(self):
|
|
1198
|
-
"""
|
|
1199
|
-
|
|
1200
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1201
|
-
"""
|
|
1202
|
-
...
|
|
1203
|
-
|
|
1204
|
-
def is_extended(self): ...
|
|
1205
|
-
def is_property_hidden(self) -> bool:
|
|
1206
|
-
"""Check if a property is hidden.
|
|
1207
|
-
|
|
1208
|
-
:return: True when the property is hidden.
|
|
1209
|
-
:rtype: bool
|
|
1210
|
-
"""
|
|
1211
|
-
...
|
|
1212
|
-
|
|
1213
|
-
def is_property_overridable_library(self) -> bool:
|
|
1214
|
-
"""Check if a property is overridable.
|
|
1215
|
-
|
|
1216
|
-
:return: True when the property is overridable.
|
|
1217
|
-
:rtype: bool
|
|
1218
|
-
"""
|
|
1219
|
-
...
|
|
1220
|
-
|
|
1221
|
-
def is_property_readonly(self) -> bool:
|
|
1222
|
-
"""Check if a property is readonly.
|
|
1223
|
-
|
|
1224
|
-
:return: True when the property is readonly (not writable).
|
|
1225
|
-
:rtype: bool
|
|
1226
|
-
"""
|
|
1227
|
-
...
|
|
1228
|
-
|
|
1229
|
-
def is_property_set(self) -> bool:
|
|
1230
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1231
|
-
|
|
1232
|
-
:return: True when the property has been set.
|
|
1233
|
-
:rtype: bool
|
|
1234
|
-
"""
|
|
1235
|
-
...
|
|
1236
|
-
|
|
1237
|
-
def items(self):
|
|
1238
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1239
|
-
dictionary function of the same name).
|
|
1240
|
-
|
|
1241
|
-
:return: custom property key, value pairs.
|
|
1242
|
-
"""
|
|
1243
|
-
...
|
|
1244
|
-
|
|
1245
|
-
def keyframe_delete(self) -> bool:
|
|
1246
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1247
|
-
|
|
1248
|
-
:return: Success of keyframe deletion.
|
|
1249
|
-
:rtype: bool
|
|
1250
|
-
"""
|
|
1251
|
-
...
|
|
1252
|
-
|
|
1253
|
-
def keyframe_insert(self) -> bool:
|
|
1254
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1255
|
-
|
|
1256
|
-
:return: Success of keyframe insertion.
|
|
1257
|
-
:rtype: bool
|
|
1258
|
-
"""
|
|
1259
|
-
...
|
|
1260
|
-
|
|
1261
|
-
def keys(self):
|
|
1262
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1263
|
-
dictionary function of the same name).
|
|
1264
|
-
|
|
1265
|
-
:return: custom property keys.
|
|
1266
|
-
"""
|
|
1267
|
-
...
|
|
1268
|
-
|
|
1269
|
-
def path_from_id(self) -> str:
|
|
1270
|
-
"""Returns the data path from the ID to this object (string).
|
|
1271
|
-
|
|
1272
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1273
|
-
to this struct and property (when given).
|
|
1274
|
-
:rtype: str
|
|
1275
|
-
"""
|
|
1276
|
-
...
|
|
1277
|
-
|
|
1278
|
-
def path_menu(
|
|
1279
|
-
self,
|
|
1280
|
-
searchpaths: list[str],
|
|
1281
|
-
operator: str,
|
|
1282
|
-
*,
|
|
1283
|
-
props_default: dict = None,
|
|
1284
|
-
prop_filepath: str | None = "filepath",
|
|
1285
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1286
|
-
filter_path=None,
|
|
1287
|
-
display_name: collections.abc.Callable | None = None,
|
|
1288
|
-
add_operator=None,
|
|
1289
|
-
add_operator_props=None,
|
|
1290
|
-
):
|
|
1291
|
-
"""Populate a menu from a list of paths.
|
|
1292
|
-
|
|
1293
|
-
:param searchpaths: Paths to scan.
|
|
1294
|
-
:type searchpaths: list[str]
|
|
1295
|
-
:param operator: The operator id to use with each file.
|
|
1296
|
-
:type operator: str
|
|
1297
|
-
:param props_default: Properties to assign to each operator.
|
|
1298
|
-
:type props_default: dict
|
|
1299
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1300
|
-
:type prop_filepath: str | None
|
|
1301
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1302
|
-
|
|
1303
|
-
Returning false excludes the file from the list.
|
|
1304
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1305
|
-
:param filter_path:
|
|
1306
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1307
|
-
:type display_name: collections.abc.Callable | None
|
|
1308
|
-
:param add_operator:
|
|
1309
|
-
:param add_operator_props:
|
|
1310
|
-
"""
|
|
1311
|
-
...
|
|
1312
|
-
|
|
1313
|
-
def path_resolve(self):
|
|
1314
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1315
|
-
...
|
|
1316
|
-
|
|
1317
|
-
def pop(self):
|
|
1318
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1319
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1320
|
-
|
|
17
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1321
18
|
"""
|
|
1322
|
-
...
|
|
1323
19
|
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
the menus draw function
|
|
1327
|
-
|
|
1328
|
-
:param draw_func:
|
|
20
|
+
:return: The RNA type or default when not found.
|
|
21
|
+
:rtype: bpy.types.Struct
|
|
1329
22
|
"""
|
|
1330
23
|
...
|
|
1331
24
|
|
|
1332
|
-
def
|
|
1333
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1334
|
-
|
|
1335
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1336
|
-
:rtype: bool
|
|
25
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1337
26
|
"""
|
|
1338
|
-
...
|
|
1339
27
|
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
...
|
|
1343
|
-
|
|
1344
|
-
def remove(self, draw_func):
|
|
1345
|
-
"""Remove a draw function that has been added to this menu
|
|
1346
|
-
|
|
1347
|
-
:param draw_func:
|
|
28
|
+
:return: The class or default when not found.
|
|
29
|
+
:rtype: typing.Any
|
|
1348
30
|
"""
|
|
1349
31
|
...
|
|
1350
32
|
|
|
1351
|
-
def
|
|
1352
|
-
"""Return a new instance, this is needed because types
|
|
1353
|
-
such as textures can be changed at runtime.
|
|
1354
|
-
|
|
1355
|
-
:return: a new instance of this object with the type initialized again.
|
|
33
|
+
def draw(self, _context):
|
|
1356
34
|
"""
|
|
1357
|
-
...
|
|
1358
35
|
|
|
1359
|
-
|
|
1360
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1361
|
-
dictionary function of the same name).
|
|
1362
|
-
|
|
1363
|
-
:return: custom property values.
|
|
36
|
+
:param _context:
|
|
1364
37
|
"""
|
|
1365
38
|
...
|
|
1366
39
|
|
|
1367
|
-
class
|
|
40
|
+
class MASK_MT_animation(bpy.types.Menu, bpy_types._GenericUI):
|
|
1368
41
|
bl_label: typing.Any
|
|
1369
42
|
bl_rna: typing.Any
|
|
1370
43
|
id_data: typing.Any
|
|
1371
44
|
|
|
1372
|
-
def append(self, draw_func):
|
|
1373
|
-
"""Append a draw function to this menu,
|
|
1374
|
-
takes the same arguments as the menus draw function
|
|
1375
|
-
|
|
1376
|
-
:param draw_func:
|
|
1377
|
-
"""
|
|
1378
|
-
...
|
|
1379
|
-
|
|
1380
|
-
def as_pointer(self) -> int:
|
|
1381
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1382
|
-
|
|
1383
|
-
:return: int (memory address).
|
|
1384
|
-
:rtype: int
|
|
1385
|
-
"""
|
|
1386
|
-
...
|
|
1387
|
-
|
|
1388
45
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1389
46
|
"""
|
|
1390
47
|
|
|
@@ -1408,230 +65,115 @@ class MASK_MT_visibility(bpy_types._GenericUI):
|
|
|
1408
65
|
"""
|
|
1409
66
|
...
|
|
1410
67
|
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
:param layout:
|
|
1416
|
-
"""
|
|
1417
|
-
...
|
|
1418
|
-
|
|
1419
|
-
def draw_preset(self, _context):
|
|
1420
|
-
"""Define these on the subclass:
|
|
1421
|
-
- preset_operator (string)
|
|
1422
|
-
- preset_subdir (string)Optionally:
|
|
1423
|
-
- preset_add_operator (string)
|
|
1424
|
-
- preset_extensions (set of strings)
|
|
1425
|
-
- preset_operator_defaults (dict of keyword args)
|
|
68
|
+
class MASK_MT_mask(bpy.types.Menu, bpy_types._GenericUI):
|
|
69
|
+
bl_label: typing.Any
|
|
70
|
+
bl_rna: typing.Any
|
|
71
|
+
id_data: typing.Any
|
|
1426
72
|
|
|
1427
|
-
|
|
73
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1428
74
|
"""
|
|
1429
|
-
...
|
|
1430
75
|
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
:return: The driver(s) added.
|
|
1435
|
-
:rtype: bpy.types.FCurve
|
|
76
|
+
:return: The RNA type or default when not found.
|
|
77
|
+
:rtype: bpy.types.Struct
|
|
1436
78
|
"""
|
|
1437
79
|
...
|
|
1438
80
|
|
|
1439
|
-
def
|
|
1440
|
-
"""Remove driver(s) from the given property
|
|
1441
|
-
|
|
1442
|
-
:return: Success of driver removal.
|
|
1443
|
-
:rtype: bool
|
|
81
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1444
82
|
"""
|
|
1445
|
-
...
|
|
1446
|
-
|
|
1447
|
-
def get(self):
|
|
1448
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1449
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1450
83
|
|
|
84
|
+
:return: The class or default when not found.
|
|
85
|
+
:rtype: typing.Any
|
|
1451
86
|
"""
|
|
1452
87
|
...
|
|
1453
88
|
|
|
1454
|
-
def
|
|
89
|
+
def draw(self, _context):
|
|
1455
90
|
"""
|
|
1456
91
|
|
|
1457
|
-
:
|
|
92
|
+
:param _context:
|
|
1458
93
|
"""
|
|
1459
94
|
...
|
|
1460
95
|
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
"""
|
|
1466
|
-
...
|
|
96
|
+
class MASK_MT_select(bpy.types.Menu, bpy_types._GenericUI):
|
|
97
|
+
bl_label: typing.Any
|
|
98
|
+
bl_rna: typing.Any
|
|
99
|
+
id_data: typing.Any
|
|
1467
100
|
|
|
1468
|
-
def
|
|
101
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1469
102
|
"""
|
|
1470
103
|
|
|
1471
|
-
:return:
|
|
104
|
+
:return: The RNA type or default when not found.
|
|
105
|
+
:rtype: bpy.types.Struct
|
|
1472
106
|
"""
|
|
1473
107
|
...
|
|
1474
108
|
|
|
1475
|
-
def
|
|
1476
|
-
def is_property_hidden(self) -> bool:
|
|
1477
|
-
"""Check if a property is hidden.
|
|
1478
|
-
|
|
1479
|
-
:return: True when the property is hidden.
|
|
1480
|
-
:rtype: bool
|
|
109
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1481
110
|
"""
|
|
1482
|
-
...
|
|
1483
111
|
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
:return: True when the property is overridable.
|
|
1488
|
-
:rtype: bool
|
|
112
|
+
:return: The class or default when not found.
|
|
113
|
+
:rtype: typing.Any
|
|
1489
114
|
"""
|
|
1490
115
|
...
|
|
1491
116
|
|
|
1492
|
-
def
|
|
1493
|
-
"""Check if a property is readonly.
|
|
1494
|
-
|
|
1495
|
-
:return: True when the property is readonly (not writable).
|
|
1496
|
-
:rtype: bool
|
|
117
|
+
def draw(self, _context):
|
|
1497
118
|
"""
|
|
1498
|
-
...
|
|
1499
119
|
|
|
1500
|
-
|
|
1501
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1502
|
-
|
|
1503
|
-
:return: True when the property has been set.
|
|
1504
|
-
:rtype: bool
|
|
120
|
+
:param _context:
|
|
1505
121
|
"""
|
|
1506
122
|
...
|
|
1507
123
|
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
124
|
+
class MASK_MT_transform(bpy.types.Menu, bpy_types._GenericUI):
|
|
125
|
+
bl_label: typing.Any
|
|
126
|
+
bl_rna: typing.Any
|
|
127
|
+
id_data: typing.Any
|
|
1511
128
|
|
|
1512
|
-
|
|
129
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1513
130
|
"""
|
|
1514
|
-
...
|
|
1515
|
-
|
|
1516
|
-
def keyframe_delete(self) -> bool:
|
|
1517
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1518
131
|
|
|
1519
|
-
:return:
|
|
1520
|
-
:rtype:
|
|
132
|
+
:return: The RNA type or default when not found.
|
|
133
|
+
:rtype: bpy.types.Struct
|
|
1521
134
|
"""
|
|
1522
135
|
...
|
|
1523
136
|
|
|
1524
|
-
def
|
|
1525
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1526
|
-
|
|
1527
|
-
:return: Success of keyframe insertion.
|
|
1528
|
-
:rtype: bool
|
|
137
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1529
138
|
"""
|
|
1530
|
-
...
|
|
1531
|
-
|
|
1532
|
-
def keys(self):
|
|
1533
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1534
|
-
dictionary function of the same name).
|
|
1535
139
|
|
|
1536
|
-
|
|
140
|
+
:return: The class or default when not found.
|
|
141
|
+
:rtype: typing.Any
|
|
1537
142
|
"""
|
|
1538
143
|
...
|
|
1539
144
|
|
|
1540
|
-
def
|
|
1541
|
-
"""Returns the data path from the ID to this object (string).
|
|
1542
|
-
|
|
1543
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1544
|
-
to this struct and property (when given).
|
|
1545
|
-
:rtype: str
|
|
145
|
+
def draw(self, _context):
|
|
1546
146
|
"""
|
|
1547
|
-
...
|
|
1548
147
|
|
|
1549
|
-
|
|
1550
|
-
self,
|
|
1551
|
-
searchpaths: list[str],
|
|
1552
|
-
operator: str,
|
|
1553
|
-
*,
|
|
1554
|
-
props_default: dict = None,
|
|
1555
|
-
prop_filepath: str | None = "filepath",
|
|
1556
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1557
|
-
filter_path=None,
|
|
1558
|
-
display_name: collections.abc.Callable | None = None,
|
|
1559
|
-
add_operator=None,
|
|
1560
|
-
add_operator_props=None,
|
|
1561
|
-
):
|
|
1562
|
-
"""Populate a menu from a list of paths.
|
|
1563
|
-
|
|
1564
|
-
:param searchpaths: Paths to scan.
|
|
1565
|
-
:type searchpaths: list[str]
|
|
1566
|
-
:param operator: The operator id to use with each file.
|
|
1567
|
-
:type operator: str
|
|
1568
|
-
:param props_default: Properties to assign to each operator.
|
|
1569
|
-
:type props_default: dict
|
|
1570
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1571
|
-
:type prop_filepath: str | None
|
|
1572
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1573
|
-
|
|
1574
|
-
Returning false excludes the file from the list.
|
|
1575
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1576
|
-
:param filter_path:
|
|
1577
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1578
|
-
:type display_name: collections.abc.Callable | None
|
|
1579
|
-
:param add_operator:
|
|
1580
|
-
:param add_operator_props:
|
|
148
|
+
:param _context:
|
|
1581
149
|
"""
|
|
1582
150
|
...
|
|
1583
151
|
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
def pop(self):
|
|
1589
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1590
|
-
when not found (matches Python's dictionary function of the same name).
|
|
152
|
+
class MASK_MT_visibility(bpy.types.Menu, bpy_types._GenericUI):
|
|
153
|
+
bl_label: typing.Any
|
|
154
|
+
bl_rna: typing.Any
|
|
155
|
+
id_data: typing.Any
|
|
1591
156
|
|
|
157
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1592
158
|
"""
|
|
1593
|
-
...
|
|
1594
|
-
|
|
1595
|
-
def prepend(self, draw_func):
|
|
1596
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1597
|
-
the menus draw function
|
|
1598
159
|
|
|
1599
|
-
|
|
160
|
+
:return: The RNA type or default when not found.
|
|
161
|
+
:rtype: bpy.types.Struct
|
|
1600
162
|
"""
|
|
1601
163
|
...
|
|
1602
164
|
|
|
1603
|
-
def
|
|
1604
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1605
|
-
|
|
1606
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1607
|
-
:rtype: bool
|
|
165
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1608
166
|
"""
|
|
1609
|
-
...
|
|
1610
|
-
|
|
1611
|
-
def property_unset(self):
|
|
1612
|
-
"""Unset a property, will use default value afterward."""
|
|
1613
|
-
...
|
|
1614
|
-
|
|
1615
|
-
def remove(self, draw_func):
|
|
1616
|
-
"""Remove a draw function that has been added to this menu
|
|
1617
167
|
|
|
1618
|
-
:
|
|
168
|
+
:return: The class or default when not found.
|
|
169
|
+
:rtype: typing.Any
|
|
1619
170
|
"""
|
|
1620
171
|
...
|
|
1621
172
|
|
|
1622
|
-
def
|
|
1623
|
-
"""Return a new instance, this is needed because types
|
|
1624
|
-
such as textures can be changed at runtime.
|
|
1625
|
-
|
|
1626
|
-
:return: a new instance of this object with the type initialized again.
|
|
173
|
+
def draw(self, _context):
|
|
1627
174
|
"""
|
|
1628
|
-
...
|
|
1629
|
-
|
|
1630
|
-
def values(self):
|
|
1631
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1632
|
-
dictionary function of the same name).
|
|
1633
175
|
|
|
1634
|
-
|
|
176
|
+
:param _context:
|
|
1635
177
|
"""
|
|
1636
178
|
...
|
|
1637
179
|
|
|
@@ -1764,26 +306,10 @@ class MASK_PT_transforms:
|
|
|
1764
306
|
"""
|
|
1765
307
|
...
|
|
1766
308
|
|
|
1767
|
-
class MASK_UL_layers(bpy_types._GenericUI):
|
|
309
|
+
class MASK_UL_layers(bpy.types.UIList, bpy_types._GenericUI):
|
|
1768
310
|
bl_rna: typing.Any
|
|
1769
311
|
id_data: typing.Any
|
|
1770
312
|
|
|
1771
|
-
def append(self, draw_func):
|
|
1772
|
-
"""Append a draw function to this menu,
|
|
1773
|
-
takes the same arguments as the menus draw function
|
|
1774
|
-
|
|
1775
|
-
:param draw_func:
|
|
1776
|
-
"""
|
|
1777
|
-
...
|
|
1778
|
-
|
|
1779
|
-
def as_pointer(self) -> int:
|
|
1780
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1781
|
-
|
|
1782
|
-
:return: int (memory address).
|
|
1783
|
-
:rtype: int
|
|
1784
|
-
"""
|
|
1785
|
-
...
|
|
1786
|
-
|
|
1787
313
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1788
314
|
"""
|
|
1789
315
|
|
|
@@ -1824,176 +350,4 @@ class MASK_UL_layers(bpy_types._GenericUI):
|
|
|
1824
350
|
"""
|
|
1825
351
|
...
|
|
1826
352
|
|
|
1827
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1828
|
-
"""Adds driver(s) to the given property
|
|
1829
|
-
|
|
1830
|
-
:return: The driver(s) added.
|
|
1831
|
-
:rtype: bpy.types.FCurve
|
|
1832
|
-
"""
|
|
1833
|
-
...
|
|
1834
|
-
|
|
1835
|
-
def driver_remove(self) -> bool:
|
|
1836
|
-
"""Remove driver(s) from the given property
|
|
1837
|
-
|
|
1838
|
-
:return: Success of driver removal.
|
|
1839
|
-
:rtype: bool
|
|
1840
|
-
"""
|
|
1841
|
-
...
|
|
1842
|
-
|
|
1843
|
-
def get(self):
|
|
1844
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1845
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1846
|
-
|
|
1847
|
-
"""
|
|
1848
|
-
...
|
|
1849
|
-
|
|
1850
|
-
def id_properties_clear(self):
|
|
1851
|
-
"""
|
|
1852
|
-
|
|
1853
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1854
|
-
"""
|
|
1855
|
-
...
|
|
1856
|
-
|
|
1857
|
-
def id_properties_ensure(self):
|
|
1858
|
-
"""
|
|
1859
|
-
|
|
1860
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1861
|
-
"""
|
|
1862
|
-
...
|
|
1863
|
-
|
|
1864
|
-
def id_properties_ui(self):
|
|
1865
|
-
"""
|
|
1866
|
-
|
|
1867
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1868
|
-
"""
|
|
1869
|
-
...
|
|
1870
|
-
|
|
1871
|
-
def is_extended(self): ...
|
|
1872
|
-
def is_property_hidden(self) -> bool:
|
|
1873
|
-
"""Check if a property is hidden.
|
|
1874
|
-
|
|
1875
|
-
:return: True when the property is hidden.
|
|
1876
|
-
:rtype: bool
|
|
1877
|
-
"""
|
|
1878
|
-
...
|
|
1879
|
-
|
|
1880
|
-
def is_property_overridable_library(self) -> bool:
|
|
1881
|
-
"""Check if a property is overridable.
|
|
1882
|
-
|
|
1883
|
-
:return: True when the property is overridable.
|
|
1884
|
-
:rtype: bool
|
|
1885
|
-
"""
|
|
1886
|
-
...
|
|
1887
|
-
|
|
1888
|
-
def is_property_readonly(self) -> bool:
|
|
1889
|
-
"""Check if a property is readonly.
|
|
1890
|
-
|
|
1891
|
-
:return: True when the property is readonly (not writable).
|
|
1892
|
-
:rtype: bool
|
|
1893
|
-
"""
|
|
1894
|
-
...
|
|
1895
|
-
|
|
1896
|
-
def is_property_set(self) -> bool:
|
|
1897
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1898
|
-
|
|
1899
|
-
:return: True when the property has been set.
|
|
1900
|
-
:rtype: bool
|
|
1901
|
-
"""
|
|
1902
|
-
...
|
|
1903
|
-
|
|
1904
|
-
def items(self):
|
|
1905
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1906
|
-
dictionary function of the same name).
|
|
1907
|
-
|
|
1908
|
-
:return: custom property key, value pairs.
|
|
1909
|
-
"""
|
|
1910
|
-
...
|
|
1911
|
-
|
|
1912
|
-
def keyframe_delete(self) -> bool:
|
|
1913
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1914
|
-
|
|
1915
|
-
:return: Success of keyframe deletion.
|
|
1916
|
-
:rtype: bool
|
|
1917
|
-
"""
|
|
1918
|
-
...
|
|
1919
|
-
|
|
1920
|
-
def keyframe_insert(self) -> bool:
|
|
1921
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1922
|
-
|
|
1923
|
-
:return: Success of keyframe insertion.
|
|
1924
|
-
:rtype: bool
|
|
1925
|
-
"""
|
|
1926
|
-
...
|
|
1927
|
-
|
|
1928
|
-
def keys(self):
|
|
1929
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1930
|
-
dictionary function of the same name).
|
|
1931
|
-
|
|
1932
|
-
:return: custom property keys.
|
|
1933
|
-
"""
|
|
1934
|
-
...
|
|
1935
|
-
|
|
1936
|
-
def path_from_id(self) -> str:
|
|
1937
|
-
"""Returns the data path from the ID to this object (string).
|
|
1938
|
-
|
|
1939
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1940
|
-
to this struct and property (when given).
|
|
1941
|
-
:rtype: str
|
|
1942
|
-
"""
|
|
1943
|
-
...
|
|
1944
|
-
|
|
1945
|
-
def path_resolve(self):
|
|
1946
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1947
|
-
...
|
|
1948
|
-
|
|
1949
|
-
def pop(self):
|
|
1950
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1951
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1952
|
-
|
|
1953
|
-
"""
|
|
1954
|
-
...
|
|
1955
|
-
|
|
1956
|
-
def prepend(self, draw_func):
|
|
1957
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1958
|
-
the menus draw function
|
|
1959
|
-
|
|
1960
|
-
:param draw_func:
|
|
1961
|
-
"""
|
|
1962
|
-
...
|
|
1963
|
-
|
|
1964
|
-
def property_overridable_library_set(self) -> bool:
|
|
1965
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1966
|
-
|
|
1967
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1968
|
-
:rtype: bool
|
|
1969
|
-
"""
|
|
1970
|
-
...
|
|
1971
|
-
|
|
1972
|
-
def property_unset(self):
|
|
1973
|
-
"""Unset a property, will use default value afterward."""
|
|
1974
|
-
...
|
|
1975
|
-
|
|
1976
|
-
def remove(self, draw_func):
|
|
1977
|
-
"""Remove a draw function that has been added to this menu
|
|
1978
|
-
|
|
1979
|
-
:param draw_func:
|
|
1980
|
-
"""
|
|
1981
|
-
...
|
|
1982
|
-
|
|
1983
|
-
def type_recast(self):
|
|
1984
|
-
"""Return a new instance, this is needed because types
|
|
1985
|
-
such as textures can be changed at runtime.
|
|
1986
|
-
|
|
1987
|
-
:return: a new instance of this object with the type initialized again.
|
|
1988
|
-
"""
|
|
1989
|
-
...
|
|
1990
|
-
|
|
1991
|
-
def values(self):
|
|
1992
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1993
|
-
dictionary function of the same name).
|
|
1994
|
-
|
|
1995
|
-
:return: custom property values.
|
|
1996
|
-
"""
|
|
1997
|
-
...
|
|
1998
|
-
|
|
1999
353
|
def draw_mask_context_menu(layout, _context): ...
|