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,11 @@ import bpy_types
|
|
|
7
7
|
GenericType1 = typing.TypeVar("GenericType1")
|
|
8
8
|
GenericType2 = typing.TypeVar("GenericType2")
|
|
9
9
|
|
|
10
|
-
class OUTLINER_HT_header(bpy_types._GenericUI):
|
|
10
|
+
class OUTLINER_HT_header(bpy.types.Header, bpy_types._GenericUI):
|
|
11
11
|
bl_rna: typing.Any
|
|
12
12
|
bl_space_type: typing.Any
|
|
13
13
|
id_data: typing.Any
|
|
14
14
|
|
|
15
|
-
def append(self, draw_func):
|
|
16
|
-
"""Append a draw function to this menu,
|
|
17
|
-
takes the same arguments as the menus draw function
|
|
18
|
-
|
|
19
|
-
:param draw_func:
|
|
20
|
-
"""
|
|
21
|
-
...
|
|
22
|
-
|
|
23
|
-
def as_pointer(self) -> int:
|
|
24
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
25
|
-
|
|
26
|
-
:return: int (memory address).
|
|
27
|
-
:rtype: int
|
|
28
|
-
"""
|
|
29
|
-
...
|
|
30
|
-
|
|
31
15
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
32
16
|
"""
|
|
33
17
|
|
|
@@ -51,199 +35,112 @@ class OUTLINER_HT_header(bpy_types._GenericUI):
|
|
|
51
35
|
"""
|
|
52
36
|
...
|
|
53
37
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
:rtype: bpy.types.FCurve
|
|
59
|
-
"""
|
|
60
|
-
...
|
|
61
|
-
|
|
62
|
-
def driver_remove(self) -> bool:
|
|
63
|
-
"""Remove driver(s) from the given property
|
|
38
|
+
class OUTLINER_MT_asset(bpy.types.Menu, bpy_types._GenericUI):
|
|
39
|
+
bl_label: typing.Any
|
|
40
|
+
bl_rna: typing.Any
|
|
41
|
+
id_data: typing.Any
|
|
64
42
|
|
|
65
|
-
|
|
66
|
-
:rtype: bool
|
|
43
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
67
44
|
"""
|
|
68
|
-
...
|
|
69
|
-
|
|
70
|
-
def get(self):
|
|
71
|
-
"""Returns the value of the custom property assigned to key or default
|
|
72
|
-
when not found (matches Python's dictionary function of the same name).
|
|
73
45
|
|
|
46
|
+
:return: The RNA type or default when not found.
|
|
47
|
+
:rtype: bpy.types.Struct
|
|
74
48
|
"""
|
|
75
49
|
...
|
|
76
50
|
|
|
77
|
-
def
|
|
51
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
78
52
|
"""
|
|
79
53
|
|
|
80
|
-
:return:
|
|
54
|
+
:return: The class or default when not found.
|
|
55
|
+
:rtype: typing.Any
|
|
81
56
|
"""
|
|
82
57
|
...
|
|
83
58
|
|
|
84
|
-
def
|
|
59
|
+
def draw(self, _context):
|
|
85
60
|
"""
|
|
86
61
|
|
|
87
|
-
:
|
|
62
|
+
:param _context:
|
|
88
63
|
"""
|
|
89
64
|
...
|
|
90
65
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
66
|
+
@classmethod
|
|
67
|
+
def poll(cls, context):
|
|
95
68
|
"""
|
|
96
|
-
...
|
|
97
69
|
|
|
98
|
-
|
|
99
|
-
def is_property_hidden(self) -> bool:
|
|
100
|
-
"""Check if a property is hidden.
|
|
101
|
-
|
|
102
|
-
:return: True when the property is hidden.
|
|
103
|
-
:rtype: bool
|
|
70
|
+
:param context:
|
|
104
71
|
"""
|
|
105
72
|
...
|
|
106
73
|
|
|
107
|
-
|
|
108
|
-
|
|
74
|
+
class OUTLINER_MT_collection(bpy.types.Menu, bpy_types._GenericUI):
|
|
75
|
+
bl_label: typing.Any
|
|
76
|
+
bl_rna: typing.Any
|
|
77
|
+
id_data: typing.Any
|
|
109
78
|
|
|
110
|
-
|
|
111
|
-
:rtype: bool
|
|
79
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
112
80
|
"""
|
|
113
|
-
...
|
|
114
|
-
|
|
115
|
-
def is_property_readonly(self) -> bool:
|
|
116
|
-
"""Check if a property is readonly.
|
|
117
81
|
|
|
118
|
-
:return:
|
|
119
|
-
:rtype:
|
|
82
|
+
:return: The RNA type or default when not found.
|
|
83
|
+
:rtype: bpy.types.Struct
|
|
120
84
|
"""
|
|
121
85
|
...
|
|
122
86
|
|
|
123
|
-
def
|
|
124
|
-
"""Check if a property is set, use for testing operator properties.
|
|
125
|
-
|
|
126
|
-
:return: True when the property has been set.
|
|
127
|
-
:rtype: bool
|
|
87
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
128
88
|
"""
|
|
129
|
-
...
|
|
130
|
-
|
|
131
|
-
def items(self):
|
|
132
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
133
|
-
dictionary function of the same name).
|
|
134
89
|
|
|
135
|
-
|
|
90
|
+
:return: The class or default when not found.
|
|
91
|
+
:rtype: typing.Any
|
|
136
92
|
"""
|
|
137
93
|
...
|
|
138
94
|
|
|
139
|
-
def
|
|
140
|
-
"""Remove a keyframe from this properties fcurve.
|
|
141
|
-
|
|
142
|
-
:return: Success of keyframe deletion.
|
|
143
|
-
:rtype: bool
|
|
95
|
+
def draw(self, context):
|
|
144
96
|
"""
|
|
145
|
-
...
|
|
146
|
-
|
|
147
|
-
def keyframe_insert(self) -> bool:
|
|
148
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
149
97
|
|
|
150
|
-
:
|
|
151
|
-
:rtype: bool
|
|
98
|
+
:param context:
|
|
152
99
|
"""
|
|
153
100
|
...
|
|
154
101
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
102
|
+
class OUTLINER_MT_collection_new(bpy.types.Menu, bpy_types._GenericUI):
|
|
103
|
+
bl_label: typing.Any
|
|
104
|
+
bl_rna: typing.Any
|
|
105
|
+
id_data: typing.Any
|
|
158
106
|
|
|
159
|
-
|
|
107
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
160
108
|
"""
|
|
161
|
-
...
|
|
162
109
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
167
|
-
to this struct and property (when given).
|
|
168
|
-
:rtype: str
|
|
110
|
+
:return: The RNA type or default when not found.
|
|
111
|
+
:rtype: bpy.types.Struct
|
|
169
112
|
"""
|
|
170
113
|
...
|
|
171
114
|
|
|
172
|
-
def
|
|
173
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
174
|
-
...
|
|
175
|
-
|
|
176
|
-
def pop(self):
|
|
177
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
178
|
-
when not found (matches Python's dictionary function of the same name).
|
|
179
|
-
|
|
115
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
180
116
|
"""
|
|
181
|
-
...
|
|
182
117
|
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
the menus draw function
|
|
186
|
-
|
|
187
|
-
:param draw_func:
|
|
118
|
+
:return: The class or default when not found.
|
|
119
|
+
:rtype: typing.Any
|
|
188
120
|
"""
|
|
189
121
|
...
|
|
190
122
|
|
|
191
|
-
def
|
|
192
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
193
|
-
|
|
194
|
-
:return: True when the overridable status of the property was successfully set.
|
|
195
|
-
:rtype: bool
|
|
123
|
+
def draw(self, context):
|
|
196
124
|
"""
|
|
197
|
-
...
|
|
198
|
-
|
|
199
|
-
def property_unset(self):
|
|
200
|
-
"""Unset a property, will use default value afterward."""
|
|
201
|
-
...
|
|
202
125
|
|
|
203
|
-
|
|
204
|
-
"""Remove a draw function that has been added to this menu
|
|
205
|
-
|
|
206
|
-
:param draw_func:
|
|
126
|
+
:param context:
|
|
207
127
|
"""
|
|
208
128
|
...
|
|
209
129
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
such as textures can be changed at runtime.
|
|
213
|
-
|
|
214
|
-
:return: a new instance of this object with the type initialized again.
|
|
130
|
+
@staticmethod
|
|
131
|
+
def draw_without_context_menu(_context, layout):
|
|
215
132
|
"""
|
|
216
|
-
...
|
|
217
133
|
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
dictionary function of the same name).
|
|
221
|
-
|
|
222
|
-
:return: custom property values.
|
|
134
|
+
:param _context:
|
|
135
|
+
:param layout:
|
|
223
136
|
"""
|
|
224
137
|
...
|
|
225
138
|
|
|
226
|
-
class
|
|
139
|
+
class OUTLINER_MT_collection_view_layer(bpy.types.Menu, bpy_types._GenericUI):
|
|
227
140
|
bl_label: typing.Any
|
|
228
141
|
bl_rna: typing.Any
|
|
229
142
|
id_data: typing.Any
|
|
230
143
|
|
|
231
|
-
def append(self, draw_func):
|
|
232
|
-
"""Append a draw function to this menu,
|
|
233
|
-
takes the same arguments as the menus draw function
|
|
234
|
-
|
|
235
|
-
:param draw_func:
|
|
236
|
-
"""
|
|
237
|
-
...
|
|
238
|
-
|
|
239
|
-
def as_pointer(self) -> int:
|
|
240
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
241
|
-
|
|
242
|
-
:return: int (memory address).
|
|
243
|
-
:rtype: int
|
|
244
|
-
"""
|
|
245
|
-
...
|
|
246
|
-
|
|
247
144
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
248
145
|
"""
|
|
249
146
|
|
|
@@ -260,269 +157,167 @@ class OUTLINER_MT_asset(bpy_types._GenericUI):
|
|
|
260
157
|
"""
|
|
261
158
|
...
|
|
262
159
|
|
|
263
|
-
def draw(self,
|
|
160
|
+
def draw(self, context):
|
|
264
161
|
"""
|
|
265
162
|
|
|
266
|
-
:param
|
|
163
|
+
:param context:
|
|
267
164
|
"""
|
|
268
165
|
...
|
|
269
166
|
|
|
270
|
-
|
|
167
|
+
class OUTLINER_MT_collection_visibility(bpy.types.Menu, bpy_types._GenericUI):
|
|
168
|
+
bl_label: typing.Any
|
|
169
|
+
bl_rna: typing.Any
|
|
170
|
+
id_data: typing.Any
|
|
171
|
+
|
|
172
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
271
173
|
"""
|
|
272
174
|
|
|
273
|
-
:
|
|
274
|
-
:
|
|
175
|
+
:return: The RNA type or default when not found.
|
|
176
|
+
:rtype: bpy.types.Struct
|
|
275
177
|
"""
|
|
276
178
|
...
|
|
277
179
|
|
|
278
|
-
def
|
|
279
|
-
"""
|
|
280
|
-
- preset_operator (string)
|
|
281
|
-
- preset_subdir (string)Optionally:
|
|
282
|
-
- preset_add_operator (string)
|
|
283
|
-
- preset_extensions (set of strings)
|
|
284
|
-
- preset_operator_defaults (dict of keyword args)
|
|
180
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
181
|
+
"""
|
|
285
182
|
|
|
286
|
-
|
|
183
|
+
:return: The class or default when not found.
|
|
184
|
+
:rtype: typing.Any
|
|
287
185
|
"""
|
|
288
186
|
...
|
|
289
187
|
|
|
290
|
-
def
|
|
291
|
-
"""
|
|
188
|
+
def draw(self, _context):
|
|
189
|
+
"""
|
|
292
190
|
|
|
293
|
-
:
|
|
294
|
-
:rtype: bpy.types.FCurve
|
|
191
|
+
:param _context:
|
|
295
192
|
"""
|
|
296
193
|
...
|
|
297
194
|
|
|
298
|
-
|
|
299
|
-
|
|
195
|
+
class OUTLINER_MT_context_menu(bpy.types.Menu, bpy_types._GenericUI):
|
|
196
|
+
bl_label: typing.Any
|
|
197
|
+
bl_rna: typing.Any
|
|
198
|
+
id_data: typing.Any
|
|
300
199
|
|
|
301
|
-
|
|
302
|
-
:rtype: bool
|
|
200
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
303
201
|
"""
|
|
304
|
-
...
|
|
305
|
-
|
|
306
|
-
def get(self):
|
|
307
|
-
"""Returns the value of the custom property assigned to key or default
|
|
308
|
-
when not found (matches Python's dictionary function of the same name).
|
|
309
202
|
|
|
203
|
+
:return: The RNA type or default when not found.
|
|
204
|
+
:rtype: bpy.types.Struct
|
|
310
205
|
"""
|
|
311
206
|
...
|
|
312
207
|
|
|
313
|
-
def
|
|
208
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
314
209
|
"""
|
|
315
210
|
|
|
316
|
-
:return:
|
|
211
|
+
:return: The class or default when not found.
|
|
212
|
+
:rtype: typing.Any
|
|
317
213
|
"""
|
|
318
214
|
...
|
|
319
215
|
|
|
320
|
-
def
|
|
216
|
+
def draw(self, context):
|
|
321
217
|
"""
|
|
322
218
|
|
|
323
|
-
:
|
|
219
|
+
:param context:
|
|
324
220
|
"""
|
|
325
221
|
...
|
|
326
222
|
|
|
327
|
-
|
|
223
|
+
@staticmethod
|
|
224
|
+
def draw_common_operators(layout):
|
|
328
225
|
"""
|
|
329
226
|
|
|
330
|
-
:
|
|
227
|
+
:param layout:
|
|
331
228
|
"""
|
|
332
229
|
...
|
|
333
230
|
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
231
|
+
class OUTLINER_MT_context_menu_view(bpy.types.Menu, bpy_types._GenericUI):
|
|
232
|
+
bl_label: typing.Any
|
|
233
|
+
bl_rna: typing.Any
|
|
234
|
+
id_data: typing.Any
|
|
337
235
|
|
|
338
|
-
|
|
339
|
-
:rtype: bool
|
|
236
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
340
237
|
"""
|
|
341
|
-
...
|
|
342
238
|
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
:return: True when the property is overridable.
|
|
347
|
-
:rtype: bool
|
|
239
|
+
:return: The RNA type or default when not found.
|
|
240
|
+
:rtype: bpy.types.Struct
|
|
348
241
|
"""
|
|
349
242
|
...
|
|
350
243
|
|
|
351
|
-
def
|
|
352
|
-
"""Check if a property is readonly.
|
|
353
|
-
|
|
354
|
-
:return: True when the property is readonly (not writable).
|
|
355
|
-
:rtype: bool
|
|
244
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
356
245
|
"""
|
|
357
|
-
...
|
|
358
246
|
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
:return: True when the property has been set.
|
|
363
|
-
:rtype: bool
|
|
247
|
+
:return: The class or default when not found.
|
|
248
|
+
:rtype: typing.Any
|
|
364
249
|
"""
|
|
365
250
|
...
|
|
366
251
|
|
|
367
|
-
def
|
|
368
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
369
|
-
dictionary function of the same name).
|
|
370
|
-
|
|
371
|
-
:return: custom property key, value pairs.
|
|
252
|
+
def draw(self, _context):
|
|
372
253
|
"""
|
|
373
|
-
...
|
|
374
254
|
|
|
375
|
-
|
|
376
|
-
"""Remove a keyframe from this properties fcurve.
|
|
377
|
-
|
|
378
|
-
:return: Success of keyframe deletion.
|
|
379
|
-
:rtype: bool
|
|
255
|
+
:param _context:
|
|
380
256
|
"""
|
|
381
257
|
...
|
|
382
258
|
|
|
383
|
-
|
|
384
|
-
|
|
259
|
+
class OUTLINER_MT_edit_datablocks(bpy.types.Menu, bpy_types._GenericUI):
|
|
260
|
+
bl_label: typing.Any
|
|
261
|
+
bl_rna: typing.Any
|
|
262
|
+
id_data: typing.Any
|
|
385
263
|
|
|
386
|
-
|
|
387
|
-
:rtype: bool
|
|
264
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
388
265
|
"""
|
|
389
|
-
...
|
|
390
|
-
|
|
391
|
-
def keys(self):
|
|
392
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
393
|
-
dictionary function of the same name).
|
|
394
266
|
|
|
395
|
-
|
|
267
|
+
:return: The RNA type or default when not found.
|
|
268
|
+
:rtype: bpy.types.Struct
|
|
396
269
|
"""
|
|
397
270
|
...
|
|
398
271
|
|
|
399
|
-
def
|
|
400
|
-
"""Returns the data path from the ID to this object (string).
|
|
401
|
-
|
|
402
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
403
|
-
to this struct and property (when given).
|
|
404
|
-
:rtype: str
|
|
272
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
405
273
|
"""
|
|
406
|
-
...
|
|
407
274
|
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
searchpaths: list[str],
|
|
411
|
-
operator: str,
|
|
412
|
-
*,
|
|
413
|
-
props_default: dict = None,
|
|
414
|
-
prop_filepath: str | None = "filepath",
|
|
415
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
416
|
-
filter_path=None,
|
|
417
|
-
display_name: collections.abc.Callable | None = None,
|
|
418
|
-
add_operator=None,
|
|
419
|
-
add_operator_props=None,
|
|
420
|
-
):
|
|
421
|
-
"""Populate a menu from a list of paths.
|
|
422
|
-
|
|
423
|
-
:param searchpaths: Paths to scan.
|
|
424
|
-
:type searchpaths: list[str]
|
|
425
|
-
:param operator: The operator id to use with each file.
|
|
426
|
-
:type operator: str
|
|
427
|
-
:param props_default: Properties to assign to each operator.
|
|
428
|
-
:type props_default: dict
|
|
429
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
430
|
-
:type prop_filepath: str | None
|
|
431
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
432
|
-
|
|
433
|
-
Returning false excludes the file from the list.
|
|
434
|
-
:type filter_ext: collections.abc.Callable | None
|
|
435
|
-
:param filter_path:
|
|
436
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
437
|
-
:type display_name: collections.abc.Callable | None
|
|
438
|
-
:param add_operator:
|
|
439
|
-
:param add_operator_props:
|
|
275
|
+
:return: The class or default when not found.
|
|
276
|
+
:rtype: typing.Any
|
|
440
277
|
"""
|
|
441
278
|
...
|
|
442
279
|
|
|
443
|
-
def
|
|
444
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
445
|
-
...
|
|
446
|
-
|
|
447
|
-
@classmethod
|
|
448
|
-
def poll(cls, context):
|
|
280
|
+
def draw(self, _context):
|
|
449
281
|
"""
|
|
450
282
|
|
|
451
|
-
:param
|
|
283
|
+
:param _context:
|
|
452
284
|
"""
|
|
453
285
|
...
|
|
454
286
|
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
287
|
+
class OUTLINER_MT_editor_menus(bpy.types.Menu, bpy_types._GenericUI):
|
|
288
|
+
bl_idname: typing.Any
|
|
289
|
+
bl_label: typing.Any
|
|
290
|
+
bl_rna: typing.Any
|
|
291
|
+
id_data: typing.Any
|
|
458
292
|
|
|
293
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
459
294
|
"""
|
|
460
|
-
...
|
|
461
295
|
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
the menus draw function
|
|
465
|
-
|
|
466
|
-
:param draw_func:
|
|
296
|
+
:return: The RNA type or default when not found.
|
|
297
|
+
:rtype: bpy.types.Struct
|
|
467
298
|
"""
|
|
468
299
|
...
|
|
469
300
|
|
|
470
|
-
def
|
|
471
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
472
|
-
|
|
473
|
-
:return: True when the overridable status of the property was successfully set.
|
|
474
|
-
:rtype: bool
|
|
301
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
475
302
|
"""
|
|
476
|
-
...
|
|
477
303
|
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
...
|
|
481
|
-
|
|
482
|
-
def remove(self, draw_func):
|
|
483
|
-
"""Remove a draw function that has been added to this menu
|
|
484
|
-
|
|
485
|
-
:param draw_func:
|
|
304
|
+
:return: The class or default when not found.
|
|
305
|
+
:rtype: typing.Any
|
|
486
306
|
"""
|
|
487
307
|
...
|
|
488
308
|
|
|
489
|
-
def
|
|
490
|
-
"""Return a new instance, this is needed because types
|
|
491
|
-
such as textures can be changed at runtime.
|
|
492
|
-
|
|
493
|
-
:return: a new instance of this object with the type initialized again.
|
|
309
|
+
def draw(self, context):
|
|
494
310
|
"""
|
|
495
|
-
...
|
|
496
311
|
|
|
497
|
-
|
|
498
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
499
|
-
dictionary function of the same name).
|
|
500
|
-
|
|
501
|
-
:return: custom property values.
|
|
312
|
+
:param context:
|
|
502
313
|
"""
|
|
503
314
|
...
|
|
504
315
|
|
|
505
|
-
class
|
|
316
|
+
class OUTLINER_MT_liboverride(bpy.types.Menu, bpy_types._GenericUI):
|
|
506
317
|
bl_label: typing.Any
|
|
507
318
|
bl_rna: typing.Any
|
|
508
319
|
id_data: typing.Any
|
|
509
320
|
|
|
510
|
-
def append(self, draw_func):
|
|
511
|
-
"""Append a draw function to this menu,
|
|
512
|
-
takes the same arguments as the menus draw function
|
|
513
|
-
|
|
514
|
-
:param draw_func:
|
|
515
|
-
"""
|
|
516
|
-
...
|
|
517
|
-
|
|
518
|
-
def as_pointer(self) -> int:
|
|
519
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
520
|
-
|
|
521
|
-
:return: int (memory address).
|
|
522
|
-
:rtype: int
|
|
523
|
-
"""
|
|
524
|
-
...
|
|
525
|
-
|
|
526
321
|
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
527
322
|
"""
|
|
528
323
|
|
|
@@ -539,3192 +334,105 @@ class OUTLINER_MT_collection(bpy_types._GenericUI):
|
|
|
539
334
|
"""
|
|
540
335
|
...
|
|
541
336
|
|
|
542
|
-
def draw(self,
|
|
337
|
+
def draw(self, _context):
|
|
543
338
|
"""
|
|
544
339
|
|
|
545
|
-
:param
|
|
340
|
+
:param _context:
|
|
546
341
|
"""
|
|
547
342
|
...
|
|
548
343
|
|
|
549
|
-
|
|
344
|
+
@classmethod
|
|
345
|
+
def poll(cls, context):
|
|
550
346
|
"""
|
|
551
347
|
|
|
552
348
|
:param context:
|
|
553
|
-
:param layout:
|
|
554
349
|
"""
|
|
555
350
|
...
|
|
556
351
|
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
- preset_add_operator (string)
|
|
562
|
-
- preset_extensions (set of strings)
|
|
563
|
-
- preset_operator_defaults (dict of keyword args)
|
|
352
|
+
class OUTLINER_MT_object(bpy.types.Menu, bpy_types._GenericUI):
|
|
353
|
+
bl_label: typing.Any
|
|
354
|
+
bl_rna: typing.Any
|
|
355
|
+
id_data: typing.Any
|
|
564
356
|
|
|
565
|
-
|
|
357
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
566
358
|
"""
|
|
567
|
-
...
|
|
568
359
|
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
:return: The driver(s) added.
|
|
573
|
-
:rtype: bpy.types.FCurve
|
|
360
|
+
:return: The RNA type or default when not found.
|
|
361
|
+
:rtype: bpy.types.Struct
|
|
574
362
|
"""
|
|
575
363
|
...
|
|
576
364
|
|
|
577
|
-
def
|
|
578
|
-
"""Remove driver(s) from the given property
|
|
579
|
-
|
|
580
|
-
:return: Success of driver removal.
|
|
581
|
-
:rtype: bool
|
|
365
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
582
366
|
"""
|
|
583
|
-
...
|
|
584
|
-
|
|
585
|
-
def get(self):
|
|
586
|
-
"""Returns the value of the custom property assigned to key or default
|
|
587
|
-
when not found (matches Python's dictionary function of the same name).
|
|
588
367
|
|
|
368
|
+
:return: The class or default when not found.
|
|
369
|
+
:rtype: typing.Any
|
|
589
370
|
"""
|
|
590
371
|
...
|
|
591
372
|
|
|
592
|
-
def
|
|
373
|
+
def draw(self, context):
|
|
593
374
|
"""
|
|
594
375
|
|
|
595
|
-
:
|
|
376
|
+
:param context:
|
|
596
377
|
"""
|
|
597
378
|
...
|
|
598
379
|
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
"""
|
|
604
|
-
...
|
|
380
|
+
class OUTLINER_MT_view_pie(bpy.types.Menu, bpy_types._GenericUI):
|
|
381
|
+
bl_label: typing.Any
|
|
382
|
+
bl_rna: typing.Any
|
|
383
|
+
id_data: typing.Any
|
|
605
384
|
|
|
606
|
-
def
|
|
385
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
607
386
|
"""
|
|
608
387
|
|
|
609
|
-
:return:
|
|
388
|
+
:return: The RNA type or default when not found.
|
|
389
|
+
:rtype: bpy.types.Struct
|
|
610
390
|
"""
|
|
611
391
|
...
|
|
612
392
|
|
|
613
|
-
def
|
|
614
|
-
def is_property_hidden(self) -> bool:
|
|
615
|
-
"""Check if a property is hidden.
|
|
616
|
-
|
|
617
|
-
:return: True when the property is hidden.
|
|
618
|
-
:rtype: bool
|
|
393
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
619
394
|
"""
|
|
620
|
-
...
|
|
621
395
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
:return: True when the property is overridable.
|
|
626
|
-
:rtype: bool
|
|
396
|
+
:return: The class or default when not found.
|
|
397
|
+
:rtype: typing.Any
|
|
627
398
|
"""
|
|
628
399
|
...
|
|
629
400
|
|
|
630
|
-
def
|
|
631
|
-
"""Check if a property is readonly.
|
|
632
|
-
|
|
633
|
-
:return: True when the property is readonly (not writable).
|
|
634
|
-
:rtype: bool
|
|
401
|
+
def draw(self, _context):
|
|
635
402
|
"""
|
|
636
|
-
...
|
|
637
403
|
|
|
638
|
-
|
|
639
|
-
"""Check if a property is set, use for testing operator properties.
|
|
640
|
-
|
|
641
|
-
:return: True when the property has been set.
|
|
642
|
-
:rtype: bool
|
|
404
|
+
:param _context:
|
|
643
405
|
"""
|
|
644
406
|
...
|
|
645
407
|
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
408
|
+
class OUTLINER_PT_filter(bpy.types.Panel, bpy_types._GenericUI):
|
|
409
|
+
bl_label: typing.Any
|
|
410
|
+
bl_region_type: typing.Any
|
|
411
|
+
bl_rna: typing.Any
|
|
412
|
+
bl_space_type: typing.Any
|
|
413
|
+
id_data: typing.Any
|
|
649
414
|
|
|
650
|
-
|
|
415
|
+
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
651
416
|
"""
|
|
652
|
-
...
|
|
653
|
-
|
|
654
|
-
def keyframe_delete(self) -> bool:
|
|
655
|
-
"""Remove a keyframe from this properties fcurve.
|
|
656
417
|
|
|
657
|
-
:return:
|
|
658
|
-
:rtype:
|
|
418
|
+
:return: The RNA type or default when not found.
|
|
419
|
+
:rtype: bpy.types.Struct
|
|
659
420
|
"""
|
|
660
421
|
...
|
|
661
422
|
|
|
662
|
-
def
|
|
663
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
664
|
-
|
|
665
|
-
:return: Success of keyframe insertion.
|
|
666
|
-
:rtype: bool
|
|
423
|
+
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
667
424
|
"""
|
|
668
|
-
...
|
|
669
|
-
|
|
670
|
-
def keys(self):
|
|
671
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
672
|
-
dictionary function of the same name).
|
|
673
425
|
|
|
674
|
-
|
|
426
|
+
:return: The class or default when not found.
|
|
427
|
+
:rtype: typing.Any
|
|
675
428
|
"""
|
|
676
429
|
...
|
|
677
430
|
|
|
678
|
-
def
|
|
679
|
-
"""Returns the data path from the ID to this object (string).
|
|
680
|
-
|
|
681
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
682
|
-
to this struct and property (when given).
|
|
683
|
-
:rtype: str
|
|
684
|
-
"""
|
|
685
|
-
...
|
|
686
|
-
|
|
687
|
-
def path_menu(
|
|
688
|
-
self,
|
|
689
|
-
searchpaths: list[str],
|
|
690
|
-
operator: str,
|
|
691
|
-
*,
|
|
692
|
-
props_default: dict = None,
|
|
693
|
-
prop_filepath: str | None = "filepath",
|
|
694
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
695
|
-
filter_path=None,
|
|
696
|
-
display_name: collections.abc.Callable | None = None,
|
|
697
|
-
add_operator=None,
|
|
698
|
-
add_operator_props=None,
|
|
699
|
-
):
|
|
700
|
-
"""Populate a menu from a list of paths.
|
|
701
|
-
|
|
702
|
-
:param searchpaths: Paths to scan.
|
|
703
|
-
:type searchpaths: list[str]
|
|
704
|
-
:param operator: The operator id to use with each file.
|
|
705
|
-
:type operator: str
|
|
706
|
-
:param props_default: Properties to assign to each operator.
|
|
707
|
-
:type props_default: dict
|
|
708
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
709
|
-
:type prop_filepath: str | None
|
|
710
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
711
|
-
|
|
712
|
-
Returning false excludes the file from the list.
|
|
713
|
-
:type filter_ext: collections.abc.Callable | None
|
|
714
|
-
:param filter_path:
|
|
715
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
716
|
-
:type display_name: collections.abc.Callable | None
|
|
717
|
-
:param add_operator:
|
|
718
|
-
:param add_operator_props:
|
|
719
|
-
"""
|
|
720
|
-
...
|
|
721
|
-
|
|
722
|
-
def path_resolve(self):
|
|
723
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
724
|
-
...
|
|
725
|
-
|
|
726
|
-
def pop(self):
|
|
727
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
728
|
-
when not found (matches Python's dictionary function of the same name).
|
|
729
|
-
|
|
730
|
-
"""
|
|
731
|
-
...
|
|
732
|
-
|
|
733
|
-
def prepend(self, draw_func):
|
|
734
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
735
|
-
the menus draw function
|
|
736
|
-
|
|
737
|
-
:param draw_func:
|
|
738
|
-
"""
|
|
739
|
-
...
|
|
740
|
-
|
|
741
|
-
def property_overridable_library_set(self) -> bool:
|
|
742
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
743
|
-
|
|
744
|
-
:return: True when the overridable status of the property was successfully set.
|
|
745
|
-
:rtype: bool
|
|
746
|
-
"""
|
|
747
|
-
...
|
|
748
|
-
|
|
749
|
-
def property_unset(self):
|
|
750
|
-
"""Unset a property, will use default value afterward."""
|
|
751
|
-
...
|
|
752
|
-
|
|
753
|
-
def remove(self, draw_func):
|
|
754
|
-
"""Remove a draw function that has been added to this menu
|
|
755
|
-
|
|
756
|
-
:param draw_func:
|
|
757
|
-
"""
|
|
758
|
-
...
|
|
759
|
-
|
|
760
|
-
def type_recast(self):
|
|
761
|
-
"""Return a new instance, this is needed because types
|
|
762
|
-
such as textures can be changed at runtime.
|
|
763
|
-
|
|
764
|
-
:return: a new instance of this object with the type initialized again.
|
|
765
|
-
"""
|
|
766
|
-
...
|
|
767
|
-
|
|
768
|
-
def values(self):
|
|
769
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
770
|
-
dictionary function of the same name).
|
|
771
|
-
|
|
772
|
-
:return: custom property values.
|
|
773
|
-
"""
|
|
774
|
-
...
|
|
775
|
-
|
|
776
|
-
class OUTLINER_MT_collection_new(bpy_types._GenericUI):
|
|
777
|
-
bl_label: typing.Any
|
|
778
|
-
bl_rna: typing.Any
|
|
779
|
-
id_data: typing.Any
|
|
780
|
-
|
|
781
|
-
def append(self, draw_func):
|
|
782
|
-
"""Append a draw function to this menu,
|
|
783
|
-
takes the same arguments as the menus draw function
|
|
784
|
-
|
|
785
|
-
:param draw_func:
|
|
786
|
-
"""
|
|
787
|
-
...
|
|
788
|
-
|
|
789
|
-
def as_pointer(self) -> int:
|
|
790
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
791
|
-
|
|
792
|
-
:return: int (memory address).
|
|
793
|
-
:rtype: int
|
|
794
|
-
"""
|
|
795
|
-
...
|
|
796
|
-
|
|
797
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
798
|
-
"""
|
|
799
|
-
|
|
800
|
-
:return: The RNA type or default when not found.
|
|
801
|
-
:rtype: bpy.types.Struct
|
|
802
|
-
"""
|
|
803
|
-
...
|
|
804
|
-
|
|
805
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
806
|
-
"""
|
|
807
|
-
|
|
808
|
-
:return: The class or default when not found.
|
|
809
|
-
:rtype: typing.Any
|
|
810
|
-
"""
|
|
811
|
-
...
|
|
812
|
-
|
|
813
|
-
def draw(self, context):
|
|
814
|
-
"""
|
|
815
|
-
|
|
816
|
-
:param context:
|
|
817
|
-
"""
|
|
818
|
-
...
|
|
819
|
-
|
|
820
|
-
def draw_collapsible(self, context, layout):
|
|
821
|
-
"""
|
|
822
|
-
|
|
823
|
-
:param context:
|
|
824
|
-
:param layout:
|
|
825
|
-
"""
|
|
826
|
-
...
|
|
827
|
-
|
|
828
|
-
def draw_preset(self, _context):
|
|
829
|
-
"""Define these on the subclass:
|
|
830
|
-
- preset_operator (string)
|
|
831
|
-
- preset_subdir (string)Optionally:
|
|
832
|
-
- preset_add_operator (string)
|
|
833
|
-
- preset_extensions (set of strings)
|
|
834
|
-
- preset_operator_defaults (dict of keyword args)
|
|
835
|
-
|
|
836
|
-
:param _context:
|
|
837
|
-
"""
|
|
838
|
-
...
|
|
839
|
-
|
|
840
|
-
@staticmethod
|
|
841
|
-
def draw_without_context_menu(_context, layout):
|
|
842
|
-
"""
|
|
843
|
-
|
|
844
|
-
:param _context:
|
|
845
|
-
:param layout:
|
|
846
|
-
"""
|
|
847
|
-
...
|
|
848
|
-
|
|
849
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
850
|
-
"""Adds driver(s) to the given property
|
|
851
|
-
|
|
852
|
-
:return: The driver(s) added.
|
|
853
|
-
:rtype: bpy.types.FCurve
|
|
854
|
-
"""
|
|
855
|
-
...
|
|
856
|
-
|
|
857
|
-
def driver_remove(self) -> bool:
|
|
858
|
-
"""Remove driver(s) from the given property
|
|
859
|
-
|
|
860
|
-
:return: Success of driver removal.
|
|
861
|
-
:rtype: bool
|
|
862
|
-
"""
|
|
863
|
-
...
|
|
864
|
-
|
|
865
|
-
def get(self):
|
|
866
|
-
"""Returns the value of the custom property assigned to key or default
|
|
867
|
-
when not found (matches Python's dictionary function of the same name).
|
|
868
|
-
|
|
869
|
-
"""
|
|
870
|
-
...
|
|
871
|
-
|
|
872
|
-
def id_properties_clear(self):
|
|
873
|
-
"""
|
|
874
|
-
|
|
875
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
876
|
-
"""
|
|
877
|
-
...
|
|
878
|
-
|
|
879
|
-
def id_properties_ensure(self):
|
|
880
|
-
"""
|
|
881
|
-
|
|
882
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
883
|
-
"""
|
|
884
|
-
...
|
|
885
|
-
|
|
886
|
-
def id_properties_ui(self):
|
|
887
|
-
"""
|
|
888
|
-
|
|
889
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
890
|
-
"""
|
|
891
|
-
...
|
|
892
|
-
|
|
893
|
-
def is_extended(self): ...
|
|
894
|
-
def is_property_hidden(self) -> bool:
|
|
895
|
-
"""Check if a property is hidden.
|
|
896
|
-
|
|
897
|
-
:return: True when the property is hidden.
|
|
898
|
-
:rtype: bool
|
|
899
|
-
"""
|
|
900
|
-
...
|
|
901
|
-
|
|
902
|
-
def is_property_overridable_library(self) -> bool:
|
|
903
|
-
"""Check if a property is overridable.
|
|
904
|
-
|
|
905
|
-
:return: True when the property is overridable.
|
|
906
|
-
:rtype: bool
|
|
907
|
-
"""
|
|
908
|
-
...
|
|
909
|
-
|
|
910
|
-
def is_property_readonly(self) -> bool:
|
|
911
|
-
"""Check if a property is readonly.
|
|
912
|
-
|
|
913
|
-
:return: True when the property is readonly (not writable).
|
|
914
|
-
:rtype: bool
|
|
915
|
-
"""
|
|
916
|
-
...
|
|
917
|
-
|
|
918
|
-
def is_property_set(self) -> bool:
|
|
919
|
-
"""Check if a property is set, use for testing operator properties.
|
|
920
|
-
|
|
921
|
-
:return: True when the property has been set.
|
|
922
|
-
:rtype: bool
|
|
923
|
-
"""
|
|
924
|
-
...
|
|
925
|
-
|
|
926
|
-
def items(self):
|
|
927
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
928
|
-
dictionary function of the same name).
|
|
929
|
-
|
|
930
|
-
:return: custom property key, value pairs.
|
|
931
|
-
"""
|
|
932
|
-
...
|
|
933
|
-
|
|
934
|
-
def keyframe_delete(self) -> bool:
|
|
935
|
-
"""Remove a keyframe from this properties fcurve.
|
|
936
|
-
|
|
937
|
-
:return: Success of keyframe deletion.
|
|
938
|
-
:rtype: bool
|
|
939
|
-
"""
|
|
940
|
-
...
|
|
941
|
-
|
|
942
|
-
def keyframe_insert(self) -> bool:
|
|
943
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
944
|
-
|
|
945
|
-
:return: Success of keyframe insertion.
|
|
946
|
-
:rtype: bool
|
|
947
|
-
"""
|
|
948
|
-
...
|
|
949
|
-
|
|
950
|
-
def keys(self):
|
|
951
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
952
|
-
dictionary function of the same name).
|
|
953
|
-
|
|
954
|
-
:return: custom property keys.
|
|
955
|
-
"""
|
|
956
|
-
...
|
|
957
|
-
|
|
958
|
-
def path_from_id(self) -> str:
|
|
959
|
-
"""Returns the data path from the ID to this object (string).
|
|
960
|
-
|
|
961
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
962
|
-
to this struct and property (when given).
|
|
963
|
-
:rtype: str
|
|
964
|
-
"""
|
|
965
|
-
...
|
|
966
|
-
|
|
967
|
-
def path_menu(
|
|
968
|
-
self,
|
|
969
|
-
searchpaths: list[str],
|
|
970
|
-
operator: str,
|
|
971
|
-
*,
|
|
972
|
-
props_default: dict = None,
|
|
973
|
-
prop_filepath: str | None = "filepath",
|
|
974
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
975
|
-
filter_path=None,
|
|
976
|
-
display_name: collections.abc.Callable | None = None,
|
|
977
|
-
add_operator=None,
|
|
978
|
-
add_operator_props=None,
|
|
979
|
-
):
|
|
980
|
-
"""Populate a menu from a list of paths.
|
|
981
|
-
|
|
982
|
-
:param searchpaths: Paths to scan.
|
|
983
|
-
:type searchpaths: list[str]
|
|
984
|
-
:param operator: The operator id to use with each file.
|
|
985
|
-
:type operator: str
|
|
986
|
-
:param props_default: Properties to assign to each operator.
|
|
987
|
-
:type props_default: dict
|
|
988
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
989
|
-
:type prop_filepath: str | None
|
|
990
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
991
|
-
|
|
992
|
-
Returning false excludes the file from the list.
|
|
993
|
-
:type filter_ext: collections.abc.Callable | None
|
|
994
|
-
:param filter_path:
|
|
995
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
996
|
-
:type display_name: collections.abc.Callable | None
|
|
997
|
-
:param add_operator:
|
|
998
|
-
:param add_operator_props:
|
|
999
|
-
"""
|
|
1000
|
-
...
|
|
1001
|
-
|
|
1002
|
-
def path_resolve(self):
|
|
1003
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1004
|
-
...
|
|
1005
|
-
|
|
1006
|
-
def pop(self):
|
|
1007
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1008
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1009
|
-
|
|
1010
|
-
"""
|
|
1011
|
-
...
|
|
1012
|
-
|
|
1013
|
-
def prepend(self, draw_func):
|
|
1014
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1015
|
-
the menus draw function
|
|
1016
|
-
|
|
1017
|
-
:param draw_func:
|
|
1018
|
-
"""
|
|
1019
|
-
...
|
|
1020
|
-
|
|
1021
|
-
def property_overridable_library_set(self) -> bool:
|
|
1022
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1023
|
-
|
|
1024
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1025
|
-
:rtype: bool
|
|
1026
|
-
"""
|
|
1027
|
-
...
|
|
1028
|
-
|
|
1029
|
-
def property_unset(self):
|
|
1030
|
-
"""Unset a property, will use default value afterward."""
|
|
1031
|
-
...
|
|
1032
|
-
|
|
1033
|
-
def remove(self, draw_func):
|
|
1034
|
-
"""Remove a draw function that has been added to this menu
|
|
1035
|
-
|
|
1036
|
-
:param draw_func:
|
|
1037
|
-
"""
|
|
1038
|
-
...
|
|
1039
|
-
|
|
1040
|
-
def type_recast(self):
|
|
1041
|
-
"""Return a new instance, this is needed because types
|
|
1042
|
-
such as textures can be changed at runtime.
|
|
1043
|
-
|
|
1044
|
-
:return: a new instance of this object with the type initialized again.
|
|
1045
|
-
"""
|
|
1046
|
-
...
|
|
1047
|
-
|
|
1048
|
-
def values(self):
|
|
1049
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1050
|
-
dictionary function of the same name).
|
|
1051
|
-
|
|
1052
|
-
:return: custom property values.
|
|
1053
|
-
"""
|
|
1054
|
-
...
|
|
1055
|
-
|
|
1056
|
-
class OUTLINER_MT_collection_view_layer(bpy_types._GenericUI):
|
|
1057
|
-
bl_label: typing.Any
|
|
1058
|
-
bl_rna: typing.Any
|
|
1059
|
-
id_data: typing.Any
|
|
1060
|
-
|
|
1061
|
-
def append(self, draw_func):
|
|
1062
|
-
"""Append a draw function to this menu,
|
|
1063
|
-
takes the same arguments as the menus draw function
|
|
1064
|
-
|
|
1065
|
-
:param draw_func:
|
|
1066
|
-
"""
|
|
1067
|
-
...
|
|
1068
|
-
|
|
1069
|
-
def as_pointer(self) -> int:
|
|
1070
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1071
|
-
|
|
1072
|
-
:return: int (memory address).
|
|
1073
|
-
:rtype: int
|
|
1074
|
-
"""
|
|
1075
|
-
...
|
|
1076
|
-
|
|
1077
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1078
|
-
"""
|
|
1079
|
-
|
|
1080
|
-
:return: The RNA type or default when not found.
|
|
1081
|
-
:rtype: bpy.types.Struct
|
|
1082
|
-
"""
|
|
1083
|
-
...
|
|
1084
|
-
|
|
1085
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1086
|
-
"""
|
|
1087
|
-
|
|
1088
|
-
:return: The class or default when not found.
|
|
1089
|
-
:rtype: typing.Any
|
|
1090
|
-
"""
|
|
1091
|
-
...
|
|
1092
|
-
|
|
1093
|
-
def draw(self, context):
|
|
1094
|
-
"""
|
|
1095
|
-
|
|
1096
|
-
:param context:
|
|
1097
|
-
"""
|
|
1098
|
-
...
|
|
1099
|
-
|
|
1100
|
-
def draw_collapsible(self, context, layout):
|
|
1101
|
-
"""
|
|
1102
|
-
|
|
1103
|
-
:param context:
|
|
1104
|
-
:param layout:
|
|
1105
|
-
"""
|
|
1106
|
-
...
|
|
1107
|
-
|
|
1108
|
-
def draw_preset(self, _context):
|
|
1109
|
-
"""Define these on the subclass:
|
|
1110
|
-
- preset_operator (string)
|
|
1111
|
-
- preset_subdir (string)Optionally:
|
|
1112
|
-
- preset_add_operator (string)
|
|
1113
|
-
- preset_extensions (set of strings)
|
|
1114
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1115
|
-
|
|
1116
|
-
:param _context:
|
|
1117
|
-
"""
|
|
1118
|
-
...
|
|
1119
|
-
|
|
1120
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1121
|
-
"""Adds driver(s) to the given property
|
|
1122
|
-
|
|
1123
|
-
:return: The driver(s) added.
|
|
1124
|
-
:rtype: bpy.types.FCurve
|
|
1125
|
-
"""
|
|
1126
|
-
...
|
|
1127
|
-
|
|
1128
|
-
def driver_remove(self) -> bool:
|
|
1129
|
-
"""Remove driver(s) from the given property
|
|
1130
|
-
|
|
1131
|
-
:return: Success of driver removal.
|
|
1132
|
-
:rtype: bool
|
|
1133
|
-
"""
|
|
1134
|
-
...
|
|
1135
|
-
|
|
1136
|
-
def get(self):
|
|
1137
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1138
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1139
|
-
|
|
1140
|
-
"""
|
|
1141
|
-
...
|
|
1142
|
-
|
|
1143
|
-
def id_properties_clear(self):
|
|
1144
|
-
"""
|
|
1145
|
-
|
|
1146
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1147
|
-
"""
|
|
1148
|
-
...
|
|
1149
|
-
|
|
1150
|
-
def id_properties_ensure(self):
|
|
1151
|
-
"""
|
|
1152
|
-
|
|
1153
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1154
|
-
"""
|
|
1155
|
-
...
|
|
1156
|
-
|
|
1157
|
-
def id_properties_ui(self):
|
|
1158
|
-
"""
|
|
1159
|
-
|
|
1160
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1161
|
-
"""
|
|
1162
|
-
...
|
|
1163
|
-
|
|
1164
|
-
def is_extended(self): ...
|
|
1165
|
-
def is_property_hidden(self) -> bool:
|
|
1166
|
-
"""Check if a property is hidden.
|
|
1167
|
-
|
|
1168
|
-
:return: True when the property is hidden.
|
|
1169
|
-
:rtype: bool
|
|
1170
|
-
"""
|
|
1171
|
-
...
|
|
1172
|
-
|
|
1173
|
-
def is_property_overridable_library(self) -> bool:
|
|
1174
|
-
"""Check if a property is overridable.
|
|
1175
|
-
|
|
1176
|
-
:return: True when the property is overridable.
|
|
1177
|
-
:rtype: bool
|
|
1178
|
-
"""
|
|
1179
|
-
...
|
|
1180
|
-
|
|
1181
|
-
def is_property_readonly(self) -> bool:
|
|
1182
|
-
"""Check if a property is readonly.
|
|
1183
|
-
|
|
1184
|
-
:return: True when the property is readonly (not writable).
|
|
1185
|
-
:rtype: bool
|
|
1186
|
-
"""
|
|
1187
|
-
...
|
|
1188
|
-
|
|
1189
|
-
def is_property_set(self) -> bool:
|
|
1190
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1191
|
-
|
|
1192
|
-
:return: True when the property has been set.
|
|
1193
|
-
:rtype: bool
|
|
1194
|
-
"""
|
|
1195
|
-
...
|
|
1196
|
-
|
|
1197
|
-
def items(self):
|
|
1198
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1199
|
-
dictionary function of the same name).
|
|
1200
|
-
|
|
1201
|
-
:return: custom property key, value pairs.
|
|
1202
|
-
"""
|
|
1203
|
-
...
|
|
1204
|
-
|
|
1205
|
-
def keyframe_delete(self) -> bool:
|
|
1206
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1207
|
-
|
|
1208
|
-
:return: Success of keyframe deletion.
|
|
1209
|
-
:rtype: bool
|
|
1210
|
-
"""
|
|
1211
|
-
...
|
|
1212
|
-
|
|
1213
|
-
def keyframe_insert(self) -> bool:
|
|
1214
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1215
|
-
|
|
1216
|
-
:return: Success of keyframe insertion.
|
|
1217
|
-
:rtype: bool
|
|
1218
|
-
"""
|
|
1219
|
-
...
|
|
1220
|
-
|
|
1221
|
-
def keys(self):
|
|
1222
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1223
|
-
dictionary function of the same name).
|
|
1224
|
-
|
|
1225
|
-
:return: custom property keys.
|
|
1226
|
-
"""
|
|
1227
|
-
...
|
|
1228
|
-
|
|
1229
|
-
def path_from_id(self) -> str:
|
|
1230
|
-
"""Returns the data path from the ID to this object (string).
|
|
1231
|
-
|
|
1232
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1233
|
-
to this struct and property (when given).
|
|
1234
|
-
:rtype: str
|
|
1235
|
-
"""
|
|
1236
|
-
...
|
|
1237
|
-
|
|
1238
|
-
def path_menu(
|
|
1239
|
-
self,
|
|
1240
|
-
searchpaths: list[str],
|
|
1241
|
-
operator: str,
|
|
1242
|
-
*,
|
|
1243
|
-
props_default: dict = None,
|
|
1244
|
-
prop_filepath: str | None = "filepath",
|
|
1245
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1246
|
-
filter_path=None,
|
|
1247
|
-
display_name: collections.abc.Callable | None = None,
|
|
1248
|
-
add_operator=None,
|
|
1249
|
-
add_operator_props=None,
|
|
1250
|
-
):
|
|
1251
|
-
"""Populate a menu from a list of paths.
|
|
1252
|
-
|
|
1253
|
-
:param searchpaths: Paths to scan.
|
|
1254
|
-
:type searchpaths: list[str]
|
|
1255
|
-
:param operator: The operator id to use with each file.
|
|
1256
|
-
:type operator: str
|
|
1257
|
-
:param props_default: Properties to assign to each operator.
|
|
1258
|
-
:type props_default: dict
|
|
1259
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1260
|
-
:type prop_filepath: str | None
|
|
1261
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1262
|
-
|
|
1263
|
-
Returning false excludes the file from the list.
|
|
1264
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1265
|
-
:param filter_path:
|
|
1266
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1267
|
-
:type display_name: collections.abc.Callable | None
|
|
1268
|
-
:param add_operator:
|
|
1269
|
-
:param add_operator_props:
|
|
1270
|
-
"""
|
|
1271
|
-
...
|
|
1272
|
-
|
|
1273
|
-
def path_resolve(self):
|
|
1274
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1275
|
-
...
|
|
1276
|
-
|
|
1277
|
-
def pop(self):
|
|
1278
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1279
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1280
|
-
|
|
1281
|
-
"""
|
|
1282
|
-
...
|
|
1283
|
-
|
|
1284
|
-
def prepend(self, draw_func):
|
|
1285
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1286
|
-
the menus draw function
|
|
1287
|
-
|
|
1288
|
-
:param draw_func:
|
|
1289
|
-
"""
|
|
1290
|
-
...
|
|
1291
|
-
|
|
1292
|
-
def property_overridable_library_set(self) -> bool:
|
|
1293
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1294
|
-
|
|
1295
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1296
|
-
:rtype: bool
|
|
1297
|
-
"""
|
|
1298
|
-
...
|
|
1299
|
-
|
|
1300
|
-
def property_unset(self):
|
|
1301
|
-
"""Unset a property, will use default value afterward."""
|
|
1302
|
-
...
|
|
1303
|
-
|
|
1304
|
-
def remove(self, draw_func):
|
|
1305
|
-
"""Remove a draw function that has been added to this menu
|
|
1306
|
-
|
|
1307
|
-
:param draw_func:
|
|
1308
|
-
"""
|
|
1309
|
-
...
|
|
1310
|
-
|
|
1311
|
-
def type_recast(self):
|
|
1312
|
-
"""Return a new instance, this is needed because types
|
|
1313
|
-
such as textures can be changed at runtime.
|
|
1314
|
-
|
|
1315
|
-
:return: a new instance of this object with the type initialized again.
|
|
1316
|
-
"""
|
|
1317
|
-
...
|
|
1318
|
-
|
|
1319
|
-
def values(self):
|
|
1320
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1321
|
-
dictionary function of the same name).
|
|
1322
|
-
|
|
1323
|
-
:return: custom property values.
|
|
1324
|
-
"""
|
|
1325
|
-
...
|
|
1326
|
-
|
|
1327
|
-
class OUTLINER_MT_collection_visibility(bpy_types._GenericUI):
|
|
1328
|
-
bl_label: typing.Any
|
|
1329
|
-
bl_rna: typing.Any
|
|
1330
|
-
id_data: typing.Any
|
|
1331
|
-
|
|
1332
|
-
def append(self, draw_func):
|
|
1333
|
-
"""Append a draw function to this menu,
|
|
1334
|
-
takes the same arguments as the menus draw function
|
|
1335
|
-
|
|
1336
|
-
:param draw_func:
|
|
1337
|
-
"""
|
|
1338
|
-
...
|
|
1339
|
-
|
|
1340
|
-
def as_pointer(self) -> int:
|
|
1341
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1342
|
-
|
|
1343
|
-
:return: int (memory address).
|
|
1344
|
-
:rtype: int
|
|
1345
|
-
"""
|
|
1346
|
-
...
|
|
1347
|
-
|
|
1348
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1349
|
-
"""
|
|
1350
|
-
|
|
1351
|
-
:return: The RNA type or default when not found.
|
|
1352
|
-
:rtype: bpy.types.Struct
|
|
1353
|
-
"""
|
|
1354
|
-
...
|
|
1355
|
-
|
|
1356
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1357
|
-
"""
|
|
1358
|
-
|
|
1359
|
-
:return: The class or default when not found.
|
|
1360
|
-
:rtype: typing.Any
|
|
1361
|
-
"""
|
|
1362
|
-
...
|
|
1363
|
-
|
|
1364
|
-
def draw(self, _context):
|
|
1365
|
-
"""
|
|
1366
|
-
|
|
1367
|
-
:param _context:
|
|
1368
|
-
"""
|
|
1369
|
-
...
|
|
1370
|
-
|
|
1371
|
-
def draw_collapsible(self, context, layout):
|
|
1372
|
-
"""
|
|
1373
|
-
|
|
1374
|
-
:param context:
|
|
1375
|
-
:param layout:
|
|
1376
|
-
"""
|
|
1377
|
-
...
|
|
1378
|
-
|
|
1379
|
-
def draw_preset(self, _context):
|
|
1380
|
-
"""Define these on the subclass:
|
|
1381
|
-
- preset_operator (string)
|
|
1382
|
-
- preset_subdir (string)Optionally:
|
|
1383
|
-
- preset_add_operator (string)
|
|
1384
|
-
- preset_extensions (set of strings)
|
|
1385
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1386
|
-
|
|
1387
|
-
:param _context:
|
|
1388
|
-
"""
|
|
1389
|
-
...
|
|
1390
|
-
|
|
1391
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1392
|
-
"""Adds driver(s) to the given property
|
|
1393
|
-
|
|
1394
|
-
:return: The driver(s) added.
|
|
1395
|
-
:rtype: bpy.types.FCurve
|
|
1396
|
-
"""
|
|
1397
|
-
...
|
|
1398
|
-
|
|
1399
|
-
def driver_remove(self) -> bool:
|
|
1400
|
-
"""Remove driver(s) from the given property
|
|
1401
|
-
|
|
1402
|
-
:return: Success of driver removal.
|
|
1403
|
-
:rtype: bool
|
|
1404
|
-
"""
|
|
1405
|
-
...
|
|
1406
|
-
|
|
1407
|
-
def get(self):
|
|
1408
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1409
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1410
|
-
|
|
1411
|
-
"""
|
|
1412
|
-
...
|
|
1413
|
-
|
|
1414
|
-
def id_properties_clear(self):
|
|
1415
|
-
"""
|
|
1416
|
-
|
|
1417
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1418
|
-
"""
|
|
1419
|
-
...
|
|
1420
|
-
|
|
1421
|
-
def id_properties_ensure(self):
|
|
1422
|
-
"""
|
|
1423
|
-
|
|
1424
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1425
|
-
"""
|
|
1426
|
-
...
|
|
1427
|
-
|
|
1428
|
-
def id_properties_ui(self):
|
|
1429
|
-
"""
|
|
1430
|
-
|
|
1431
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1432
|
-
"""
|
|
1433
|
-
...
|
|
1434
|
-
|
|
1435
|
-
def is_extended(self): ...
|
|
1436
|
-
def is_property_hidden(self) -> bool:
|
|
1437
|
-
"""Check if a property is hidden.
|
|
1438
|
-
|
|
1439
|
-
:return: True when the property is hidden.
|
|
1440
|
-
:rtype: bool
|
|
1441
|
-
"""
|
|
1442
|
-
...
|
|
1443
|
-
|
|
1444
|
-
def is_property_overridable_library(self) -> bool:
|
|
1445
|
-
"""Check if a property is overridable.
|
|
1446
|
-
|
|
1447
|
-
:return: True when the property is overridable.
|
|
1448
|
-
:rtype: bool
|
|
1449
|
-
"""
|
|
1450
|
-
...
|
|
1451
|
-
|
|
1452
|
-
def is_property_readonly(self) -> bool:
|
|
1453
|
-
"""Check if a property is readonly.
|
|
1454
|
-
|
|
1455
|
-
:return: True when the property is readonly (not writable).
|
|
1456
|
-
:rtype: bool
|
|
1457
|
-
"""
|
|
1458
|
-
...
|
|
1459
|
-
|
|
1460
|
-
def is_property_set(self) -> bool:
|
|
1461
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1462
|
-
|
|
1463
|
-
:return: True when the property has been set.
|
|
1464
|
-
:rtype: bool
|
|
1465
|
-
"""
|
|
1466
|
-
...
|
|
1467
|
-
|
|
1468
|
-
def items(self):
|
|
1469
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1470
|
-
dictionary function of the same name).
|
|
1471
|
-
|
|
1472
|
-
:return: custom property key, value pairs.
|
|
1473
|
-
"""
|
|
1474
|
-
...
|
|
1475
|
-
|
|
1476
|
-
def keyframe_delete(self) -> bool:
|
|
1477
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1478
|
-
|
|
1479
|
-
:return: Success of keyframe deletion.
|
|
1480
|
-
:rtype: bool
|
|
1481
|
-
"""
|
|
1482
|
-
...
|
|
1483
|
-
|
|
1484
|
-
def keyframe_insert(self) -> bool:
|
|
1485
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1486
|
-
|
|
1487
|
-
:return: Success of keyframe insertion.
|
|
1488
|
-
:rtype: bool
|
|
1489
|
-
"""
|
|
1490
|
-
...
|
|
1491
|
-
|
|
1492
|
-
def keys(self):
|
|
1493
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1494
|
-
dictionary function of the same name).
|
|
1495
|
-
|
|
1496
|
-
:return: custom property keys.
|
|
1497
|
-
"""
|
|
1498
|
-
...
|
|
1499
|
-
|
|
1500
|
-
def path_from_id(self) -> str:
|
|
1501
|
-
"""Returns the data path from the ID to this object (string).
|
|
1502
|
-
|
|
1503
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1504
|
-
to this struct and property (when given).
|
|
1505
|
-
:rtype: str
|
|
1506
|
-
"""
|
|
1507
|
-
...
|
|
1508
|
-
|
|
1509
|
-
def path_menu(
|
|
1510
|
-
self,
|
|
1511
|
-
searchpaths: list[str],
|
|
1512
|
-
operator: str,
|
|
1513
|
-
*,
|
|
1514
|
-
props_default: dict = None,
|
|
1515
|
-
prop_filepath: str | None = "filepath",
|
|
1516
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1517
|
-
filter_path=None,
|
|
1518
|
-
display_name: collections.abc.Callable | None = None,
|
|
1519
|
-
add_operator=None,
|
|
1520
|
-
add_operator_props=None,
|
|
1521
|
-
):
|
|
1522
|
-
"""Populate a menu from a list of paths.
|
|
1523
|
-
|
|
1524
|
-
:param searchpaths: Paths to scan.
|
|
1525
|
-
:type searchpaths: list[str]
|
|
1526
|
-
:param operator: The operator id to use with each file.
|
|
1527
|
-
:type operator: str
|
|
1528
|
-
:param props_default: Properties to assign to each operator.
|
|
1529
|
-
:type props_default: dict
|
|
1530
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1531
|
-
:type prop_filepath: str | None
|
|
1532
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1533
|
-
|
|
1534
|
-
Returning false excludes the file from the list.
|
|
1535
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1536
|
-
:param filter_path:
|
|
1537
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1538
|
-
:type display_name: collections.abc.Callable | None
|
|
1539
|
-
:param add_operator:
|
|
1540
|
-
:param add_operator_props:
|
|
1541
|
-
"""
|
|
1542
|
-
...
|
|
1543
|
-
|
|
1544
|
-
def path_resolve(self):
|
|
1545
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1546
|
-
...
|
|
1547
|
-
|
|
1548
|
-
def pop(self):
|
|
1549
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1550
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1551
|
-
|
|
1552
|
-
"""
|
|
1553
|
-
...
|
|
1554
|
-
|
|
1555
|
-
def prepend(self, draw_func):
|
|
1556
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1557
|
-
the menus draw function
|
|
1558
|
-
|
|
1559
|
-
:param draw_func:
|
|
1560
|
-
"""
|
|
1561
|
-
...
|
|
1562
|
-
|
|
1563
|
-
def property_overridable_library_set(self) -> bool:
|
|
1564
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1565
|
-
|
|
1566
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1567
|
-
:rtype: bool
|
|
1568
|
-
"""
|
|
1569
|
-
...
|
|
1570
|
-
|
|
1571
|
-
def property_unset(self):
|
|
1572
|
-
"""Unset a property, will use default value afterward."""
|
|
1573
|
-
...
|
|
1574
|
-
|
|
1575
|
-
def remove(self, draw_func):
|
|
1576
|
-
"""Remove a draw function that has been added to this menu
|
|
1577
|
-
|
|
1578
|
-
:param draw_func:
|
|
1579
|
-
"""
|
|
1580
|
-
...
|
|
1581
|
-
|
|
1582
|
-
def type_recast(self):
|
|
1583
|
-
"""Return a new instance, this is needed because types
|
|
1584
|
-
such as textures can be changed at runtime.
|
|
1585
|
-
|
|
1586
|
-
:return: a new instance of this object with the type initialized again.
|
|
1587
|
-
"""
|
|
1588
|
-
...
|
|
1589
|
-
|
|
1590
|
-
def values(self):
|
|
1591
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1592
|
-
dictionary function of the same name).
|
|
1593
|
-
|
|
1594
|
-
:return: custom property values.
|
|
1595
|
-
"""
|
|
1596
|
-
...
|
|
1597
|
-
|
|
1598
|
-
class OUTLINER_MT_context_menu(bpy_types._GenericUI):
|
|
1599
|
-
bl_label: typing.Any
|
|
1600
|
-
bl_rna: typing.Any
|
|
1601
|
-
id_data: typing.Any
|
|
1602
|
-
|
|
1603
|
-
def append(self, draw_func):
|
|
1604
|
-
"""Append a draw function to this menu,
|
|
1605
|
-
takes the same arguments as the menus draw function
|
|
1606
|
-
|
|
1607
|
-
:param draw_func:
|
|
1608
|
-
"""
|
|
1609
|
-
...
|
|
1610
|
-
|
|
1611
|
-
def as_pointer(self) -> int:
|
|
1612
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1613
|
-
|
|
1614
|
-
:return: int (memory address).
|
|
1615
|
-
:rtype: int
|
|
1616
|
-
"""
|
|
1617
|
-
...
|
|
1618
|
-
|
|
1619
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1620
|
-
"""
|
|
1621
|
-
|
|
1622
|
-
:return: The RNA type or default when not found.
|
|
1623
|
-
:rtype: bpy.types.Struct
|
|
1624
|
-
"""
|
|
1625
|
-
...
|
|
1626
|
-
|
|
1627
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1628
|
-
"""
|
|
1629
|
-
|
|
1630
|
-
:return: The class or default when not found.
|
|
1631
|
-
:rtype: typing.Any
|
|
1632
|
-
"""
|
|
1633
|
-
...
|
|
1634
|
-
|
|
1635
|
-
def draw(self, context):
|
|
1636
|
-
"""
|
|
1637
|
-
|
|
1638
|
-
:param context:
|
|
1639
|
-
"""
|
|
1640
|
-
...
|
|
1641
|
-
|
|
1642
|
-
def draw_collapsible(self, context, layout):
|
|
1643
|
-
"""
|
|
1644
|
-
|
|
1645
|
-
:param context:
|
|
1646
|
-
:param layout:
|
|
1647
|
-
"""
|
|
1648
|
-
...
|
|
1649
|
-
|
|
1650
|
-
@staticmethod
|
|
1651
|
-
def draw_common_operators(layout):
|
|
1652
|
-
"""
|
|
1653
|
-
|
|
1654
|
-
:param layout:
|
|
1655
|
-
"""
|
|
1656
|
-
...
|
|
1657
|
-
|
|
1658
|
-
def draw_preset(self, _context):
|
|
1659
|
-
"""Define these on the subclass:
|
|
1660
|
-
- preset_operator (string)
|
|
1661
|
-
- preset_subdir (string)Optionally:
|
|
1662
|
-
- preset_add_operator (string)
|
|
1663
|
-
- preset_extensions (set of strings)
|
|
1664
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1665
|
-
|
|
1666
|
-
:param _context:
|
|
1667
|
-
"""
|
|
1668
|
-
...
|
|
1669
|
-
|
|
1670
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1671
|
-
"""Adds driver(s) to the given property
|
|
1672
|
-
|
|
1673
|
-
:return: The driver(s) added.
|
|
1674
|
-
:rtype: bpy.types.FCurve
|
|
1675
|
-
"""
|
|
1676
|
-
...
|
|
1677
|
-
|
|
1678
|
-
def driver_remove(self) -> bool:
|
|
1679
|
-
"""Remove driver(s) from the given property
|
|
1680
|
-
|
|
1681
|
-
:return: Success of driver removal.
|
|
1682
|
-
:rtype: bool
|
|
1683
|
-
"""
|
|
1684
|
-
...
|
|
1685
|
-
|
|
1686
|
-
def get(self):
|
|
1687
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1688
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1689
|
-
|
|
1690
|
-
"""
|
|
1691
|
-
...
|
|
1692
|
-
|
|
1693
|
-
def id_properties_clear(self):
|
|
1694
|
-
"""
|
|
1695
|
-
|
|
1696
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1697
|
-
"""
|
|
1698
|
-
...
|
|
1699
|
-
|
|
1700
|
-
def id_properties_ensure(self):
|
|
1701
|
-
"""
|
|
1702
|
-
|
|
1703
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1704
|
-
"""
|
|
1705
|
-
...
|
|
1706
|
-
|
|
1707
|
-
def id_properties_ui(self):
|
|
1708
|
-
"""
|
|
1709
|
-
|
|
1710
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1711
|
-
"""
|
|
1712
|
-
...
|
|
1713
|
-
|
|
1714
|
-
def is_extended(self): ...
|
|
1715
|
-
def is_property_hidden(self) -> bool:
|
|
1716
|
-
"""Check if a property is hidden.
|
|
1717
|
-
|
|
1718
|
-
:return: True when the property is hidden.
|
|
1719
|
-
:rtype: bool
|
|
1720
|
-
"""
|
|
1721
|
-
...
|
|
1722
|
-
|
|
1723
|
-
def is_property_overridable_library(self) -> bool:
|
|
1724
|
-
"""Check if a property is overridable.
|
|
1725
|
-
|
|
1726
|
-
:return: True when the property is overridable.
|
|
1727
|
-
:rtype: bool
|
|
1728
|
-
"""
|
|
1729
|
-
...
|
|
1730
|
-
|
|
1731
|
-
def is_property_readonly(self) -> bool:
|
|
1732
|
-
"""Check if a property is readonly.
|
|
1733
|
-
|
|
1734
|
-
:return: True when the property is readonly (not writable).
|
|
1735
|
-
:rtype: bool
|
|
1736
|
-
"""
|
|
1737
|
-
...
|
|
1738
|
-
|
|
1739
|
-
def is_property_set(self) -> bool:
|
|
1740
|
-
"""Check if a property is set, use for testing operator properties.
|
|
1741
|
-
|
|
1742
|
-
:return: True when the property has been set.
|
|
1743
|
-
:rtype: bool
|
|
1744
|
-
"""
|
|
1745
|
-
...
|
|
1746
|
-
|
|
1747
|
-
def items(self):
|
|
1748
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
1749
|
-
dictionary function of the same name).
|
|
1750
|
-
|
|
1751
|
-
:return: custom property key, value pairs.
|
|
1752
|
-
"""
|
|
1753
|
-
...
|
|
1754
|
-
|
|
1755
|
-
def keyframe_delete(self) -> bool:
|
|
1756
|
-
"""Remove a keyframe from this properties fcurve.
|
|
1757
|
-
|
|
1758
|
-
:return: Success of keyframe deletion.
|
|
1759
|
-
:rtype: bool
|
|
1760
|
-
"""
|
|
1761
|
-
...
|
|
1762
|
-
|
|
1763
|
-
def keyframe_insert(self) -> bool:
|
|
1764
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
1765
|
-
|
|
1766
|
-
:return: Success of keyframe insertion.
|
|
1767
|
-
:rtype: bool
|
|
1768
|
-
"""
|
|
1769
|
-
...
|
|
1770
|
-
|
|
1771
|
-
def keys(self):
|
|
1772
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
1773
|
-
dictionary function of the same name).
|
|
1774
|
-
|
|
1775
|
-
:return: custom property keys.
|
|
1776
|
-
"""
|
|
1777
|
-
...
|
|
1778
|
-
|
|
1779
|
-
def path_from_id(self) -> str:
|
|
1780
|
-
"""Returns the data path from the ID to this object (string).
|
|
1781
|
-
|
|
1782
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
1783
|
-
to this struct and property (when given).
|
|
1784
|
-
:rtype: str
|
|
1785
|
-
"""
|
|
1786
|
-
...
|
|
1787
|
-
|
|
1788
|
-
def path_menu(
|
|
1789
|
-
self,
|
|
1790
|
-
searchpaths: list[str],
|
|
1791
|
-
operator: str,
|
|
1792
|
-
*,
|
|
1793
|
-
props_default: dict = None,
|
|
1794
|
-
prop_filepath: str | None = "filepath",
|
|
1795
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
1796
|
-
filter_path=None,
|
|
1797
|
-
display_name: collections.abc.Callable | None = None,
|
|
1798
|
-
add_operator=None,
|
|
1799
|
-
add_operator_props=None,
|
|
1800
|
-
):
|
|
1801
|
-
"""Populate a menu from a list of paths.
|
|
1802
|
-
|
|
1803
|
-
:param searchpaths: Paths to scan.
|
|
1804
|
-
:type searchpaths: list[str]
|
|
1805
|
-
:param operator: The operator id to use with each file.
|
|
1806
|
-
:type operator: str
|
|
1807
|
-
:param props_default: Properties to assign to each operator.
|
|
1808
|
-
:type props_default: dict
|
|
1809
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
1810
|
-
:type prop_filepath: str | None
|
|
1811
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
1812
|
-
|
|
1813
|
-
Returning false excludes the file from the list.
|
|
1814
|
-
:type filter_ext: collections.abc.Callable | None
|
|
1815
|
-
:param filter_path:
|
|
1816
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
1817
|
-
:type display_name: collections.abc.Callable | None
|
|
1818
|
-
:param add_operator:
|
|
1819
|
-
:param add_operator_props:
|
|
1820
|
-
"""
|
|
1821
|
-
...
|
|
1822
|
-
|
|
1823
|
-
def path_resolve(self):
|
|
1824
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
1825
|
-
...
|
|
1826
|
-
|
|
1827
|
-
def pop(self):
|
|
1828
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
1829
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1830
|
-
|
|
1831
|
-
"""
|
|
1832
|
-
...
|
|
1833
|
-
|
|
1834
|
-
def prepend(self, draw_func):
|
|
1835
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
1836
|
-
the menus draw function
|
|
1837
|
-
|
|
1838
|
-
:param draw_func:
|
|
1839
|
-
"""
|
|
1840
|
-
...
|
|
1841
|
-
|
|
1842
|
-
def property_overridable_library_set(self) -> bool:
|
|
1843
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
1844
|
-
|
|
1845
|
-
:return: True when the overridable status of the property was successfully set.
|
|
1846
|
-
:rtype: bool
|
|
1847
|
-
"""
|
|
1848
|
-
...
|
|
1849
|
-
|
|
1850
|
-
def property_unset(self):
|
|
1851
|
-
"""Unset a property, will use default value afterward."""
|
|
1852
|
-
...
|
|
1853
|
-
|
|
1854
|
-
def remove(self, draw_func):
|
|
1855
|
-
"""Remove a draw function that has been added to this menu
|
|
1856
|
-
|
|
1857
|
-
:param draw_func:
|
|
1858
|
-
"""
|
|
1859
|
-
...
|
|
1860
|
-
|
|
1861
|
-
def type_recast(self):
|
|
1862
|
-
"""Return a new instance, this is needed because types
|
|
1863
|
-
such as textures can be changed at runtime.
|
|
1864
|
-
|
|
1865
|
-
:return: a new instance of this object with the type initialized again.
|
|
1866
|
-
"""
|
|
1867
|
-
...
|
|
1868
|
-
|
|
1869
|
-
def values(self):
|
|
1870
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
1871
|
-
dictionary function of the same name).
|
|
1872
|
-
|
|
1873
|
-
:return: custom property values.
|
|
1874
|
-
"""
|
|
1875
|
-
...
|
|
1876
|
-
|
|
1877
|
-
class OUTLINER_MT_context_menu_view(bpy_types._GenericUI):
|
|
1878
|
-
bl_label: typing.Any
|
|
1879
|
-
bl_rna: typing.Any
|
|
1880
|
-
id_data: typing.Any
|
|
1881
|
-
|
|
1882
|
-
def append(self, draw_func):
|
|
1883
|
-
"""Append a draw function to this menu,
|
|
1884
|
-
takes the same arguments as the menus draw function
|
|
1885
|
-
|
|
1886
|
-
:param draw_func:
|
|
1887
|
-
"""
|
|
1888
|
-
...
|
|
1889
|
-
|
|
1890
|
-
def as_pointer(self) -> int:
|
|
1891
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
1892
|
-
|
|
1893
|
-
:return: int (memory address).
|
|
1894
|
-
:rtype: int
|
|
1895
|
-
"""
|
|
1896
|
-
...
|
|
1897
|
-
|
|
1898
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
1899
|
-
"""
|
|
1900
|
-
|
|
1901
|
-
:return: The RNA type or default when not found.
|
|
1902
|
-
:rtype: bpy.types.Struct
|
|
1903
|
-
"""
|
|
1904
|
-
...
|
|
1905
|
-
|
|
1906
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
1907
|
-
"""
|
|
1908
|
-
|
|
1909
|
-
:return: The class or default when not found.
|
|
1910
|
-
:rtype: typing.Any
|
|
1911
|
-
"""
|
|
1912
|
-
...
|
|
1913
|
-
|
|
1914
|
-
def draw(self, _context):
|
|
1915
|
-
"""
|
|
1916
|
-
|
|
1917
|
-
:param _context:
|
|
1918
|
-
"""
|
|
1919
|
-
...
|
|
1920
|
-
|
|
1921
|
-
def draw_collapsible(self, context, layout):
|
|
1922
|
-
"""
|
|
1923
|
-
|
|
1924
|
-
:param context:
|
|
1925
|
-
:param layout:
|
|
1926
|
-
"""
|
|
1927
|
-
...
|
|
1928
|
-
|
|
1929
|
-
def draw_preset(self, _context):
|
|
1930
|
-
"""Define these on the subclass:
|
|
1931
|
-
- preset_operator (string)
|
|
1932
|
-
- preset_subdir (string)Optionally:
|
|
1933
|
-
- preset_add_operator (string)
|
|
1934
|
-
- preset_extensions (set of strings)
|
|
1935
|
-
- preset_operator_defaults (dict of keyword args)
|
|
1936
|
-
|
|
1937
|
-
:param _context:
|
|
1938
|
-
"""
|
|
1939
|
-
...
|
|
1940
|
-
|
|
1941
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
1942
|
-
"""Adds driver(s) to the given property
|
|
1943
|
-
|
|
1944
|
-
:return: The driver(s) added.
|
|
1945
|
-
:rtype: bpy.types.FCurve
|
|
1946
|
-
"""
|
|
1947
|
-
...
|
|
1948
|
-
|
|
1949
|
-
def driver_remove(self) -> bool:
|
|
1950
|
-
"""Remove driver(s) from the given property
|
|
1951
|
-
|
|
1952
|
-
:return: Success of driver removal.
|
|
1953
|
-
:rtype: bool
|
|
1954
|
-
"""
|
|
1955
|
-
...
|
|
1956
|
-
|
|
1957
|
-
def get(self):
|
|
1958
|
-
"""Returns the value of the custom property assigned to key or default
|
|
1959
|
-
when not found (matches Python's dictionary function of the same name).
|
|
1960
|
-
|
|
1961
|
-
"""
|
|
1962
|
-
...
|
|
1963
|
-
|
|
1964
|
-
def id_properties_clear(self):
|
|
1965
|
-
"""
|
|
1966
|
-
|
|
1967
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
1968
|
-
"""
|
|
1969
|
-
...
|
|
1970
|
-
|
|
1971
|
-
def id_properties_ensure(self):
|
|
1972
|
-
"""
|
|
1973
|
-
|
|
1974
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
1975
|
-
"""
|
|
1976
|
-
...
|
|
1977
|
-
|
|
1978
|
-
def id_properties_ui(self):
|
|
1979
|
-
"""
|
|
1980
|
-
|
|
1981
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
1982
|
-
"""
|
|
1983
|
-
...
|
|
1984
|
-
|
|
1985
|
-
def is_extended(self): ...
|
|
1986
|
-
def is_property_hidden(self) -> bool:
|
|
1987
|
-
"""Check if a property is hidden.
|
|
1988
|
-
|
|
1989
|
-
:return: True when the property is hidden.
|
|
1990
|
-
:rtype: bool
|
|
1991
|
-
"""
|
|
1992
|
-
...
|
|
1993
|
-
|
|
1994
|
-
def is_property_overridable_library(self) -> bool:
|
|
1995
|
-
"""Check if a property is overridable.
|
|
1996
|
-
|
|
1997
|
-
:return: True when the property is overridable.
|
|
1998
|
-
:rtype: bool
|
|
1999
|
-
"""
|
|
2000
|
-
...
|
|
2001
|
-
|
|
2002
|
-
def is_property_readonly(self) -> bool:
|
|
2003
|
-
"""Check if a property is readonly.
|
|
2004
|
-
|
|
2005
|
-
:return: True when the property is readonly (not writable).
|
|
2006
|
-
:rtype: bool
|
|
2007
|
-
"""
|
|
2008
|
-
...
|
|
2009
|
-
|
|
2010
|
-
def is_property_set(self) -> bool:
|
|
2011
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2012
|
-
|
|
2013
|
-
:return: True when the property has been set.
|
|
2014
|
-
:rtype: bool
|
|
2015
|
-
"""
|
|
2016
|
-
...
|
|
2017
|
-
|
|
2018
|
-
def items(self):
|
|
2019
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2020
|
-
dictionary function of the same name).
|
|
2021
|
-
|
|
2022
|
-
:return: custom property key, value pairs.
|
|
2023
|
-
"""
|
|
2024
|
-
...
|
|
2025
|
-
|
|
2026
|
-
def keyframe_delete(self) -> bool:
|
|
2027
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2028
|
-
|
|
2029
|
-
:return: Success of keyframe deletion.
|
|
2030
|
-
:rtype: bool
|
|
2031
|
-
"""
|
|
2032
|
-
...
|
|
2033
|
-
|
|
2034
|
-
def keyframe_insert(self) -> bool:
|
|
2035
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2036
|
-
|
|
2037
|
-
:return: Success of keyframe insertion.
|
|
2038
|
-
:rtype: bool
|
|
2039
|
-
"""
|
|
2040
|
-
...
|
|
2041
|
-
|
|
2042
|
-
def keys(self):
|
|
2043
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2044
|
-
dictionary function of the same name).
|
|
2045
|
-
|
|
2046
|
-
:return: custom property keys.
|
|
2047
|
-
"""
|
|
2048
|
-
...
|
|
2049
|
-
|
|
2050
|
-
def path_from_id(self) -> str:
|
|
2051
|
-
"""Returns the data path from the ID to this object (string).
|
|
2052
|
-
|
|
2053
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2054
|
-
to this struct and property (when given).
|
|
2055
|
-
:rtype: str
|
|
2056
|
-
"""
|
|
2057
|
-
...
|
|
2058
|
-
|
|
2059
|
-
def path_menu(
|
|
2060
|
-
self,
|
|
2061
|
-
searchpaths: list[str],
|
|
2062
|
-
operator: str,
|
|
2063
|
-
*,
|
|
2064
|
-
props_default: dict = None,
|
|
2065
|
-
prop_filepath: str | None = "filepath",
|
|
2066
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2067
|
-
filter_path=None,
|
|
2068
|
-
display_name: collections.abc.Callable | None = None,
|
|
2069
|
-
add_operator=None,
|
|
2070
|
-
add_operator_props=None,
|
|
2071
|
-
):
|
|
2072
|
-
"""Populate a menu from a list of paths.
|
|
2073
|
-
|
|
2074
|
-
:param searchpaths: Paths to scan.
|
|
2075
|
-
:type searchpaths: list[str]
|
|
2076
|
-
:param operator: The operator id to use with each file.
|
|
2077
|
-
:type operator: str
|
|
2078
|
-
:param props_default: Properties to assign to each operator.
|
|
2079
|
-
:type props_default: dict
|
|
2080
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2081
|
-
:type prop_filepath: str | None
|
|
2082
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2083
|
-
|
|
2084
|
-
Returning false excludes the file from the list.
|
|
2085
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2086
|
-
:param filter_path:
|
|
2087
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2088
|
-
:type display_name: collections.abc.Callable | None
|
|
2089
|
-
:param add_operator:
|
|
2090
|
-
:param add_operator_props:
|
|
2091
|
-
"""
|
|
2092
|
-
...
|
|
2093
|
-
|
|
2094
|
-
def path_resolve(self):
|
|
2095
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2096
|
-
...
|
|
2097
|
-
|
|
2098
|
-
def pop(self):
|
|
2099
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2100
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2101
|
-
|
|
2102
|
-
"""
|
|
2103
|
-
...
|
|
2104
|
-
|
|
2105
|
-
def prepend(self, draw_func):
|
|
2106
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2107
|
-
the menus draw function
|
|
2108
|
-
|
|
2109
|
-
:param draw_func:
|
|
2110
|
-
"""
|
|
2111
|
-
...
|
|
2112
|
-
|
|
2113
|
-
def property_overridable_library_set(self) -> bool:
|
|
2114
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2115
|
-
|
|
2116
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2117
|
-
:rtype: bool
|
|
2118
|
-
"""
|
|
2119
|
-
...
|
|
2120
|
-
|
|
2121
|
-
def property_unset(self):
|
|
2122
|
-
"""Unset a property, will use default value afterward."""
|
|
2123
|
-
...
|
|
2124
|
-
|
|
2125
|
-
def remove(self, draw_func):
|
|
2126
|
-
"""Remove a draw function that has been added to this menu
|
|
2127
|
-
|
|
2128
|
-
:param draw_func:
|
|
2129
|
-
"""
|
|
2130
|
-
...
|
|
2131
|
-
|
|
2132
|
-
def type_recast(self):
|
|
2133
|
-
"""Return a new instance, this is needed because types
|
|
2134
|
-
such as textures can be changed at runtime.
|
|
2135
|
-
|
|
2136
|
-
:return: a new instance of this object with the type initialized again.
|
|
2137
|
-
"""
|
|
2138
|
-
...
|
|
2139
|
-
|
|
2140
|
-
def values(self):
|
|
2141
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2142
|
-
dictionary function of the same name).
|
|
2143
|
-
|
|
2144
|
-
:return: custom property values.
|
|
2145
|
-
"""
|
|
2146
|
-
...
|
|
2147
|
-
|
|
2148
|
-
class OUTLINER_MT_edit_datablocks(bpy_types._GenericUI):
|
|
2149
|
-
bl_label: typing.Any
|
|
2150
|
-
bl_rna: typing.Any
|
|
2151
|
-
id_data: typing.Any
|
|
2152
|
-
|
|
2153
|
-
def append(self, draw_func):
|
|
2154
|
-
"""Append a draw function to this menu,
|
|
2155
|
-
takes the same arguments as the menus draw function
|
|
2156
|
-
|
|
2157
|
-
:param draw_func:
|
|
2158
|
-
"""
|
|
2159
|
-
...
|
|
2160
|
-
|
|
2161
|
-
def as_pointer(self) -> int:
|
|
2162
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2163
|
-
|
|
2164
|
-
:return: int (memory address).
|
|
2165
|
-
:rtype: int
|
|
2166
|
-
"""
|
|
2167
|
-
...
|
|
2168
|
-
|
|
2169
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2170
|
-
"""
|
|
2171
|
-
|
|
2172
|
-
:return: The RNA type or default when not found.
|
|
2173
|
-
:rtype: bpy.types.Struct
|
|
2174
|
-
"""
|
|
2175
|
-
...
|
|
2176
|
-
|
|
2177
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2178
|
-
"""
|
|
2179
|
-
|
|
2180
|
-
:return: The class or default when not found.
|
|
2181
|
-
:rtype: typing.Any
|
|
2182
|
-
"""
|
|
2183
|
-
...
|
|
2184
|
-
|
|
2185
|
-
def draw(self, _context):
|
|
2186
|
-
"""
|
|
2187
|
-
|
|
2188
|
-
:param _context:
|
|
2189
|
-
"""
|
|
2190
|
-
...
|
|
2191
|
-
|
|
2192
|
-
def draw_collapsible(self, context, layout):
|
|
2193
|
-
"""
|
|
2194
|
-
|
|
2195
|
-
:param context:
|
|
2196
|
-
:param layout:
|
|
2197
|
-
"""
|
|
2198
|
-
...
|
|
2199
|
-
|
|
2200
|
-
def draw_preset(self, _context):
|
|
2201
|
-
"""Define these on the subclass:
|
|
2202
|
-
- preset_operator (string)
|
|
2203
|
-
- preset_subdir (string)Optionally:
|
|
2204
|
-
- preset_add_operator (string)
|
|
2205
|
-
- preset_extensions (set of strings)
|
|
2206
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2207
|
-
|
|
2208
|
-
:param _context:
|
|
2209
|
-
"""
|
|
2210
|
-
...
|
|
2211
|
-
|
|
2212
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2213
|
-
"""Adds driver(s) to the given property
|
|
2214
|
-
|
|
2215
|
-
:return: The driver(s) added.
|
|
2216
|
-
:rtype: bpy.types.FCurve
|
|
2217
|
-
"""
|
|
2218
|
-
...
|
|
2219
|
-
|
|
2220
|
-
def driver_remove(self) -> bool:
|
|
2221
|
-
"""Remove driver(s) from the given property
|
|
2222
|
-
|
|
2223
|
-
:return: Success of driver removal.
|
|
2224
|
-
:rtype: bool
|
|
2225
|
-
"""
|
|
2226
|
-
...
|
|
2227
|
-
|
|
2228
|
-
def get(self):
|
|
2229
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2230
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2231
|
-
|
|
2232
|
-
"""
|
|
2233
|
-
...
|
|
2234
|
-
|
|
2235
|
-
def id_properties_clear(self):
|
|
2236
|
-
"""
|
|
2237
|
-
|
|
2238
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2239
|
-
"""
|
|
2240
|
-
...
|
|
2241
|
-
|
|
2242
|
-
def id_properties_ensure(self):
|
|
2243
|
-
"""
|
|
2244
|
-
|
|
2245
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2246
|
-
"""
|
|
2247
|
-
...
|
|
2248
|
-
|
|
2249
|
-
def id_properties_ui(self):
|
|
2250
|
-
"""
|
|
2251
|
-
|
|
2252
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2253
|
-
"""
|
|
2254
|
-
...
|
|
2255
|
-
|
|
2256
|
-
def is_extended(self): ...
|
|
2257
|
-
def is_property_hidden(self) -> bool:
|
|
2258
|
-
"""Check if a property is hidden.
|
|
2259
|
-
|
|
2260
|
-
:return: True when the property is hidden.
|
|
2261
|
-
:rtype: bool
|
|
2262
|
-
"""
|
|
2263
|
-
...
|
|
2264
|
-
|
|
2265
|
-
def is_property_overridable_library(self) -> bool:
|
|
2266
|
-
"""Check if a property is overridable.
|
|
2267
|
-
|
|
2268
|
-
:return: True when the property is overridable.
|
|
2269
|
-
:rtype: bool
|
|
2270
|
-
"""
|
|
2271
|
-
...
|
|
2272
|
-
|
|
2273
|
-
def is_property_readonly(self) -> bool:
|
|
2274
|
-
"""Check if a property is readonly.
|
|
2275
|
-
|
|
2276
|
-
:return: True when the property is readonly (not writable).
|
|
2277
|
-
:rtype: bool
|
|
2278
|
-
"""
|
|
2279
|
-
...
|
|
2280
|
-
|
|
2281
|
-
def is_property_set(self) -> bool:
|
|
2282
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2283
|
-
|
|
2284
|
-
:return: True when the property has been set.
|
|
2285
|
-
:rtype: bool
|
|
2286
|
-
"""
|
|
2287
|
-
...
|
|
2288
|
-
|
|
2289
|
-
def items(self):
|
|
2290
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2291
|
-
dictionary function of the same name).
|
|
2292
|
-
|
|
2293
|
-
:return: custom property key, value pairs.
|
|
2294
|
-
"""
|
|
2295
|
-
...
|
|
2296
|
-
|
|
2297
|
-
def keyframe_delete(self) -> bool:
|
|
2298
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2299
|
-
|
|
2300
|
-
:return: Success of keyframe deletion.
|
|
2301
|
-
:rtype: bool
|
|
2302
|
-
"""
|
|
2303
|
-
...
|
|
2304
|
-
|
|
2305
|
-
def keyframe_insert(self) -> bool:
|
|
2306
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2307
|
-
|
|
2308
|
-
:return: Success of keyframe insertion.
|
|
2309
|
-
:rtype: bool
|
|
2310
|
-
"""
|
|
2311
|
-
...
|
|
2312
|
-
|
|
2313
|
-
def keys(self):
|
|
2314
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2315
|
-
dictionary function of the same name).
|
|
2316
|
-
|
|
2317
|
-
:return: custom property keys.
|
|
2318
|
-
"""
|
|
2319
|
-
...
|
|
2320
|
-
|
|
2321
|
-
def path_from_id(self) -> str:
|
|
2322
|
-
"""Returns the data path from the ID to this object (string).
|
|
2323
|
-
|
|
2324
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2325
|
-
to this struct and property (when given).
|
|
2326
|
-
:rtype: str
|
|
2327
|
-
"""
|
|
2328
|
-
...
|
|
2329
|
-
|
|
2330
|
-
def path_menu(
|
|
2331
|
-
self,
|
|
2332
|
-
searchpaths: list[str],
|
|
2333
|
-
operator: str,
|
|
2334
|
-
*,
|
|
2335
|
-
props_default: dict = None,
|
|
2336
|
-
prop_filepath: str | None = "filepath",
|
|
2337
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2338
|
-
filter_path=None,
|
|
2339
|
-
display_name: collections.abc.Callable | None = None,
|
|
2340
|
-
add_operator=None,
|
|
2341
|
-
add_operator_props=None,
|
|
2342
|
-
):
|
|
2343
|
-
"""Populate a menu from a list of paths.
|
|
2344
|
-
|
|
2345
|
-
:param searchpaths: Paths to scan.
|
|
2346
|
-
:type searchpaths: list[str]
|
|
2347
|
-
:param operator: The operator id to use with each file.
|
|
2348
|
-
:type operator: str
|
|
2349
|
-
:param props_default: Properties to assign to each operator.
|
|
2350
|
-
:type props_default: dict
|
|
2351
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2352
|
-
:type prop_filepath: str | None
|
|
2353
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2354
|
-
|
|
2355
|
-
Returning false excludes the file from the list.
|
|
2356
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2357
|
-
:param filter_path:
|
|
2358
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2359
|
-
:type display_name: collections.abc.Callable | None
|
|
2360
|
-
:param add_operator:
|
|
2361
|
-
:param add_operator_props:
|
|
2362
|
-
"""
|
|
2363
|
-
...
|
|
2364
|
-
|
|
2365
|
-
def path_resolve(self):
|
|
2366
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2367
|
-
...
|
|
2368
|
-
|
|
2369
|
-
def pop(self):
|
|
2370
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2371
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2372
|
-
|
|
2373
|
-
"""
|
|
2374
|
-
...
|
|
2375
|
-
|
|
2376
|
-
def prepend(self, draw_func):
|
|
2377
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2378
|
-
the menus draw function
|
|
2379
|
-
|
|
2380
|
-
:param draw_func:
|
|
2381
|
-
"""
|
|
2382
|
-
...
|
|
2383
|
-
|
|
2384
|
-
def property_overridable_library_set(self) -> bool:
|
|
2385
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2386
|
-
|
|
2387
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2388
|
-
:rtype: bool
|
|
2389
|
-
"""
|
|
2390
|
-
...
|
|
2391
|
-
|
|
2392
|
-
def property_unset(self):
|
|
2393
|
-
"""Unset a property, will use default value afterward."""
|
|
2394
|
-
...
|
|
2395
|
-
|
|
2396
|
-
def remove(self, draw_func):
|
|
2397
|
-
"""Remove a draw function that has been added to this menu
|
|
2398
|
-
|
|
2399
|
-
:param draw_func:
|
|
2400
|
-
"""
|
|
2401
|
-
...
|
|
2402
|
-
|
|
2403
|
-
def type_recast(self):
|
|
2404
|
-
"""Return a new instance, this is needed because types
|
|
2405
|
-
such as textures can be changed at runtime.
|
|
2406
|
-
|
|
2407
|
-
:return: a new instance of this object with the type initialized again.
|
|
2408
|
-
"""
|
|
2409
|
-
...
|
|
2410
|
-
|
|
2411
|
-
def values(self):
|
|
2412
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2413
|
-
dictionary function of the same name).
|
|
2414
|
-
|
|
2415
|
-
:return: custom property values.
|
|
2416
|
-
"""
|
|
2417
|
-
...
|
|
2418
|
-
|
|
2419
|
-
class OUTLINER_MT_editor_menus(bpy_types._GenericUI):
|
|
2420
|
-
bl_idname: typing.Any
|
|
2421
|
-
bl_label: typing.Any
|
|
2422
|
-
bl_rna: typing.Any
|
|
2423
|
-
id_data: typing.Any
|
|
2424
|
-
|
|
2425
|
-
def append(self, draw_func):
|
|
2426
|
-
"""Append a draw function to this menu,
|
|
2427
|
-
takes the same arguments as the menus draw function
|
|
2428
|
-
|
|
2429
|
-
:param draw_func:
|
|
2430
|
-
"""
|
|
2431
|
-
...
|
|
2432
|
-
|
|
2433
|
-
def as_pointer(self) -> int:
|
|
2434
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2435
|
-
|
|
2436
|
-
:return: int (memory address).
|
|
2437
|
-
:rtype: int
|
|
2438
|
-
"""
|
|
2439
|
-
...
|
|
2440
|
-
|
|
2441
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2442
|
-
"""
|
|
2443
|
-
|
|
2444
|
-
:return: The RNA type or default when not found.
|
|
2445
|
-
:rtype: bpy.types.Struct
|
|
2446
|
-
"""
|
|
2447
|
-
...
|
|
2448
|
-
|
|
2449
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2450
|
-
"""
|
|
2451
|
-
|
|
2452
|
-
:return: The class or default when not found.
|
|
2453
|
-
:rtype: typing.Any
|
|
2454
|
-
"""
|
|
2455
|
-
...
|
|
2456
|
-
|
|
2457
|
-
def draw(self, context):
|
|
2458
|
-
"""
|
|
2459
|
-
|
|
2460
|
-
:param context:
|
|
2461
|
-
"""
|
|
2462
|
-
...
|
|
2463
|
-
|
|
2464
|
-
def draw_collapsible(self, context, layout):
|
|
2465
|
-
"""
|
|
2466
|
-
|
|
2467
|
-
:param context:
|
|
2468
|
-
:param layout:
|
|
2469
|
-
"""
|
|
2470
|
-
...
|
|
2471
|
-
|
|
2472
|
-
def draw_preset(self, _context):
|
|
2473
|
-
"""Define these on the subclass:
|
|
2474
|
-
- preset_operator (string)
|
|
2475
|
-
- preset_subdir (string)Optionally:
|
|
2476
|
-
- preset_add_operator (string)
|
|
2477
|
-
- preset_extensions (set of strings)
|
|
2478
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2479
|
-
|
|
2480
|
-
:param _context:
|
|
2481
|
-
"""
|
|
2482
|
-
...
|
|
2483
|
-
|
|
2484
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2485
|
-
"""Adds driver(s) to the given property
|
|
2486
|
-
|
|
2487
|
-
:return: The driver(s) added.
|
|
2488
|
-
:rtype: bpy.types.FCurve
|
|
2489
|
-
"""
|
|
2490
|
-
...
|
|
2491
|
-
|
|
2492
|
-
def driver_remove(self) -> bool:
|
|
2493
|
-
"""Remove driver(s) from the given property
|
|
2494
|
-
|
|
2495
|
-
:return: Success of driver removal.
|
|
2496
|
-
:rtype: bool
|
|
2497
|
-
"""
|
|
2498
|
-
...
|
|
2499
|
-
|
|
2500
|
-
def get(self):
|
|
2501
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2502
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2503
|
-
|
|
2504
|
-
"""
|
|
2505
|
-
...
|
|
2506
|
-
|
|
2507
|
-
def id_properties_clear(self):
|
|
2508
|
-
"""
|
|
2509
|
-
|
|
2510
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2511
|
-
"""
|
|
2512
|
-
...
|
|
2513
|
-
|
|
2514
|
-
def id_properties_ensure(self):
|
|
2515
|
-
"""
|
|
2516
|
-
|
|
2517
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2518
|
-
"""
|
|
2519
|
-
...
|
|
2520
|
-
|
|
2521
|
-
def id_properties_ui(self):
|
|
2522
|
-
"""
|
|
2523
|
-
|
|
2524
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2525
|
-
"""
|
|
2526
|
-
...
|
|
2527
|
-
|
|
2528
|
-
def is_extended(self): ...
|
|
2529
|
-
def is_property_hidden(self) -> bool:
|
|
2530
|
-
"""Check if a property is hidden.
|
|
2531
|
-
|
|
2532
|
-
:return: True when the property is hidden.
|
|
2533
|
-
:rtype: bool
|
|
2534
|
-
"""
|
|
2535
|
-
...
|
|
2536
|
-
|
|
2537
|
-
def is_property_overridable_library(self) -> bool:
|
|
2538
|
-
"""Check if a property is overridable.
|
|
2539
|
-
|
|
2540
|
-
:return: True when the property is overridable.
|
|
2541
|
-
:rtype: bool
|
|
2542
|
-
"""
|
|
2543
|
-
...
|
|
2544
|
-
|
|
2545
|
-
def is_property_readonly(self) -> bool:
|
|
2546
|
-
"""Check if a property is readonly.
|
|
2547
|
-
|
|
2548
|
-
:return: True when the property is readonly (not writable).
|
|
2549
|
-
:rtype: bool
|
|
2550
|
-
"""
|
|
2551
|
-
...
|
|
2552
|
-
|
|
2553
|
-
def is_property_set(self) -> bool:
|
|
2554
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2555
|
-
|
|
2556
|
-
:return: True when the property has been set.
|
|
2557
|
-
:rtype: bool
|
|
2558
|
-
"""
|
|
2559
|
-
...
|
|
2560
|
-
|
|
2561
|
-
def items(self):
|
|
2562
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2563
|
-
dictionary function of the same name).
|
|
2564
|
-
|
|
2565
|
-
:return: custom property key, value pairs.
|
|
2566
|
-
"""
|
|
2567
|
-
...
|
|
2568
|
-
|
|
2569
|
-
def keyframe_delete(self) -> bool:
|
|
2570
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2571
|
-
|
|
2572
|
-
:return: Success of keyframe deletion.
|
|
2573
|
-
:rtype: bool
|
|
2574
|
-
"""
|
|
2575
|
-
...
|
|
2576
|
-
|
|
2577
|
-
def keyframe_insert(self) -> bool:
|
|
2578
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2579
|
-
|
|
2580
|
-
:return: Success of keyframe insertion.
|
|
2581
|
-
:rtype: bool
|
|
2582
|
-
"""
|
|
2583
|
-
...
|
|
2584
|
-
|
|
2585
|
-
def keys(self):
|
|
2586
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2587
|
-
dictionary function of the same name).
|
|
2588
|
-
|
|
2589
|
-
:return: custom property keys.
|
|
2590
|
-
"""
|
|
2591
|
-
...
|
|
2592
|
-
|
|
2593
|
-
def path_from_id(self) -> str:
|
|
2594
|
-
"""Returns the data path from the ID to this object (string).
|
|
2595
|
-
|
|
2596
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2597
|
-
to this struct and property (when given).
|
|
2598
|
-
:rtype: str
|
|
2599
|
-
"""
|
|
2600
|
-
...
|
|
2601
|
-
|
|
2602
|
-
def path_menu(
|
|
2603
|
-
self,
|
|
2604
|
-
searchpaths: list[str],
|
|
2605
|
-
operator: str,
|
|
2606
|
-
*,
|
|
2607
|
-
props_default: dict = None,
|
|
2608
|
-
prop_filepath: str | None = "filepath",
|
|
2609
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2610
|
-
filter_path=None,
|
|
2611
|
-
display_name: collections.abc.Callable | None = None,
|
|
2612
|
-
add_operator=None,
|
|
2613
|
-
add_operator_props=None,
|
|
2614
|
-
):
|
|
2615
|
-
"""Populate a menu from a list of paths.
|
|
2616
|
-
|
|
2617
|
-
:param searchpaths: Paths to scan.
|
|
2618
|
-
:type searchpaths: list[str]
|
|
2619
|
-
:param operator: The operator id to use with each file.
|
|
2620
|
-
:type operator: str
|
|
2621
|
-
:param props_default: Properties to assign to each operator.
|
|
2622
|
-
:type props_default: dict
|
|
2623
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2624
|
-
:type prop_filepath: str | None
|
|
2625
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2626
|
-
|
|
2627
|
-
Returning false excludes the file from the list.
|
|
2628
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2629
|
-
:param filter_path:
|
|
2630
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2631
|
-
:type display_name: collections.abc.Callable | None
|
|
2632
|
-
:param add_operator:
|
|
2633
|
-
:param add_operator_props:
|
|
2634
|
-
"""
|
|
2635
|
-
...
|
|
2636
|
-
|
|
2637
|
-
def path_resolve(self):
|
|
2638
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2639
|
-
...
|
|
2640
|
-
|
|
2641
|
-
def pop(self):
|
|
2642
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2643
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2644
|
-
|
|
2645
|
-
"""
|
|
2646
|
-
...
|
|
2647
|
-
|
|
2648
|
-
def prepend(self, draw_func):
|
|
2649
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2650
|
-
the menus draw function
|
|
2651
|
-
|
|
2652
|
-
:param draw_func:
|
|
2653
|
-
"""
|
|
2654
|
-
...
|
|
2655
|
-
|
|
2656
|
-
def property_overridable_library_set(self) -> bool:
|
|
2657
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2658
|
-
|
|
2659
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2660
|
-
:rtype: bool
|
|
2661
|
-
"""
|
|
2662
|
-
...
|
|
2663
|
-
|
|
2664
|
-
def property_unset(self):
|
|
2665
|
-
"""Unset a property, will use default value afterward."""
|
|
2666
|
-
...
|
|
2667
|
-
|
|
2668
|
-
def remove(self, draw_func):
|
|
2669
|
-
"""Remove a draw function that has been added to this menu
|
|
2670
|
-
|
|
2671
|
-
:param draw_func:
|
|
2672
|
-
"""
|
|
2673
|
-
...
|
|
2674
|
-
|
|
2675
|
-
def type_recast(self):
|
|
2676
|
-
"""Return a new instance, this is needed because types
|
|
2677
|
-
such as textures can be changed at runtime.
|
|
2678
|
-
|
|
2679
|
-
:return: a new instance of this object with the type initialized again.
|
|
2680
|
-
"""
|
|
2681
|
-
...
|
|
2682
|
-
|
|
2683
|
-
def values(self):
|
|
2684
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2685
|
-
dictionary function of the same name).
|
|
2686
|
-
|
|
2687
|
-
:return: custom property values.
|
|
2688
|
-
"""
|
|
2689
|
-
...
|
|
2690
|
-
|
|
2691
|
-
class OUTLINER_MT_liboverride(bpy_types._GenericUI):
|
|
2692
|
-
bl_label: typing.Any
|
|
2693
|
-
bl_rna: typing.Any
|
|
2694
|
-
id_data: typing.Any
|
|
2695
|
-
|
|
2696
|
-
def append(self, draw_func):
|
|
2697
|
-
"""Append a draw function to this menu,
|
|
2698
|
-
takes the same arguments as the menus draw function
|
|
2699
|
-
|
|
2700
|
-
:param draw_func:
|
|
2701
|
-
"""
|
|
2702
|
-
...
|
|
2703
|
-
|
|
2704
|
-
def as_pointer(self) -> int:
|
|
2705
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2706
|
-
|
|
2707
|
-
:return: int (memory address).
|
|
2708
|
-
:rtype: int
|
|
2709
|
-
"""
|
|
2710
|
-
...
|
|
2711
|
-
|
|
2712
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2713
|
-
"""
|
|
2714
|
-
|
|
2715
|
-
:return: The RNA type or default when not found.
|
|
2716
|
-
:rtype: bpy.types.Struct
|
|
2717
|
-
"""
|
|
2718
|
-
...
|
|
2719
|
-
|
|
2720
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
2721
|
-
"""
|
|
2722
|
-
|
|
2723
|
-
:return: The class or default when not found.
|
|
2724
|
-
:rtype: typing.Any
|
|
2725
|
-
"""
|
|
2726
|
-
...
|
|
2727
|
-
|
|
2728
|
-
def draw(self, _context):
|
|
2729
|
-
"""
|
|
2730
|
-
|
|
2731
|
-
:param _context:
|
|
2732
|
-
"""
|
|
2733
|
-
...
|
|
2734
|
-
|
|
2735
|
-
def draw_collapsible(self, context, layout):
|
|
2736
|
-
"""
|
|
2737
|
-
|
|
2738
|
-
:param context:
|
|
2739
|
-
:param layout:
|
|
2740
|
-
"""
|
|
2741
|
-
...
|
|
2742
|
-
|
|
2743
|
-
def draw_preset(self, _context):
|
|
2744
|
-
"""Define these on the subclass:
|
|
2745
|
-
- preset_operator (string)
|
|
2746
|
-
- preset_subdir (string)Optionally:
|
|
2747
|
-
- preset_add_operator (string)
|
|
2748
|
-
- preset_extensions (set of strings)
|
|
2749
|
-
- preset_operator_defaults (dict of keyword args)
|
|
2750
|
-
|
|
2751
|
-
:param _context:
|
|
2752
|
-
"""
|
|
2753
|
-
...
|
|
2754
|
-
|
|
2755
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
2756
|
-
"""Adds driver(s) to the given property
|
|
2757
|
-
|
|
2758
|
-
:return: The driver(s) added.
|
|
2759
|
-
:rtype: bpy.types.FCurve
|
|
2760
|
-
"""
|
|
2761
|
-
...
|
|
2762
|
-
|
|
2763
|
-
def driver_remove(self) -> bool:
|
|
2764
|
-
"""Remove driver(s) from the given property
|
|
2765
|
-
|
|
2766
|
-
:return: Success of driver removal.
|
|
2767
|
-
:rtype: bool
|
|
2768
|
-
"""
|
|
2769
|
-
...
|
|
2770
|
-
|
|
2771
|
-
def get(self):
|
|
2772
|
-
"""Returns the value of the custom property assigned to key or default
|
|
2773
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2774
|
-
|
|
2775
|
-
"""
|
|
2776
|
-
...
|
|
2777
|
-
|
|
2778
|
-
def id_properties_clear(self):
|
|
2779
|
-
"""
|
|
2780
|
-
|
|
2781
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
2782
|
-
"""
|
|
2783
|
-
...
|
|
2784
|
-
|
|
2785
|
-
def id_properties_ensure(self):
|
|
2786
|
-
"""
|
|
2787
|
-
|
|
2788
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
2789
|
-
"""
|
|
2790
|
-
...
|
|
2791
|
-
|
|
2792
|
-
def id_properties_ui(self):
|
|
2793
|
-
"""
|
|
2794
|
-
|
|
2795
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
2796
|
-
"""
|
|
2797
|
-
...
|
|
2798
|
-
|
|
2799
|
-
def is_extended(self): ...
|
|
2800
|
-
def is_property_hidden(self) -> bool:
|
|
2801
|
-
"""Check if a property is hidden.
|
|
2802
|
-
|
|
2803
|
-
:return: True when the property is hidden.
|
|
2804
|
-
:rtype: bool
|
|
2805
|
-
"""
|
|
2806
|
-
...
|
|
2807
|
-
|
|
2808
|
-
def is_property_overridable_library(self) -> bool:
|
|
2809
|
-
"""Check if a property is overridable.
|
|
2810
|
-
|
|
2811
|
-
:return: True when the property is overridable.
|
|
2812
|
-
:rtype: bool
|
|
2813
|
-
"""
|
|
2814
|
-
...
|
|
2815
|
-
|
|
2816
|
-
def is_property_readonly(self) -> bool:
|
|
2817
|
-
"""Check if a property is readonly.
|
|
2818
|
-
|
|
2819
|
-
:return: True when the property is readonly (not writable).
|
|
2820
|
-
:rtype: bool
|
|
2821
|
-
"""
|
|
2822
|
-
...
|
|
2823
|
-
|
|
2824
|
-
def is_property_set(self) -> bool:
|
|
2825
|
-
"""Check if a property is set, use for testing operator properties.
|
|
2826
|
-
|
|
2827
|
-
:return: True when the property has been set.
|
|
2828
|
-
:rtype: bool
|
|
2829
|
-
"""
|
|
2830
|
-
...
|
|
2831
|
-
|
|
2832
|
-
def items(self):
|
|
2833
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
2834
|
-
dictionary function of the same name).
|
|
2835
|
-
|
|
2836
|
-
:return: custom property key, value pairs.
|
|
2837
|
-
"""
|
|
2838
|
-
...
|
|
2839
|
-
|
|
2840
|
-
def keyframe_delete(self) -> bool:
|
|
2841
|
-
"""Remove a keyframe from this properties fcurve.
|
|
2842
|
-
|
|
2843
|
-
:return: Success of keyframe deletion.
|
|
2844
|
-
:rtype: bool
|
|
2845
|
-
"""
|
|
2846
|
-
...
|
|
2847
|
-
|
|
2848
|
-
def keyframe_insert(self) -> bool:
|
|
2849
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
2850
|
-
|
|
2851
|
-
:return: Success of keyframe insertion.
|
|
2852
|
-
:rtype: bool
|
|
2853
|
-
"""
|
|
2854
|
-
...
|
|
2855
|
-
|
|
2856
|
-
def keys(self):
|
|
2857
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
2858
|
-
dictionary function of the same name).
|
|
2859
|
-
|
|
2860
|
-
:return: custom property keys.
|
|
2861
|
-
"""
|
|
2862
|
-
...
|
|
2863
|
-
|
|
2864
|
-
def path_from_id(self) -> str:
|
|
2865
|
-
"""Returns the data path from the ID to this object (string).
|
|
2866
|
-
|
|
2867
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
2868
|
-
to this struct and property (when given).
|
|
2869
|
-
:rtype: str
|
|
2870
|
-
"""
|
|
2871
|
-
...
|
|
2872
|
-
|
|
2873
|
-
def path_menu(
|
|
2874
|
-
self,
|
|
2875
|
-
searchpaths: list[str],
|
|
2876
|
-
operator: str,
|
|
2877
|
-
*,
|
|
2878
|
-
props_default: dict = None,
|
|
2879
|
-
prop_filepath: str | None = "filepath",
|
|
2880
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
2881
|
-
filter_path=None,
|
|
2882
|
-
display_name: collections.abc.Callable | None = None,
|
|
2883
|
-
add_operator=None,
|
|
2884
|
-
add_operator_props=None,
|
|
2885
|
-
):
|
|
2886
|
-
"""Populate a menu from a list of paths.
|
|
2887
|
-
|
|
2888
|
-
:param searchpaths: Paths to scan.
|
|
2889
|
-
:type searchpaths: list[str]
|
|
2890
|
-
:param operator: The operator id to use with each file.
|
|
2891
|
-
:type operator: str
|
|
2892
|
-
:param props_default: Properties to assign to each operator.
|
|
2893
|
-
:type props_default: dict
|
|
2894
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
2895
|
-
:type prop_filepath: str | None
|
|
2896
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
2897
|
-
|
|
2898
|
-
Returning false excludes the file from the list.
|
|
2899
|
-
:type filter_ext: collections.abc.Callable | None
|
|
2900
|
-
:param filter_path:
|
|
2901
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
2902
|
-
:type display_name: collections.abc.Callable | None
|
|
2903
|
-
:param add_operator:
|
|
2904
|
-
:param add_operator_props:
|
|
2905
|
-
"""
|
|
2906
|
-
...
|
|
2907
|
-
|
|
2908
|
-
def path_resolve(self):
|
|
2909
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
2910
|
-
...
|
|
2911
|
-
|
|
2912
|
-
@classmethod
|
|
2913
|
-
def poll(cls, context):
|
|
2914
|
-
"""
|
|
2915
|
-
|
|
2916
|
-
:param context:
|
|
2917
|
-
"""
|
|
2918
|
-
...
|
|
2919
|
-
|
|
2920
|
-
def pop(self):
|
|
2921
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
2922
|
-
when not found (matches Python's dictionary function of the same name).
|
|
2923
|
-
|
|
2924
|
-
"""
|
|
2925
|
-
...
|
|
2926
|
-
|
|
2927
|
-
def prepend(self, draw_func):
|
|
2928
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
2929
|
-
the menus draw function
|
|
2930
|
-
|
|
2931
|
-
:param draw_func:
|
|
2932
|
-
"""
|
|
2933
|
-
...
|
|
2934
|
-
|
|
2935
|
-
def property_overridable_library_set(self) -> bool:
|
|
2936
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
2937
|
-
|
|
2938
|
-
:return: True when the overridable status of the property was successfully set.
|
|
2939
|
-
:rtype: bool
|
|
2940
|
-
"""
|
|
2941
|
-
...
|
|
2942
|
-
|
|
2943
|
-
def property_unset(self):
|
|
2944
|
-
"""Unset a property, will use default value afterward."""
|
|
2945
|
-
...
|
|
2946
|
-
|
|
2947
|
-
def remove(self, draw_func):
|
|
2948
|
-
"""Remove a draw function that has been added to this menu
|
|
2949
|
-
|
|
2950
|
-
:param draw_func:
|
|
2951
|
-
"""
|
|
2952
|
-
...
|
|
2953
|
-
|
|
2954
|
-
def type_recast(self):
|
|
2955
|
-
"""Return a new instance, this is needed because types
|
|
2956
|
-
such as textures can be changed at runtime.
|
|
2957
|
-
|
|
2958
|
-
:return: a new instance of this object with the type initialized again.
|
|
2959
|
-
"""
|
|
2960
|
-
...
|
|
2961
|
-
|
|
2962
|
-
def values(self):
|
|
2963
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
2964
|
-
dictionary function of the same name).
|
|
2965
|
-
|
|
2966
|
-
:return: custom property values.
|
|
2967
|
-
"""
|
|
2968
|
-
...
|
|
2969
|
-
|
|
2970
|
-
class OUTLINER_MT_object(bpy_types._GenericUI):
|
|
2971
|
-
bl_label: typing.Any
|
|
2972
|
-
bl_rna: typing.Any
|
|
2973
|
-
id_data: typing.Any
|
|
2974
|
-
|
|
2975
|
-
def append(self, draw_func):
|
|
2976
|
-
"""Append a draw function to this menu,
|
|
2977
|
-
takes the same arguments as the menus draw function
|
|
2978
|
-
|
|
2979
|
-
:param draw_func:
|
|
2980
|
-
"""
|
|
2981
|
-
...
|
|
2982
|
-
|
|
2983
|
-
def as_pointer(self) -> int:
|
|
2984
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
2985
|
-
|
|
2986
|
-
:return: int (memory address).
|
|
2987
|
-
:rtype: int
|
|
2988
|
-
"""
|
|
2989
|
-
...
|
|
2990
|
-
|
|
2991
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
2992
|
-
"""
|
|
2993
|
-
|
|
2994
|
-
:return: The RNA type or default when not found.
|
|
2995
|
-
:rtype: bpy.types.Struct
|
|
2996
|
-
"""
|
|
2997
|
-
...
|
|
2998
|
-
|
|
2999
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3000
|
-
"""
|
|
3001
|
-
|
|
3002
|
-
:return: The class or default when not found.
|
|
3003
|
-
:rtype: typing.Any
|
|
3004
|
-
"""
|
|
3005
|
-
...
|
|
3006
|
-
|
|
3007
|
-
def draw(self, context):
|
|
3008
|
-
"""
|
|
3009
|
-
|
|
3010
|
-
:param context:
|
|
3011
|
-
"""
|
|
3012
|
-
...
|
|
3013
|
-
|
|
3014
|
-
def draw_collapsible(self, context, layout):
|
|
3015
|
-
"""
|
|
3016
|
-
|
|
3017
|
-
:param context:
|
|
3018
|
-
:param layout:
|
|
3019
|
-
"""
|
|
3020
|
-
...
|
|
3021
|
-
|
|
3022
|
-
def draw_preset(self, _context):
|
|
3023
|
-
"""Define these on the subclass:
|
|
3024
|
-
- preset_operator (string)
|
|
3025
|
-
- preset_subdir (string)Optionally:
|
|
3026
|
-
- preset_add_operator (string)
|
|
3027
|
-
- preset_extensions (set of strings)
|
|
3028
|
-
- preset_operator_defaults (dict of keyword args)
|
|
3029
|
-
|
|
3030
|
-
:param _context:
|
|
3031
|
-
"""
|
|
3032
|
-
...
|
|
3033
|
-
|
|
3034
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3035
|
-
"""Adds driver(s) to the given property
|
|
3036
|
-
|
|
3037
|
-
:return: The driver(s) added.
|
|
3038
|
-
:rtype: bpy.types.FCurve
|
|
3039
|
-
"""
|
|
3040
|
-
...
|
|
3041
|
-
|
|
3042
|
-
def driver_remove(self) -> bool:
|
|
3043
|
-
"""Remove driver(s) from the given property
|
|
3044
|
-
|
|
3045
|
-
:return: Success of driver removal.
|
|
3046
|
-
:rtype: bool
|
|
3047
|
-
"""
|
|
3048
|
-
...
|
|
3049
|
-
|
|
3050
|
-
def get(self):
|
|
3051
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3052
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3053
|
-
|
|
3054
|
-
"""
|
|
3055
|
-
...
|
|
3056
|
-
|
|
3057
|
-
def id_properties_clear(self):
|
|
3058
|
-
"""
|
|
3059
|
-
|
|
3060
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3061
|
-
"""
|
|
3062
|
-
...
|
|
3063
|
-
|
|
3064
|
-
def id_properties_ensure(self):
|
|
3065
|
-
"""
|
|
3066
|
-
|
|
3067
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3068
|
-
"""
|
|
3069
|
-
...
|
|
3070
|
-
|
|
3071
|
-
def id_properties_ui(self):
|
|
3072
|
-
"""
|
|
3073
|
-
|
|
3074
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
3075
|
-
"""
|
|
3076
|
-
...
|
|
3077
|
-
|
|
3078
|
-
def is_extended(self): ...
|
|
3079
|
-
def is_property_hidden(self) -> bool:
|
|
3080
|
-
"""Check if a property is hidden.
|
|
3081
|
-
|
|
3082
|
-
:return: True when the property is hidden.
|
|
3083
|
-
:rtype: bool
|
|
3084
|
-
"""
|
|
3085
|
-
...
|
|
3086
|
-
|
|
3087
|
-
def is_property_overridable_library(self) -> bool:
|
|
3088
|
-
"""Check if a property is overridable.
|
|
3089
|
-
|
|
3090
|
-
:return: True when the property is overridable.
|
|
3091
|
-
:rtype: bool
|
|
3092
|
-
"""
|
|
3093
|
-
...
|
|
3094
|
-
|
|
3095
|
-
def is_property_readonly(self) -> bool:
|
|
3096
|
-
"""Check if a property is readonly.
|
|
3097
|
-
|
|
3098
|
-
:return: True when the property is readonly (not writable).
|
|
3099
|
-
:rtype: bool
|
|
3100
|
-
"""
|
|
3101
|
-
...
|
|
3102
|
-
|
|
3103
|
-
def is_property_set(self) -> bool:
|
|
3104
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3105
|
-
|
|
3106
|
-
:return: True when the property has been set.
|
|
3107
|
-
:rtype: bool
|
|
3108
|
-
"""
|
|
3109
|
-
...
|
|
3110
|
-
|
|
3111
|
-
def items(self):
|
|
3112
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3113
|
-
dictionary function of the same name).
|
|
3114
|
-
|
|
3115
|
-
:return: custom property key, value pairs.
|
|
3116
|
-
"""
|
|
3117
|
-
...
|
|
3118
|
-
|
|
3119
|
-
def keyframe_delete(self) -> bool:
|
|
3120
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3121
|
-
|
|
3122
|
-
:return: Success of keyframe deletion.
|
|
3123
|
-
:rtype: bool
|
|
3124
|
-
"""
|
|
3125
|
-
...
|
|
3126
|
-
|
|
3127
|
-
def keyframe_insert(self) -> bool:
|
|
3128
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3129
|
-
|
|
3130
|
-
:return: Success of keyframe insertion.
|
|
3131
|
-
:rtype: bool
|
|
3132
|
-
"""
|
|
3133
|
-
...
|
|
3134
|
-
|
|
3135
|
-
def keys(self):
|
|
3136
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3137
|
-
dictionary function of the same name).
|
|
3138
|
-
|
|
3139
|
-
:return: custom property keys.
|
|
3140
|
-
"""
|
|
3141
|
-
...
|
|
3142
|
-
|
|
3143
|
-
def path_from_id(self) -> str:
|
|
3144
|
-
"""Returns the data path from the ID to this object (string).
|
|
3145
|
-
|
|
3146
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3147
|
-
to this struct and property (when given).
|
|
3148
|
-
:rtype: str
|
|
3149
|
-
"""
|
|
3150
|
-
...
|
|
3151
|
-
|
|
3152
|
-
def path_menu(
|
|
3153
|
-
self,
|
|
3154
|
-
searchpaths: list[str],
|
|
3155
|
-
operator: str,
|
|
3156
|
-
*,
|
|
3157
|
-
props_default: dict = None,
|
|
3158
|
-
prop_filepath: str | None = "filepath",
|
|
3159
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
3160
|
-
filter_path=None,
|
|
3161
|
-
display_name: collections.abc.Callable | None = None,
|
|
3162
|
-
add_operator=None,
|
|
3163
|
-
add_operator_props=None,
|
|
3164
|
-
):
|
|
3165
|
-
"""Populate a menu from a list of paths.
|
|
3166
|
-
|
|
3167
|
-
:param searchpaths: Paths to scan.
|
|
3168
|
-
:type searchpaths: list[str]
|
|
3169
|
-
:param operator: The operator id to use with each file.
|
|
3170
|
-
:type operator: str
|
|
3171
|
-
:param props_default: Properties to assign to each operator.
|
|
3172
|
-
:type props_default: dict
|
|
3173
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3174
|
-
:type prop_filepath: str | None
|
|
3175
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
3176
|
-
|
|
3177
|
-
Returning false excludes the file from the list.
|
|
3178
|
-
:type filter_ext: collections.abc.Callable | None
|
|
3179
|
-
:param filter_path:
|
|
3180
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3181
|
-
:type display_name: collections.abc.Callable | None
|
|
3182
|
-
:param add_operator:
|
|
3183
|
-
:param add_operator_props:
|
|
3184
|
-
"""
|
|
3185
|
-
...
|
|
3186
|
-
|
|
3187
|
-
def path_resolve(self):
|
|
3188
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3189
|
-
...
|
|
3190
|
-
|
|
3191
|
-
def pop(self):
|
|
3192
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3193
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3194
|
-
|
|
3195
|
-
"""
|
|
3196
|
-
...
|
|
3197
|
-
|
|
3198
|
-
def prepend(self, draw_func):
|
|
3199
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3200
|
-
the menus draw function
|
|
3201
|
-
|
|
3202
|
-
:param draw_func:
|
|
3203
|
-
"""
|
|
3204
|
-
...
|
|
3205
|
-
|
|
3206
|
-
def property_overridable_library_set(self) -> bool:
|
|
3207
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3208
|
-
|
|
3209
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3210
|
-
:rtype: bool
|
|
3211
|
-
"""
|
|
3212
|
-
...
|
|
3213
|
-
|
|
3214
|
-
def property_unset(self):
|
|
3215
|
-
"""Unset a property, will use default value afterward."""
|
|
3216
|
-
...
|
|
3217
|
-
|
|
3218
|
-
def remove(self, draw_func):
|
|
3219
|
-
"""Remove a draw function that has been added to this menu
|
|
3220
|
-
|
|
3221
|
-
:param draw_func:
|
|
3222
|
-
"""
|
|
3223
|
-
...
|
|
3224
|
-
|
|
3225
|
-
def type_recast(self):
|
|
3226
|
-
"""Return a new instance, this is needed because types
|
|
3227
|
-
such as textures can be changed at runtime.
|
|
3228
|
-
|
|
3229
|
-
:return: a new instance of this object with the type initialized again.
|
|
3230
|
-
"""
|
|
3231
|
-
...
|
|
3232
|
-
|
|
3233
|
-
def values(self):
|
|
3234
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3235
|
-
dictionary function of the same name).
|
|
3236
|
-
|
|
3237
|
-
:return: custom property values.
|
|
3238
|
-
"""
|
|
3239
|
-
...
|
|
3240
|
-
|
|
3241
|
-
class OUTLINER_MT_view_pie(bpy_types._GenericUI):
|
|
3242
|
-
bl_label: typing.Any
|
|
3243
|
-
bl_rna: typing.Any
|
|
3244
|
-
id_data: typing.Any
|
|
3245
|
-
|
|
3246
|
-
def append(self, draw_func):
|
|
3247
|
-
"""Append a draw function to this menu,
|
|
3248
|
-
takes the same arguments as the menus draw function
|
|
3249
|
-
|
|
3250
|
-
:param draw_func:
|
|
3251
|
-
"""
|
|
3252
|
-
...
|
|
3253
|
-
|
|
3254
|
-
def as_pointer(self) -> int:
|
|
3255
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3256
|
-
|
|
3257
|
-
:return: int (memory address).
|
|
3258
|
-
:rtype: int
|
|
3259
|
-
"""
|
|
3260
|
-
...
|
|
3261
|
-
|
|
3262
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3263
|
-
"""
|
|
3264
|
-
|
|
3265
|
-
:return: The RNA type or default when not found.
|
|
3266
|
-
:rtype: bpy.types.Struct
|
|
3267
|
-
"""
|
|
3268
|
-
...
|
|
3269
|
-
|
|
3270
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3271
|
-
"""
|
|
3272
|
-
|
|
3273
|
-
:return: The class or default when not found.
|
|
3274
|
-
:rtype: typing.Any
|
|
3275
|
-
"""
|
|
3276
|
-
...
|
|
3277
|
-
|
|
3278
|
-
def draw(self, _context):
|
|
3279
|
-
"""
|
|
3280
|
-
|
|
3281
|
-
:param _context:
|
|
3282
|
-
"""
|
|
3283
|
-
...
|
|
3284
|
-
|
|
3285
|
-
def draw_collapsible(self, context, layout):
|
|
3286
|
-
"""
|
|
3287
|
-
|
|
3288
|
-
:param context:
|
|
3289
|
-
:param layout:
|
|
3290
|
-
"""
|
|
3291
|
-
...
|
|
3292
|
-
|
|
3293
|
-
def draw_preset(self, _context):
|
|
3294
|
-
"""Define these on the subclass:
|
|
3295
|
-
- preset_operator (string)
|
|
3296
|
-
- preset_subdir (string)Optionally:
|
|
3297
|
-
- preset_add_operator (string)
|
|
3298
|
-
- preset_extensions (set of strings)
|
|
3299
|
-
- preset_operator_defaults (dict of keyword args)
|
|
3300
|
-
|
|
3301
|
-
:param _context:
|
|
3302
|
-
"""
|
|
3303
|
-
...
|
|
3304
|
-
|
|
3305
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3306
|
-
"""Adds driver(s) to the given property
|
|
3307
|
-
|
|
3308
|
-
:return: The driver(s) added.
|
|
3309
|
-
:rtype: bpy.types.FCurve
|
|
3310
|
-
"""
|
|
3311
|
-
...
|
|
3312
|
-
|
|
3313
|
-
def driver_remove(self) -> bool:
|
|
3314
|
-
"""Remove driver(s) from the given property
|
|
3315
|
-
|
|
3316
|
-
:return: Success of driver removal.
|
|
3317
|
-
:rtype: bool
|
|
3318
|
-
"""
|
|
3319
|
-
...
|
|
3320
|
-
|
|
3321
|
-
def get(self):
|
|
3322
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3323
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3324
|
-
|
|
3325
|
-
"""
|
|
3326
|
-
...
|
|
3327
|
-
|
|
3328
|
-
def id_properties_clear(self):
|
|
3329
|
-
"""
|
|
3330
|
-
|
|
3331
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3332
|
-
"""
|
|
3333
|
-
...
|
|
3334
|
-
|
|
3335
|
-
def id_properties_ensure(self):
|
|
3336
|
-
"""
|
|
3337
|
-
|
|
3338
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3339
|
-
"""
|
|
3340
|
-
...
|
|
3341
|
-
|
|
3342
|
-
def id_properties_ui(self):
|
|
3343
|
-
"""
|
|
3344
|
-
|
|
3345
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
3346
|
-
"""
|
|
3347
|
-
...
|
|
3348
|
-
|
|
3349
|
-
def is_extended(self): ...
|
|
3350
|
-
def is_property_hidden(self) -> bool:
|
|
3351
|
-
"""Check if a property is hidden.
|
|
3352
|
-
|
|
3353
|
-
:return: True when the property is hidden.
|
|
3354
|
-
:rtype: bool
|
|
3355
|
-
"""
|
|
3356
|
-
...
|
|
3357
|
-
|
|
3358
|
-
def is_property_overridable_library(self) -> bool:
|
|
3359
|
-
"""Check if a property is overridable.
|
|
3360
|
-
|
|
3361
|
-
:return: True when the property is overridable.
|
|
3362
|
-
:rtype: bool
|
|
3363
|
-
"""
|
|
3364
|
-
...
|
|
3365
|
-
|
|
3366
|
-
def is_property_readonly(self) -> bool:
|
|
3367
|
-
"""Check if a property is readonly.
|
|
3368
|
-
|
|
3369
|
-
:return: True when the property is readonly (not writable).
|
|
3370
|
-
:rtype: bool
|
|
3371
|
-
"""
|
|
3372
|
-
...
|
|
3373
|
-
|
|
3374
|
-
def is_property_set(self) -> bool:
|
|
3375
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3376
|
-
|
|
3377
|
-
:return: True when the property has been set.
|
|
3378
|
-
:rtype: bool
|
|
3379
|
-
"""
|
|
3380
|
-
...
|
|
3381
|
-
|
|
3382
|
-
def items(self):
|
|
3383
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3384
|
-
dictionary function of the same name).
|
|
3385
|
-
|
|
3386
|
-
:return: custom property key, value pairs.
|
|
3387
|
-
"""
|
|
3388
|
-
...
|
|
3389
|
-
|
|
3390
|
-
def keyframe_delete(self) -> bool:
|
|
3391
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3392
|
-
|
|
3393
|
-
:return: Success of keyframe deletion.
|
|
3394
|
-
:rtype: bool
|
|
3395
|
-
"""
|
|
3396
|
-
...
|
|
3397
|
-
|
|
3398
|
-
def keyframe_insert(self) -> bool:
|
|
3399
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3400
|
-
|
|
3401
|
-
:return: Success of keyframe insertion.
|
|
3402
|
-
:rtype: bool
|
|
3403
|
-
"""
|
|
3404
|
-
...
|
|
3405
|
-
|
|
3406
|
-
def keys(self):
|
|
3407
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3408
|
-
dictionary function of the same name).
|
|
3409
|
-
|
|
3410
|
-
:return: custom property keys.
|
|
3411
|
-
"""
|
|
3412
|
-
...
|
|
3413
|
-
|
|
3414
|
-
def path_from_id(self) -> str:
|
|
3415
|
-
"""Returns the data path from the ID to this object (string).
|
|
3416
|
-
|
|
3417
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3418
|
-
to this struct and property (when given).
|
|
3419
|
-
:rtype: str
|
|
3420
|
-
"""
|
|
3421
|
-
...
|
|
3422
|
-
|
|
3423
|
-
def path_menu(
|
|
3424
|
-
self,
|
|
3425
|
-
searchpaths: list[str],
|
|
3426
|
-
operator: str,
|
|
3427
|
-
*,
|
|
3428
|
-
props_default: dict = None,
|
|
3429
|
-
prop_filepath: str | None = "filepath",
|
|
3430
|
-
filter_ext: collections.abc.Callable | None = None,
|
|
3431
|
-
filter_path=None,
|
|
3432
|
-
display_name: collections.abc.Callable | None = None,
|
|
3433
|
-
add_operator=None,
|
|
3434
|
-
add_operator_props=None,
|
|
3435
|
-
):
|
|
3436
|
-
"""Populate a menu from a list of paths.
|
|
3437
|
-
|
|
3438
|
-
:param searchpaths: Paths to scan.
|
|
3439
|
-
:type searchpaths: list[str]
|
|
3440
|
-
:param operator: The operator id to use with each file.
|
|
3441
|
-
:type operator: str
|
|
3442
|
-
:param props_default: Properties to assign to each operator.
|
|
3443
|
-
:type props_default: dict
|
|
3444
|
-
:param prop_filepath: Optional operator filepath property (defaults to "filepath").
|
|
3445
|
-
:type prop_filepath: str | None
|
|
3446
|
-
:param filter_ext: Optional callback that takes the file extensions.
|
|
3447
|
-
|
|
3448
|
-
Returning false excludes the file from the list.
|
|
3449
|
-
:type filter_ext: collections.abc.Callable | None
|
|
3450
|
-
:param filter_path:
|
|
3451
|
-
:param display_name: Optional callback that takes the full path, returns the name to display.
|
|
3452
|
-
:type display_name: collections.abc.Callable | None
|
|
3453
|
-
:param add_operator:
|
|
3454
|
-
:param add_operator_props:
|
|
3455
|
-
"""
|
|
3456
|
-
...
|
|
3457
|
-
|
|
3458
|
-
def path_resolve(self):
|
|
3459
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3460
|
-
...
|
|
3461
|
-
|
|
3462
|
-
def pop(self):
|
|
3463
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3464
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3465
|
-
|
|
3466
|
-
"""
|
|
3467
|
-
...
|
|
3468
|
-
|
|
3469
|
-
def prepend(self, draw_func):
|
|
3470
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3471
|
-
the menus draw function
|
|
3472
|
-
|
|
3473
|
-
:param draw_func:
|
|
3474
|
-
"""
|
|
3475
|
-
...
|
|
3476
|
-
|
|
3477
|
-
def property_overridable_library_set(self) -> bool:
|
|
3478
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3479
|
-
|
|
3480
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3481
|
-
:rtype: bool
|
|
3482
|
-
"""
|
|
3483
|
-
...
|
|
3484
|
-
|
|
3485
|
-
def property_unset(self):
|
|
3486
|
-
"""Unset a property, will use default value afterward."""
|
|
3487
|
-
...
|
|
3488
|
-
|
|
3489
|
-
def remove(self, draw_func):
|
|
3490
|
-
"""Remove a draw function that has been added to this menu
|
|
3491
|
-
|
|
3492
|
-
:param draw_func:
|
|
3493
|
-
"""
|
|
3494
|
-
...
|
|
3495
|
-
|
|
3496
|
-
def type_recast(self):
|
|
3497
|
-
"""Return a new instance, this is needed because types
|
|
3498
|
-
such as textures can be changed at runtime.
|
|
3499
|
-
|
|
3500
|
-
:return: a new instance of this object with the type initialized again.
|
|
3501
|
-
"""
|
|
3502
|
-
...
|
|
3503
|
-
|
|
3504
|
-
def values(self):
|
|
3505
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3506
|
-
dictionary function of the same name).
|
|
3507
|
-
|
|
3508
|
-
:return: custom property values.
|
|
3509
|
-
"""
|
|
3510
|
-
...
|
|
3511
|
-
|
|
3512
|
-
class OUTLINER_PT_filter(bpy_types._GenericUI):
|
|
3513
|
-
bl_label: typing.Any
|
|
3514
|
-
bl_region_type: typing.Any
|
|
3515
|
-
bl_rna: typing.Any
|
|
3516
|
-
bl_space_type: typing.Any
|
|
3517
|
-
id_data: typing.Any
|
|
3518
|
-
|
|
3519
|
-
def append(self, draw_func):
|
|
3520
|
-
"""Append a draw function to this menu,
|
|
3521
|
-
takes the same arguments as the menus draw function
|
|
3522
|
-
|
|
3523
|
-
:param draw_func:
|
|
3524
|
-
"""
|
|
3525
|
-
...
|
|
3526
|
-
|
|
3527
|
-
def as_pointer(self) -> int:
|
|
3528
|
-
"""Returns the memory address which holds a pointer to Blender's internal data
|
|
3529
|
-
|
|
3530
|
-
:return: int (memory address).
|
|
3531
|
-
:rtype: int
|
|
3532
|
-
"""
|
|
3533
|
-
...
|
|
3534
|
-
|
|
3535
|
-
def bl_rna_get_subclass(self) -> bpy.types.Struct:
|
|
3536
|
-
"""
|
|
3537
|
-
|
|
3538
|
-
:return: The RNA type or default when not found.
|
|
3539
|
-
:rtype: bpy.types.Struct
|
|
3540
|
-
"""
|
|
3541
|
-
...
|
|
3542
|
-
|
|
3543
|
-
def bl_rna_get_subclass_py(self) -> typing.Any:
|
|
3544
|
-
"""
|
|
3545
|
-
|
|
3546
|
-
:return: The class or default when not found.
|
|
3547
|
-
:rtype: typing.Any
|
|
3548
|
-
"""
|
|
3549
|
-
...
|
|
3550
|
-
|
|
3551
|
-
def draw(self, context):
|
|
431
|
+
def draw(self, context):
|
|
3552
432
|
"""
|
|
3553
433
|
|
|
3554
434
|
:param context:
|
|
3555
435
|
"""
|
|
3556
436
|
...
|
|
3557
437
|
|
|
3558
|
-
def driver_add(self) -> bpy.types.FCurve:
|
|
3559
|
-
"""Adds driver(s) to the given property
|
|
3560
|
-
|
|
3561
|
-
:return: The driver(s) added.
|
|
3562
|
-
:rtype: bpy.types.FCurve
|
|
3563
|
-
"""
|
|
3564
|
-
...
|
|
3565
|
-
|
|
3566
|
-
def driver_remove(self) -> bool:
|
|
3567
|
-
"""Remove driver(s) from the given property
|
|
3568
|
-
|
|
3569
|
-
:return: Success of driver removal.
|
|
3570
|
-
:rtype: bool
|
|
3571
|
-
"""
|
|
3572
|
-
...
|
|
3573
|
-
|
|
3574
|
-
def get(self):
|
|
3575
|
-
"""Returns the value of the custom property assigned to key or default
|
|
3576
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3577
|
-
|
|
3578
|
-
"""
|
|
3579
|
-
...
|
|
3580
|
-
|
|
3581
|
-
def id_properties_clear(self):
|
|
3582
|
-
"""
|
|
3583
|
-
|
|
3584
|
-
:return: Remove the parent group for an RNA struct's custom IDProperties.
|
|
3585
|
-
"""
|
|
3586
|
-
...
|
|
3587
|
-
|
|
3588
|
-
def id_properties_ensure(self):
|
|
3589
|
-
"""
|
|
3590
|
-
|
|
3591
|
-
:return: the parent group for an RNA struct's custom IDProperties.
|
|
3592
|
-
"""
|
|
3593
|
-
...
|
|
3594
|
-
|
|
3595
|
-
def id_properties_ui(self):
|
|
3596
|
-
"""
|
|
3597
|
-
|
|
3598
|
-
:return: Return an object used to manage an IDProperty's UI data.
|
|
3599
|
-
"""
|
|
3600
|
-
...
|
|
3601
|
-
|
|
3602
|
-
def is_extended(self): ...
|
|
3603
|
-
def is_property_hidden(self) -> bool:
|
|
3604
|
-
"""Check if a property is hidden.
|
|
3605
|
-
|
|
3606
|
-
:return: True when the property is hidden.
|
|
3607
|
-
:rtype: bool
|
|
3608
|
-
"""
|
|
3609
|
-
...
|
|
3610
|
-
|
|
3611
|
-
def is_property_overridable_library(self) -> bool:
|
|
3612
|
-
"""Check if a property is overridable.
|
|
3613
|
-
|
|
3614
|
-
:return: True when the property is overridable.
|
|
3615
|
-
:rtype: bool
|
|
3616
|
-
"""
|
|
3617
|
-
...
|
|
3618
|
-
|
|
3619
|
-
def is_property_readonly(self) -> bool:
|
|
3620
|
-
"""Check if a property is readonly.
|
|
3621
|
-
|
|
3622
|
-
:return: True when the property is readonly (not writable).
|
|
3623
|
-
:rtype: bool
|
|
3624
|
-
"""
|
|
3625
|
-
...
|
|
3626
|
-
|
|
3627
|
-
def is_property_set(self) -> bool:
|
|
3628
|
-
"""Check if a property is set, use for testing operator properties.
|
|
3629
|
-
|
|
3630
|
-
:return: True when the property has been set.
|
|
3631
|
-
:rtype: bool
|
|
3632
|
-
"""
|
|
3633
|
-
...
|
|
3634
|
-
|
|
3635
|
-
def items(self):
|
|
3636
|
-
"""Returns the items of this objects custom properties (matches Python's
|
|
3637
|
-
dictionary function of the same name).
|
|
3638
|
-
|
|
3639
|
-
:return: custom property key, value pairs.
|
|
3640
|
-
"""
|
|
3641
|
-
...
|
|
3642
|
-
|
|
3643
|
-
def keyframe_delete(self) -> bool:
|
|
3644
|
-
"""Remove a keyframe from this properties fcurve.
|
|
3645
|
-
|
|
3646
|
-
:return: Success of keyframe deletion.
|
|
3647
|
-
:rtype: bool
|
|
3648
|
-
"""
|
|
3649
|
-
...
|
|
3650
|
-
|
|
3651
|
-
def keyframe_insert(self) -> bool:
|
|
3652
|
-
"""Insert a keyframe on the property given, adding fcurves and animation data when necessary.
|
|
3653
|
-
|
|
3654
|
-
:return: Success of keyframe insertion.
|
|
3655
|
-
:rtype: bool
|
|
3656
|
-
"""
|
|
3657
|
-
...
|
|
3658
|
-
|
|
3659
|
-
def keys(self):
|
|
3660
|
-
"""Returns the keys of this objects custom properties (matches Python's
|
|
3661
|
-
dictionary function of the same name).
|
|
3662
|
-
|
|
3663
|
-
:return: custom property keys.
|
|
3664
|
-
"""
|
|
3665
|
-
...
|
|
3666
|
-
|
|
3667
|
-
def path_from_id(self) -> str:
|
|
3668
|
-
"""Returns the data path from the ID to this object (string).
|
|
3669
|
-
|
|
3670
|
-
:return: The path from `bpy.types.bpy_struct.id_data`
|
|
3671
|
-
to this struct and property (when given).
|
|
3672
|
-
:rtype: str
|
|
3673
|
-
"""
|
|
3674
|
-
...
|
|
3675
|
-
|
|
3676
|
-
def path_resolve(self):
|
|
3677
|
-
"""Returns the property from the path, raise an exception when not found."""
|
|
3678
|
-
...
|
|
3679
|
-
|
|
3680
|
-
def pop(self):
|
|
3681
|
-
"""Remove and return the value of the custom property assigned to key or default
|
|
3682
|
-
when not found (matches Python's dictionary function of the same name).
|
|
3683
|
-
|
|
3684
|
-
"""
|
|
3685
|
-
...
|
|
3686
|
-
|
|
3687
|
-
def prepend(self, draw_func):
|
|
3688
|
-
"""Prepend a draw function to this menu, takes the same arguments as
|
|
3689
|
-
the menus draw function
|
|
3690
|
-
|
|
3691
|
-
:param draw_func:
|
|
3692
|
-
"""
|
|
3693
|
-
...
|
|
3694
|
-
|
|
3695
|
-
def property_overridable_library_set(self) -> bool:
|
|
3696
|
-
"""Define a property as overridable or not (only for custom properties!).
|
|
3697
|
-
|
|
3698
|
-
:return: True when the overridable status of the property was successfully set.
|
|
3699
|
-
:rtype: bool
|
|
3700
|
-
"""
|
|
3701
|
-
...
|
|
3702
|
-
|
|
3703
|
-
def property_unset(self):
|
|
3704
|
-
"""Unset a property, will use default value afterward."""
|
|
3705
|
-
...
|
|
3706
|
-
|
|
3707
|
-
def remove(self, draw_func):
|
|
3708
|
-
"""Remove a draw function that has been added to this menu
|
|
3709
|
-
|
|
3710
|
-
:param draw_func:
|
|
3711
|
-
"""
|
|
3712
|
-
...
|
|
3713
|
-
|
|
3714
|
-
def type_recast(self):
|
|
3715
|
-
"""Return a new instance, this is needed because types
|
|
3716
|
-
such as textures can be changed at runtime.
|
|
3717
|
-
|
|
3718
|
-
:return: a new instance of this object with the type initialized again.
|
|
3719
|
-
"""
|
|
3720
|
-
...
|
|
3721
|
-
|
|
3722
|
-
def values(self):
|
|
3723
|
-
"""Returns the values of this objects custom properties (matches Python's
|
|
3724
|
-
dictionary function of the same name).
|
|
3725
|
-
|
|
3726
|
-
:return: custom property values.
|
|
3727
|
-
"""
|
|
3728
|
-
...
|
|
3729
|
-
|
|
3730
438
|
def has_selected_ids_in_context(context): ...
|