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