fake-bpy-module 20240717__py3-none-any.whl → 20240719__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

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