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