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
|
@@ -7,28 +7,12 @@ import bpy_types
|
|
|
7
7
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
8
8
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
9
9
|
|
|
10
|
-
class NODE_MT_category_shader_color(bpy_types._GenericUI):
|
|
10
|
+
class NODE_MT_category_shader_color(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
|
id_data: typing.Any
|
|
15
15
|
|
|
16
|
-
def append(self, draw_func):
|
|
17
|
-
"""Append a draw function to this menu,
|
|
18
|
-
takes the same arguments as the menus draw function
|
|
19
|
-
|
|
20
|
-
:param draw_func:
|
|
21
|
-
"""
|
|
22
|
-
...
|
|
23
|
-
|
|
24
|
-
def as_pointer(self) -> int:
|
|
25
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
26
|
-
|
|
27
|
-
:return: int (memory address).
|
|
28
|
-
:rtype: int
|
|
29
|
-
"""
|
|
30
|
-
...
|
|
31
|
-
|
|
32
16
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
33
17
|
"""
|
|
34
18
|
|
|
@@ -52,255 +36,70 @@ class NODE_MT_category_shader_color(bpy_types._GenericUI):
|
|
|
52
36
|
"""
|
|
53
37
|
...
|
|
54
38
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
"""
|
|
61
|
-
...
|
|
62
|
-
|
|
63
|
-
def draw_preset(self, _context):
|
|
64
|
-
"""Define these on the subclass:
|
|
65
|
-
- preset_operator (string)
|
|
66
|
-
- preset_subdir (string)Optionally:
|
|
67
|
-
- preset_add_operator (string)
|
|
68
|
-
- preset_extensions (set of strings)
|
|
69
|
-
- preset_operator_defaults (dict of keyword args)
|
|
70
|
-
|
|
71
|
-
:param _context:
|
|
72
|
-
"""
|
|
73
|
-
...
|
|
74
|
-
|
|
75
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
76
|
-
"""Adds driver(s) to the given property
|
|
77
|
-
|
|
78
|
-
:return: The driver(s) added.
|
|
79
|
-
:rtype: bpy.types.FCurve
|
|
80
|
-
"""
|
|
81
|
-
...
|
|
82
|
-
|
|
83
|
-
def driver_remove(self) -> bool:
|
|
84
|
-
"""Remove driver(s) from the given property
|
|
85
|
-
|
|
86
|
-
:return: Success of driver removal.
|
|
87
|
-
:rtype: bool
|
|
88
|
-
"""
|
|
89
|
-
...
|
|
90
|
-
|
|
91
|
-
def get(self):
|
|
92
|
-
"""Returns the value of the custom property assigned to key or default
|
|
93
|
-
when not found (matches Python's dictionary function of the same name).
|
|
94
|
-
|
|
95
|
-
"""
|
|
96
|
-
...
|
|
97
|
-
|
|
98
|
-
def id_properties_clear(self):
|
|
99
|
-
"""
|
|
100
|
-
|
|
101
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
102
|
-
"""
|
|
103
|
-
...
|
|
104
|
-
|
|
105
|
-
def id_properties_ensure(self):
|
|
106
|
-
"""
|
|
107
|
-
|
|
108
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
109
|
-
"""
|
|
110
|
-
...
|
|
111
|
-
|
|
112
|
-
def id_properties_ui(self):
|
|
113
|
-
"""
|
|
114
|
-
|
|
115
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
116
|
-
"""
|
|
117
|
-
...
|
|
118
|
-
|
|
119
|
-
def is_extended(self): ...
|
|
120
|
-
def is_property_hidden(self) -> bool:
|
|
121
|
-
"""Check if a property is hidden.
|
|
122
|
-
|
|
123
|
-
:return: True when the property is hidden.
|
|
124
|
-
:rtype: bool
|
|
125
|
-
"""
|
|
126
|
-
...
|
|
127
|
-
|
|
128
|
-
def is_property_overridable_library(self) -> bool:
|
|
129
|
-
"""Check if a property is overridable.
|
|
130
|
-
|
|
131
|
-
:return: True when the property is overridable.
|
|
132
|
-
:rtype: bool
|
|
133
|
-
"""
|
|
134
|
-
...
|
|
135
|
-
|
|
136
|
-
def is_property_readonly(self) -> bool:
|
|
137
|
-
"""Check if a property is readonly.
|
|
138
|
-
|
|
139
|
-
:return: True when the property is readonly (not writable).
|
|
140
|
-
:rtype: bool
|
|
141
|
-
"""
|
|
142
|
-
...
|
|
143
|
-
|
|
144
|
-
def is_property_set(self) -> bool:
|
|
145
|
-
"""Check if a property is set, use for testing operator properties.
|
|
146
|
-
|
|
147
|
-
:return: True when the property has been set.
|
|
148
|
-
:rtype: bool
|
|
149
|
-
"""
|
|
150
|
-
...
|
|
151
|
-
|
|
152
|
-
def items(self):
|
|
153
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
154
|
-
dictionary function of the same name).
|
|
39
|
+
class NODE_MT_category_shader_converter(bpy.types.Menu, bpy_types._GenericUI):
|
|
40
|
+
bl_idname: typing.Any
|
|
41
|
+
bl_label: typing.Any
|
|
42
|
+
bl_rna: typing.Any
|
|
43
|
+
id_data: typing.Any
|
|
155
44
|
|
|
156
|
-
|
|
45
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
157
46
|
"""
|
|
158
|
-
...
|
|
159
|
-
|
|
160
|
-
def keyframe_delete(self) -> bool:
|
|
161
|
-
"""Remove a keyframe from this properties fcurve.
|
|
162
47
|
|
|
163
|
-
:return:
|
|
164
|
-
:rtype:
|
|
48
|
+
:return: The RNA type or default when not found.
|
|
49
|
+
:rtype: bpy.types.Struct
|
|
165
50
|
"""
|
|
166
51
|
...
|
|
167
52
|
|
|
168
|
-
def
|
|
169
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
170
|
-
|
|
171
|
-
:return: Success of keyframe insertion.
|
|
172
|
-
:rtype: bool
|
|
53
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
173
54
|
"""
|
|
174
|
-
...
|
|
175
|
-
|
|
176
|
-
def keys(self):
|
|
177
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
178
|
-
dictionary function of the same name).
|
|
179
55
|
|
|
180
|
-
|
|
56
|
+
:return: The class or default when not found.
|
|
57
|
+
:rtype: typing.Any
|
|
181
58
|
"""
|
|
182
59
|
...
|
|
183
60
|
|
|
184
|
-
def
|
|
185
|
-
"""Returns the data path from the ID to this object (string).
|
|
186
|
-
|
|
187
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
188
|
-
to this struct and property (when given).
|
|
189
|
-
:rtype: str
|
|
61
|
+
def draw(self, context):
|
|
190
62
|
"""
|
|
191
|
-
...
|
|
192
63
|
|
|
193
|
-
|
|
194
|
-
self,
|
|
195
|
-
searchpaths: list[str],
|
|
196
|
-
operator: str,
|
|
197
|
-
*,
|
|
198
|
-
props_default: dict = None,
|
|
199
|
-
prop_filepath: str | None = "filepath",
|
|
200
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
201
|
-
filter_path=None,
|
|
202
|
-
display_name: collections.abc.Callable | None = None,
|
|
203
|
-
add_operator=None,
|
|
204
|
-
add_operator_props=None,
|
|
205
|
-
):
|
|
206
|
-
"""Populate a menu from a list of paths.
|
|
207
|
-
|
|
208
|
-
:param searchpaths: Paths to scan.
|
|
209
|
-
:type searchpaths: list[str]
|
|
210
|
-
:param operator: The operator id to use with each file.
|
|
211
|
-
:type operator: str
|
|
212
|
-
:param props_default: Properties to assign to each operator.
|
|
213
|
-
:type props_default: dict
|
|
214
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
215
|
-
:type prop_filepath: str | None
|
|
216
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
217
|
-
|
|
218
|
-
Returning false excludes the file from the list.
|
|
219
|
-
:type filter_ext: collections.abc.Callable | None
|
|
220
|
-
:param filter_path:
|
|
221
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
222
|
-
:type display_name: collections.abc.Callable | None
|
|
223
|
-
:param add_operator:
|
|
224
|
-
:param add_operator_props:
|
|
64
|
+
:param context:
|
|
225
65
|
"""
|
|
226
66
|
...
|
|
227
67
|
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
234
|
-
when not found (matches Python's dictionary function of the same name).
|
|
68
|
+
class NODE_MT_category_shader_group(bpy.types.Menu, bpy_types._GenericUI):
|
|
69
|
+
bl_idname: typing.Any
|
|
70
|
+
bl_label: typing.Any
|
|
71
|
+
bl_rna: typing.Any
|
|
72
|
+
id_data: typing.Any
|
|
235
73
|
|
|
74
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
236
75
|
"""
|
|
237
|
-
...
|
|
238
76
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
the menus draw function
|
|
242
|
-
|
|
243
|
-
:param draw_func:
|
|
77
|
+
:return: The RNA type or default when not found.
|
|
78
|
+
:rtype: bpy.types.Struct
|
|
244
79
|
"""
|
|
245
80
|
...
|
|
246
81
|
|
|
247
|
-
def
|
|
248
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
249
|
-
|
|
250
|
-
:return: True when the overridable status of the property was successfully set.
|
|
251
|
-
:rtype: bool
|
|
82
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
252
83
|
"""
|
|
253
|
-
...
|
|
254
|
-
|
|
255
|
-
def property_unset(self):
|
|
256
|
-
"""Unset a property, will use default value afterward."""
|
|
257
|
-
...
|
|
258
84
|
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
:param draw_func:
|
|
85
|
+
:return: The class or default when not found.
|
|
86
|
+
:rtype: typing.Any
|
|
263
87
|
"""
|
|
264
88
|
...
|
|
265
89
|
|
|
266
|
-
def
|
|
267
|
-
"""Return a new instance, this is needed because types
|
|
268
|
-
such as textures can be changed at runtime.
|
|
269
|
-
|
|
270
|
-
:return: a new instance of this object with the type initialized again.
|
|
90
|
+
def draw(self, context):
|
|
271
91
|
"""
|
|
272
|
-
...
|
|
273
92
|
|
|
274
|
-
|
|
275
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
276
|
-
dictionary function of the same name).
|
|
277
|
-
|
|
278
|
-
:return: custom property values.
|
|
93
|
+
:param context:
|
|
279
94
|
"""
|
|
280
95
|
...
|
|
281
96
|
|
|
282
|
-
class
|
|
97
|
+
class NODE_MT_category_shader_input(bpy.types.Menu, bpy_types._GenericUI):
|
|
283
98
|
bl_idname: typing.Any
|
|
284
99
|
bl_label: typing.Any
|
|
285
100
|
bl_rna: typing.Any
|
|
286
101
|
id_data: typing.Any
|
|
287
102
|
|
|
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
103
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
305
104
|
"""
|
|
306
105
|
|
|
@@ -324,255 +123,121 @@ class NODE_MT_category_shader_converter(bpy_types._GenericUI):
|
|
|
324
123
|
"""
|
|
325
124
|
...
|
|
326
125
|
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
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
|
|
126
|
+
class NODE_MT_category_shader_output(bpy.types.Menu, bpy_types._GenericUI):
|
|
127
|
+
bl_idname: typing.Any
|
|
128
|
+
bl_label: typing.Any
|
|
129
|
+
bl_rna: typing.Any
|
|
130
|
+
id_data: typing.Any
|
|
357
131
|
|
|
358
|
-
|
|
359
|
-
:rtype: bool
|
|
132
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
360
133
|
"""
|
|
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
134
|
|
|
135
|
+
:return: The RNA type or default when not found.
|
|
136
|
+
:rtype: bpy.types.Struct
|
|
367
137
|
"""
|
|
368
138
|
...
|
|
369
139
|
|
|
370
|
-
def
|
|
140
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
371
141
|
"""
|
|
372
142
|
|
|
373
|
-
:return:
|
|
143
|
+
:return: The class or default when not found.
|
|
144
|
+
:rtype: typing.Any
|
|
374
145
|
"""
|
|
375
146
|
...
|
|
376
147
|
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
...
|
|
148
|
+
class NODE_MT_category_shader_script(bpy.types.Menu, bpy_types._GenericUI):
|
|
149
|
+
bl_idname: typing.Any
|
|
150
|
+
bl_label: typing.Any
|
|
151
|
+
bl_rna: typing.Any
|
|
152
|
+
id_data: typing.Any
|
|
383
153
|
|
|
384
|
-
def
|
|
154
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
385
155
|
"""
|
|
386
156
|
|
|
387
|
-
:return:
|
|
157
|
+
:return: The RNA type or default when not found.
|
|
158
|
+
:rtype: bpy.types.Struct
|
|
388
159
|
"""
|
|
389
160
|
...
|
|
390
161
|
|
|
391
|
-
def
|
|
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
|
|
162
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
397
163
|
"""
|
|
398
|
-
...
|
|
399
164
|
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
:return: True when the property is overridable.
|
|
404
|
-
:rtype: bool
|
|
165
|
+
:return: The class or default when not found.
|
|
166
|
+
:rtype: typing.Any
|
|
405
167
|
"""
|
|
406
168
|
...
|
|
407
169
|
|
|
408
|
-
def
|
|
409
|
-
"""Check if a property is readonly.
|
|
410
|
-
|
|
411
|
-
:return: True when the property is readonly (not writable).
|
|
412
|
-
:rtype: bool
|
|
170
|
+
def draw(self, _context):
|
|
413
171
|
"""
|
|
414
|
-
...
|
|
415
172
|
|
|
416
|
-
|
|
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
|
|
173
|
+
:param _context:
|
|
421
174
|
"""
|
|
422
175
|
...
|
|
423
176
|
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
177
|
+
class NODE_MT_category_shader_shader(bpy.types.Menu, bpy_types._GenericUI):
|
|
178
|
+
bl_idname: typing.Any
|
|
179
|
+
bl_label: typing.Any
|
|
180
|
+
bl_rna: typing.Any
|
|
181
|
+
id_data: typing.Any
|
|
427
182
|
|
|
428
|
-
|
|
183
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
429
184
|
"""
|
|
430
|
-
...
|
|
431
185
|
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
:return: Success of keyframe deletion.
|
|
436
|
-
:rtype: bool
|
|
186
|
+
:return: The RNA type or default when not found.
|
|
187
|
+
:rtype: bpy.types.Struct
|
|
437
188
|
"""
|
|
438
189
|
...
|
|
439
190
|
|
|
440
|
-
def
|
|
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
|
|
191
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
445
192
|
"""
|
|
446
|
-
...
|
|
447
193
|
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
dictionary function of the same name).
|
|
451
|
-
|
|
452
|
-
:return: custom property keys.
|
|
194
|
+
:return: The class or default when not found.
|
|
195
|
+
:rtype: typing.Any
|
|
453
196
|
"""
|
|
454
197
|
...
|
|
455
198
|
|
|
456
|
-
def
|
|
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
|
|
199
|
+
def draw(self, context):
|
|
462
200
|
"""
|
|
463
|
-
...
|
|
464
201
|
|
|
465
|
-
|
|
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:
|
|
202
|
+
:param context:
|
|
497
203
|
"""
|
|
498
204
|
...
|
|
499
205
|
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
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).
|
|
206
|
+
class NODE_MT_category_shader_texture(bpy.types.Menu, bpy_types._GenericUI):
|
|
207
|
+
bl_idname: typing.Any
|
|
208
|
+
bl_label: typing.Any
|
|
209
|
+
bl_rna: typing.Any
|
|
210
|
+
id_data: typing.Any
|
|
507
211
|
|
|
212
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
508
213
|
"""
|
|
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
214
|
|
|
515
|
-
|
|
215
|
+
:return: The RNA type or default when not found.
|
|
216
|
+
:rtype: bpy.types.Struct
|
|
516
217
|
"""
|
|
517
218
|
...
|
|
518
219
|
|
|
519
|
-
def
|
|
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
|
|
220
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
524
221
|
"""
|
|
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
222
|
|
|
534
|
-
:
|
|
223
|
+
:return: The class or default when not found.
|
|
224
|
+
:rtype: typing.Any
|
|
535
225
|
"""
|
|
536
226
|
...
|
|
537
227
|
|
|
538
|
-
def
|
|
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.
|
|
228
|
+
def draw(self, _context):
|
|
543
229
|
"""
|
|
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
230
|
|
|
550
|
-
|
|
231
|
+
:param _context:
|
|
551
232
|
"""
|
|
552
233
|
...
|
|
553
234
|
|
|
554
|
-
class
|
|
235
|
+
class NODE_MT_category_shader_vector(bpy.types.Menu, bpy_types._GenericUI):
|
|
555
236
|
bl_idname: typing.Any
|
|
556
237
|
bl_label: typing.Any
|
|
557
238
|
bl_rna: typing.Any
|
|
558
239
|
id_data: typing.Any
|
|
559
240
|
|
|
560
|
-
def append(self, draw_func):
|
|
561
|
-
"""Append a draw function to this menu,
|
|
562
|
-
takes the same arguments as the menus draw function
|
|
563
|
-
|
|
564
|
-
:param draw_func:
|
|
565
|
-
"""
|
|
566
|
-
...
|
|
567
|
-
|
|
568
|
-
def as_pointer(self) -> int:
|
|
569
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
570
|
-
|
|
571
|
-
:return: int (memory address).
|
|
572
|
-
:rtype: int
|
|
573
|
-
"""
|
|
574
|
-
...
|
|
575
|
-
|
|
576
241
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
577
242
|
"""
|
|
578
243
|
|
|
@@ -589,2145 +254,43 @@ class NODE_MT_category_shader_group(bpy_types._GenericUI):
|
|
|
589
254
|
"""
|
|
590
255
|
...
|
|
591
256
|
|
|
592
|
-
def draw(self,
|
|
593
|
-
"""
|
|
594
|
-
|
|
595
|
-
:param context:
|
|
596
|
-
"""
|
|
597
|
-
...
|
|
598
|
-
|
|
599
|
-
def draw_collapsible(self, context, layout):
|
|
600
|
-
"""
|
|
601
|
-
|
|
602
|
-
:param context:
|
|
603
|
-
:param layout:
|
|
604
|
-
"""
|
|
605
|
-
...
|
|
606
|
-
|
|
607
|
-
def draw_preset(self, _context):
|
|
608
|
-
"""Define these on the subclass:
|
|
609
|
-
- preset_operator (string)
|
|
610
|
-
- preset_subdir (string)Optionally:
|
|
611
|
-
- preset_add_operator (string)
|
|
612
|
-
- preset_extensions (set of strings)
|
|
613
|
-
- preset_operator_defaults (dict of keyword args)
|
|
614
|
-
|
|
615
|
-
:param _context:
|
|
616
|
-
"""
|
|
617
|
-
...
|
|
618
|
-
|
|
619
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
620
|
-
"""Adds driver(s) to the given property
|
|
621
|
-
|
|
622
|
-
:return: The driver(s) added.
|
|
623
|
-
:rtype: bpy.types.FCurve
|
|
624
|
-
"""
|
|
625
|
-
...
|
|
626
|
-
|
|
627
|
-
def driver_remove(self) -> bool:
|
|
628
|
-
"""Remove driver(s) from the given property
|
|
629
|
-
|
|
630
|
-
:return: Success of driver removal.
|
|
631
|
-
:rtype: bool
|
|
257
|
+
def draw(self, _context):
|
|
632
258
|
"""
|
|
633
|
-
...
|
|
634
|
-
|
|
635
|
-
def get(self):
|
|
636
|
-
"""Returns the value of the custom property assigned to key or default
|
|
637
|
-
when not found (matches Python's dictionary function of the same name).
|
|
638
259
|
|
|
260
|
+
:param _context:
|
|
639
261
|
"""
|
|
640
262
|
...
|
|
641
263
|
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
264
|
+
class NODE_MT_shader_node_add_all(bpy.types.Menu, bpy_types._GenericUI):
|
|
265
|
+
bl_idname: typing.Any
|
|
266
|
+
bl_label: typing.Any
|
|
267
|
+
bl_rna: typing.Any
|
|
268
|
+
bl_translation_context: typing.Any
|
|
269
|
+
id_data: typing.Any
|
|
648
270
|
|
|
649
|
-
def
|
|
271
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
650
272
|
"""
|
|
651
273
|
|
|
652
|
-
:return:
|
|
274
|
+
:return: The RNA type or default when not found.
|
|
275
|
+
:rtype: bpy.types.Struct
|
|
653
276
|
"""
|
|
654
277
|
...
|
|
655
278
|
|
|
656
|
-
def
|
|
279
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
657
280
|
"""
|
|
658
281
|
|
|
659
|
-
:return:
|
|
282
|
+
:return: The class or default when not found.
|
|
283
|
+
:rtype: typing.Any
|
|
660
284
|
"""
|
|
661
285
|
...
|
|
662
286
|
|
|
663
|
-
def
|
|
664
|
-
def is_property_hidden(self) -> bool:
|
|
665
|
-
"""Check if a property is hidden.
|
|
666
|
-
|
|
667
|
-
:return: True when the property is hidden.
|
|
668
|
-
:rtype: bool
|
|
669
|
-
"""
|
|
670
|
-
...
|
|
671
|
-
|
|
672
|
-
def is_property_overridable_library(self) -> bool:
|
|
673
|
-
"""Check if a property is overridable.
|
|
674
|
-
|
|
675
|
-
:return: True when the property is overridable.
|
|
676
|
-
:rtype: bool
|
|
677
|
-
"""
|
|
678
|
-
...
|
|
679
|
-
|
|
680
|
-
def is_property_readonly(self) -> bool:
|
|
681
|
-
"""Check if a property is readonly.
|
|
682
|
-
|
|
683
|
-
:return: True when the property is readonly (not writable).
|
|
684
|
-
:rtype: bool
|
|
685
|
-
"""
|
|
686
|
-
...
|
|
687
|
-
|
|
688
|
-
def is_property_set(self) -> bool:
|
|
689
|
-
"""Check if a property is set, use for testing operator properties.
|
|
690
|
-
|
|
691
|
-
:return: True when the property has been set.
|
|
692
|
-
:rtype: bool
|
|
693
|
-
"""
|
|
694
|
-
...
|
|
695
|
-
|
|
696
|
-
def items(self):
|
|
697
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
698
|
-
dictionary function of the same name).
|
|
699
|
-
|
|
700
|
-
:return: custom property key, value pairs.
|
|
701
|
-
"""
|
|
702
|
-
...
|
|
703
|
-
|
|
704
|
-
def keyframe_delete(self) -> bool:
|
|
705
|
-
"""Remove a keyframe from this properties fcurve.
|
|
706
|
-
|
|
707
|
-
:return: Success of keyframe deletion.
|
|
708
|
-
:rtype: bool
|
|
709
|
-
"""
|
|
710
|
-
...
|
|
711
|
-
|
|
712
|
-
def keyframe_insert(self) -> bool:
|
|
713
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
714
|
-
|
|
715
|
-
:return: Success of keyframe insertion.
|
|
716
|
-
:rtype: bool
|
|
717
|
-
"""
|
|
718
|
-
...
|
|
719
|
-
|
|
720
|
-
def keys(self):
|
|
721
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
722
|
-
dictionary function of the same name).
|
|
723
|
-
|
|
724
|
-
:return: custom property keys.
|
|
725
|
-
"""
|
|
726
|
-
...
|
|
727
|
-
|
|
728
|
-
def path_from_id(self) -> str:
|
|
729
|
-
"""Returns the data path from the ID to this object (string).
|
|
730
|
-
|
|
731
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
732
|
-
to this struct and property (when given).
|
|
733
|
-
:rtype: str
|
|
734
|
-
"""
|
|
735
|
-
...
|
|
736
|
-
|
|
737
|
-
def path_menu(
|
|
738
|
-
self,
|
|
739
|
-
searchpaths: list[str],
|
|
740
|
-
operator: str,
|
|
741
|
-
*,
|
|
742
|
-
props_default: dict = None,
|
|
743
|
-
prop_filepath: str | None = "filepath",
|
|
744
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
745
|
-
filter_path=None,
|
|
746
|
-
display_name: collections.abc.Callable | None = None,
|
|
747
|
-
add_operator=None,
|
|
748
|
-
add_operator_props=None,
|
|
749
|
-
):
|
|
750
|
-
"""Populate a menu from a list of paths.
|
|
751
|
-
|
|
752
|
-
:param searchpaths: Paths to scan.
|
|
753
|
-
:type searchpaths: list[str]
|
|
754
|
-
:param operator: The operator id to use with each file.
|
|
755
|
-
:type operator: str
|
|
756
|
-
:param props_default: Properties to assign to each operator.
|
|
757
|
-
:type props_default: dict
|
|
758
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
759
|
-
:type prop_filepath: str | None
|
|
760
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
761
|
-
|
|
762
|
-
Returning false excludes the file from the list.
|
|
763
|
-
:type filter_ext: collections.abc.Callable | None
|
|
764
|
-
:param filter_path:
|
|
765
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
766
|
-
:type display_name: collections.abc.Callable | None
|
|
767
|
-
:param add_operator:
|
|
768
|
-
:param add_operator_props:
|
|
769
|
-
"""
|
|
770
|
-
...
|
|
771
|
-
|
|
772
|
-
def path_resolve(self):
|
|
773
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
774
|
-
...
|
|
775
|
-
|
|
776
|
-
def pop(self):
|
|
777
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
778
|
-
when not found (matches Python's dictionary function of the same name).
|
|
779
|
-
|
|
780
|
-
"""
|
|
781
|
-
...
|
|
782
|
-
|
|
783
|
-
def prepend(self, draw_func):
|
|
784
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
785
|
-
the menus draw function
|
|
786
|
-
|
|
787
|
-
:param draw_func:
|
|
788
|
-
"""
|
|
789
|
-
...
|
|
790
|
-
|
|
791
|
-
def property_overridable_library_set(self) -> bool:
|
|
792
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
793
|
-
|
|
794
|
-
:return: True when the overridable status of the property was successfully set.
|
|
795
|
-
:rtype: bool
|
|
796
|
-
"""
|
|
797
|
-
...
|
|
798
|
-
|
|
799
|
-
def property_unset(self):
|
|
800
|
-
"""Unset a property, will use default value afterward."""
|
|
801
|
-
...
|
|
802
|
-
|
|
803
|
-
def remove(self, draw_func):
|
|
804
|
-
"""Remove a draw function that has been added to this menu
|
|
805
|
-
|
|
806
|
-
:param draw_func:
|
|
807
|
-
"""
|
|
808
|
-
...
|
|
809
|
-
|
|
810
|
-
def type_recast(self):
|
|
811
|
-
"""Return a new instance, this is needed because types
|
|
812
|
-
such as textures can be changed at runtime.
|
|
813
|
-
|
|
814
|
-
:return: a new instance of this object with the type initialized again.
|
|
815
|
-
"""
|
|
816
|
-
...
|
|
817
|
-
|
|
818
|
-
def values(self):
|
|
819
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
820
|
-
dictionary function of the same name).
|
|
821
|
-
|
|
822
|
-
:return: custom property values.
|
|
823
|
-
"""
|
|
824
|
-
...
|
|
825
|
-
|
|
826
|
-
class NODE_MT_category_shader_input(bpy_types._GenericUI):
|
|
827
|
-
bl_idname: typing.Any
|
|
828
|
-
bl_label: typing.Any
|
|
829
|
-
bl_rna: typing.Any
|
|
830
|
-
id_data: typing.Any
|
|
831
|
-
|
|
832
|
-
def append(self, draw_func):
|
|
833
|
-
"""Append a draw function to this menu,
|
|
834
|
-
takes the same arguments as the menus draw function
|
|
835
|
-
|
|
836
|
-
:param draw_func:
|
|
837
|
-
"""
|
|
838
|
-
...
|
|
839
|
-
|
|
840
|
-
def as_pointer(self) -> int:
|
|
841
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
842
|
-
|
|
843
|
-
:return: int (memory address).
|
|
844
|
-
:rtype: int
|
|
845
|
-
"""
|
|
846
|
-
...
|
|
847
|
-
|
|
848
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
849
|
-
"""
|
|
850
|
-
|
|
851
|
-
:return: The RNA type or default when not found.
|
|
852
|
-
:rtype: bpy.types.Struct
|
|
853
|
-
"""
|
|
854
|
-
...
|
|
855
|
-
|
|
856
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
857
|
-
"""
|
|
858
|
-
|
|
859
|
-
:return: The class or default when not found.
|
|
860
|
-
:rtype: typing.Any
|
|
861
|
-
"""
|
|
862
|
-
...
|
|
863
|
-
|
|
864
|
-
def draw(self, context):
|
|
865
|
-
"""
|
|
866
|
-
|
|
867
|
-
:param context:
|
|
868
|
-
"""
|
|
869
|
-
...
|
|
870
|
-
|
|
871
|
-
def draw_collapsible(self, context, layout):
|
|
872
|
-
"""
|
|
873
|
-
|
|
874
|
-
:param context:
|
|
875
|
-
:param layout:
|
|
876
|
-
"""
|
|
877
|
-
...
|
|
878
|
-
|
|
879
|
-
def draw_preset(self, _context):
|
|
880
|
-
"""Define these on the subclass:
|
|
881
|
-
- preset_operator (string)
|
|
882
|
-
- preset_subdir (string)Optionally:
|
|
883
|
-
- preset_add_operator (string)
|
|
884
|
-
- preset_extensions (set of strings)
|
|
885
|
-
- preset_operator_defaults (dict of keyword args)
|
|
886
|
-
|
|
887
|
-
:param _context:
|
|
888
|
-
"""
|
|
889
|
-
...
|
|
890
|
-
|
|
891
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
892
|
-
"""Adds driver(s) to the given property
|
|
893
|
-
|
|
894
|
-
:return: The driver(s) added.
|
|
895
|
-
:rtype: bpy.types.FCurve
|
|
896
|
-
"""
|
|
897
|
-
...
|
|
898
|
-
|
|
899
|
-
def driver_remove(self) -> bool:
|
|
900
|
-
"""Remove driver(s) from the given property
|
|
901
|
-
|
|
902
|
-
:return: Success of driver removal.
|
|
903
|
-
:rtype: bool
|
|
904
|
-
"""
|
|
905
|
-
...
|
|
906
|
-
|
|
907
|
-
def get(self):
|
|
908
|
-
"""Returns the value of the custom property assigned to key or default
|
|
909
|
-
when not found (matches Python's dictionary function of the same name).
|
|
910
|
-
|
|
911
|
-
"""
|
|
912
|
-
...
|
|
913
|
-
|
|
914
|
-
def id_properties_clear(self):
|
|
915
|
-
"""
|
|
916
|
-
|
|
917
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
918
|
-
"""
|
|
919
|
-
...
|
|
920
|
-
|
|
921
|
-
def id_properties_ensure(self):
|
|
922
|
-
"""
|
|
923
|
-
|
|
924
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
925
|
-
"""
|
|
926
|
-
...
|
|
927
|
-
|
|
928
|
-
def id_properties_ui(self):
|
|
929
|
-
"""
|
|
930
|
-
|
|
931
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
932
|
-
"""
|
|
933
|
-
...
|
|
934
|
-
|
|
935
|
-
def is_extended(self): ...
|
|
936
|
-
def is_property_hidden(self) -> bool:
|
|
937
|
-
"""Check if a property is hidden.
|
|
938
|
-
|
|
939
|
-
:return: True when the property is hidden.
|
|
940
|
-
:rtype: bool
|
|
941
|
-
"""
|
|
942
|
-
...
|
|
943
|
-
|
|
944
|
-
def is_property_overridable_library(self) -> bool:
|
|
945
|
-
"""Check if a property is overridable.
|
|
946
|
-
|
|
947
|
-
:return: True when the property is overridable.
|
|
948
|
-
:rtype: bool
|
|
949
|
-
"""
|
|
950
|
-
...
|
|
951
|
-
|
|
952
|
-
def is_property_readonly(self) -> bool:
|
|
953
|
-
"""Check if a property is readonly.
|
|
954
|
-
|
|
955
|
-
:return: True when the property is readonly (not writable).
|
|
956
|
-
:rtype: bool
|
|
957
|
-
"""
|
|
958
|
-
...
|
|
959
|
-
|
|
960
|
-
def is_property_set(self) -> bool:
|
|
961
|
-
"""Check if a property is set, use for testing operator properties.
|
|
962
|
-
|
|
963
|
-
:return: True when the property has been set.
|
|
964
|
-
:rtype: bool
|
|
965
|
-
"""
|
|
966
|
-
...
|
|
967
|
-
|
|
968
|
-
def items(self):
|
|
969
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
970
|
-
dictionary function of the same name).
|
|
971
|
-
|
|
972
|
-
:return: custom property key, value pairs.
|
|
973
|
-
"""
|
|
974
|
-
...
|
|
975
|
-
|
|
976
|
-
def keyframe_delete(self) -> bool:
|
|
977
|
-
"""Remove a keyframe from this properties fcurve.
|
|
978
|
-
|
|
979
|
-
:return: Success of keyframe deletion.
|
|
980
|
-
:rtype: bool
|
|
981
|
-
"""
|
|
982
|
-
...
|
|
983
|
-
|
|
984
|
-
def keyframe_insert(self) -> bool:
|
|
985
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
986
|
-
|
|
987
|
-
:return: Success of keyframe insertion.
|
|
988
|
-
:rtype: bool
|
|
989
|
-
"""
|
|
990
|
-
...
|
|
991
|
-
|
|
992
|
-
def keys(self):
|
|
993
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
994
|
-
dictionary function of the same name).
|
|
995
|
-
|
|
996
|
-
:return: custom property keys.
|
|
997
|
-
"""
|
|
998
|
-
...
|
|
999
|
-
|
|
1000
|
-
def path_from_id(self) -> str:
|
|
1001
|
-
"""Returns the data path from the ID to this object (string).
|
|
1002
|
-
|
|
1003
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1004
|
-
to this struct and property (when given).
|
|
1005
|
-
:rtype: str
|
|
1006
|
-
"""
|
|
1007
|
-
...
|
|
1008
|
-
|
|
1009
|
-
def path_menu(
|
|
1010
|
-
self,
|
|
1011
|
-
searchpaths: list[str],
|
|
1012
|
-
operator: str,
|
|
1013
|
-
*,
|
|
1014
|
-
props_default: dict = None,
|
|
1015
|
-
prop_filepath: str | None = "filepath",
|
|
1016
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1017
|
-
filter_path=None,
|
|
1018
|
-
display_name: collections.abc.Callable | None = None,
|
|
1019
|
-
add_operator=None,
|
|
1020
|
-
add_operator_props=None,
|
|
1021
|
-
):
|
|
1022
|
-
"""Populate a menu from a list of paths.
|
|
1023
|
-
|
|
1024
|
-
:param searchpaths: Paths to scan.
|
|
1025
|
-
:type searchpaths: list[str]
|
|
1026
|
-
:param operator: The operator id to use with each file.
|
|
1027
|
-
:type operator: str
|
|
1028
|
-
:param props_default: Properties to assign to each operator.
|
|
1029
|
-
:type props_default: dict
|
|
1030
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1031
|
-
:type prop_filepath: str | None
|
|
1032
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1033
|
-
|
|
1034
|
-
Returning false excludes the file from the list.
|
|
1035
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1036
|
-
:param filter_path:
|
|
1037
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1038
|
-
:type display_name: collections.abc.Callable | None
|
|
1039
|
-
:param add_operator:
|
|
1040
|
-
:param add_operator_props:
|
|
1041
|
-
"""
|
|
1042
|
-
...
|
|
1043
|
-
|
|
1044
|
-
def path_resolve(self):
|
|
1045
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1046
|
-
...
|
|
1047
|
-
|
|
1048
|
-
def pop(self):
|
|
1049
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1050
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1051
|
-
|
|
1052
|
-
"""
|
|
1053
|
-
...
|
|
1054
|
-
|
|
1055
|
-
def prepend(self, draw_func):
|
|
1056
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1057
|
-
the menus draw function
|
|
1058
|
-
|
|
1059
|
-
:param draw_func:
|
|
1060
|
-
"""
|
|
1061
|
-
...
|
|
1062
|
-
|
|
1063
|
-
def property_overridable_library_set(self) -> bool:
|
|
1064
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1065
|
-
|
|
1066
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1067
|
-
:rtype: bool
|
|
1068
|
-
"""
|
|
1069
|
-
...
|
|
1070
|
-
|
|
1071
|
-
def property_unset(self):
|
|
1072
|
-
"""Unset a property, will use default value afterward."""
|
|
1073
|
-
...
|
|
1074
|
-
|
|
1075
|
-
def remove(self, draw_func):
|
|
1076
|
-
"""Remove a draw function that has been added to this menu
|
|
1077
|
-
|
|
1078
|
-
:param draw_func:
|
|
1079
|
-
"""
|
|
1080
|
-
...
|
|
1081
|
-
|
|
1082
|
-
def type_recast(self):
|
|
1083
|
-
"""Return a new instance, this is needed because types
|
|
1084
|
-
such as textures can be changed at runtime.
|
|
1085
|
-
|
|
1086
|
-
:return: a new instance of this object with the type initialized again.
|
|
1087
|
-
"""
|
|
1088
|
-
...
|
|
1089
|
-
|
|
1090
|
-
def values(self):
|
|
1091
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1092
|
-
dictionary function of the same name).
|
|
1093
|
-
|
|
1094
|
-
:return: custom property values.
|
|
1095
|
-
"""
|
|
1096
|
-
...
|
|
1097
|
-
|
|
1098
|
-
class NODE_MT_category_shader_output(bpy_types._GenericUI):
|
|
1099
|
-
bl_idname: typing.Any
|
|
1100
|
-
bl_label: typing.Any
|
|
1101
|
-
bl_rna: typing.Any
|
|
1102
|
-
id_data: typing.Any
|
|
1103
|
-
|
|
1104
|
-
def append(self, draw_func):
|
|
1105
|
-
"""Append a draw function to this menu,
|
|
1106
|
-
takes the same arguments as the menus draw function
|
|
1107
|
-
|
|
1108
|
-
:param draw_func:
|
|
1109
|
-
"""
|
|
1110
|
-
...
|
|
1111
|
-
|
|
1112
|
-
def as_pointer(self) -> int:
|
|
1113
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1114
|
-
|
|
1115
|
-
:return: int (memory address).
|
|
1116
|
-
:rtype: int
|
|
1117
|
-
"""
|
|
1118
|
-
...
|
|
1119
|
-
|
|
1120
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1121
|
-
"""
|
|
1122
|
-
|
|
1123
|
-
:return: The RNA type or default when not found.
|
|
1124
|
-
:rtype: bpy.types.Struct
|
|
1125
|
-
"""
|
|
1126
|
-
...
|
|
1127
|
-
|
|
1128
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1129
|
-
"""
|
|
1130
|
-
|
|
1131
|
-
:return: The class or default when not found.
|
|
1132
|
-
:rtype: typing.Any
|
|
1133
|
-
"""
|
|
1134
|
-
...
|
|
1135
|
-
|
|
1136
|
-
def draw(self, context):
|
|
1137
|
-
"""
|
|
1138
|
-
|
|
1139
|
-
:param context:
|
|
1140
|
-
"""
|
|
1141
|
-
...
|
|
1142
|
-
|
|
1143
|
-
def draw_collapsible(self, context, layout):
|
|
1144
|
-
"""
|
|
1145
|
-
|
|
1146
|
-
:param context:
|
|
1147
|
-
:param layout:
|
|
1148
|
-
"""
|
|
1149
|
-
...
|
|
1150
|
-
|
|
1151
|
-
def draw_preset(self, _context):
|
|
1152
|
-
"""Define these on the subclass:
|
|
1153
|
-
- preset_operator (string)
|
|
1154
|
-
- preset_subdir (string)Optionally:
|
|
1155
|
-
- preset_add_operator (string)
|
|
1156
|
-
- preset_extensions (set of strings)
|
|
1157
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1158
|
-
|
|
1159
|
-
:param _context:
|
|
1160
|
-
"""
|
|
1161
|
-
...
|
|
1162
|
-
|
|
1163
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1164
|
-
"""Adds driver(s) to the given property
|
|
1165
|
-
|
|
1166
|
-
:return: The driver(s) added.
|
|
1167
|
-
:rtype: bpy.types.FCurve
|
|
1168
|
-
"""
|
|
1169
|
-
...
|
|
1170
|
-
|
|
1171
|
-
def driver_remove(self) -> bool:
|
|
1172
|
-
"""Remove driver(s) from the given property
|
|
1173
|
-
|
|
1174
|
-
:return: Success of driver removal.
|
|
1175
|
-
:rtype: bool
|
|
1176
|
-
"""
|
|
1177
|
-
...
|
|
1178
|
-
|
|
1179
|
-
def get(self):
|
|
1180
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1181
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1182
|
-
|
|
1183
|
-
"""
|
|
1184
|
-
...
|
|
1185
|
-
|
|
1186
|
-
def id_properties_clear(self):
|
|
1187
|
-
"""
|
|
1188
|
-
|
|
1189
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1190
|
-
"""
|
|
1191
|
-
...
|
|
1192
|
-
|
|
1193
|
-
def id_properties_ensure(self):
|
|
1194
|
-
"""
|
|
1195
|
-
|
|
1196
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1197
|
-
"""
|
|
1198
|
-
...
|
|
1199
|
-
|
|
1200
|
-
def id_properties_ui(self):
|
|
1201
|
-
"""
|
|
1202
|
-
|
|
1203
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1204
|
-
"""
|
|
1205
|
-
...
|
|
1206
|
-
|
|
1207
|
-
def is_extended(self): ...
|
|
1208
|
-
def is_property_hidden(self) -> bool:
|
|
1209
|
-
"""Check if a property is hidden.
|
|
1210
|
-
|
|
1211
|
-
:return: True when the property is hidden.
|
|
1212
|
-
:rtype: bool
|
|
1213
|
-
"""
|
|
1214
|
-
...
|
|
1215
|
-
|
|
1216
|
-
def is_property_overridable_library(self) -> bool:
|
|
1217
|
-
"""Check if a property is overridable.
|
|
1218
|
-
|
|
1219
|
-
:return: True when the property is overridable.
|
|
1220
|
-
:rtype: bool
|
|
1221
|
-
"""
|
|
1222
|
-
...
|
|
1223
|
-
|
|
1224
|
-
def is_property_readonly(self) -> bool:
|
|
1225
|
-
"""Check if a property is readonly.
|
|
1226
|
-
|
|
1227
|
-
:return: True when the property is readonly (not writable).
|
|
1228
|
-
:rtype: bool
|
|
1229
|
-
"""
|
|
1230
|
-
...
|
|
1231
|
-
|
|
1232
|
-
def is_property_set(self) -> bool:
|
|
1233
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1234
|
-
|
|
1235
|
-
:return: True when the property has been set.
|
|
1236
|
-
:rtype: bool
|
|
1237
|
-
"""
|
|
1238
|
-
...
|
|
1239
|
-
|
|
1240
|
-
def items(self):
|
|
1241
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1242
|
-
dictionary function of the same name).
|
|
1243
|
-
|
|
1244
|
-
:return: custom property key, value pairs.
|
|
1245
|
-
"""
|
|
1246
|
-
...
|
|
1247
|
-
|
|
1248
|
-
def keyframe_delete(self) -> bool:
|
|
1249
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1250
|
-
|
|
1251
|
-
:return: Success of keyframe deletion.
|
|
1252
|
-
:rtype: bool
|
|
1253
|
-
"""
|
|
1254
|
-
...
|
|
1255
|
-
|
|
1256
|
-
def keyframe_insert(self) -> bool:
|
|
1257
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1258
|
-
|
|
1259
|
-
:return: Success of keyframe insertion.
|
|
1260
|
-
:rtype: bool
|
|
1261
|
-
"""
|
|
1262
|
-
...
|
|
1263
|
-
|
|
1264
|
-
def keys(self):
|
|
1265
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1266
|
-
dictionary function of the same name).
|
|
1267
|
-
|
|
1268
|
-
:return: custom property keys.
|
|
1269
|
-
"""
|
|
1270
|
-
...
|
|
1271
|
-
|
|
1272
|
-
def path_from_id(self) -> str:
|
|
1273
|
-
"""Returns the data path from the ID to this object (string).
|
|
1274
|
-
|
|
1275
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1276
|
-
to this struct and property (when given).
|
|
1277
|
-
:rtype: str
|
|
1278
|
-
"""
|
|
1279
|
-
...
|
|
1280
|
-
|
|
1281
|
-
def path_menu(
|
|
1282
|
-
self,
|
|
1283
|
-
searchpaths: list[str],
|
|
1284
|
-
operator: str,
|
|
1285
|
-
*,
|
|
1286
|
-
props_default: dict = None,
|
|
1287
|
-
prop_filepath: str | None = "filepath",
|
|
1288
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1289
|
-
filter_path=None,
|
|
1290
|
-
display_name: collections.abc.Callable | None = None,
|
|
1291
|
-
add_operator=None,
|
|
1292
|
-
add_operator_props=None,
|
|
1293
|
-
):
|
|
1294
|
-
"""Populate a menu from a list of paths.
|
|
1295
|
-
|
|
1296
|
-
:param searchpaths: Paths to scan.
|
|
1297
|
-
:type searchpaths: list[str]
|
|
1298
|
-
:param operator: The operator id to use with each file.
|
|
1299
|
-
:type operator: str
|
|
1300
|
-
:param props_default: Properties to assign to each operator.
|
|
1301
|
-
:type props_default: dict
|
|
1302
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1303
|
-
:type prop_filepath: str | None
|
|
1304
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1305
|
-
|
|
1306
|
-
Returning false excludes the file from the list.
|
|
1307
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1308
|
-
:param filter_path:
|
|
1309
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1310
|
-
:type display_name: collections.abc.Callable | None
|
|
1311
|
-
:param add_operator:
|
|
1312
|
-
:param add_operator_props:
|
|
1313
|
-
"""
|
|
1314
|
-
...
|
|
1315
|
-
|
|
1316
|
-
def path_resolve(self):
|
|
1317
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1318
|
-
...
|
|
1319
|
-
|
|
1320
|
-
def pop(self):
|
|
1321
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1322
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1323
|
-
|
|
1324
|
-
"""
|
|
1325
|
-
...
|
|
1326
|
-
|
|
1327
|
-
def prepend(self, draw_func):
|
|
1328
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1329
|
-
the menus draw function
|
|
1330
|
-
|
|
1331
|
-
:param draw_func:
|
|
1332
|
-
"""
|
|
1333
|
-
...
|
|
1334
|
-
|
|
1335
|
-
def property_overridable_library_set(self) -> bool:
|
|
1336
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1337
|
-
|
|
1338
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1339
|
-
:rtype: bool
|
|
1340
|
-
"""
|
|
1341
|
-
...
|
|
1342
|
-
|
|
1343
|
-
def property_unset(self):
|
|
1344
|
-
"""Unset a property, will use default value afterward."""
|
|
1345
|
-
...
|
|
1346
|
-
|
|
1347
|
-
def remove(self, draw_func):
|
|
1348
|
-
"""Remove a draw function that has been added to this menu
|
|
1349
|
-
|
|
1350
|
-
:param draw_func:
|
|
1351
|
-
"""
|
|
1352
|
-
...
|
|
1353
|
-
|
|
1354
|
-
def type_recast(self):
|
|
1355
|
-
"""Return a new instance, this is needed because types
|
|
1356
|
-
such as textures can be changed at runtime.
|
|
1357
|
-
|
|
1358
|
-
:return: a new instance of this object with the type initialized again.
|
|
1359
|
-
"""
|
|
1360
|
-
...
|
|
1361
|
-
|
|
1362
|
-
def values(self):
|
|
1363
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1364
|
-
dictionary function of the same name).
|
|
1365
|
-
|
|
1366
|
-
:return: custom property values.
|
|
1367
|
-
"""
|
|
1368
|
-
...
|
|
1369
|
-
|
|
1370
|
-
class NODE_MT_category_shader_script(bpy_types._GenericUI):
|
|
1371
|
-
bl_idname: typing.Any
|
|
1372
|
-
bl_label: typing.Any
|
|
1373
|
-
bl_rna: typing.Any
|
|
1374
|
-
id_data: typing.Any
|
|
1375
|
-
|
|
1376
|
-
def append(self, draw_func):
|
|
1377
|
-
"""Append a draw function to this menu,
|
|
1378
|
-
takes the same arguments as the menus draw function
|
|
1379
|
-
|
|
1380
|
-
:param draw_func:
|
|
1381
|
-
"""
|
|
1382
|
-
...
|
|
1383
|
-
|
|
1384
|
-
def as_pointer(self) -> int:
|
|
1385
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1386
|
-
|
|
1387
|
-
:return: int (memory address).
|
|
1388
|
-
:rtype: int
|
|
1389
|
-
"""
|
|
1390
|
-
...
|
|
1391
|
-
|
|
1392
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1393
|
-
"""
|
|
1394
|
-
|
|
1395
|
-
:return: The RNA type or default when not found.
|
|
1396
|
-
:rtype: bpy.types.Struct
|
|
1397
|
-
"""
|
|
1398
|
-
...
|
|
1399
|
-
|
|
1400
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1401
|
-
"""
|
|
1402
|
-
|
|
1403
|
-
:return: The class or default when not found.
|
|
1404
|
-
:rtype: typing.Any
|
|
1405
|
-
"""
|
|
1406
|
-
...
|
|
1407
|
-
|
|
1408
|
-
def draw(self, _context):
|
|
1409
|
-
"""
|
|
1410
|
-
|
|
1411
|
-
:param _context:
|
|
1412
|
-
"""
|
|
1413
|
-
...
|
|
1414
|
-
|
|
1415
|
-
def draw_collapsible(self, context, layout):
|
|
1416
|
-
"""
|
|
1417
|
-
|
|
1418
|
-
:param context:
|
|
1419
|
-
:param layout:
|
|
1420
|
-
"""
|
|
1421
|
-
...
|
|
1422
|
-
|
|
1423
|
-
def draw_preset(self, _context):
|
|
1424
|
-
"""Define these on the subclass:
|
|
1425
|
-
- preset_operator (string)
|
|
1426
|
-
- preset_subdir (string)Optionally:
|
|
1427
|
-
- preset_add_operator (string)
|
|
1428
|
-
- preset_extensions (set of strings)
|
|
1429
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1430
|
-
|
|
1431
|
-
:param _context:
|
|
1432
|
-
"""
|
|
1433
|
-
...
|
|
1434
|
-
|
|
1435
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1436
|
-
"""Adds driver(s) to the given property
|
|
1437
|
-
|
|
1438
|
-
:return: The driver(s) added.
|
|
1439
|
-
:rtype: bpy.types.FCurve
|
|
1440
|
-
"""
|
|
1441
|
-
...
|
|
1442
|
-
|
|
1443
|
-
def driver_remove(self) -> bool:
|
|
1444
|
-
"""Remove driver(s) from the given property
|
|
1445
|
-
|
|
1446
|
-
:return: Success of driver removal.
|
|
1447
|
-
:rtype: bool
|
|
1448
|
-
"""
|
|
1449
|
-
...
|
|
1450
|
-
|
|
1451
|
-
def get(self):
|
|
1452
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1453
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1454
|
-
|
|
1455
|
-
"""
|
|
1456
|
-
...
|
|
1457
|
-
|
|
1458
|
-
def id_properties_clear(self):
|
|
1459
|
-
"""
|
|
1460
|
-
|
|
1461
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1462
|
-
"""
|
|
1463
|
-
...
|
|
1464
|
-
|
|
1465
|
-
def id_properties_ensure(self):
|
|
1466
|
-
"""
|
|
1467
|
-
|
|
1468
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1469
|
-
"""
|
|
1470
|
-
...
|
|
1471
|
-
|
|
1472
|
-
def id_properties_ui(self):
|
|
1473
|
-
"""
|
|
1474
|
-
|
|
1475
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1476
|
-
"""
|
|
1477
|
-
...
|
|
1478
|
-
|
|
1479
|
-
def is_extended(self): ...
|
|
1480
|
-
def is_property_hidden(self) -> bool:
|
|
1481
|
-
"""Check if a property is hidden.
|
|
1482
|
-
|
|
1483
|
-
:return: True when the property is hidden.
|
|
1484
|
-
:rtype: bool
|
|
1485
|
-
"""
|
|
1486
|
-
...
|
|
1487
|
-
|
|
1488
|
-
def is_property_overridable_library(self) -> bool:
|
|
1489
|
-
"""Check if a property is overridable.
|
|
1490
|
-
|
|
1491
|
-
:return: True when the property is overridable.
|
|
1492
|
-
:rtype: bool
|
|
1493
|
-
"""
|
|
1494
|
-
...
|
|
1495
|
-
|
|
1496
|
-
def is_property_readonly(self) -> bool:
|
|
1497
|
-
"""Check if a property is readonly.
|
|
1498
|
-
|
|
1499
|
-
:return: True when the property is readonly (not writable).
|
|
1500
|
-
:rtype: bool
|
|
1501
|
-
"""
|
|
1502
|
-
...
|
|
1503
|
-
|
|
1504
|
-
def is_property_set(self) -> bool:
|
|
1505
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1506
|
-
|
|
1507
|
-
:return: True when the property has been set.
|
|
1508
|
-
:rtype: bool
|
|
1509
|
-
"""
|
|
1510
|
-
...
|
|
1511
|
-
|
|
1512
|
-
def items(self):
|
|
1513
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1514
|
-
dictionary function of the same name).
|
|
1515
|
-
|
|
1516
|
-
:return: custom property key, value pairs.
|
|
1517
|
-
"""
|
|
1518
|
-
...
|
|
1519
|
-
|
|
1520
|
-
def keyframe_delete(self) -> bool:
|
|
1521
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1522
|
-
|
|
1523
|
-
:return: Success of keyframe deletion.
|
|
1524
|
-
:rtype: bool
|
|
1525
|
-
"""
|
|
1526
|
-
...
|
|
1527
|
-
|
|
1528
|
-
def keyframe_insert(self) -> bool:
|
|
1529
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1530
|
-
|
|
1531
|
-
:return: Success of keyframe insertion.
|
|
1532
|
-
:rtype: bool
|
|
1533
|
-
"""
|
|
1534
|
-
...
|
|
1535
|
-
|
|
1536
|
-
def keys(self):
|
|
1537
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1538
|
-
dictionary function of the same name).
|
|
1539
|
-
|
|
1540
|
-
:return: custom property keys.
|
|
1541
|
-
"""
|
|
1542
|
-
...
|
|
1543
|
-
|
|
1544
|
-
def path_from_id(self) -> str:
|
|
1545
|
-
"""Returns the data path from the ID to this object (string).
|
|
1546
|
-
|
|
1547
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1548
|
-
to this struct and property (when given).
|
|
1549
|
-
:rtype: str
|
|
1550
|
-
"""
|
|
1551
|
-
...
|
|
1552
|
-
|
|
1553
|
-
def path_menu(
|
|
1554
|
-
self,
|
|
1555
|
-
searchpaths: list[str],
|
|
1556
|
-
operator: str,
|
|
1557
|
-
*,
|
|
1558
|
-
props_default: dict = None,
|
|
1559
|
-
prop_filepath: str | None = "filepath",
|
|
1560
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1561
|
-
filter_path=None,
|
|
1562
|
-
display_name: collections.abc.Callable | None = None,
|
|
1563
|
-
add_operator=None,
|
|
1564
|
-
add_operator_props=None,
|
|
1565
|
-
):
|
|
1566
|
-
"""Populate a menu from a list of paths.
|
|
1567
|
-
|
|
1568
|
-
:param searchpaths: Paths to scan.
|
|
1569
|
-
:type searchpaths: list[str]
|
|
1570
|
-
:param operator: The operator id to use with each file.
|
|
1571
|
-
:type operator: str
|
|
1572
|
-
:param props_default: Properties to assign to each operator.
|
|
1573
|
-
:type props_default: dict
|
|
1574
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1575
|
-
:type prop_filepath: str | None
|
|
1576
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1577
|
-
|
|
1578
|
-
Returning false excludes the file from the list.
|
|
1579
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1580
|
-
:param filter_path:
|
|
1581
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1582
|
-
:type display_name: collections.abc.Callable | None
|
|
1583
|
-
:param add_operator:
|
|
1584
|
-
:param add_operator_props:
|
|
1585
|
-
"""
|
|
1586
|
-
...
|
|
1587
|
-
|
|
1588
|
-
def path_resolve(self):
|
|
1589
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1590
|
-
...
|
|
1591
|
-
|
|
1592
|
-
def pop(self):
|
|
1593
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1594
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1595
|
-
|
|
1596
|
-
"""
|
|
1597
|
-
...
|
|
1598
|
-
|
|
1599
|
-
def prepend(self, draw_func):
|
|
1600
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1601
|
-
the menus draw function
|
|
1602
|
-
|
|
1603
|
-
:param draw_func:
|
|
1604
|
-
"""
|
|
1605
|
-
...
|
|
1606
|
-
|
|
1607
|
-
def property_overridable_library_set(self) -> bool:
|
|
1608
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1609
|
-
|
|
1610
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1611
|
-
:rtype: bool
|
|
1612
|
-
"""
|
|
1613
|
-
...
|
|
1614
|
-
|
|
1615
|
-
def property_unset(self):
|
|
1616
|
-
"""Unset a property, will use default value afterward."""
|
|
1617
|
-
...
|
|
1618
|
-
|
|
1619
|
-
def remove(self, draw_func):
|
|
1620
|
-
"""Remove a draw function that has been added to this menu
|
|
1621
|
-
|
|
1622
|
-
:param draw_func:
|
|
1623
|
-
"""
|
|
1624
|
-
...
|
|
1625
|
-
|
|
1626
|
-
def type_recast(self):
|
|
1627
|
-
"""Return a new instance, this is needed because types
|
|
1628
|
-
such as textures can be changed at runtime.
|
|
1629
|
-
|
|
1630
|
-
:return: a new instance of this object with the type initialized again.
|
|
1631
|
-
"""
|
|
1632
|
-
...
|
|
1633
|
-
|
|
1634
|
-
def values(self):
|
|
1635
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1636
|
-
dictionary function of the same name).
|
|
1637
|
-
|
|
1638
|
-
:return: custom property values.
|
|
1639
|
-
"""
|
|
1640
|
-
...
|
|
1641
|
-
|
|
1642
|
-
class NODE_MT_category_shader_shader(bpy_types._GenericUI):
|
|
1643
|
-
bl_idname: typing.Any
|
|
1644
|
-
bl_label: typing.Any
|
|
1645
|
-
bl_rna: typing.Any
|
|
1646
|
-
id_data: typing.Any
|
|
1647
|
-
|
|
1648
|
-
def append(self, draw_func):
|
|
1649
|
-
"""Append a draw function to this menu,
|
|
1650
|
-
takes the same arguments as the menus draw function
|
|
1651
|
-
|
|
1652
|
-
:param draw_func:
|
|
1653
|
-
"""
|
|
1654
|
-
...
|
|
1655
|
-
|
|
1656
|
-
def as_pointer(self) -> int:
|
|
1657
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1658
|
-
|
|
1659
|
-
:return: int (memory address).
|
|
1660
|
-
:rtype: int
|
|
1661
|
-
"""
|
|
1662
|
-
...
|
|
1663
|
-
|
|
1664
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1665
|
-
"""
|
|
1666
|
-
|
|
1667
|
-
:return: The RNA type or default when not found.
|
|
1668
|
-
:rtype: bpy.types.Struct
|
|
1669
|
-
"""
|
|
1670
|
-
...
|
|
1671
|
-
|
|
1672
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1673
|
-
"""
|
|
1674
|
-
|
|
1675
|
-
:return: The class or default when not found.
|
|
1676
|
-
:rtype: typing.Any
|
|
1677
|
-
"""
|
|
1678
|
-
...
|
|
1679
|
-
|
|
1680
|
-
def draw(self, context):
|
|
1681
|
-
"""
|
|
1682
|
-
|
|
1683
|
-
:param context:
|
|
1684
|
-
"""
|
|
1685
|
-
...
|
|
1686
|
-
|
|
1687
|
-
def draw_collapsible(self, context, layout):
|
|
1688
|
-
"""
|
|
1689
|
-
|
|
1690
|
-
:param context:
|
|
1691
|
-
:param layout:
|
|
1692
|
-
"""
|
|
1693
|
-
...
|
|
1694
|
-
|
|
1695
|
-
def draw_preset(self, _context):
|
|
1696
|
-
"""Define these on the subclass:
|
|
1697
|
-
- preset_operator (string)
|
|
1698
|
-
- preset_subdir (string)Optionally:
|
|
1699
|
-
- preset_add_operator (string)
|
|
1700
|
-
- preset_extensions (set of strings)
|
|
1701
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1702
|
-
|
|
1703
|
-
:param _context:
|
|
1704
|
-
"""
|
|
1705
|
-
...
|
|
1706
|
-
|
|
1707
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1708
|
-
"""Adds driver(s) to the given property
|
|
1709
|
-
|
|
1710
|
-
:return: The driver(s) added.
|
|
1711
|
-
:rtype: bpy.types.FCurve
|
|
1712
|
-
"""
|
|
1713
|
-
...
|
|
1714
|
-
|
|
1715
|
-
def driver_remove(self) -> bool:
|
|
1716
|
-
"""Remove driver(s) from the given property
|
|
1717
|
-
|
|
1718
|
-
:return: Success of driver removal.
|
|
1719
|
-
:rtype: bool
|
|
1720
|
-
"""
|
|
1721
|
-
...
|
|
1722
|
-
|
|
1723
|
-
def get(self):
|
|
1724
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1725
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1726
|
-
|
|
1727
|
-
"""
|
|
1728
|
-
...
|
|
1729
|
-
|
|
1730
|
-
def id_properties_clear(self):
|
|
1731
|
-
"""
|
|
1732
|
-
|
|
1733
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1734
|
-
"""
|
|
1735
|
-
...
|
|
1736
|
-
|
|
1737
|
-
def id_properties_ensure(self):
|
|
1738
|
-
"""
|
|
1739
|
-
|
|
1740
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1741
|
-
"""
|
|
1742
|
-
...
|
|
1743
|
-
|
|
1744
|
-
def id_properties_ui(self):
|
|
1745
|
-
"""
|
|
1746
|
-
|
|
1747
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1748
|
-
"""
|
|
1749
|
-
...
|
|
1750
|
-
|
|
1751
|
-
def is_extended(self): ...
|
|
1752
|
-
def is_property_hidden(self) -> bool:
|
|
1753
|
-
"""Check if a property is hidden.
|
|
1754
|
-
|
|
1755
|
-
:return: True when the property is hidden.
|
|
1756
|
-
:rtype: bool
|
|
1757
|
-
"""
|
|
1758
|
-
...
|
|
1759
|
-
|
|
1760
|
-
def is_property_overridable_library(self) -> bool:
|
|
1761
|
-
"""Check if a property is overridable.
|
|
1762
|
-
|
|
1763
|
-
:return: True when the property is overridable.
|
|
1764
|
-
:rtype: bool
|
|
1765
|
-
"""
|
|
1766
|
-
...
|
|
1767
|
-
|
|
1768
|
-
def is_property_readonly(self) -> bool:
|
|
1769
|
-
"""Check if a property is readonly.
|
|
1770
|
-
|
|
1771
|
-
:return: True when the property is readonly (not writable).
|
|
1772
|
-
:rtype: bool
|
|
1773
|
-
"""
|
|
1774
|
-
...
|
|
1775
|
-
|
|
1776
|
-
def is_property_set(self) -> bool:
|
|
1777
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1778
|
-
|
|
1779
|
-
:return: True when the property has been set.
|
|
1780
|
-
:rtype: bool
|
|
1781
|
-
"""
|
|
1782
|
-
...
|
|
1783
|
-
|
|
1784
|
-
def items(self):
|
|
1785
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1786
|
-
dictionary function of the same name).
|
|
1787
|
-
|
|
1788
|
-
:return: custom property key, value pairs.
|
|
1789
|
-
"""
|
|
1790
|
-
...
|
|
1791
|
-
|
|
1792
|
-
def keyframe_delete(self) -> bool:
|
|
1793
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1794
|
-
|
|
1795
|
-
:return: Success of keyframe deletion.
|
|
1796
|
-
:rtype: bool
|
|
1797
|
-
"""
|
|
1798
|
-
...
|
|
1799
|
-
|
|
1800
|
-
def keyframe_insert(self) -> bool:
|
|
1801
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1802
|
-
|
|
1803
|
-
:return: Success of keyframe insertion.
|
|
1804
|
-
:rtype: bool
|
|
1805
|
-
"""
|
|
1806
|
-
...
|
|
1807
|
-
|
|
1808
|
-
def keys(self):
|
|
1809
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1810
|
-
dictionary function of the same name).
|
|
1811
|
-
|
|
1812
|
-
:return: custom property keys.
|
|
1813
|
-
"""
|
|
1814
|
-
...
|
|
1815
|
-
|
|
1816
|
-
def path_from_id(self) -> str:
|
|
1817
|
-
"""Returns the data path from the ID to this object (string).
|
|
1818
|
-
|
|
1819
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1820
|
-
to this struct and property (when given).
|
|
1821
|
-
:rtype: str
|
|
1822
|
-
"""
|
|
1823
|
-
...
|
|
1824
|
-
|
|
1825
|
-
def path_menu(
|
|
1826
|
-
self,
|
|
1827
|
-
searchpaths: list[str],
|
|
1828
|
-
operator: str,
|
|
1829
|
-
*,
|
|
1830
|
-
props_default: dict = None,
|
|
1831
|
-
prop_filepath: str | None = "filepath",
|
|
1832
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1833
|
-
filter_path=None,
|
|
1834
|
-
display_name: collections.abc.Callable | None = None,
|
|
1835
|
-
add_operator=None,
|
|
1836
|
-
add_operator_props=None,
|
|
1837
|
-
):
|
|
1838
|
-
"""Populate a menu from a list of paths.
|
|
1839
|
-
|
|
1840
|
-
:param searchpaths: Paths to scan.
|
|
1841
|
-
:type searchpaths: list[str]
|
|
1842
|
-
:param operator: The operator id to use with each file.
|
|
1843
|
-
:type operator: str
|
|
1844
|
-
:param props_default: Properties to assign to each operator.
|
|
1845
|
-
:type props_default: dict
|
|
1846
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1847
|
-
:type prop_filepath: str | None
|
|
1848
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1849
|
-
|
|
1850
|
-
Returning false excludes the file from the list.
|
|
1851
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1852
|
-
:param filter_path:
|
|
1853
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1854
|
-
:type display_name: collections.abc.Callable | None
|
|
1855
|
-
:param add_operator:
|
|
1856
|
-
:param add_operator_props:
|
|
1857
|
-
"""
|
|
1858
|
-
...
|
|
1859
|
-
|
|
1860
|
-
def path_resolve(self):
|
|
1861
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1862
|
-
...
|
|
1863
|
-
|
|
1864
|
-
def pop(self):
|
|
1865
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1866
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1867
|
-
|
|
1868
|
-
"""
|
|
1869
|
-
...
|
|
1870
|
-
|
|
1871
|
-
def prepend(self, draw_func):
|
|
1872
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1873
|
-
the menus draw function
|
|
1874
|
-
|
|
1875
|
-
:param draw_func:
|
|
1876
|
-
"""
|
|
1877
|
-
...
|
|
1878
|
-
|
|
1879
|
-
def property_overridable_library_set(self) -> bool:
|
|
1880
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1881
|
-
|
|
1882
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1883
|
-
:rtype: bool
|
|
1884
|
-
"""
|
|
1885
|
-
...
|
|
1886
|
-
|
|
1887
|
-
def property_unset(self):
|
|
1888
|
-
"""Unset a property, will use default value afterward."""
|
|
1889
|
-
...
|
|
1890
|
-
|
|
1891
|
-
def remove(self, draw_func):
|
|
1892
|
-
"""Remove a draw function that has been added to this menu
|
|
1893
|
-
|
|
1894
|
-
:param draw_func:
|
|
1895
|
-
"""
|
|
1896
|
-
...
|
|
1897
|
-
|
|
1898
|
-
def type_recast(self):
|
|
1899
|
-
"""Return a new instance, this is needed because types
|
|
1900
|
-
such as textures can be changed at runtime.
|
|
1901
|
-
|
|
1902
|
-
:return: a new instance of this object with the type initialized again.
|
|
1903
|
-
"""
|
|
1904
|
-
...
|
|
1905
|
-
|
|
1906
|
-
def values(self):
|
|
1907
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1908
|
-
dictionary function of the same name).
|
|
1909
|
-
|
|
1910
|
-
:return: custom property values.
|
|
1911
|
-
"""
|
|
1912
|
-
...
|
|
1913
|
-
|
|
1914
|
-
class NODE_MT_category_shader_texture(bpy_types._GenericUI):
|
|
1915
|
-
bl_idname: typing.Any
|
|
1916
|
-
bl_label: typing.Any
|
|
1917
|
-
bl_rna: typing.Any
|
|
1918
|
-
id_data: typing.Any
|
|
1919
|
-
|
|
1920
|
-
def append(self, draw_func):
|
|
1921
|
-
"""Append a draw function to this menu,
|
|
1922
|
-
takes the same arguments as the menus draw function
|
|
1923
|
-
|
|
1924
|
-
:param draw_func:
|
|
1925
|
-
"""
|
|
1926
|
-
...
|
|
1927
|
-
|
|
1928
|
-
def as_pointer(self) -> int:
|
|
1929
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1930
|
-
|
|
1931
|
-
:return: int (memory address).
|
|
1932
|
-
:rtype: int
|
|
1933
|
-
"""
|
|
1934
|
-
...
|
|
1935
|
-
|
|
1936
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1937
|
-
"""
|
|
1938
|
-
|
|
1939
|
-
:return: The RNA type or default when not found.
|
|
1940
|
-
:rtype: bpy.types.Struct
|
|
1941
|
-
"""
|
|
1942
|
-
...
|
|
1943
|
-
|
|
1944
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1945
|
-
"""
|
|
1946
|
-
|
|
1947
|
-
:return: The class or default when not found.
|
|
1948
|
-
:rtype: typing.Any
|
|
1949
|
-
"""
|
|
1950
|
-
...
|
|
1951
|
-
|
|
1952
|
-
def draw(self, _context):
|
|
1953
|
-
"""
|
|
1954
|
-
|
|
1955
|
-
:param _context:
|
|
1956
|
-
"""
|
|
1957
|
-
...
|
|
1958
|
-
|
|
1959
|
-
def draw_collapsible(self, context, layout):
|
|
1960
|
-
"""
|
|
1961
|
-
|
|
1962
|
-
:param context:
|
|
1963
|
-
:param layout:
|
|
1964
|
-
"""
|
|
1965
|
-
...
|
|
1966
|
-
|
|
1967
|
-
def draw_preset(self, _context):
|
|
1968
|
-
"""Define these on the subclass:
|
|
1969
|
-
- preset_operator (string)
|
|
1970
|
-
- preset_subdir (string)Optionally:
|
|
1971
|
-
- preset_add_operator (string)
|
|
1972
|
-
- preset_extensions (set of strings)
|
|
1973
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1974
|
-
|
|
1975
|
-
:param _context:
|
|
1976
|
-
"""
|
|
1977
|
-
...
|
|
1978
|
-
|
|
1979
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1980
|
-
"""Adds driver(s) to the given property
|
|
1981
|
-
|
|
1982
|
-
:return: The driver(s) added.
|
|
1983
|
-
:rtype: bpy.types.FCurve
|
|
1984
|
-
"""
|
|
1985
|
-
...
|
|
1986
|
-
|
|
1987
|
-
def driver_remove(self) -> bool:
|
|
1988
|
-
"""Remove driver(s) from the given property
|
|
1989
|
-
|
|
1990
|
-
:return: Success of driver removal.
|
|
1991
|
-
:rtype: bool
|
|
1992
|
-
"""
|
|
1993
|
-
...
|
|
1994
|
-
|
|
1995
|
-
def get(self):
|
|
1996
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1997
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1998
|
-
|
|
1999
|
-
"""
|
|
2000
|
-
...
|
|
2001
|
-
|
|
2002
|
-
def id_properties_clear(self):
|
|
2003
|
-
"""
|
|
2004
|
-
|
|
2005
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2006
|
-
"""
|
|
2007
|
-
...
|
|
2008
|
-
|
|
2009
|
-
def id_properties_ensure(self):
|
|
2010
|
-
"""
|
|
2011
|
-
|
|
2012
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2013
|
-
"""
|
|
2014
|
-
...
|
|
2015
|
-
|
|
2016
|
-
def id_properties_ui(self):
|
|
2017
|
-
"""
|
|
2018
|
-
|
|
2019
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2020
|
-
"""
|
|
2021
|
-
...
|
|
2022
|
-
|
|
2023
|
-
def is_extended(self): ...
|
|
2024
|
-
def is_property_hidden(self) -> bool:
|
|
2025
|
-
"""Check if a property is hidden.
|
|
2026
|
-
|
|
2027
|
-
:return: True when the property is hidden.
|
|
2028
|
-
:rtype: bool
|
|
2029
|
-
"""
|
|
2030
|
-
...
|
|
2031
|
-
|
|
2032
|
-
def is_property_overridable_library(self) -> bool:
|
|
2033
|
-
"""Check if a property is overridable.
|
|
2034
|
-
|
|
2035
|
-
:return: True when the property is overridable.
|
|
2036
|
-
:rtype: bool
|
|
2037
|
-
"""
|
|
2038
|
-
...
|
|
2039
|
-
|
|
2040
|
-
def is_property_readonly(self) -> bool:
|
|
2041
|
-
"""Check if a property is readonly.
|
|
2042
|
-
|
|
2043
|
-
:return: True when the property is readonly (not writable).
|
|
2044
|
-
:rtype: bool
|
|
2045
|
-
"""
|
|
2046
|
-
...
|
|
2047
|
-
|
|
2048
|
-
def is_property_set(self) -> bool:
|
|
2049
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2050
|
-
|
|
2051
|
-
:return: True when the property has been set.
|
|
2052
|
-
:rtype: bool
|
|
2053
|
-
"""
|
|
2054
|
-
...
|
|
2055
|
-
|
|
2056
|
-
def items(self):
|
|
2057
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2058
|
-
dictionary function of the same name).
|
|
2059
|
-
|
|
2060
|
-
:return: custom property key, value pairs.
|
|
2061
|
-
"""
|
|
2062
|
-
...
|
|
2063
|
-
|
|
2064
|
-
def keyframe_delete(self) -> bool:
|
|
2065
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2066
|
-
|
|
2067
|
-
:return: Success of keyframe deletion.
|
|
2068
|
-
:rtype: bool
|
|
2069
|
-
"""
|
|
2070
|
-
...
|
|
2071
|
-
|
|
2072
|
-
def keyframe_insert(self) -> bool:
|
|
2073
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2074
|
-
|
|
2075
|
-
:return: Success of keyframe insertion.
|
|
2076
|
-
:rtype: bool
|
|
2077
|
-
"""
|
|
2078
|
-
...
|
|
2079
|
-
|
|
2080
|
-
def keys(self):
|
|
2081
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2082
|
-
dictionary function of the same name).
|
|
2083
|
-
|
|
2084
|
-
:return: custom property keys.
|
|
2085
|
-
"""
|
|
2086
|
-
...
|
|
2087
|
-
|
|
2088
|
-
def path_from_id(self) -> str:
|
|
2089
|
-
"""Returns the data path from the ID to this object (string).
|
|
2090
|
-
|
|
2091
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2092
|
-
to this struct and property (when given).
|
|
2093
|
-
:rtype: str
|
|
2094
|
-
"""
|
|
2095
|
-
...
|
|
2096
|
-
|
|
2097
|
-
def path_menu(
|
|
2098
|
-
self,
|
|
2099
|
-
searchpaths: list[str],
|
|
2100
|
-
operator: str,
|
|
2101
|
-
*,
|
|
2102
|
-
props_default: dict = None,
|
|
2103
|
-
prop_filepath: str | None = "filepath",
|
|
2104
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2105
|
-
filter_path=None,
|
|
2106
|
-
display_name: collections.abc.Callable | None = None,
|
|
2107
|
-
add_operator=None,
|
|
2108
|
-
add_operator_props=None,
|
|
2109
|
-
):
|
|
2110
|
-
"""Populate a menu from a list of paths.
|
|
2111
|
-
|
|
2112
|
-
:param searchpaths: Paths to scan.
|
|
2113
|
-
:type searchpaths: list[str]
|
|
2114
|
-
:param operator: The operator id to use with each file.
|
|
2115
|
-
:type operator: str
|
|
2116
|
-
:param props_default: Properties to assign to each operator.
|
|
2117
|
-
:type props_default: dict
|
|
2118
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2119
|
-
:type prop_filepath: str | None
|
|
2120
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2121
|
-
|
|
2122
|
-
Returning false excludes the file from the list.
|
|
2123
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2124
|
-
:param filter_path:
|
|
2125
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2126
|
-
:type display_name: collections.abc.Callable | None
|
|
2127
|
-
:param add_operator:
|
|
2128
|
-
:param add_operator_props:
|
|
2129
|
-
"""
|
|
2130
|
-
...
|
|
2131
|
-
|
|
2132
|
-
def path_resolve(self):
|
|
2133
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2134
|
-
...
|
|
2135
|
-
|
|
2136
|
-
def pop(self):
|
|
2137
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2138
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2139
|
-
|
|
2140
|
-
"""
|
|
2141
|
-
...
|
|
2142
|
-
|
|
2143
|
-
def prepend(self, draw_func):
|
|
2144
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2145
|
-
the menus draw function
|
|
2146
|
-
|
|
2147
|
-
:param draw_func:
|
|
2148
|
-
"""
|
|
2149
|
-
...
|
|
2150
|
-
|
|
2151
|
-
def property_overridable_library_set(self) -> bool:
|
|
2152
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2153
|
-
|
|
2154
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2155
|
-
:rtype: bool
|
|
2156
|
-
"""
|
|
2157
|
-
...
|
|
2158
|
-
|
|
2159
|
-
def property_unset(self):
|
|
2160
|
-
"""Unset a property, will use default value afterward."""
|
|
2161
|
-
...
|
|
2162
|
-
|
|
2163
|
-
def remove(self, draw_func):
|
|
2164
|
-
"""Remove a draw function that has been added to this menu
|
|
2165
|
-
|
|
2166
|
-
:param draw_func:
|
|
2167
|
-
"""
|
|
2168
|
-
...
|
|
2169
|
-
|
|
2170
|
-
def type_recast(self):
|
|
2171
|
-
"""Return a new instance, this is needed because types
|
|
2172
|
-
such as textures can be changed at runtime.
|
|
2173
|
-
|
|
2174
|
-
:return: a new instance of this object with the type initialized again.
|
|
2175
|
-
"""
|
|
2176
|
-
...
|
|
2177
|
-
|
|
2178
|
-
def values(self):
|
|
2179
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2180
|
-
dictionary function of the same name).
|
|
2181
|
-
|
|
2182
|
-
:return: custom property values.
|
|
2183
|
-
"""
|
|
2184
|
-
...
|
|
2185
|
-
|
|
2186
|
-
class NODE_MT_category_shader_vector(bpy_types._GenericUI):
|
|
2187
|
-
bl_idname: typing.Any
|
|
2188
|
-
bl_label: typing.Any
|
|
2189
|
-
bl_rna: typing.Any
|
|
2190
|
-
id_data: typing.Any
|
|
2191
|
-
|
|
2192
|
-
def append(self, draw_func):
|
|
2193
|
-
"""Append a draw function to this menu,
|
|
2194
|
-
takes the same arguments as the menus draw function
|
|
2195
|
-
|
|
2196
|
-
:param draw_func:
|
|
2197
|
-
"""
|
|
2198
|
-
...
|
|
2199
|
-
|
|
2200
|
-
def as_pointer(self) -> int:
|
|
2201
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2202
|
-
|
|
2203
|
-
:return: int (memory address).
|
|
2204
|
-
:rtype: int
|
|
2205
|
-
"""
|
|
2206
|
-
...
|
|
2207
|
-
|
|
2208
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2209
|
-
"""
|
|
2210
|
-
|
|
2211
|
-
:return: The RNA type or default when not found.
|
|
2212
|
-
:rtype: bpy.types.Struct
|
|
2213
|
-
"""
|
|
2214
|
-
...
|
|
2215
|
-
|
|
2216
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2217
|
-
"""
|
|
2218
|
-
|
|
2219
|
-
:return: The class or default when not found.
|
|
2220
|
-
:rtype: typing.Any
|
|
2221
|
-
"""
|
|
2222
|
-
...
|
|
2223
|
-
|
|
2224
|
-
def draw(self, _context):
|
|
2225
|
-
"""
|
|
2226
|
-
|
|
2227
|
-
:param _context:
|
|
2228
|
-
"""
|
|
2229
|
-
...
|
|
2230
|
-
|
|
2231
|
-
def draw_collapsible(self, context, layout):
|
|
2232
|
-
"""
|
|
2233
|
-
|
|
2234
|
-
:param context:
|
|
2235
|
-
:param layout:
|
|
2236
|
-
"""
|
|
2237
|
-
...
|
|
2238
|
-
|
|
2239
|
-
def draw_preset(self, _context):
|
|
2240
|
-
"""Define these on the subclass:
|
|
2241
|
-
- preset_operator (string)
|
|
2242
|
-
- preset_subdir (string)Optionally:
|
|
2243
|
-
- preset_add_operator (string)
|
|
2244
|
-
- preset_extensions (set of strings)
|
|
2245
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2246
|
-
|
|
2247
|
-
:param _context:
|
|
2248
|
-
"""
|
|
2249
|
-
...
|
|
2250
|
-
|
|
2251
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2252
|
-
"""Adds driver(s) to the given property
|
|
2253
|
-
|
|
2254
|
-
:return: The driver(s) added.
|
|
2255
|
-
:rtype: bpy.types.FCurve
|
|
2256
|
-
"""
|
|
2257
|
-
...
|
|
2258
|
-
|
|
2259
|
-
def driver_remove(self) -> bool:
|
|
2260
|
-
"""Remove driver(s) from the given property
|
|
2261
|
-
|
|
2262
|
-
:return: Success of driver removal.
|
|
2263
|
-
:rtype: bool
|
|
2264
|
-
"""
|
|
2265
|
-
...
|
|
2266
|
-
|
|
2267
|
-
def get(self):
|
|
2268
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2269
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2270
|
-
|
|
2271
|
-
"""
|
|
2272
|
-
...
|
|
2273
|
-
|
|
2274
|
-
def id_properties_clear(self):
|
|
2275
|
-
"""
|
|
2276
|
-
|
|
2277
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2278
|
-
"""
|
|
2279
|
-
...
|
|
2280
|
-
|
|
2281
|
-
def id_properties_ensure(self):
|
|
2282
|
-
"""
|
|
2283
|
-
|
|
2284
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2285
|
-
"""
|
|
2286
|
-
...
|
|
2287
|
-
|
|
2288
|
-
def id_properties_ui(self):
|
|
2289
|
-
"""
|
|
2290
|
-
|
|
2291
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2292
|
-
"""
|
|
2293
|
-
...
|
|
2294
|
-
|
|
2295
|
-
def is_extended(self): ...
|
|
2296
|
-
def is_property_hidden(self) -> bool:
|
|
2297
|
-
"""Check if a property is hidden.
|
|
2298
|
-
|
|
2299
|
-
:return: True when the property is hidden.
|
|
2300
|
-
:rtype: bool
|
|
2301
|
-
"""
|
|
2302
|
-
...
|
|
2303
|
-
|
|
2304
|
-
def is_property_overridable_library(self) -> bool:
|
|
2305
|
-
"""Check if a property is overridable.
|
|
2306
|
-
|
|
2307
|
-
:return: True when the property is overridable.
|
|
2308
|
-
:rtype: bool
|
|
2309
|
-
"""
|
|
2310
|
-
...
|
|
2311
|
-
|
|
2312
|
-
def is_property_readonly(self) -> bool:
|
|
2313
|
-
"""Check if a property is readonly.
|
|
2314
|
-
|
|
2315
|
-
:return: True when the property is readonly (not writable).
|
|
2316
|
-
:rtype: bool
|
|
2317
|
-
"""
|
|
2318
|
-
...
|
|
2319
|
-
|
|
2320
|
-
def is_property_set(self) -> bool:
|
|
2321
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2322
|
-
|
|
2323
|
-
:return: True when the property has been set.
|
|
2324
|
-
:rtype: bool
|
|
2325
|
-
"""
|
|
2326
|
-
...
|
|
2327
|
-
|
|
2328
|
-
def items(self):
|
|
2329
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2330
|
-
dictionary function of the same name).
|
|
2331
|
-
|
|
2332
|
-
:return: custom property key, value pairs.
|
|
2333
|
-
"""
|
|
2334
|
-
...
|
|
2335
|
-
|
|
2336
|
-
def keyframe_delete(self) -> bool:
|
|
2337
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2338
|
-
|
|
2339
|
-
:return: Success of keyframe deletion.
|
|
2340
|
-
:rtype: bool
|
|
2341
|
-
"""
|
|
2342
|
-
...
|
|
2343
|
-
|
|
2344
|
-
def keyframe_insert(self) -> bool:
|
|
2345
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2346
|
-
|
|
2347
|
-
:return: Success of keyframe insertion.
|
|
2348
|
-
:rtype: bool
|
|
2349
|
-
"""
|
|
2350
|
-
...
|
|
2351
|
-
|
|
2352
|
-
def keys(self):
|
|
2353
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2354
|
-
dictionary function of the same name).
|
|
2355
|
-
|
|
2356
|
-
:return: custom property keys.
|
|
2357
|
-
"""
|
|
2358
|
-
...
|
|
2359
|
-
|
|
2360
|
-
def path_from_id(self) -> str:
|
|
2361
|
-
"""Returns the data path from the ID to this object (string).
|
|
2362
|
-
|
|
2363
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2364
|
-
to this struct and property (when given).
|
|
2365
|
-
:rtype: str
|
|
2366
|
-
"""
|
|
2367
|
-
...
|
|
2368
|
-
|
|
2369
|
-
def path_menu(
|
|
2370
|
-
self,
|
|
2371
|
-
searchpaths: list[str],
|
|
2372
|
-
operator: str,
|
|
2373
|
-
*,
|
|
2374
|
-
props_default: dict = None,
|
|
2375
|
-
prop_filepath: str | None = "filepath",
|
|
2376
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2377
|
-
filter_path=None,
|
|
2378
|
-
display_name: collections.abc.Callable | None = None,
|
|
2379
|
-
add_operator=None,
|
|
2380
|
-
add_operator_props=None,
|
|
2381
|
-
):
|
|
2382
|
-
"""Populate a menu from a list of paths.
|
|
2383
|
-
|
|
2384
|
-
:param searchpaths: Paths to scan.
|
|
2385
|
-
:type searchpaths: list[str]
|
|
2386
|
-
:param operator: The operator id to use with each file.
|
|
2387
|
-
:type operator: str
|
|
2388
|
-
:param props_default: Properties to assign to each operator.
|
|
2389
|
-
:type props_default: dict
|
|
2390
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2391
|
-
:type prop_filepath: str | None
|
|
2392
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2393
|
-
|
|
2394
|
-
Returning false excludes the file from the list.
|
|
2395
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2396
|
-
:param filter_path:
|
|
2397
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2398
|
-
:type display_name: collections.abc.Callable | None
|
|
2399
|
-
:param add_operator:
|
|
2400
|
-
:param add_operator_props:
|
|
2401
|
-
"""
|
|
2402
|
-
...
|
|
2403
|
-
|
|
2404
|
-
def path_resolve(self):
|
|
2405
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2406
|
-
...
|
|
2407
|
-
|
|
2408
|
-
def pop(self):
|
|
2409
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2410
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2411
|
-
|
|
2412
|
-
"""
|
|
2413
|
-
...
|
|
2414
|
-
|
|
2415
|
-
def prepend(self, draw_func):
|
|
2416
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2417
|
-
the menus draw function
|
|
2418
|
-
|
|
2419
|
-
:param draw_func:
|
|
2420
|
-
"""
|
|
2421
|
-
...
|
|
2422
|
-
|
|
2423
|
-
def property_overridable_library_set(self) -> bool:
|
|
2424
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2425
|
-
|
|
2426
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2427
|
-
:rtype: bool
|
|
2428
|
-
"""
|
|
2429
|
-
...
|
|
2430
|
-
|
|
2431
|
-
def property_unset(self):
|
|
2432
|
-
"""Unset a property, will use default value afterward."""
|
|
2433
|
-
...
|
|
2434
|
-
|
|
2435
|
-
def remove(self, draw_func):
|
|
2436
|
-
"""Remove a draw function that has been added to this menu
|
|
2437
|
-
|
|
2438
|
-
:param draw_func:
|
|
2439
|
-
"""
|
|
2440
|
-
...
|
|
2441
|
-
|
|
2442
|
-
def type_recast(self):
|
|
2443
|
-
"""Return a new instance, this is needed because types
|
|
2444
|
-
such as textures can be changed at runtime.
|
|
2445
|
-
|
|
2446
|
-
:return: a new instance of this object with the type initialized again.
|
|
2447
|
-
"""
|
|
2448
|
-
...
|
|
2449
|
-
|
|
2450
|
-
def values(self):
|
|
2451
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2452
|
-
dictionary function of the same name).
|
|
2453
|
-
|
|
2454
|
-
:return: custom property values.
|
|
2455
|
-
"""
|
|
2456
|
-
...
|
|
2457
|
-
|
|
2458
|
-
class NODE_MT_shader_node_add_all(bpy_types._GenericUI):
|
|
2459
|
-
bl_idname: typing.Any
|
|
2460
|
-
bl_label: typing.Any
|
|
2461
|
-
bl_rna: typing.Any
|
|
2462
|
-
bl_translation_context: typing.Any
|
|
2463
|
-
id_data: typing.Any
|
|
2464
|
-
|
|
2465
|
-
def append(self, draw_func):
|
|
2466
|
-
"""Append a draw function to this menu,
|
|
2467
|
-
takes the same arguments as the menus draw function
|
|
2468
|
-
|
|
2469
|
-
:param draw_func:
|
|
2470
|
-
"""
|
|
2471
|
-
...
|
|
2472
|
-
|
|
2473
|
-
def as_pointer(self) -> int:
|
|
2474
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2475
|
-
|
|
2476
|
-
:return: int (memory address).
|
|
2477
|
-
:rtype: int
|
|
2478
|
-
"""
|
|
2479
|
-
...
|
|
2480
|
-
|
|
2481
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2482
|
-
"""
|
|
2483
|
-
|
|
2484
|
-
:return: The RNA type or default when not found.
|
|
2485
|
-
:rtype: bpy.types.Struct
|
|
2486
|
-
"""
|
|
2487
|
-
...
|
|
2488
|
-
|
|
2489
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2490
|
-
"""
|
|
2491
|
-
|
|
2492
|
-
:return: The class or default when not found.
|
|
2493
|
-
:rtype: typing.Any
|
|
2494
|
-
"""
|
|
2495
|
-
...
|
|
2496
|
-
|
|
2497
|
-
def draw(self, _context):
|
|
287
|
+
def draw(self, _context):
|
|
2498
288
|
"""
|
|
2499
289
|
|
|
2500
290
|
:param _context:
|
|
2501
291
|
"""
|
|
2502
292
|
...
|
|
2503
293
|
|
|
2504
|
-
def draw_collapsible(self, context, layout):
|
|
2505
|
-
"""
|
|
2506
|
-
|
|
2507
|
-
:param context:
|
|
2508
|
-
:param layout:
|
|
2509
|
-
"""
|
|
2510
|
-
...
|
|
2511
|
-
|
|
2512
|
-
def draw_preset(self, _context):
|
|
2513
|
-
"""Define these on the subclass:
|
|
2514
|
-
- preset_operator (string)
|
|
2515
|
-
- preset_subdir (string)Optionally:
|
|
2516
|
-
- preset_add_operator (string)
|
|
2517
|
-
- preset_extensions (set of strings)
|
|
2518
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2519
|
-
|
|
2520
|
-
:param _context:
|
|
2521
|
-
"""
|
|
2522
|
-
...
|
|
2523
|
-
|
|
2524
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2525
|
-
"""Adds driver(s) to the given property
|
|
2526
|
-
|
|
2527
|
-
:return: The driver(s) added.
|
|
2528
|
-
:rtype: bpy.types.FCurve
|
|
2529
|
-
"""
|
|
2530
|
-
...
|
|
2531
|
-
|
|
2532
|
-
def driver_remove(self) -> bool:
|
|
2533
|
-
"""Remove driver(s) from the given property
|
|
2534
|
-
|
|
2535
|
-
:return: Success of driver removal.
|
|
2536
|
-
:rtype: bool
|
|
2537
|
-
"""
|
|
2538
|
-
...
|
|
2539
|
-
|
|
2540
|
-
def get(self):
|
|
2541
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2542
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2543
|
-
|
|
2544
|
-
"""
|
|
2545
|
-
...
|
|
2546
|
-
|
|
2547
|
-
def id_properties_clear(self):
|
|
2548
|
-
"""
|
|
2549
|
-
|
|
2550
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2551
|
-
"""
|
|
2552
|
-
...
|
|
2553
|
-
|
|
2554
|
-
def id_properties_ensure(self):
|
|
2555
|
-
"""
|
|
2556
|
-
|
|
2557
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2558
|
-
"""
|
|
2559
|
-
...
|
|
2560
|
-
|
|
2561
|
-
def id_properties_ui(self):
|
|
2562
|
-
"""
|
|
2563
|
-
|
|
2564
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2565
|
-
"""
|
|
2566
|
-
...
|
|
2567
|
-
|
|
2568
|
-
def is_extended(self): ...
|
|
2569
|
-
def is_property_hidden(self) -> bool:
|
|
2570
|
-
"""Check if a property is hidden.
|
|
2571
|
-
|
|
2572
|
-
:return: True when the property is hidden.
|
|
2573
|
-
:rtype: bool
|
|
2574
|
-
"""
|
|
2575
|
-
...
|
|
2576
|
-
|
|
2577
|
-
def is_property_overridable_library(self) -> bool:
|
|
2578
|
-
"""Check if a property is overridable.
|
|
2579
|
-
|
|
2580
|
-
:return: True when the property is overridable.
|
|
2581
|
-
:rtype: bool
|
|
2582
|
-
"""
|
|
2583
|
-
...
|
|
2584
|
-
|
|
2585
|
-
def is_property_readonly(self) -> bool:
|
|
2586
|
-
"""Check if a property is readonly.
|
|
2587
|
-
|
|
2588
|
-
:return: True when the property is readonly (not writable).
|
|
2589
|
-
:rtype: bool
|
|
2590
|
-
"""
|
|
2591
|
-
...
|
|
2592
|
-
|
|
2593
|
-
def is_property_set(self) -> bool:
|
|
2594
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2595
|
-
|
|
2596
|
-
:return: True when the property has been set.
|
|
2597
|
-
:rtype: bool
|
|
2598
|
-
"""
|
|
2599
|
-
...
|
|
2600
|
-
|
|
2601
|
-
def items(self):
|
|
2602
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2603
|
-
dictionary function of the same name).
|
|
2604
|
-
|
|
2605
|
-
:return: custom property key, value pairs.
|
|
2606
|
-
"""
|
|
2607
|
-
...
|
|
2608
|
-
|
|
2609
|
-
def keyframe_delete(self) -> bool:
|
|
2610
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2611
|
-
|
|
2612
|
-
:return: Success of keyframe deletion.
|
|
2613
|
-
:rtype: bool
|
|
2614
|
-
"""
|
|
2615
|
-
...
|
|
2616
|
-
|
|
2617
|
-
def keyframe_insert(self) -> bool:
|
|
2618
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2619
|
-
|
|
2620
|
-
:return: Success of keyframe insertion.
|
|
2621
|
-
:rtype: bool
|
|
2622
|
-
"""
|
|
2623
|
-
...
|
|
2624
|
-
|
|
2625
|
-
def keys(self):
|
|
2626
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2627
|
-
dictionary function of the same name).
|
|
2628
|
-
|
|
2629
|
-
:return: custom property keys.
|
|
2630
|
-
"""
|
|
2631
|
-
...
|
|
2632
|
-
|
|
2633
|
-
def path_from_id(self) -> str:
|
|
2634
|
-
"""Returns the data path from the ID to this object (string).
|
|
2635
|
-
|
|
2636
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2637
|
-
to this struct and property (when given).
|
|
2638
|
-
:rtype: str
|
|
2639
|
-
"""
|
|
2640
|
-
...
|
|
2641
|
-
|
|
2642
|
-
def path_menu(
|
|
2643
|
-
self,
|
|
2644
|
-
searchpaths: list[str],
|
|
2645
|
-
operator: str,
|
|
2646
|
-
*,
|
|
2647
|
-
props_default: dict = None,
|
|
2648
|
-
prop_filepath: str | None = "filepath",
|
|
2649
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2650
|
-
filter_path=None,
|
|
2651
|
-
display_name: collections.abc.Callable | None = None,
|
|
2652
|
-
add_operator=None,
|
|
2653
|
-
add_operator_props=None,
|
|
2654
|
-
):
|
|
2655
|
-
"""Populate a menu from a list of paths.
|
|
2656
|
-
|
|
2657
|
-
:param searchpaths: Paths to scan.
|
|
2658
|
-
:type searchpaths: list[str]
|
|
2659
|
-
:param operator: The operator id to use with each file.
|
|
2660
|
-
:type operator: str
|
|
2661
|
-
:param props_default: Properties to assign to each operator.
|
|
2662
|
-
:type props_default: dict
|
|
2663
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2664
|
-
:type prop_filepath: str | None
|
|
2665
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2666
|
-
|
|
2667
|
-
Returning false excludes the file from the list.
|
|
2668
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2669
|
-
:param filter_path:
|
|
2670
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2671
|
-
:type display_name: collections.abc.Callable | None
|
|
2672
|
-
:param add_operator:
|
|
2673
|
-
:param add_operator_props:
|
|
2674
|
-
"""
|
|
2675
|
-
...
|
|
2676
|
-
|
|
2677
|
-
def path_resolve(self):
|
|
2678
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2679
|
-
...
|
|
2680
|
-
|
|
2681
|
-
def pop(self):
|
|
2682
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2683
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2684
|
-
|
|
2685
|
-
"""
|
|
2686
|
-
...
|
|
2687
|
-
|
|
2688
|
-
def prepend(self, draw_func):
|
|
2689
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2690
|
-
the menus draw function
|
|
2691
|
-
|
|
2692
|
-
:param draw_func:
|
|
2693
|
-
"""
|
|
2694
|
-
...
|
|
2695
|
-
|
|
2696
|
-
def property_overridable_library_set(self) -> bool:
|
|
2697
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2698
|
-
|
|
2699
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2700
|
-
:rtype: bool
|
|
2701
|
-
"""
|
|
2702
|
-
...
|
|
2703
|
-
|
|
2704
|
-
def property_unset(self):
|
|
2705
|
-
"""Unset a property, will use default value afterward."""
|
|
2706
|
-
...
|
|
2707
|
-
|
|
2708
|
-
def remove(self, draw_func):
|
|
2709
|
-
"""Remove a draw function that has been added to this menu
|
|
2710
|
-
|
|
2711
|
-
:param draw_func:
|
|
2712
|
-
"""
|
|
2713
|
-
...
|
|
2714
|
-
|
|
2715
|
-
def type_recast(self):
|
|
2716
|
-
"""Return a new instance, this is needed because types
|
|
2717
|
-
such as textures can be changed at runtime.
|
|
2718
|
-
|
|
2719
|
-
:return: a new instance of this object with the type initialized again.
|
|
2720
|
-
"""
|
|
2721
|
-
...
|
|
2722
|
-
|
|
2723
|
-
def values(self):
|
|
2724
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2725
|
-
dictionary function of the same name).
|
|
2726
|
-
|
|
2727
|
-
:return: custom property values.
|
|
2728
|
-
"""
|
|
2729
|
-
...
|
|
2730
|
-
|
|
2731
294
|
def cycles_shader_nodes_poll(context): ...
|
|
2732
295
|
def eevee_shader_nodes_poll(context): ...
|
|
2733
296
|
def line_style_shader_nodes_poll(context): ...
|