fake-bpy-module 20241004__py3-none-any.whl → 20241009__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.

@@ -1,33 +1,7 @@
1
1
  import typing
2
2
  import collections.abc
3
3
  import typing_extensions
4
- import bpy.ops.transform
5
4
  import bpy.types
6
- import mathutils
7
-
8
- def active_frame_delete(
9
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
10
- execution_context: int | str | None = None,
11
- undo: bool | None = None,
12
- ):
13
- """Delete the active frame for the active Grease Pencil Layer
14
-
15
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
16
- :type execution_context: int | str | None
17
- :type undo: bool | None
18
- """
19
-
20
- def active_frames_delete_all(
21
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
22
- execution_context: int | str | None = None,
23
- undo: bool | None = None,
24
- ):
25
- """Delete the active frame(s) of all editable Grease Pencil layers
26
-
27
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
28
- :type execution_context: int | str | None
29
- :type undo: bool | None
30
- """
31
5
 
32
6
  def annotate(
33
7
  override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
@@ -140,247 +114,6 @@ def annotation_add(
140
114
  :type undo: bool | None
141
115
  """
142
116
 
143
- def bake_grease_pencil_animation(
144
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
145
- execution_context: int | str | None = None,
146
- undo: bool | None = None,
147
- *,
148
- frame_start: int | None = 1,
149
- frame_end: int | None = 250,
150
- step: int | None = 1,
151
- only_selected: bool | None = False,
152
- frame_target: int | None = 1,
153
- project_type: typing.Literal["KEEP", "FRONT", "SIDE", "TOP", "VIEW", "CURSOR"]
154
- | None = "KEEP",
155
- ):
156
- """Bake grease pencil object transform to grease pencil keyframes
157
-
158
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
159
- :type execution_context: int | str | None
160
- :type undo: bool | None
161
- :param frame_start: Start Frame, The start frame
162
- :type frame_start: int | None
163
- :param frame_end: End Frame, The end frame of animation
164
- :type frame_end: int | None
165
- :param step: Step, Step between generated frames
166
- :type step: int | None
167
- :param only_selected: Only Selected Keyframes, Convert only selected keyframes
168
- :type only_selected: bool | None
169
- :param frame_target: Target Frame, Destination frame
170
- :type frame_target: int | None
171
- :param project_type: Projection Type
172
-
173
- KEEP
174
- No Reproject.
175
-
176
- FRONT
177
- Front -- Reproject the strokes using the X-Z plane.
178
-
179
- SIDE
180
- Side -- Reproject the strokes using the Y-Z plane.
181
-
182
- TOP
183
- Top -- Reproject the strokes using the X-Y plane.
184
-
185
- VIEW
186
- View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using 'Cursor' Stroke Placement.
187
-
188
- CURSOR
189
- Cursor -- Reproject the strokes using the orientation of 3D cursor.
190
- :type project_type: typing.Literal['KEEP','FRONT','SIDE','TOP','VIEW','CURSOR'] | None
191
- """
192
-
193
- def bake_mesh_animation(
194
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
195
- execution_context: int | str | None = None,
196
- undo: bool | None = None,
197
- *,
198
- target: typing.Literal["NEW", "SELECTED"] | None = "NEW",
199
- frame_start: int | None = 1,
200
- frame_end: int | None = 250,
201
- step: int | None = 1,
202
- thickness: int | None = 1,
203
- angle: float | None = 1.22173,
204
- offset: float | None = 0.001,
205
- seams: bool | None = False,
206
- faces: bool | None = True,
207
- only_selected: bool | None = False,
208
- frame_target: int | None = 1,
209
- project_type: typing.Literal["KEEP", "FRONT", "SIDE", "TOP", "VIEW", "CURSOR"]
210
- | None = "VIEW",
211
- ):
212
- """Bake mesh animation to grease pencil strokes
213
-
214
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
215
- :type execution_context: int | str | None
216
- :type undo: bool | None
217
- :param target: Target Object, Target grease pencil
218
- :type target: typing.Literal['NEW','SELECTED'] | None
219
- :param frame_start: Start Frame, The start frame
220
- :type frame_start: int | None
221
- :param frame_end: End Frame, The end frame of animation
222
- :type frame_end: int | None
223
- :param step: Step, Step between generated frames
224
- :type step: int | None
225
- :param thickness: Thickness
226
- :type thickness: int | None
227
- :param angle: Threshold Angle, Threshold to determine ends of the strokes
228
- :type angle: float | None
229
- :param offset: Stroke Offset, Offset strokes from fill
230
- :type offset: float | None
231
- :param seams: Only Seam Edges, Convert only seam edges
232
- :type seams: bool | None
233
- :param faces: Export Faces, Export faces as filled strokes
234
- :type faces: bool | None
235
- :param only_selected: Only Selected Keyframes, Convert only selected keyframes
236
- :type only_selected: bool | None
237
- :param frame_target: Target Frame, Destination frame
238
- :type frame_target: int | None
239
- :param project_type: Projection Type
240
-
241
- KEEP
242
- No Reproject.
243
-
244
- FRONT
245
- Front -- Reproject the strokes using the X-Z plane.
246
-
247
- SIDE
248
- Side -- Reproject the strokes using the Y-Z plane.
249
-
250
- TOP
251
- Top -- Reproject the strokes using the X-Y plane.
252
-
253
- VIEW
254
- View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using 'Cursor' Stroke Placement.
255
-
256
- CURSOR
257
- Cursor -- Reproject the strokes using the orientation of 3D cursor.
258
- :type project_type: typing.Literal['KEEP','FRONT','SIDE','TOP','VIEW','CURSOR'] | None
259
- """
260
-
261
- def blank_frame_add(
262
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
263
- execution_context: int | str | None = None,
264
- undo: bool | None = None,
265
- *,
266
- all_layers: bool | None = False,
267
- ):
268
- """Insert a blank frame on the current frame (all subsequently existing frames, if any, are shifted right by one frame)
269
-
270
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
271
- :type execution_context: int | str | None
272
- :type undo: bool | None
273
- :param all_layers: All Layers, Create blank frame in all layers, not only active
274
- :type all_layers: bool | None
275
- """
276
-
277
- def convert(
278
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
279
- execution_context: int | str | None = None,
280
- undo: bool | None = None,
281
- *,
282
- type: typing.Literal["PATH", "CURVE", "POLY"] | None = "PATH",
283
- bevel_depth: float | None = 0.0,
284
- bevel_resolution: int | None = 0,
285
- use_normalize_weights: bool | None = True,
286
- radius_multiplier: float | None = 1.0,
287
- use_link_strokes: bool | None = False,
288
- timing_mode: typing.Literal["NONE", "LINEAR", "FULL", "CUSTOMGAP"] | None = "FULL",
289
- frame_range: int | None = 100,
290
- start_frame: int | None = 1,
291
- use_realtime: bool | None = False,
292
- end_frame: int | None = 250,
293
- gap_duration: float | None = 0.0,
294
- gap_randomness: float | None = 0.0,
295
- seed: int | None = 0,
296
- use_timing_data: bool | None = False,
297
- ):
298
- """Convert the active Grease Pencil layer to a new Curve Object
299
-
300
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
301
- :type execution_context: int | str | None
302
- :type undo: bool | None
303
- :param type: Type, Which type of curve to convert to
304
-
305
- PATH
306
- Path -- Animation path.
307
-
308
- CURVE
309
- Bézier Curve -- Smooth Bézier curve.
310
-
311
- POLY
312
- Polygon Curve -- Bézier curve with straight-line segments (vector handles).
313
- :type type: typing.Literal['PATH','CURVE','POLY'] | None
314
- :param bevel_depth: Bevel Depth
315
- :type bevel_depth: float | None
316
- :param bevel_resolution: Bevel Resolution, Bevel resolution when depth is non-zero
317
- :type bevel_resolution: int | None
318
- :param use_normalize_weights: Normalize Weight, Normalize weight (set from stroke width)
319
- :type use_normalize_weights: bool | None
320
- :param radius_multiplier: Radius Factor, Multiplier for the points' radii (set from stroke width)
321
- :type radius_multiplier: float | None
322
- :param use_link_strokes: Link Strokes, Whether to link strokes with zero-radius sections of curves
323
- :type use_link_strokes: bool | None
324
- :param timing_mode: Timing Mode, How to use timing data stored in strokes
325
-
326
- NONE
327
- No Timing -- Ignore timing.
328
-
329
- LINEAR
330
- Linear -- Simple linear timing.
331
-
332
- FULL
333
- Original -- Use the original timing, gaps included.
334
-
335
- CUSTOMGAP
336
- Custom Gaps -- Use the original timing, but with custom gap lengths (in frames).
337
- :type timing_mode: typing.Literal['NONE','LINEAR','FULL','CUSTOMGAP'] | None
338
- :param frame_range: Frame Range, The duration of evaluation of the path control curve
339
- :type frame_range: int | None
340
- :param start_frame: Start Frame, The start frame of the path control curve
341
- :type start_frame: int | None
342
- :param use_realtime: Realtime, Whether the path control curve reproduces the drawing in realtime, starting from Start Frame
343
- :type use_realtime: bool | None
344
- :param end_frame: End Frame, The end frame of the path control curve (if Realtime is not set)
345
- :type end_frame: int | None
346
- :param gap_duration: Gap Duration, Custom Gap mode: (Average) length of gaps, in frames (Note: Realtime value, will be scaled if Realtime is not set)
347
- :type gap_duration: float | None
348
- :param gap_randomness: Gap Randomness, Custom Gap mode: Number of frames that gap lengths can vary
349
- :type gap_randomness: float | None
350
- :param seed: Random Seed, Custom Gap mode: Random generator seed
351
- :type seed: int | None
352
- :param use_timing_data: Has Valid Timing, Whether the converted Grease Pencil layer has valid timing data (internal use)
353
- :type use_timing_data: bool | None
354
- """
355
-
356
- def convert_old_files(
357
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
358
- execution_context: int | str | None = None,
359
- undo: bool | None = None,
360
- *,
361
- annotation: bool | None = False,
362
- ):
363
- """Convert 2.7x grease pencil files to 2.80
364
-
365
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
366
- :type execution_context: int | str | None
367
- :type undo: bool | None
368
- :param annotation: Annotation, Convert to Annotations
369
- :type annotation: bool | None
370
- """
371
-
372
- def copy(
373
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
374
- execution_context: int | str | None = None,
375
- undo: bool | None = None,
376
- ):
377
- """Copy selected Grease Pencil points and strokes
378
-
379
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
380
- :type execution_context: int | str | None
381
- :type undo: bool | None
382
- """
383
-
384
117
  def data_unlink(
385
118
  override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
386
119
  execution_context: int | str | None = None,
@@ -393,2208 +126,47 @@ def data_unlink(
393
126
  :type undo: bool | None
394
127
  """
395
128
 
396
- def delete(
397
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
398
- execution_context: int | str | None = None,
399
- undo: bool | None = None,
400
- *,
401
- type: typing.Literal["POINTS", "STROKES", "FRAME"] | None = "POINTS",
402
- ):
403
- """Delete selected Grease Pencil strokes, vertices, or frames
404
-
405
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
406
- :type execution_context: int | str | None
407
- :type undo: bool | None
408
- :param type: Type, Method used for deleting Grease Pencil data
409
-
410
- POINTS
411
- Points -- Delete selected points and split strokes into segments.
412
-
413
- STROKES
414
- Strokes -- Delete selected strokes.
415
-
416
- FRAME
417
- Frame -- Delete active frame.
418
- :type type: typing.Literal['POINTS','STROKES','FRAME'] | None
419
- """
420
-
421
- def dissolve(
422
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
423
- execution_context: int | str | None = None,
424
- undo: bool | None = None,
425
- *,
426
- type: typing.Literal["POINTS", "BETWEEN", "UNSELECT"] | None = "POINTS",
427
- ):
428
- """Delete selected points without splitting strokes
429
-
430
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
431
- :type execution_context: int | str | None
432
- :type undo: bool | None
433
- :param type: Type, Method used for dissolving stroke points
434
-
435
- POINTS
436
- Dissolve -- Dissolve selected points.
437
-
438
- BETWEEN
439
- Dissolve Between -- Dissolve points between selected points.
440
-
441
- UNSELECT
442
- Dissolve Unselect -- Dissolve all unselected points.
443
- :type type: typing.Literal['POINTS','BETWEEN','UNSELECT'] | None
444
- """
445
-
446
- def draw(
447
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
448
- execution_context: int | str | None = None,
449
- undo: bool | None = None,
450
- *,
451
- mode: typing.Literal["DRAW", "DRAW_STRAIGHT", "ERASER"] | None = "DRAW",
452
- stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
453
- | None = None,
454
- wait_for_input: bool | None = True,
455
- disable_straight: bool | None = False,
456
- disable_fill: bool | None = False,
457
- disable_stabilizer: bool | None = False,
458
- guide_last_angle: float | None = 0.0,
459
- ):
460
- """Draw a new stroke in the active Grease Pencil object
461
-
462
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
463
- :type execution_context: int | str | None
464
- :type undo: bool | None
465
- :param mode: Mode, Way to interpret mouse movements
466
-
467
- DRAW
468
- Draw Freehand -- Draw freehand stroke(s).
469
-
470
- DRAW_STRAIGHT
471
- Draw Straight Lines -- Draw straight line segment(s).
472
-
473
- ERASER
474
- Eraser -- Erase Grease Pencil strokes.
475
- :type mode: typing.Literal['DRAW','DRAW_STRAIGHT','ERASER'] | None
476
- :param stroke: Stroke
477
- :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
478
- :param wait_for_input: Wait for Input, Wait for first click instead of painting immediately
479
- :type wait_for_input: bool | None
480
- :param disable_straight: No Straight lines, Disable key for straight lines
481
- :type disable_straight: bool | None
482
- :param disable_fill: No Fill Areas, Disable fill to use stroke as fill boundary
483
- :type disable_fill: bool | None
484
- :param disable_stabilizer: No Stabilizer
485
- :type disable_stabilizer: bool | None
486
- :param guide_last_angle: Angle, Speed guide angle
487
- :type guide_last_angle: float | None
488
- """
489
-
490
- def duplicate(
491
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
492
- execution_context: int | str | None = None,
493
- undo: bool | None = None,
494
- ):
495
- """Duplicate the selected Grease Pencil strokes
496
-
497
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
498
- :type execution_context: int | str | None
499
- :type undo: bool | None
500
- """
501
-
502
- def duplicate_move(
503
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
504
- execution_context: int | str | None = None,
505
- undo: bool | None = None,
506
- *,
507
- GPENCIL_OT_duplicate: duplicate | None = None,
508
- TRANSFORM_OT_translate: bpy.ops.transform.translate | None = None,
509
- ):
510
- """Make copies of the selected Grease Pencil strokes and move them
511
-
512
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
513
- :type execution_context: int | str | None
514
- :type undo: bool | None
515
- :param GPENCIL_OT_duplicate: Duplicate Strokes, Duplicate the selected Grease Pencil strokes
516
- :type GPENCIL_OT_duplicate: duplicate | None
517
- :param TRANSFORM_OT_translate: Move, Move selected items
518
- :type TRANSFORM_OT_translate: bpy.ops.transform.translate | None
519
- """
520
-
521
- def editmode_toggle(
522
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
523
- execution_context: int | str | None = None,
524
- undo: bool | None = None,
525
- *,
526
- back: bool | None = False,
527
- ):
528
- """Enter/Exit edit mode for Grease Pencil strokes
529
-
530
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
531
- :type execution_context: int | str | None
532
- :type undo: bool | None
533
- :param back: Return to Previous Mode, Return to previous mode
534
- :type back: bool | None
535
- """
536
-
537
- def extract_palette_vertex(
538
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
539
- execution_context: int | str | None = None,
540
- undo: bool | None = None,
541
- *,
542
- selected: bool | None = False,
543
- threshold: int | None = 1,
544
- ):
545
- """Extract all colors used in Grease Pencil Vertex and create a Palette
546
-
547
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
548
- :type execution_context: int | str | None
549
- :type undo: bool | None
550
- :param selected: Only Selected, Convert only selected strokes
551
- :type selected: bool | None
552
- :param threshold: Threshold
553
- :type threshold: int | None
554
- """
555
-
556
- def extrude(
557
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
558
- execution_context: int | str | None = None,
559
- undo: bool | None = None,
560
- ):
561
- """Extrude the selected Grease Pencil points
562
-
563
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
564
- :type execution_context: int | str | None
565
- :type undo: bool | None
566
- """
567
-
568
- def extrude_move(
569
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
570
- execution_context: int | str | None = None,
571
- undo: bool | None = None,
572
- *,
573
- GPENCIL_OT_extrude: extrude | None = None,
574
- TRANSFORM_OT_translate: bpy.ops.transform.translate | None = None,
575
- ):
576
- """Extrude selected points and move them
577
-
578
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
579
- :type execution_context: int | str | None
580
- :type undo: bool | None
581
- :param GPENCIL_OT_extrude: Extrude Stroke Points, Extrude the selected Grease Pencil points
582
- :type GPENCIL_OT_extrude: extrude | None
583
- :param TRANSFORM_OT_translate: Move, Move selected items
584
- :type TRANSFORM_OT_translate: bpy.ops.transform.translate | None
585
- """
586
-
587
- def fill(
129
+ def layer_annotation_add(
588
130
  override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
589
131
  execution_context: int | str | None = None,
590
132
  undo: bool | None = None,
591
- *,
592
- on_back: bool | None = False,
593
133
  ):
594
- """Fill with color the shape formed by strokes
134
+ """Add new Annotation layer or note for the active data-block
595
135
 
596
136
  :type override_context: bpy.types.Context | dict[str, typing.Any] | None
597
137
  :type execution_context: int | str | None
598
138
  :type undo: bool | None
599
- :param on_back: Draw on Back, Send new stroke to back
600
- :type on_back: bool | None
601
139
  """
602
140
 
603
- def frame_clean_duplicate(
141
+ def layer_annotation_move(
604
142
  override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
605
143
  execution_context: int | str | None = None,
606
144
  undo: bool | None = None,
607
145
  *,
608
- type: typing.Literal["ALL", "SELECTED"] | None = "ALL",
146
+ type: typing.Literal["UP", "DOWN"] | None = "UP",
609
147
  ):
610
- """Remove duplicate keyframes
148
+ """Move the active Annotation layer up/down in the list
611
149
 
612
150
  :type override_context: bpy.types.Context | dict[str, typing.Any] | None
613
151
  :type execution_context: int | str | None
614
152
  :type undo: bool | None
615
153
  :param type: Type
616
- :type type: typing.Literal['ALL','SELECTED'] | None
617
- """
618
-
619
- def frame_clean_fill(
620
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
621
- execution_context: int | str | None = None,
622
- undo: bool | None = None,
623
- *,
624
- mode: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
625
- ):
626
- """Remove 'no fill' boundary strokes
627
-
628
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
629
- :type execution_context: int | str | None
630
- :type undo: bool | None
631
- :param mode: Mode
632
-
633
- ACTIVE
634
- Active Frame Only -- Clean active frame only.
635
-
636
- ALL
637
- All Frames -- Clean all frames in all layers.
638
- :type mode: typing.Literal['ACTIVE','ALL'] | None
154
+ :type type: typing.Literal['UP','DOWN'] | None
639
155
  """
640
156
 
641
- def frame_clean_loose(
157
+ def layer_annotation_remove(
642
158
  override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
643
159
  execution_context: int | str | None = None,
644
160
  undo: bool | None = None,
645
- *,
646
- limit: int | None = 1,
647
161
  ):
648
- """Remove loose points
162
+ """Remove active Annotation layer
649
163
 
650
164
  :type override_context: bpy.types.Context | dict[str, typing.Any] | None
651
165
  :type execution_context: int | str | None
652
166
  :type undo: bool | None
653
- :param limit: Limit, Number of points to consider stroke as loose
654
- :type limit: int | None
655
167
  """
656
168
 
657
- def frame_duplicate(
658
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
659
- execution_context: int | str | None = None,
660
- undo: bool | None = None,
661
- *,
662
- mode: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
663
- ):
664
- """Make a copy of the active Grease Pencil Frame
665
-
666
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
667
- :type execution_context: int | str | None
668
- :type undo: bool | None
669
- :param mode: Mode
670
-
671
- ACTIVE
672
- Active -- Duplicate frame in active layer only.
673
-
674
- ALL
675
- All -- Duplicate active frames in all layers.
676
- :type mode: typing.Literal['ACTIVE','ALL'] | None
677
- """
678
-
679
- def generate_weights(
680
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
681
- execution_context: int | str | None = None,
682
- undo: bool | None = None,
683
- *,
684
- mode: typing.Literal["NAME", "AUTO"] | None = "NAME",
685
- armature: str | None = "DEFAULT",
686
- ratio: float | None = 0.1,
687
- decay: float | None = 0.8,
688
- ):
689
- """Generate automatic weights for armatures (requires armature modifier)
690
-
691
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
692
- :type execution_context: int | str | None
693
- :type undo: bool | None
694
- :param mode: Mode
695
- :type mode: typing.Literal['NAME','AUTO'] | None
696
- :param armature: Armature, Armature to use
697
- :type armature: str | None
698
- :param ratio: Ratio, Ratio between bone length and influence radius
699
- :type ratio: float | None
700
- :param decay: Decay, Factor to reduce influence depending of distance to bone axis
701
- :type decay: float | None
702
- """
703
-
704
- def guide_rotate(
705
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
706
- execution_context: int | str | None = None,
707
- undo: bool | None = None,
708
- *,
709
- increment: bool | None = True,
710
- angle: float | None = 0.0,
711
- ):
712
- """Rotate guide angle
713
-
714
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
715
- :type execution_context: int | str | None
716
- :type undo: bool | None
717
- :param increment: Increment, Increment angle
718
- :type increment: bool | None
719
- :param angle: Angle, Guide angle
720
- :type angle: float | None
721
- """
722
-
723
- def hide(
724
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
725
- execution_context: int | str | None = None,
726
- undo: bool | None = None,
727
- *,
728
- unselected: bool | None = False,
729
- ):
730
- """Hide selected/unselected Grease Pencil layers
731
-
732
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
733
- :type execution_context: int | str | None
734
- :type undo: bool | None
735
- :param unselected: Unselected, Hide unselected rather than selected layers
736
- :type unselected: bool | None
737
- """
738
-
739
- def image_to_grease_pencil(
740
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
741
- execution_context: int | str | None = None,
742
- undo: bool | None = None,
743
- *,
744
- size: float | None = 0.005,
745
- mask: bool | None = False,
746
- ):
747
- """Generate a Grease Pencil Object using Image as source
748
-
749
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
750
- :type execution_context: int | str | None
751
- :type undo: bool | None
752
- :param size: Point Size, Size used for grease pencil points
753
- :type size: float | None
754
- :param mask: Generate Mask, Create an inverted image for masking using alpha channel
755
- :type mask: bool | None
756
- """
757
-
758
- def interpolate(
759
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
760
- execution_context: int | str | None = None,
761
- undo: bool | None = None,
762
- *,
763
- shift: float | None = 0.0,
764
- layers: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
765
- interpolate_selected_only: bool | None = False,
766
- exclude_breakdowns: bool | None = False,
767
- flip: typing.Literal["NOFLIP", "FLIP", "AUTO"] | None = "AUTO",
768
- smooth_steps: int | None = 1,
769
- smooth_factor: float | None = 0.0,
770
- release_confirm: bool | None = False,
771
- ):
772
- """Interpolate grease pencil strokes between frames
773
-
774
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
775
- :type execution_context: int | str | None
776
- :type undo: bool | None
777
- :param shift: Shift, Bias factor for which frame has more influence on the interpolated strokes
778
- :type shift: float | None
779
- :param layers: Layer, Layers included in the interpolation
780
- :type layers: typing.Literal['ACTIVE','ALL'] | None
781
- :param interpolate_selected_only: Only Selected, Interpolate only selected strokes
782
- :type interpolate_selected_only: bool | None
783
- :param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
784
- :type exclude_breakdowns: bool | None
785
- :param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
786
- :type flip: typing.Literal['NOFLIP','FLIP','AUTO'] | None
787
- :param smooth_steps: Iterations, Number of times to smooth newly created strokes
788
- :type smooth_steps: int | None
789
- :param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
790
- :type smooth_factor: float | None
791
- :param release_confirm: Confirm on Release
792
- :type release_confirm: bool | None
793
- """
794
-
795
- def interpolate_reverse(
796
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
797
- execution_context: int | str | None = None,
798
- undo: bool | None = None,
799
- ):
800
- """Remove breakdown frames generated by interpolating between two Grease Pencil frames
801
-
802
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
803
- :type execution_context: int | str | None
804
- :type undo: bool | None
805
- """
806
-
807
- def interpolate_sequence(
808
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
809
- execution_context: int | str | None = None,
810
- undo: bool | None = None,
811
- *,
812
- step: int | None = 1,
813
- layers: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
814
- interpolate_selected_only: bool | None = False,
815
- exclude_breakdowns: bool | None = False,
816
- flip: typing.Literal["NOFLIP", "FLIP", "AUTO"] | None = "AUTO",
817
- smooth_steps: int | None = 1,
818
- smooth_factor: float | None = 0.0,
819
- type: typing.Literal[
820
- "LINEAR",
821
- "CUSTOM",
822
- "SINE",
823
- "QUAD",
824
- "CUBIC",
825
- "QUART",
826
- "QUINT",
827
- "EXPO",
828
- "CIRC",
829
- "BACK",
830
- "BOUNCE",
831
- "ELASTIC",
832
- ]
833
- | None = "LINEAR",
834
- easing: typing.Literal["AUTO", "EASE_IN", "EASE_OUT", "EASE_IN_OUT"]
835
- | None = "AUTO",
836
- back: float | None = 1.702,
837
- amplitude: float | None = 0.15,
838
- period: float | None = 0.15,
839
- ):
840
- """Generate 'in-betweens' to smoothly interpolate between Grease Pencil frames
841
-
842
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
843
- :type execution_context: int | str | None
844
- :type undo: bool | None
845
- :param step: Step, Number of frames between generated interpolated frames
846
- :type step: int | None
847
- :param layers: Layer, Layers included in the interpolation
848
- :type layers: typing.Literal['ACTIVE','ALL'] | None
849
- :param interpolate_selected_only: Only Selected, Interpolate only selected strokes
850
- :type interpolate_selected_only: bool | None
851
- :param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
852
- :type exclude_breakdowns: bool | None
853
- :param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
854
- :type flip: typing.Literal['NOFLIP','FLIP','AUTO'] | None
855
- :param smooth_steps: Iterations, Number of times to smooth newly created strokes
856
- :type smooth_steps: int | None
857
- :param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
858
- :type smooth_factor: float | None
859
- :param type: Type, Interpolation method to use the next time 'Interpolate Sequence' is run
860
-
861
- LINEAR
862
- Linear -- Straight-line interpolation between A and B (i.e. no ease in/out).
863
-
864
- CUSTOM
865
- Custom -- Custom interpolation defined using a curve map.
866
-
867
- SINE
868
- Sinusoidal -- Sinusoidal easing (weakest, almost linear but with a slight curvature).
869
-
870
- QUAD
871
- Quadratic -- Quadratic easing.
872
-
873
- CUBIC
874
- Cubic -- Cubic easing.
875
-
876
- QUART
877
- Quartic -- Quartic easing.
878
-
879
- QUINT
880
- Quintic -- Quintic easing.
881
-
882
- EXPO
883
- Exponential -- Exponential easing (dramatic).
884
-
885
- CIRC
886
- Circular -- Circular easing (strongest and most dynamic).
887
-
888
- BACK
889
- Back -- Cubic easing with overshoot and settle.
890
-
891
- BOUNCE
892
- Bounce -- Exponentially decaying parabolic bounce, like when objects collide.
893
-
894
- ELASTIC
895
- Elastic -- Exponentially decaying sine wave, like an elastic band.
896
- :type type: typing.Literal['LINEAR','CUSTOM','SINE','QUAD','CUBIC','QUART','QUINT','EXPO','CIRC','BACK','BOUNCE','ELASTIC'] | None
897
- :param easing: Easing, Which ends of the segment between the preceding and following grease pencil frames easing interpolation is applied to
898
-
899
- AUTO
900
- Automatic Easing -- Easing type is chosen automatically based on what the type of interpolation used (e.g. 'Ease In' for transitional types, and 'Ease Out' for dynamic effects).
901
-
902
- EASE_IN
903
- Ease In -- Only on the end closest to the next keyframe.
904
-
905
- EASE_OUT
906
- Ease Out -- Only on the end closest to the first keyframe.
907
-
908
- EASE_IN_OUT
909
- Ease In and Out -- Segment between both keyframes.
910
- :type easing: typing.Literal['AUTO','EASE_IN','EASE_OUT','EASE_IN_OUT'] | None
911
- :param back: Back, Amount of overshoot for 'back' easing
912
- :type back: float | None
913
- :param amplitude: Amplitude, Amount to boost elastic bounces for 'elastic' easing
914
- :type amplitude: float | None
915
- :param period: Period, Time between bounces for elastic easing
916
- :type period: float | None
917
- """
918
-
919
- def layer_active(
920
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
921
- execution_context: int | str | None = None,
922
- undo: bool | None = None,
923
- *,
924
- layer: int | None = 0,
925
- ):
926
- """Active Grease Pencil layer
927
-
928
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
929
- :type execution_context: int | str | None
930
- :type undo: bool | None
931
- :param layer: Grease Pencil Layer
932
- :type layer: int | None
933
- """
934
-
935
- def layer_add(
936
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
937
- execution_context: int | str | None = None,
938
- undo: bool | None = None,
939
- *,
940
- layer: int | None = 0,
941
- new_layer_name: str = "",
942
- ):
943
- """Add new layer or note for the active data-block
944
-
945
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
946
- :type execution_context: int | str | None
947
- :type undo: bool | None
948
- :param layer: Grease Pencil Layer
949
- :type layer: int | None
950
- :param new_layer_name: Name, Name of the newly added layer
951
- :type new_layer_name: str
952
- """
953
-
954
- def layer_annotation_add(
955
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
956
- execution_context: int | str | None = None,
957
- undo: bool | None = None,
958
- ):
959
- """Add new Annotation layer or note for the active data-block
960
-
961
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
962
- :type execution_context: int | str | None
963
- :type undo: bool | None
964
- """
965
-
966
- def layer_annotation_move(
967
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
968
- execution_context: int | str | None = None,
969
- undo: bool | None = None,
970
- *,
971
- type: typing.Literal["UP", "DOWN"] | None = "UP",
972
- ):
973
- """Move the active Annotation layer up/down in the list
974
-
975
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
976
- :type execution_context: int | str | None
977
- :type undo: bool | None
978
- :param type: Type
979
- :type type: typing.Literal['UP','DOWN'] | None
980
- """
981
-
982
- def layer_annotation_remove(
983
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
984
- execution_context: int | str | None = None,
985
- undo: bool | None = None,
986
- ):
987
- """Remove active Annotation layer
988
-
989
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
990
- :type execution_context: int | str | None
991
- :type undo: bool | None
992
- """
993
-
994
- def layer_change(
995
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
996
- execution_context: int | str | None = None,
997
- undo: bool | None = None,
998
- *,
999
- layer: str | None = "DEFAULT",
1000
- ):
1001
- """Change active Grease Pencil layer
1002
-
1003
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1004
- :type execution_context: int | str | None
1005
- :type undo: bool | None
1006
- :param layer: Grease Pencil Layer
1007
- :type layer: str | None
1008
- """
1009
-
1010
- def layer_duplicate(
1011
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1012
- execution_context: int | str | None = None,
1013
- undo: bool | None = None,
1014
- *,
1015
- mode: typing.Literal["ALL", "EMPTY"] | None = "ALL",
1016
- ):
1017
- """Make a copy of the active Grease Pencil layer
1018
-
1019
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1020
- :type execution_context: int | str | None
1021
- :type undo: bool | None
1022
- :param mode: Mode
1023
- :type mode: typing.Literal['ALL','EMPTY'] | None
1024
- """
1025
-
1026
- def layer_duplicate_object(
1027
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1028
- execution_context: int | str | None = None,
1029
- undo: bool | None = None,
1030
- *,
1031
- mode: typing.Literal["ALL", "ACTIVE"] | None = "ALL",
1032
- only_active: bool | None = True,
1033
- ):
1034
- """Make a copy of the active Grease Pencil layer to selected object
1035
-
1036
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1037
- :type execution_context: int | str | None
1038
- :type undo: bool | None
1039
- :param mode: Mode
1040
- :type mode: typing.Literal['ALL','ACTIVE'] | None
1041
- :param only_active: Only Active, Copy only active Layer, uncheck to append all layers
1042
- :type only_active: bool | None
1043
- """
1044
-
1045
- def layer_isolate(
1046
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1047
- execution_context: int | str | None = None,
1048
- undo: bool | None = None,
1049
- *,
1050
- affect_visibility: bool | None = False,
1051
- ):
1052
- """Toggle whether the active layer is the only one that can be edited and/or visible
1053
-
1054
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1055
- :type execution_context: int | str | None
1056
- :type undo: bool | None
1057
- :param affect_visibility: Affect Visibility, In addition to toggling the editability, also affect the visibility
1058
- :type affect_visibility: bool | None
1059
- """
1060
-
1061
- def layer_mask_add(
1062
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1063
- execution_context: int | str | None = None,
1064
- undo: bool | None = None,
1065
- *,
1066
- name: str = "",
1067
- ):
1068
- """Add new layer as masking
1069
-
1070
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1071
- :type execution_context: int | str | None
1072
- :type undo: bool | None
1073
- :param name: Layer, Name of the layer
1074
- :type name: str
1075
- """
1076
-
1077
- def layer_mask_move(
1078
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1079
- execution_context: int | str | None = None,
1080
- undo: bool | None = None,
1081
- *,
1082
- type: typing.Literal["UP", "DOWN"] | None = "UP",
1083
- ):
1084
- """Move the active Grease Pencil mask layer up/down in the list
1085
-
1086
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1087
- :type execution_context: int | str | None
1088
- :type undo: bool | None
1089
- :param type: Type
1090
- :type type: typing.Literal['UP','DOWN'] | None
1091
- """
1092
-
1093
- def layer_mask_remove(
1094
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1095
- execution_context: int | str | None = None,
1096
- undo: bool | None = None,
1097
- ):
1098
- """Remove Layer Mask
1099
-
1100
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1101
- :type execution_context: int | str | None
1102
- :type undo: bool | None
1103
- """
1104
-
1105
- def layer_merge(
1106
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1107
- execution_context: int | str | None = None,
1108
- undo: bool | None = None,
1109
- *,
1110
- mode: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
1111
- ):
1112
- """Combine Layers
1113
-
1114
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1115
- :type execution_context: int | str | None
1116
- :type undo: bool | None
1117
- :param mode: Mode
1118
-
1119
- ACTIVE
1120
- Active -- Combine active layer into the layer below.
1121
-
1122
- ALL
1123
- All -- Combine all layers into the active layer.
1124
- :type mode: typing.Literal['ACTIVE','ALL'] | None
1125
- """
1126
-
1127
- def layer_move(
1128
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1129
- execution_context: int | str | None = None,
1130
- undo: bool | None = None,
1131
- *,
1132
- type: typing.Literal["UP", "DOWN"] | None = "UP",
1133
- ):
1134
- """Move the active Grease Pencil layer up/down in the list
1135
-
1136
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1137
- :type execution_context: int | str | None
1138
- :type undo: bool | None
1139
- :param type: Type
1140
- :type type: typing.Literal['UP','DOWN'] | None
1141
- """
1142
-
1143
- def layer_remove(
1144
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1145
- execution_context: int | str | None = None,
1146
- undo: bool | None = None,
1147
- ):
1148
- """Remove active Grease Pencil layer
1149
-
1150
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1151
- :type execution_context: int | str | None
1152
- :type undo: bool | None
1153
- """
1154
-
1155
- def lock_all(
1156
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1157
- execution_context: int | str | None = None,
1158
- undo: bool | None = None,
1159
- ):
1160
- """Lock all Grease Pencil layers to prevent them from being accidentally modified
1161
-
1162
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1163
- :type execution_context: int | str | None
1164
- :type undo: bool | None
1165
- """
1166
-
1167
- def lock_layer(
1168
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1169
- execution_context: int | str | None = None,
1170
- undo: bool | None = None,
1171
- ):
1172
- """Lock and hide any color not used in any layer
1173
-
1174
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1175
- :type execution_context: int | str | None
1176
- :type undo: bool | None
1177
- """
1178
-
1179
- def material_hide(
1180
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1181
- execution_context: int | str | None = None,
1182
- undo: bool | None = None,
1183
- *,
1184
- unselected: bool | None = False,
1185
- ):
1186
- """Hide selected/unselected Grease Pencil materials
1187
-
1188
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1189
- :type execution_context: int | str | None
1190
- :type undo: bool | None
1191
- :param unselected: Unselected, Hide unselected rather than selected colors
1192
- :type unselected: bool | None
1193
- """
1194
-
1195
- def material_isolate(
1196
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1197
- execution_context: int | str | None = None,
1198
- undo: bool | None = None,
1199
- *,
1200
- affect_visibility: bool | None = False,
1201
- ):
1202
- """Toggle whether the active material is the only one that is editable and/or visible
1203
-
1204
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1205
- :type execution_context: int | str | None
1206
- :type undo: bool | None
1207
- :param affect_visibility: Affect Visibility, In addition to toggling the editability, also affect the visibility
1208
- :type affect_visibility: bool | None
1209
- """
1210
-
1211
- def material_lock_all(
1212
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1213
- execution_context: int | str | None = None,
1214
- undo: bool | None = None,
1215
- ):
1216
- """Lock all Grease Pencil materials to prevent them from being accidentally modified
1217
-
1218
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1219
- :type execution_context: int | str | None
1220
- :type undo: bool | None
1221
- """
1222
-
1223
- def material_lock_unused(
1224
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1225
- execution_context: int | str | None = None,
1226
- undo: bool | None = None,
1227
- ):
1228
- """Lock any material not used in any selected stroke
1229
-
1230
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1231
- :type execution_context: int | str | None
1232
- :type undo: bool | None
1233
- """
1234
-
1235
- def material_reveal(
1236
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1237
- execution_context: int | str | None = None,
1238
- undo: bool | None = None,
1239
- ):
1240
- """Unhide all hidden Grease Pencil materials
1241
-
1242
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1243
- :type execution_context: int | str | None
1244
- :type undo: bool | None
1245
- """
1246
-
1247
- def material_select(
1248
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1249
- execution_context: int | str | None = None,
1250
- undo: bool | None = None,
1251
- *,
1252
- deselect: bool | None = False,
1253
- ):
1254
- """Select/Deselect all Grease Pencil strokes using current material
1255
-
1256
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1257
- :type execution_context: int | str | None
1258
- :type undo: bool | None
1259
- :param deselect: Deselect, Unselect strokes
1260
- :type deselect: bool | None
1261
- """
1262
-
1263
- def material_set(
1264
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1265
- execution_context: int | str | None = None,
1266
- undo: bool | None = None,
1267
- *,
1268
- slot: str | None = "DEFAULT",
1269
- ):
1270
- """Set active material
1271
-
1272
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1273
- :type execution_context: int | str | None
1274
- :type undo: bool | None
1275
- :param slot: Material Slot
1276
- :type slot: str | None
1277
- """
1278
-
1279
- def material_to_vertex_color(
1280
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1281
- execution_context: int | str | None = None,
1282
- undo: bool | None = None,
1283
- *,
1284
- remove: bool | None = True,
1285
- palette: bool | None = True,
1286
- selected: bool | None = False,
1287
- threshold: int | None = 3,
1288
- ):
1289
- """Replace materials in strokes with Vertex Color
1290
-
1291
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1292
- :type execution_context: int | str | None
1293
- :type undo: bool | None
1294
- :param remove: Remove Unused Materials, Remove any unused material after the conversion
1295
- :type remove: bool | None
1296
- :param palette: Create Palette, Create a new palette with colors
1297
- :type palette: bool | None
1298
- :param selected: Only Selected, Convert only selected strokes
1299
- :type selected: bool | None
1300
- :param threshold: Threshold
1301
- :type threshold: int | None
1302
- """
1303
-
1304
- def material_unlock_all(
1305
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1306
- execution_context: int | str | None = None,
1307
- undo: bool | None = None,
1308
- ):
1309
- """Unlock all Grease Pencil materials so that they can be edited
1310
-
1311
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1312
- :type execution_context: int | str | None
1313
- :type undo: bool | None
1314
- """
1315
-
1316
- def materials_copy_to_object(
1317
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1318
- execution_context: int | str | None = None,
1319
- undo: bool | None = None,
1320
- *,
1321
- only_active: bool | None = True,
1322
- ):
1323
- """Append Materials of the active Grease Pencil to other object
1324
-
1325
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1326
- :type execution_context: int | str | None
1327
- :type undo: bool | None
1328
- :param only_active: Only Active, Append only active material, uncheck to append all materials
1329
- :type only_active: bool | None
1330
- """
1331
-
1332
- def move_to_layer(
1333
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1334
- execution_context: int | str | None = None,
1335
- undo: bool | None = None,
1336
- *,
1337
- layer: int | None = 0,
1338
- new_layer_name: str = "",
1339
- ):
1340
- """Move selected strokes to another layer
1341
-
1342
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1343
- :type execution_context: int | str | None
1344
- :type undo: bool | None
1345
- :param layer: Grease Pencil Layer
1346
- :type layer: int | None
1347
- :param new_layer_name: Name, Name of the newly added layer
1348
- :type new_layer_name: str
1349
- """
1350
-
1351
- def paintmode_toggle(
1352
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1353
- execution_context: int | str | None = None,
1354
- undo: bool | None = None,
1355
- *,
1356
- back: bool | None = False,
1357
- ):
1358
- """Enter/Exit paint mode for Grease Pencil strokes
1359
-
1360
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1361
- :type execution_context: int | str | None
1362
- :type undo: bool | None
1363
- :param back: Return to Previous Mode, Return to previous mode
1364
- :type back: bool | None
1365
- """
1366
-
1367
- def paste(
1368
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1369
- execution_context: int | str | None = None,
1370
- undo: bool | None = None,
1371
- *,
1372
- type: typing.Literal["ACTIVE", "LAYER"] | None = "ACTIVE",
1373
- paste_back: bool | None = False,
1374
- ):
1375
- """Paste previously copied strokes to active layer or to original layer
1376
-
1377
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1378
- :type execution_context: int | str | None
1379
- :type undo: bool | None
1380
- :param type: Type
1381
- :type type: typing.Literal['ACTIVE','LAYER'] | None
1382
- :param paste_back: Paste on Back, Add pasted strokes behind all strokes
1383
- :type paste_back: bool | None
1384
- """
1385
-
1386
- def primitive_box(
1387
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1388
- execution_context: int | str | None = None,
1389
- undo: bool | None = None,
1390
- *,
1391
- subdivision: int | None = 3,
1392
- edges: int | None = 1,
1393
- type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
1394
- | None = "BOX",
1395
- wait_for_input: bool | None = True,
1396
- ):
1397
- """Create predefined grease pencil stroke box shapes
1398
-
1399
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1400
- :type execution_context: int | str | None
1401
- :type undo: bool | None
1402
- :param subdivision: Subdivisions, Number of subdivisions per segment
1403
- :type subdivision: int | None
1404
- :param edges: Edges, Number of points per segment
1405
- :type edges: int | None
1406
- :param type: Type, Type of shape
1407
- :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
1408
- :param wait_for_input: Wait for Input
1409
- :type wait_for_input: bool | None
1410
- """
1411
-
1412
- def primitive_circle(
1413
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1414
- execution_context: int | str | None = None,
1415
- undo: bool | None = None,
1416
- *,
1417
- subdivision: int | None = 94,
1418
- edges: int | None = 1,
1419
- type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
1420
- | None = "CIRCLE",
1421
- wait_for_input: bool | None = True,
1422
- ):
1423
- """Create predefined grease pencil stroke circle shapes
1424
-
1425
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1426
- :type execution_context: int | str | None
1427
- :type undo: bool | None
1428
- :param subdivision: Subdivisions, Number of subdivisions per segment
1429
- :type subdivision: int | None
1430
- :param edges: Edges, Number of points per segment
1431
- :type edges: int | None
1432
- :param type: Type, Type of shape
1433
- :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
1434
- :param wait_for_input: Wait for Input
1435
- :type wait_for_input: bool | None
1436
- """
1437
-
1438
- def primitive_curve(
1439
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1440
- execution_context: int | str | None = None,
1441
- undo: bool | None = None,
1442
- *,
1443
- subdivision: int | None = 62,
1444
- edges: int | None = 1,
1445
- type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
1446
- | None = "CURVE",
1447
- wait_for_input: bool | None = True,
1448
- ):
1449
- """Create predefined grease pencil stroke curve shapes
1450
-
1451
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1452
- :type execution_context: int | str | None
1453
- :type undo: bool | None
1454
- :param subdivision: Subdivisions, Number of subdivisions per segment
1455
- :type subdivision: int | None
1456
- :param edges: Edges, Number of points per segment
1457
- :type edges: int | None
1458
- :param type: Type, Type of shape
1459
- :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
1460
- :param wait_for_input: Wait for Input
1461
- :type wait_for_input: bool | None
1462
- """
1463
-
1464
- def primitive_line(
1465
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1466
- execution_context: int | str | None = None,
1467
- undo: bool | None = None,
1468
- *,
1469
- subdivision: int | None = 6,
1470
- edges: int | None = 1,
1471
- type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
1472
- | None = "LINE",
1473
- wait_for_input: bool | None = True,
1474
- ):
1475
- """Create predefined grease pencil stroke lines
1476
-
1477
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1478
- :type execution_context: int | str | None
1479
- :type undo: bool | None
1480
- :param subdivision: Subdivisions, Number of subdivisions per segment
1481
- :type subdivision: int | None
1482
- :param edges: Edges, Number of points per segment
1483
- :type edges: int | None
1484
- :param type: Type, Type of shape
1485
- :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
1486
- :param wait_for_input: Wait for Input
1487
- :type wait_for_input: bool | None
1488
- """
1489
-
1490
- def primitive_polyline(
1491
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1492
- execution_context: int | str | None = None,
1493
- undo: bool | None = None,
1494
- *,
1495
- subdivision: int | None = 6,
1496
- edges: int | None = 1,
1497
- type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
1498
- | None = "POLYLINE",
1499
- wait_for_input: bool | None = True,
1500
- ):
1501
- """Create predefined grease pencil stroke polylines
1502
-
1503
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1504
- :type execution_context: int | str | None
1505
- :type undo: bool | None
1506
- :param subdivision: Subdivisions, Number of subdivisions per segment
1507
- :type subdivision: int | None
1508
- :param edges: Edges, Number of points per segment
1509
- :type edges: int | None
1510
- :param type: Type, Type of shape
1511
- :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
1512
- :param wait_for_input: Wait for Input
1513
- :type wait_for_input: bool | None
1514
- """
1515
-
1516
- def recalc_geometry(
1517
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1518
- execution_context: int | str | None = None,
1519
- undo: bool | None = None,
1520
- ):
1521
- """Update all internal geometry data
1522
-
1523
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1524
- :type execution_context: int | str | None
1525
- :type undo: bool | None
1526
- """
1527
-
1528
- def reproject(
1529
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1530
- execution_context: int | str | None = None,
1531
- undo: bool | None = None,
1532
- *,
1533
- type: typing.Literal["FRONT", "SIDE", "TOP", "VIEW", "SURFACE", "CURSOR"]
1534
- | None = "VIEW",
1535
- keep_original: bool | None = False,
1536
- offset: float | None = 0.0,
1537
- ):
1538
- """Reproject the selected strokes from the current viewpoint as if they had been newly drawn (e.g. to fix problems from accidental 3D cursor movement or accidental viewport changes, or for matching deforming geometry)
1539
-
1540
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1541
- :type execution_context: int | str | None
1542
- :type undo: bool | None
1543
- :param type: Projection Type
1544
-
1545
- FRONT
1546
- Front -- Reproject the strokes using the X-Z plane.
1547
-
1548
- SIDE
1549
- Side -- Reproject the strokes using the Y-Z plane.
1550
-
1551
- TOP
1552
- Top -- Reproject the strokes using the X-Y plane.
1553
-
1554
- VIEW
1555
- View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using 'Cursor' Stroke Placement.
1556
-
1557
- SURFACE
1558
- Surface -- Reproject the strokes on to the scene geometry, as if drawn using 'Surface' placement.
1559
-
1560
- CURSOR
1561
- Cursor -- Reproject the strokes using the orientation of 3D cursor.
1562
- :type type: typing.Literal['FRONT','SIDE','TOP','VIEW','SURFACE','CURSOR'] | None
1563
- :param keep_original: Keep Original, Keep original strokes and create a copy before reprojecting
1564
- :type keep_original: bool | None
1565
- :param offset: Surface Offset
1566
- :type offset: float | None
1567
- """
1568
-
1569
- def reset_transform_fill(
1570
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1571
- execution_context: int | str | None = None,
1572
- undo: bool | None = None,
1573
- *,
1574
- mode: typing.Literal["ALL", "TRANSLATE", "ROTATE", "SCALE"] | None = "ALL",
1575
- ):
1576
- """Reset any UV transformation and back to default values
1577
-
1578
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1579
- :type execution_context: int | str | None
1580
- :type undo: bool | None
1581
- :param mode: Mode
1582
- :type mode: typing.Literal['ALL','TRANSLATE','ROTATE','SCALE'] | None
1583
- """
1584
-
1585
- def reveal(
1586
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1587
- execution_context: int | str | None = None,
1588
- undo: bool | None = None,
1589
- *,
1590
- select: bool | None = True,
1591
- ):
1592
- """Show all Grease Pencil layers
1593
-
1594
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1595
- :type execution_context: int | str | None
1596
- :type undo: bool | None
1597
- :param select: Select
1598
- :type select: bool | None
1599
- """
1600
-
1601
- def sculpt_paint(
1602
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1603
- execution_context: int | str | None = None,
1604
- undo: bool | None = None,
1605
- *,
1606
- stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
1607
- | None = None,
1608
- wait_for_input: bool | None = True,
1609
- ):
1610
- """Apply tweaks to strokes by painting over the strokes
1611
-
1612
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1613
- :type execution_context: int | str | None
1614
- :type undo: bool | None
1615
- :param stroke: Stroke
1616
- :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
1617
- :param wait_for_input: Wait for Input, Enter a mini 'sculpt-mode' if enabled, otherwise, exit after drawing a single stroke
1618
- :type wait_for_input: bool | None
1619
- """
1620
-
1621
- def sculptmode_toggle(
1622
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1623
- execution_context: int | str | None = None,
1624
- undo: bool | None = None,
1625
- *,
1626
- back: bool | None = False,
1627
- ):
1628
- """Enter/Exit sculpt mode for Grease Pencil strokes
1629
-
1630
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1631
- :type execution_context: int | str | None
1632
- :type undo: bool | None
1633
- :param back: Return to Previous Mode, Return to previous mode
1634
- :type back: bool | None
1635
- """
1636
-
1637
- def select(
1638
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1639
- execution_context: int | str | None = None,
1640
- undo: bool | None = None,
1641
- *,
1642
- extend: bool | None = False,
1643
- deselect: bool | None = False,
1644
- toggle: bool | None = False,
1645
- deselect_all: bool | None = False,
1646
- select_passthrough: bool | None = False,
1647
- entire_strokes: bool | None = False,
1648
- location: collections.abc.Iterable[int] | None = (0, 0),
1649
- use_shift_extend: bool | None = False,
1650
- ):
1651
- """Select Grease Pencil strokes and/or stroke points
1652
-
1653
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1654
- :type execution_context: int | str | None
1655
- :type undo: bool | None
1656
- :param extend: Extend, Extend selection instead of deselecting everything first
1657
- :type extend: bool | None
1658
- :param deselect: Deselect, Remove from selection
1659
- :type deselect: bool | None
1660
- :param toggle: Toggle Selection, Toggle the selection
1661
- :type toggle: bool | None
1662
- :param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
1663
- :type deselect_all: bool | None
1664
- :param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
1665
- :type select_passthrough: bool | None
1666
- :param entire_strokes: Entire Strokes, Select entire strokes instead of just the nearest stroke vertex
1667
- :type entire_strokes: bool | None
1668
- :param location: Location, Mouse location
1669
- :type location: collections.abc.Iterable[int] | None
1670
- :param use_shift_extend: Extend
1671
- :type use_shift_extend: bool | None
1672
- """
1673
-
1674
- def select_all(
1675
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1676
- execution_context: int | str | None = None,
1677
- undo: bool | None = None,
1678
- *,
1679
- action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
1680
- ):
1681
- """Change selection of all Grease Pencil strokes currently visible
1682
-
1683
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1684
- :type execution_context: int | str | None
1685
- :type undo: bool | None
1686
- :param action: Action, Selection action to execute
1687
-
1688
- TOGGLE
1689
- Toggle -- Toggle selection for all elements.
1690
-
1691
- SELECT
1692
- Select -- Select all elements.
1693
-
1694
- DESELECT
1695
- Deselect -- Deselect all elements.
1696
-
1697
- INVERT
1698
- Invert -- Invert selection of all elements.
1699
- :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
1700
- """
1701
-
1702
- def select_alternate(
1703
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1704
- execution_context: int | str | None = None,
1705
- undo: bool | None = None,
1706
- *,
1707
- unselect_ends: bool | None = False,
1708
- ):
1709
- """Select alternative points in same strokes as already selected points
1710
-
1711
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1712
- :type execution_context: int | str | None
1713
- :type undo: bool | None
1714
- :param unselect_ends: Unselect Ends, Do not select the first and last point of the stroke
1715
- :type unselect_ends: bool | None
1716
- """
1717
-
1718
- def select_box(
1719
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1720
- execution_context: int | str | None = None,
1721
- undo: bool | None = None,
1722
- *,
1723
- xmin: int | None = 0,
1724
- xmax: int | None = 0,
1725
- ymin: int | None = 0,
1726
- ymax: int | None = 0,
1727
- wait_for_input: bool | None = True,
1728
- mode: typing.Literal["SET", "ADD", "SUB", "XOR", "AND"] | None = "SET",
1729
- ):
1730
- """Select Grease Pencil strokes within a rectangular region
1731
-
1732
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1733
- :type execution_context: int | str | None
1734
- :type undo: bool | None
1735
- :param xmin: X Min
1736
- :type xmin: int | None
1737
- :param xmax: X Max
1738
- :type xmax: int | None
1739
- :param ymin: Y Min
1740
- :type ymin: int | None
1741
- :param ymax: Y Max
1742
- :type ymax: int | None
1743
- :param wait_for_input: Wait for Input
1744
- :type wait_for_input: bool | None
1745
- :param mode: Mode
1746
-
1747
- SET
1748
- Set -- Set a new selection.
1749
-
1750
- ADD
1751
- Extend -- Extend existing selection.
1752
-
1753
- SUB
1754
- Subtract -- Subtract existing selection.
1755
-
1756
- XOR
1757
- Difference -- Invert existing selection.
1758
-
1759
- AND
1760
- Intersect -- Intersect existing selection.
1761
- :type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
1762
- """
1763
-
1764
- def select_circle(
1765
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1766
- execution_context: int | str | None = None,
1767
- undo: bool | None = None,
1768
- *,
1769
- x: int | None = 0,
1770
- y: int | None = 0,
1771
- radius: int | None = 25,
1772
- wait_for_input: bool | None = True,
1773
- mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
1774
- ):
1775
- """Select Grease Pencil strokes using brush selection
1776
-
1777
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1778
- :type execution_context: int | str | None
1779
- :type undo: bool | None
1780
- :param x: X
1781
- :type x: int | None
1782
- :param y: Y
1783
- :type y: int | None
1784
- :param radius: Radius
1785
- :type radius: int | None
1786
- :param wait_for_input: Wait for Input
1787
- :type wait_for_input: bool | None
1788
- :param mode: Mode
1789
-
1790
- SET
1791
- Set -- Set a new selection.
1792
-
1793
- ADD
1794
- Extend -- Extend existing selection.
1795
-
1796
- SUB
1797
- Subtract -- Subtract existing selection.
1798
- :type mode: typing.Literal['SET','ADD','SUB'] | None
1799
- """
1800
-
1801
- def select_first(
1802
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1803
- execution_context: int | str | None = None,
1804
- undo: bool | None = None,
1805
- *,
1806
- only_selected_strokes: bool | None = False,
1807
- extend: bool | None = False,
1808
- ):
1809
- """Select first point in Grease Pencil strokes
1810
-
1811
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1812
- :type execution_context: int | str | None
1813
- :type undo: bool | None
1814
- :param only_selected_strokes: Selected Strokes Only, Only select the first point of strokes that already have points selected
1815
- :type only_selected_strokes: bool | None
1816
- :param extend: Extend, Extend selection instead of deselecting all other selected points
1817
- :type extend: bool | None
1818
- """
1819
-
1820
- def select_grouped(
1821
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1822
- execution_context: int | str | None = None,
1823
- undo: bool | None = None,
1824
- *,
1825
- type: typing.Literal["LAYER", "MATERIAL"] | None = "LAYER",
1826
- ):
1827
- """Select all strokes with similar characteristics
1828
-
1829
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1830
- :type execution_context: int | str | None
1831
- :type undo: bool | None
1832
- :param type: Type
1833
-
1834
- LAYER
1835
- Layer -- Shared layers.
1836
-
1837
- MATERIAL
1838
- Material -- Shared materials.
1839
- :type type: typing.Literal['LAYER','MATERIAL'] | None
1840
- """
1841
-
1842
- def select_lasso(
1843
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1844
- execution_context: int | str | None = None,
1845
- undo: bool | None = None,
1846
- *,
1847
- mode: typing.Literal["SET", "ADD", "SUB", "XOR", "AND"] | None = "SET",
1848
- path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None = None,
1849
- use_smooth_stroke: bool | None = False,
1850
- smooth_stroke_factor: float | None = 0.75,
1851
- smooth_stroke_radius: int | None = 35,
1852
- ):
1853
- """Select Grease Pencil strokes using lasso selection
1854
-
1855
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1856
- :type execution_context: int | str | None
1857
- :type undo: bool | None
1858
- :param mode: Mode
1859
-
1860
- SET
1861
- Set -- Set a new selection.
1862
-
1863
- ADD
1864
- Extend -- Extend existing selection.
1865
-
1866
- SUB
1867
- Subtract -- Subtract existing selection.
1868
-
1869
- XOR
1870
- Difference -- Invert existing selection.
1871
-
1872
- AND
1873
- Intersect -- Intersect existing selection.
1874
- :type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
1875
- :param path: Path
1876
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
1877
- :param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
1878
- :type use_smooth_stroke: bool | None
1879
- :param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
1880
- :type smooth_stroke_factor: float | None
1881
- :param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
1882
- :type smooth_stroke_radius: int | None
1883
- """
1884
-
1885
- def select_last(
1886
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1887
- execution_context: int | str | None = None,
1888
- undo: bool | None = None,
1889
- *,
1890
- only_selected_strokes: bool | None = False,
1891
- extend: bool | None = False,
1892
- ):
1893
- """Select last point in Grease Pencil strokes
1894
-
1895
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1896
- :type execution_context: int | str | None
1897
- :type undo: bool | None
1898
- :param only_selected_strokes: Selected Strokes Only, Only select the last point of strokes that already have points selected
1899
- :type only_selected_strokes: bool | None
1900
- :param extend: Extend, Extend selection instead of deselecting all other selected points
1901
- :type extend: bool | None
1902
- """
1903
-
1904
- def select_less(
1905
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1906
- execution_context: int | str | None = None,
1907
- undo: bool | None = None,
1908
- ):
1909
- """Shrink sets of selected Grease Pencil points
1910
-
1911
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1912
- :type execution_context: int | str | None
1913
- :type undo: bool | None
1914
- """
1915
-
1916
- def select_linked(
1917
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1918
- execution_context: int | str | None = None,
1919
- undo: bool | None = None,
1920
- ):
1921
- """Select all points in same strokes as already selected points
1922
-
1923
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1924
- :type execution_context: int | str | None
1925
- :type undo: bool | None
1926
- """
1927
-
1928
- def select_more(
1929
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1930
- execution_context: int | str | None = None,
1931
- undo: bool | None = None,
1932
- ):
1933
- """Grow sets of selected Grease Pencil points
1934
-
1935
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1936
- :type execution_context: int | str | None
1937
- :type undo: bool | None
1938
- """
1939
-
1940
- def select_random(
1941
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1942
- execution_context: int | str | None = None,
1943
- undo: bool | None = None,
1944
- *,
1945
- ratio: float | None = 0.5,
1946
- seed: int | None = 0,
1947
- action: typing.Literal["SELECT", "DESELECT"] | None = "SELECT",
1948
- unselect_ends: bool | None = False,
1949
- ):
1950
- """Select random points for non selected strokes
1951
-
1952
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1953
- :type execution_context: int | str | None
1954
- :type undo: bool | None
1955
- :param ratio: Ratio, Portion of items to select randomly
1956
- :type ratio: float | None
1957
- :param seed: Random Seed, Seed for the random number generator
1958
- :type seed: int | None
1959
- :param action: Action, Selection action to execute
1960
-
1961
- SELECT
1962
- Select -- Select all elements.
1963
-
1964
- DESELECT
1965
- Deselect -- Deselect all elements.
1966
- :type action: typing.Literal['SELECT','DESELECT'] | None
1967
- :param unselect_ends: Unselect Ends, Do not select the first and last point of the stroke
1968
- :type unselect_ends: bool | None
1969
- """
1970
-
1971
- def select_vertex_color(
1972
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1973
- execution_context: int | str | None = None,
1974
- undo: bool | None = None,
1975
- *,
1976
- threshold: int | None = 0,
1977
- ):
1978
- """Select all points with similar vertex color of current selected
1979
-
1980
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1981
- :type execution_context: int | str | None
1982
- :type undo: bool | None
1983
- :param threshold: Threshold, Tolerance of the selection. Higher values select a wider range of similar colors
1984
- :type threshold: int | None
1985
- """
1986
-
1987
- def selection_opacity_toggle(
1988
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
1989
- execution_context: int | str | None = None,
1990
- undo: bool | None = None,
1991
- ):
1992
- """Hide/Unhide selected points for Grease Pencil strokes setting alpha factor
1993
-
1994
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
1995
- :type execution_context: int | str | None
1996
- :type undo: bool | None
1997
- """
1998
-
1999
- def selectmode_toggle(
2000
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2001
- execution_context: int | str | None = None,
2002
- undo: bool | None = None,
2003
- *,
2004
- mode: int | None = 0,
2005
- ):
2006
- """Set selection mode for Grease Pencil strokes
2007
-
2008
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2009
- :type execution_context: int | str | None
2010
- :type undo: bool | None
2011
- :param mode: Select Mode, Select mode
2012
- :type mode: int | None
2013
- """
2014
-
2015
- def set_active_material(
2016
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2017
- execution_context: int | str | None = None,
2018
- undo: bool | None = None,
2019
- ):
2020
- """Set the selected stroke material as the active material
2021
-
2022
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2023
- :type execution_context: int | str | None
2024
- :type undo: bool | None
2025
- """
2026
-
2027
- def snap_cursor_to_selected(
2028
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2029
- execution_context: int | str | None = None,
2030
- undo: bool | None = None,
2031
- ):
2032
- """Snap cursor to center of selected points
2033
-
2034
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2035
- :type execution_context: int | str | None
2036
- :type undo: bool | None
2037
- """
2038
-
2039
- def snap_to_cursor(
2040
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2041
- execution_context: int | str | None = None,
2042
- undo: bool | None = None,
2043
- *,
2044
- use_offset: bool | None = True,
2045
- ):
2046
- """Snap selected points/strokes to the cursor
2047
-
2048
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2049
- :type execution_context: int | str | None
2050
- :type undo: bool | None
2051
- :param use_offset: With Offset, Offset the entire stroke instead of selected points only
2052
- :type use_offset: bool | None
2053
- """
2054
-
2055
- def snap_to_grid(
2056
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2057
- execution_context: int | str | None = None,
2058
- undo: bool | None = None,
2059
- ):
2060
- """Snap selected points to the nearest grid points
2061
-
2062
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2063
- :type execution_context: int | str | None
2064
- :type undo: bool | None
2065
- """
2066
-
2067
- def stroke_apply_thickness(
2068
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2069
- execution_context: int | str | None = None,
2070
- undo: bool | None = None,
2071
- ):
2072
- """Apply the thickness change of the layer to its strokes
2073
-
2074
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2075
- :type execution_context: int | str | None
2076
- :type undo: bool | None
2077
- """
2078
-
2079
- def stroke_arrange(
2080
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2081
- execution_context: int | str | None = None,
2082
- undo: bool | None = None,
2083
- *,
2084
- direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "UP",
2085
- ):
2086
- """Arrange selected strokes up/down in the display order of the active layer
2087
-
2088
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2089
- :type execution_context: int | str | None
2090
- :type undo: bool | None
2091
- :param direction: Direction
2092
- :type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
2093
- """
2094
-
2095
- def stroke_caps_set(
2096
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2097
- execution_context: int | str | None = None,
2098
- undo: bool | None = None,
2099
- *,
2100
- type: typing.Literal["TOGGLE", "START", "END", "DEFAULT"] | None = "TOGGLE",
2101
- ):
2102
- """Change stroke caps mode (rounded or flat)
2103
-
2104
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2105
- :type execution_context: int | str | None
2106
- :type undo: bool | None
2107
- :param type: Type
2108
-
2109
- TOGGLE
2110
- Both.
2111
-
2112
- START
2113
- Start.
2114
-
2115
- END
2116
- End.
2117
-
2118
- DEFAULT
2119
- Default -- Set as default rounded.
2120
- :type type: typing.Literal['TOGGLE','START','END','DEFAULT'] | None
2121
- """
2122
-
2123
- def stroke_change_color(
2124
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2125
- execution_context: int | str | None = None,
2126
- undo: bool | None = None,
2127
- *,
2128
- material: str = "",
2129
- ):
2130
- """Move selected strokes to active material
2131
-
2132
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2133
- :type execution_context: int | str | None
2134
- :type undo: bool | None
2135
- :param material: Material, Name of the material
2136
- :type material: str
2137
- """
2138
-
2139
- def stroke_cutter(
2140
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2141
- execution_context: int | str | None = None,
2142
- undo: bool | None = None,
2143
- *,
2144
- path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None = None,
2145
- use_smooth_stroke: bool | None = False,
2146
- smooth_stroke_factor: float | None = 0.75,
2147
- smooth_stroke_radius: int | None = 35,
2148
- flat_caps: bool | None = False,
2149
- ):
2150
- """Select section and cut
2151
-
2152
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2153
- :type execution_context: int | str | None
2154
- :type undo: bool | None
2155
- :param path: Path
2156
- :type path: bpy.types.bpy_prop_collection[bpy.types.OperatorMousePath] | None
2157
- :param use_smooth_stroke: Stabilize Stroke, Selection lags behind mouse and follows a smoother path
2158
- :type use_smooth_stroke: bool | None
2159
- :param smooth_stroke_factor: Smooth Stroke Factor, Higher values gives a smoother stroke
2160
- :type smooth_stroke_factor: float | None
2161
- :param smooth_stroke_radius: Smooth Stroke Radius, Minimum distance from last point before selection continues
2162
- :type smooth_stroke_radius: int | None
2163
- :param flat_caps: Flat Caps
2164
- :type flat_caps: bool | None
2165
- """
2166
-
2167
- def stroke_cyclical_set(
2168
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2169
- execution_context: int | str | None = None,
2170
- undo: bool | None = None,
2171
- *,
2172
- type: typing.Literal["CLOSE", "OPEN", "TOGGLE"] | None = "TOGGLE",
2173
- geometry: bool | None = False,
2174
- ):
2175
- """Close or open the selected stroke adding a segment from last to first point
2176
-
2177
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2178
- :type execution_context: int | str | None
2179
- :type undo: bool | None
2180
- :param type: Type
2181
- :type type: typing.Literal['CLOSE','OPEN','TOGGLE'] | None
2182
- :param geometry: Create Geometry, Create new geometry for closing stroke
2183
- :type geometry: bool | None
2184
- """
2185
-
2186
- def stroke_editcurve_set_handle_type(
2187
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2188
- execution_context: int | str | None = None,
2189
- undo: bool | None = None,
2190
- *,
2191
- type: typing.Literal["FREE", "AUTOMATIC", "VECTOR", "ALIGNED"] | None = "AUTOMATIC",
2192
- ):
2193
- """Set the type of an edit curve handle
2194
-
2195
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2196
- :type execution_context: int | str | None
2197
- :type undo: bool | None
2198
- :param type: Type, Spline type
2199
- :type type: typing.Literal['FREE','AUTOMATIC','VECTOR','ALIGNED'] | None
2200
- """
2201
-
2202
- def stroke_enter_editcurve_mode(
2203
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2204
- execution_context: int | str | None = None,
2205
- undo: bool | None = None,
2206
- *,
2207
- error_threshold: float | None = 0.1,
2208
- ):
2209
- """Called to transform a stroke into a curve
2210
-
2211
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2212
- :type execution_context: int | str | None
2213
- :type undo: bool | None
2214
- :param error_threshold: Error Threshold, Threshold on the maximum deviation from the actual stroke
2215
- :type error_threshold: float | None
2216
- """
2217
-
2218
- def stroke_flip(
2219
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2220
- execution_context: int | str | None = None,
2221
- undo: bool | None = None,
2222
- ):
2223
- """Change direction of the points of the selected strokes
2224
-
2225
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2226
- :type execution_context: int | str | None
2227
- :type undo: bool | None
2228
- """
2229
-
2230
- def stroke_join(
2231
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2232
- execution_context: int | str | None = None,
2233
- undo: bool | None = None,
2234
- *,
2235
- type: typing.Literal["JOIN", "JOINCOPY"] | None = "JOIN",
2236
- leave_gaps: bool | None = False,
2237
- ):
2238
- """Join selected strokes (optionally as new stroke)
2239
-
2240
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2241
- :type execution_context: int | str | None
2242
- :type undo: bool | None
2243
- :param type: Type
2244
- :type type: typing.Literal['JOIN','JOINCOPY'] | None
2245
- :param leave_gaps: Leave Gaps, Leave gaps between joined strokes instead of linking them
2246
- :type leave_gaps: bool | None
2247
- """
2248
-
2249
- def stroke_merge(
2250
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2251
- execution_context: int | str | None = None,
2252
- undo: bool | None = None,
2253
- *,
2254
- mode: typing.Literal["STROKE", "POINT"] | None = "STROKE",
2255
- back: bool | None = False,
2256
- additive: bool | None = False,
2257
- cyclic: bool | None = False,
2258
- clear_point: bool | None = False,
2259
- clear_stroke: bool | None = False,
2260
- ):
2261
- """Create a new stroke with the selected stroke points
2262
-
2263
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2264
- :type execution_context: int | str | None
2265
- :type undo: bool | None
2266
- :param mode: Mode
2267
- :type mode: typing.Literal['STROKE','POINT'] | None
2268
- :param back: Draw on Back, Draw new stroke below all previous strokes
2269
- :type back: bool | None
2270
- :param additive: Additive Drawing, Add to previous drawing
2271
- :type additive: bool | None
2272
- :param cyclic: Cyclic, Close new stroke
2273
- :type cyclic: bool | None
2274
- :param clear_point: Dissolve Points, Dissolve old selected points
2275
- :type clear_point: bool | None
2276
- :param clear_stroke: Delete Strokes, Delete old selected strokes
2277
- :type clear_stroke: bool | None
2278
- """
2279
-
2280
- def stroke_merge_by_distance(
2281
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2282
- execution_context: int | str | None = None,
2283
- undo: bool | None = None,
2284
- *,
2285
- threshold: float | None = 0.001,
2286
- use_unselected: bool | None = False,
2287
- ):
2288
- """Merge points by distance
2289
-
2290
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2291
- :type execution_context: int | str | None
2292
- :type undo: bool | None
2293
- :param threshold: Threshold
2294
- :type threshold: float | None
2295
- :param use_unselected: Unselected, Use whole stroke, not only selected points
2296
- :type use_unselected: bool | None
2297
- """
2298
-
2299
- def stroke_merge_material(
2300
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2301
- execution_context: int | str | None = None,
2302
- undo: bool | None = None,
2303
- *,
2304
- hue_threshold: float | None = 0.001,
2305
- sat_threshold: float | None = 0.001,
2306
- val_threshold: float | None = 0.001,
2307
- ):
2308
- """Replace materials in strokes merging similar
2309
-
2310
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2311
- :type execution_context: int | str | None
2312
- :type undo: bool | None
2313
- :param hue_threshold: Hue Threshold
2314
- :type hue_threshold: float | None
2315
- :param sat_threshold: Saturation Threshold
2316
- :type sat_threshold: float | None
2317
- :param val_threshold: Value Threshold
2318
- :type val_threshold: float | None
2319
- """
2320
-
2321
- def stroke_normalize(
2322
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2323
- execution_context: int | str | None = None,
2324
- undo: bool | None = None,
2325
- *,
2326
- mode: typing.Literal["THICKNESS", "OPACITY"] | None = "THICKNESS",
2327
- factor: float | None = 1.0,
2328
- value: int | None = 10,
2329
- ):
2330
- """Normalize stroke attributes
2331
-
2332
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2333
- :type execution_context: int | str | None
2334
- :type undo: bool | None
2335
- :param mode: Mode, Attribute to be normalized
2336
-
2337
- THICKNESS
2338
- Thickness -- Normalizes the stroke thickness by making all points use the same thickness value.
2339
-
2340
- OPACITY
2341
- Opacity -- Normalizes the stroke opacity by making all points use the same opacity value.
2342
- :type mode: typing.Literal['THICKNESS','OPACITY'] | None
2343
- :param factor: Factor
2344
- :type factor: float | None
2345
- :param value: Value, Value
2346
- :type value: int | None
2347
- """
2348
-
2349
- def stroke_outline(
2350
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2351
- execution_context: int | str | None = None,
2352
- undo: bool | None = None,
2353
- *,
2354
- view_mode: typing.Literal["VIEW", "FRONT", "SIDE", "TOP", "CAMERA"] | None = "VIEW",
2355
- material_mode: typing.Literal["ACTIVE", "KEEP", "NEW"] | None = "ACTIVE",
2356
- thickness: int | None = 1,
2357
- keep: bool | None = True,
2358
- subdivisions: int | None = 3,
2359
- length: float | None = 0.0,
2360
- ):
2361
- """Convert stroke to perimeter
2362
-
2363
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2364
- :type execution_context: int | str | None
2365
- :type undo: bool | None
2366
- :param view_mode: View
2367
- :type view_mode: typing.Literal['VIEW','FRONT','SIDE','TOP','CAMERA'] | None
2368
- :param material_mode: Material Mode
2369
-
2370
- ACTIVE
2371
- Active Material.
2372
-
2373
- KEEP
2374
- Keep Material -- Keep current stroke material.
2375
-
2376
- NEW
2377
- New Material.
2378
- :type material_mode: typing.Literal['ACTIVE','KEEP','NEW'] | None
2379
- :param thickness: Thickness, Thickness of the stroke perimeter
2380
- :type thickness: int | None
2381
- :param keep: Keep Shape, Try to keep global shape when the stroke thickness change
2382
- :type keep: bool | None
2383
- :param subdivisions: Subdivisions
2384
- :type subdivisions: int | None
2385
- :param length: Sample Length
2386
- :type length: float | None
2387
- """
2388
-
2389
- def stroke_reset_vertex_color(
2390
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2391
- execution_context: int | str | None = None,
2392
- undo: bool | None = None,
2393
- *,
2394
- mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
2395
- ):
2396
- """Reset vertex color for all or selected strokes
2397
-
2398
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2399
- :type execution_context: int | str | None
2400
- :type undo: bool | None
2401
- :param mode: Mode
2402
-
2403
- STROKE
2404
- Stroke -- Reset Vertex Color to Stroke only.
2405
-
2406
- FILL
2407
- Fill -- Reset Vertex Color to Fill only.
2408
-
2409
- BOTH
2410
- Stroke & Fill -- Reset Vertex Color to Stroke and Fill.
2411
- :type mode: typing.Literal['STROKE','FILL','BOTH'] | None
2412
- """
2413
-
2414
- def stroke_sample(
2415
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2416
- execution_context: int | str | None = None,
2417
- undo: bool | None = None,
2418
- *,
2419
- length: float | None = 0.1,
2420
- sharp_threshold: float | None = 0.1,
2421
- ):
2422
- """Sample stroke points to predefined segment length
2423
-
2424
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2425
- :type execution_context: int | str | None
2426
- :type undo: bool | None
2427
- :param length: Length
2428
- :type length: float | None
2429
- :param sharp_threshold: Sharp Threshold
2430
- :type sharp_threshold: float | None
2431
- """
2432
-
2433
- def stroke_separate(
2434
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2435
- execution_context: int | str | None = None,
2436
- undo: bool | None = None,
2437
- *,
2438
- mode: typing.Literal["POINT", "STROKE", "LAYER"] | None = "POINT",
2439
- ):
2440
- """Separate the selected strokes or layer in a new grease pencil object
2441
-
2442
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2443
- :type execution_context: int | str | None
2444
- :type undo: bool | None
2445
- :param mode: Mode
2446
-
2447
- POINT
2448
- Selected Points -- Separate the selected points.
2449
-
2450
- STROKE
2451
- Selected Strokes -- Separate the selected strokes.
2452
-
2453
- LAYER
2454
- Active Layer -- Separate the strokes of the current layer.
2455
- :type mode: typing.Literal['POINT','STROKE','LAYER'] | None
2456
- """
2457
-
2458
- def stroke_simplify(
2459
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2460
- execution_context: int | str | None = None,
2461
- undo: bool | None = None,
2462
- *,
2463
- factor: float | None = 0.0,
2464
- ):
2465
- """Simplify selected strokes, reducing number of points
2466
-
2467
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2468
- :type execution_context: int | str | None
2469
- :type undo: bool | None
2470
- :param factor: Factor
2471
- :type factor: float | None
2472
- """
2473
-
2474
- def stroke_simplify_fixed(
2475
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2476
- execution_context: int | str | None = None,
2477
- undo: bool | None = None,
2478
- *,
2479
- step: int | None = 1,
2480
- ):
2481
- """Simplify selected strokes, reducing number of points using fixed algorithm
2482
-
2483
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2484
- :type execution_context: int | str | None
2485
- :type undo: bool | None
2486
- :param step: Steps, Number of simplify steps
2487
- :type step: int | None
2488
- """
2489
-
2490
- def stroke_smooth(
2491
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2492
- execution_context: int | str | None = None,
2493
- undo: bool | None = None,
2494
- *,
2495
- repeat: int | None = 2,
2496
- factor: float | None = 1.0,
2497
- only_selected: bool | None = True,
2498
- smooth_position: bool | None = True,
2499
- smooth_thickness: bool | None = True,
2500
- smooth_strength: bool | None = False,
2501
- smooth_uv: bool | None = False,
2502
- ):
2503
- """Smooth selected strokes
2504
-
2505
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2506
- :type execution_context: int | str | None
2507
- :type undo: bool | None
2508
- :param repeat: Repeat
2509
- :type repeat: int | None
2510
- :param factor: Factor
2511
- :type factor: float | None
2512
- :param only_selected: Selected Points, Smooth only selected points in the stroke
2513
- :type only_selected: bool | None
2514
- :param smooth_position: Position
2515
- :type smooth_position: bool | None
2516
- :param smooth_thickness: Thickness
2517
- :type smooth_thickness: bool | None
2518
- :param smooth_strength: Strength
2519
- :type smooth_strength: bool | None
2520
- :param smooth_uv: UV
2521
- :type smooth_uv: bool | None
2522
- """
2523
-
2524
- def stroke_split(
2525
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2526
- execution_context: int | str | None = None,
2527
- undo: bool | None = None,
2528
- ):
2529
- """Split selected points as new stroke on same frame
2530
-
2531
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2532
- :type execution_context: int | str | None
2533
- :type undo: bool | None
2534
- """
2535
-
2536
- def stroke_start_set(
2537
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2538
- execution_context: int | str | None = None,
2539
- undo: bool | None = None,
2540
- ):
2541
- """Set start point for cyclic strokes
2542
-
2543
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2544
- :type execution_context: int | str | None
2545
- :type undo: bool | None
2546
- """
2547
-
2548
- def stroke_subdivide(
2549
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2550
- execution_context: int | str | None = None,
2551
- undo: bool | None = None,
2552
- *,
2553
- number_cuts: int | None = 1,
2554
- factor: float | None = 0.0,
2555
- repeat: int | None = 1,
2556
- only_selected: bool | None = True,
2557
- smooth_position: bool | None = True,
2558
- smooth_thickness: bool | None = True,
2559
- smooth_strength: bool | None = False,
2560
- smooth_uv: bool | None = False,
2561
- ):
2562
- """Subdivide between continuous selected points of the stroke adding a point half way between them
2563
-
2564
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2565
- :type execution_context: int | str | None
2566
- :type undo: bool | None
2567
- :param number_cuts: Number of Cuts
2568
- :type number_cuts: int | None
2569
- :param factor: Smooth
2570
- :type factor: float | None
2571
- :param repeat: Repeat
2572
- :type repeat: int | None
2573
- :param only_selected: Selected Points, Smooth only selected points in the stroke
2574
- :type only_selected: bool | None
2575
- :param smooth_position: Position
2576
- :type smooth_position: bool | None
2577
- :param smooth_thickness: Thickness
2578
- :type smooth_thickness: bool | None
2579
- :param smooth_strength: Strength
2580
- :type smooth_strength: bool | None
2581
- :param smooth_uv: UV
2582
- :type smooth_uv: bool | None
2583
- """
2584
-
2585
- def stroke_trim(
2586
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2587
- execution_context: int | str | None = None,
2588
- undo: bool | None = None,
2589
- ):
2590
- """Trim selected stroke to first loop or intersection
2591
-
2592
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2593
- :type execution_context: int | str | None
2594
- :type undo: bool | None
2595
- """
2596
-
2597
- def tint_flip(
169
+ def tint_flip(
2598
170
  override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2599
171
  execution_context: int | str | None = None,
2600
172
  undo: bool | None = None,
@@ -2605,423 +177,3 @@ def tint_flip(
2605
177
  :type execution_context: int | str | None
2606
178
  :type undo: bool | None
2607
179
  """
2608
-
2609
- def trace_image(
2610
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2611
- execution_context: int | str | None = None,
2612
- undo: bool | None = None,
2613
- *,
2614
- target: typing.Literal["NEW", "SELECTED"] | None = "NEW",
2615
- thickness: int | None = 10,
2616
- resolution: int | None = 5,
2617
- scale: float | None = 1.0,
2618
- sample: float | None = 0.0,
2619
- threshold: float | None = 0.5,
2620
- turnpolicy: typing.Literal[
2621
- "BLACK", "WHITE", "LEFT", "RIGHT", "MINORITY", "MAJORITY", "RANDOM"
2622
- ]
2623
- | None = "MINORITY",
2624
- mode: typing.Literal["SINGLE", "SEQUENCE"] | None = "SINGLE",
2625
- use_current_frame: bool | None = True,
2626
- frame_number: int | None = 0,
2627
- ):
2628
- """Extract Grease Pencil strokes from image
2629
-
2630
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2631
- :type execution_context: int | str | None
2632
- :type undo: bool | None
2633
- :param target: Target Object, Target grease pencil
2634
- :type target: typing.Literal['NEW','SELECTED'] | None
2635
- :param thickness: Thickness
2636
- :type thickness: int | None
2637
- :param resolution: Resolution, Resolution of the generated curves
2638
- :type resolution: int | None
2639
- :param scale: Scale, Scale of the final stroke
2640
- :type scale: float | None
2641
- :param sample: Sample, Distance to sample points, zero to disable
2642
- :type sample: float | None
2643
- :param threshold: Color Threshold, Determine the lightness threshold above which strokes are generated
2644
- :type threshold: float | None
2645
- :param turnpolicy: Turn Policy, Determines how to resolve ambiguities during decomposition of bitmaps into paths
2646
-
2647
- BLACK
2648
- Black -- Prefers to connect black (foreground) components.
2649
-
2650
- WHITE
2651
- White -- Prefers to connect white (background) components.
2652
-
2653
- LEFT
2654
- Left -- Always take a left turn.
2655
-
2656
- RIGHT
2657
- Right -- Always take a right turn.
2658
-
2659
- MINORITY
2660
- Minority -- Prefers to connect the color (black or white) that occurs least frequently in the local neighborhood of the current position.
2661
-
2662
- MAJORITY
2663
- Majority -- Prefers to connect the color (black or white) that occurs most frequently in the local neighborhood of the current position.
2664
-
2665
- RANDOM
2666
- Random -- Choose pseudo-randomly.
2667
- :type turnpolicy: typing.Literal['BLACK','WHITE','LEFT','RIGHT','MINORITY','MAJORITY','RANDOM'] | None
2668
- :param mode: Mode, Determines if trace simple image or full sequence
2669
-
2670
- SINGLE
2671
- Single -- Trace the current frame of the image.
2672
-
2673
- SEQUENCE
2674
- Sequence -- Trace full sequence.
2675
- :type mode: typing.Literal['SINGLE','SEQUENCE'] | None
2676
- :param use_current_frame: Start At Current Frame, Trace Image starting in current image frame
2677
- :type use_current_frame: bool | None
2678
- :param frame_number: Trace Frame, Used to trace only one frame of the image sequence, set to zero to trace all
2679
- :type frame_number: int | None
2680
- """
2681
-
2682
- def transform_fill(
2683
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2684
- execution_context: int | str | None = None,
2685
- undo: bool | None = None,
2686
- *,
2687
- mode: typing.Literal["TRANSLATE", "ROTATE", "SCALE"] | None = "ROTATE",
2688
- location: collections.abc.Sequence[float] | mathutils.Vector | None = (0.0, 0.0),
2689
- rotation: float | None = 0.0,
2690
- scale: float | None = 0.0,
2691
- release_confirm: bool | None = False,
2692
- ):
2693
- """Transform grease pencil stroke fill
2694
-
2695
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2696
- :type execution_context: int | str | None
2697
- :type undo: bool | None
2698
- :param mode: Mode
2699
- :type mode: typing.Literal['TRANSLATE','ROTATE','SCALE'] | None
2700
- :param location: Location
2701
- :type location: collections.abc.Sequence[float] | mathutils.Vector | None
2702
- :param rotation: Rotation
2703
- :type rotation: float | None
2704
- :param scale: Scale
2705
- :type scale: float | None
2706
- :param release_confirm: Confirm on Release
2707
- :type release_confirm: bool | None
2708
- """
2709
-
2710
- def unlock_all(
2711
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2712
- execution_context: int | str | None = None,
2713
- undo: bool | None = None,
2714
- ):
2715
- """Unlock all Grease Pencil layers so that they can be edited
2716
-
2717
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2718
- :type execution_context: int | str | None
2719
- :type undo: bool | None
2720
- """
2721
-
2722
- def vertex_color_brightness_contrast(
2723
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2724
- execution_context: int | str | None = None,
2725
- undo: bool | None = None,
2726
- *,
2727
- mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
2728
- brightness: float | None = 0.0,
2729
- contrast: float | None = 0.0,
2730
- ):
2731
- """Adjust vertex color brightness/contrast
2732
-
2733
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2734
- :type execution_context: int | str | None
2735
- :type undo: bool | None
2736
- :param mode: Mode
2737
- :type mode: typing.Literal['STROKE','FILL','BOTH'] | None
2738
- :param brightness: Brightness
2739
- :type brightness: float | None
2740
- :param contrast: Contrast
2741
- :type contrast: float | None
2742
- """
2743
-
2744
- def vertex_color_hsv(
2745
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2746
- execution_context: int | str | None = None,
2747
- undo: bool | None = None,
2748
- *,
2749
- mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
2750
- h: float | None = 0.5,
2751
- s: float | None = 1.0,
2752
- v: float | None = 1.0,
2753
- ):
2754
- """Adjust vertex color HSV values
2755
-
2756
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2757
- :type execution_context: int | str | None
2758
- :type undo: bool | None
2759
- :param mode: Mode
2760
- :type mode: typing.Literal['STROKE','FILL','BOTH'] | None
2761
- :param h: Hue
2762
- :type h: float | None
2763
- :param s: Saturation
2764
- :type s: float | None
2765
- :param v: Value
2766
- :type v: float | None
2767
- """
2768
-
2769
- def vertex_color_invert(
2770
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2771
- execution_context: int | str | None = None,
2772
- undo: bool | None = None,
2773
- *,
2774
- mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
2775
- ):
2776
- """Invert RGB values
2777
-
2778
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2779
- :type execution_context: int | str | None
2780
- :type undo: bool | None
2781
- :param mode: Mode
2782
- :type mode: typing.Literal['STROKE','FILL','BOTH'] | None
2783
- """
2784
-
2785
- def vertex_color_levels(
2786
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2787
- execution_context: int | str | None = None,
2788
- undo: bool | None = None,
2789
- *,
2790
- mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
2791
- offset: float | None = 0.0,
2792
- gain: float | None = 1.0,
2793
- ):
2794
- """Adjust levels of vertex colors
2795
-
2796
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2797
- :type execution_context: int | str | None
2798
- :type undo: bool | None
2799
- :param mode: Mode
2800
- :type mode: typing.Literal['STROKE','FILL','BOTH'] | None
2801
- :param offset: Offset, Value to add to colors
2802
- :type offset: float | None
2803
- :param gain: Gain, Value to multiply colors by
2804
- :type gain: float | None
2805
- """
2806
-
2807
- def vertex_color_set(
2808
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2809
- execution_context: int | str | None = None,
2810
- undo: bool | None = None,
2811
- *,
2812
- mode: typing.Literal["STROKE", "FILL", "BOTH"] | None = "BOTH",
2813
- factor: float | None = 1.0,
2814
- ):
2815
- """Set active color to all selected vertex
2816
-
2817
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2818
- :type execution_context: int | str | None
2819
- :type undo: bool | None
2820
- :param mode: Mode
2821
- :type mode: typing.Literal['STROKE','FILL','BOTH'] | None
2822
- :param factor: Factor, Mix Factor
2823
- :type factor: float | None
2824
- """
2825
-
2826
- def vertex_group_assign(
2827
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2828
- execution_context: int | str | None = None,
2829
- undo: bool | None = None,
2830
- ):
2831
- """Assign the selected vertices to the active vertex group
2832
-
2833
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2834
- :type execution_context: int | str | None
2835
- :type undo: bool | None
2836
- """
2837
-
2838
- def vertex_group_deselect(
2839
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2840
- execution_context: int | str | None = None,
2841
- undo: bool | None = None,
2842
- ):
2843
- """Deselect all selected vertices assigned to the active vertex group
2844
-
2845
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2846
- :type execution_context: int | str | None
2847
- :type undo: bool | None
2848
- """
2849
-
2850
- def vertex_group_invert(
2851
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2852
- execution_context: int | str | None = None,
2853
- undo: bool | None = None,
2854
- ):
2855
- """Invert weights to the active vertex group
2856
-
2857
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2858
- :type execution_context: int | str | None
2859
- :type undo: bool | None
2860
- """
2861
-
2862
- def vertex_group_normalize(
2863
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2864
- execution_context: int | str | None = None,
2865
- undo: bool | None = None,
2866
- ):
2867
- """Normalize weights to the active vertex group
2868
-
2869
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2870
- :type execution_context: int | str | None
2871
- :type undo: bool | None
2872
- """
2873
-
2874
- def vertex_group_normalize_all(
2875
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2876
- execution_context: int | str | None = None,
2877
- undo: bool | None = None,
2878
- *,
2879
- lock_active: bool | None = True,
2880
- ):
2881
- """Normalize all weights of all vertex groups, so that for each vertex, the sum of all weights is 1.0
2882
-
2883
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2884
- :type execution_context: int | str | None
2885
- :type undo: bool | None
2886
- :param lock_active: Lock Active, Keep the values of the active group while normalizing others
2887
- :type lock_active: bool | None
2888
- """
2889
-
2890
- def vertex_group_remove_from(
2891
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2892
- execution_context: int | str | None = None,
2893
- undo: bool | None = None,
2894
- ):
2895
- """Remove the selected vertices from active or all vertex group(s)
2896
-
2897
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2898
- :type execution_context: int | str | None
2899
- :type undo: bool | None
2900
- """
2901
-
2902
- def vertex_group_select(
2903
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2904
- execution_context: int | str | None = None,
2905
- undo: bool | None = None,
2906
- ):
2907
- """Select all the vertices assigned to the active vertex group
2908
-
2909
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2910
- :type execution_context: int | str | None
2911
- :type undo: bool | None
2912
- """
2913
-
2914
- def vertex_group_smooth(
2915
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2916
- execution_context: int | str | None = None,
2917
- undo: bool | None = None,
2918
- *,
2919
- factor: float | None = 0.5,
2920
- repeat: int | None = 1,
2921
- ):
2922
- """Smooth weights to the active vertex group
2923
-
2924
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2925
- :type execution_context: int | str | None
2926
- :type undo: bool | None
2927
- :param factor: Factor
2928
- :type factor: float | None
2929
- :param repeat: Iterations
2930
- :type repeat: int | None
2931
- """
2932
-
2933
- def vertex_paint(
2934
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2935
- execution_context: int | str | None = None,
2936
- undo: bool | None = None,
2937
- *,
2938
- stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
2939
- | None = None,
2940
- wait_for_input: bool | None = True,
2941
- ):
2942
- """Paint stroke points with a color
2943
-
2944
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2945
- :type execution_context: int | str | None
2946
- :type undo: bool | None
2947
- :param stroke: Stroke
2948
- :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
2949
- :param wait_for_input: Wait for Input
2950
- :type wait_for_input: bool | None
2951
- """
2952
-
2953
- def vertexmode_toggle(
2954
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2955
- execution_context: int | str | None = None,
2956
- undo: bool | None = None,
2957
- *,
2958
- back: bool | None = False,
2959
- ):
2960
- """Enter/Exit vertex paint mode for Grease Pencil strokes
2961
-
2962
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2963
- :type execution_context: int | str | None
2964
- :type undo: bool | None
2965
- :param back: Return to Previous Mode, Return to previous mode
2966
- :type back: bool | None
2967
- """
2968
-
2969
- def weight_paint(
2970
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2971
- execution_context: int | str | None = None,
2972
- undo: bool | None = None,
2973
- *,
2974
- stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
2975
- | None = None,
2976
- wait_for_input: bool | None = True,
2977
- ):
2978
- """Draw weight on stroke points
2979
-
2980
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2981
- :type execution_context: int | str | None
2982
- :type undo: bool | None
2983
- :param stroke: Stroke
2984
- :type stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement] | None
2985
- :param wait_for_input: Wait for Input
2986
- :type wait_for_input: bool | None
2987
- """
2988
-
2989
- def weight_sample(
2990
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
2991
- execution_context: int | str | None = None,
2992
- undo: bool | None = None,
2993
- ):
2994
- """Use the mouse to sample a weight in the 3D view
2995
-
2996
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
2997
- :type execution_context: int | str | None
2998
- :type undo: bool | None
2999
- """
3000
-
3001
- def weight_toggle_direction(
3002
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
3003
- execution_context: int | str | None = None,
3004
- undo: bool | None = None,
3005
- ):
3006
- """Toggle Add/Subtract for the weight paint draw tool
3007
-
3008
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
3009
- :type execution_context: int | str | None
3010
- :type undo: bool | None
3011
- """
3012
-
3013
- def weightmode_toggle(
3014
- override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
3015
- execution_context: int | str | None = None,
3016
- undo: bool | None = None,
3017
- *,
3018
- back: bool | None = False,
3019
- ):
3020
- """Enter/Exit weight paint mode for Grease Pencil strokes
3021
-
3022
- :type override_context: bpy.types.Context | dict[str, typing.Any] | None
3023
- :type execution_context: int | str | None
3024
- :type undo: bool | None
3025
- :param back: Return to Previous Mode, Return to previous mode
3026
- :type back: bool | None
3027
- """