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