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