fake-bpy-module 20250628__py3-none-any.whl → 20250830__py3-none-any.whl

bpy/ops/grease_pencil/__init__.pyi

@@ -63,7 +63,7 @@ def bake_grease_pencil_animation(
     Top -- Reproject the strokes using the X-Y plane.
 
     VIEW
-    View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using 'Cursor' Stroke Placement.
+    View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using Cursor Stroke Placement.
 
     CURSOR
     Cursor -- Reproject the strokes using the orientation of 3D cursor.
@@ -100,7 +100,7 @@ def brush_stroke(
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
         :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
-        :param pen_flip: Pen Flip, Whether a tablet's eraser mode is being used
+        :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :type pen_flip: bool | None
     """
 
@@ -164,7 +164,11 @@ def convert_curve_type(
     :type threshold: float | None
     """
 
-def copy(execution_context: int | str | None = None, undo: bool | None = None) -> None:
+def copy(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+) -> None:
     """Copy the selected Grease Pencil points or strokes to the internal clipboard
 
     :type execution_context: int | str | None
@@ -190,7 +194,9 @@ def cyclical_set(
     """
 
 def delete(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Delete selected strokes or points
 
@@ -199,7 +205,9 @@ def delete(
     """
 
 def delete_breakdown(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Remove breakdown frames generated by interpolating between two Grease Pencil frames
 
@@ -253,7 +261,9 @@ def dissolve(
     """
 
 def duplicate(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Duplicate the selected points
 
@@ -331,7 +341,9 @@ def erase_lasso(
     """
 
 def extrude(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Extrude the selected points
 
@@ -489,7 +501,7 @@ def interpolate_sequence(
     amplitude: float | None = 0.15,
     period: float | None = 0.15,
 ) -> None:
-    """Generate 'in-betweens' to smoothly interpolate between Grease Pencil frames
+    """Generate in-betweens to smoothly interpolate between Grease Pencil frames
 
         :type execution_context: int | str | None
         :type undo: bool | None
@@ -507,7 +519,7 @@ def interpolate_sequence(
         :type smooth_steps: int | None
         :param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
         :type smooth_factor: float | None
-        :param type: Type, Interpolation method to use the next time 'Interpolate Sequence' is run
+        :param type: Type, Interpolation method to use the next time Interpolate Sequence is run
 
     LINEAR
     Linear -- Straight-line interpolation between A and B (i.e. no ease in/out).
@@ -547,9 +559,9 @@ def interpolate_sequence(
         :type type: typing.Literal['LINEAR','CUSTOM','SINE','QUAD','CUBIC','QUART','QUINT','EXPO','CIRC','BACK','BOUNCE','ELASTIC'] | None
         :param easing: Easing, Which ends of the segment between the preceding and following Grease Pencil frames easing interpolation is applied to
         :type easing: bpy.stub_internal.rna_enums.BeztripleInterpolationEasingItems | None
-        :param back: Back, Amount of overshoot for 'back' easing
+        :param back: Back, Amount of overshoot for back easing
         :type back: float | None
-        :param amplitude: Amplitude, Amount to boost elastic bounces for 'elastic' easing
+        :param amplitude: Amplitude, Amount to boost elastic bounces for elastic easing
         :type amplitude: float | None
         :param period: Period, Time between bounces for elastic easing
         :type period: float | None
@@ -560,7 +572,7 @@ def join_selection(
     undo: bool | None = None,
     /,
     *,
-    type: typing.Literal["JOINCOPY", "JOIN"] | None = "JOIN",
+    type: typing.Literal["JOINSTROKES", "SPLITCOPY", "SPLIT"] | None = "JOINSTROKES",
 ) -> None:
     """New stroke from selected points/strokes
 
@@ -568,12 +580,15 @@ def join_selection(
         :type undo: bool | None
         :param type: Type, Defines how the operator will behave on the selection in the active layer
 
-    JOINCOPY
-    Join and Copy -- Copy the selection in the new stroke.
+    JOINSTROKES
+    Join Strokes -- Join the selected strokes into one stroke.
 
-    JOIN
-    Join -- Move the selection to the new stroke.
-        :type type: typing.Literal['JOINCOPY','JOIN'] | None
+    SPLITCOPY
+    Split and Copy -- Copy the selected points to a new stroke.
+
+    SPLIT
+    Split -- Split the selected point to a new stroke.
+        :type type: typing.Literal['JOINSTROKES','SPLITCOPY','SPLIT'] | None
     """
 
 def layer_active(
@@ -756,7 +771,9 @@ def layer_mask_add(
     """
 
 def layer_mask_remove(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Remove Layer Mask
 
@@ -819,7 +836,9 @@ def layer_move(
     """
 
 def layer_remove(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Remove the active Grease Pencil layer
 
@@ -828,7 +847,9 @@ def layer_remove(
     """
 
 def layer_reveal(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Show all Grease Pencil layers
 
@@ -882,7 +903,9 @@ def material_isolate(
     """
 
 def material_lock_all(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Lock all Grease Pencil materials to prevent them from being accidentally modified
 
@@ -891,7 +914,9 @@ def material_lock_all(
     """
 
 def material_lock_unselected(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Lock any material not used in any selected stroke
 
@@ -900,7 +925,9 @@ def material_lock_unselected(
     """
 
 def material_lock_unused(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Lock and hide any material not used
 
@@ -909,7 +936,9 @@ def material_lock_unused(
     """
 
 def material_reveal(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Unhide all hidden Grease Pencil materials
 
@@ -933,7 +962,9 @@ def material_select(
     """
 
 def material_unlock_all(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Unlock all Grease Pencil materials so that they can be edited
 
@@ -1020,6 +1051,60 @@ def paste(
     :type keep_world_transform: bool | None
     """
 
+def pen(
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
+    *,
+    extend: bool | None = False,
+    deselect: bool | None = False,
+    toggle: bool | None = False,
+    deselect_all: bool | None = False,
+    select_passthrough: bool | None = False,
+    extrude_point: bool | None = False,
+    extrude_handle: typing.Literal["AUTO", "VECTOR"] | None = "VECTOR",
+    delete_point: bool | None = False,
+    insert_point: bool | None = False,
+    move_segment: bool | None = False,
+    select_point: bool | None = False,
+    move_point: bool | None = False,
+    cycle_handle_type: bool | None = False,
+    radius: float | None = 0.01,
+) -> None:
+    """Construct and edit splines
+
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param extend: Extend, Extend selection instead of deselecting everything first
+    :type extend: bool | None
+    :param deselect: Deselect, Remove from selection
+    :type deselect: bool | None
+    :param toggle: Toggle Selection, Toggle the selection
+    :type toggle: bool | None
+    :param deselect_all: Deselect On Nothing, Deselect all when nothing under the cursor
+    :type deselect_all: bool | None
+    :param select_passthrough: Only Select Unselected, Ignore the select action when the element is already selected
+    :type select_passthrough: bool | None
+    :param extrude_point: Extrude Point, Add a point connected to the last selected point
+    :type extrude_point: bool | None
+    :param extrude_handle: Extrude Handle Type, Type of the extruded handle
+    :type extrude_handle: typing.Literal['AUTO','VECTOR'] | None
+    :param delete_point: Delete Point, Delete an existing point
+    :type delete_point: bool | None
+    :param insert_point: Insert Point, Insert Point into a curve segment
+    :type insert_point: bool | None
+    :param move_segment: Move Segment, Delete an existing point
+    :type move_segment: bool | None
+    :param select_point: Select Point, Select a point or its handles
+    :type select_point: bool | None
+    :param move_point: Move Point, Move a point or its handles
+    :type move_point: bool | None
+    :param cycle_handle_type: Cycle Handle Type, Cycle between all four handle types
+    :type cycle_handle_type: bool | None
+    :param radius: Radius
+    :type radius: float | None
+    """
+
 def primitive_arc(
     execution_context: int | str | None = None,
     undo: bool | None = None,
@@ -1205,10 +1290,10 @@ def reproject(
     Top -- Reproject the strokes using the X-Y plane.
 
     VIEW
-    View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using 'Cursor' Stroke Placement.
+    View -- Reproject the strokes to end up on the same plane, as if drawn from the current viewpoint using Cursor Stroke Placement.
 
     SURFACE
-    Surface -- Reproject the strokes on to the scene geometry, as if drawn using 'Surface' placement.
+    Surface -- Reproject the strokes on to the scene geometry, as if drawn using Surface placement.
 
     CURSOR
     Cursor -- Reproject the strokes using the orientation of 3D cursor.
@@ -1220,7 +1305,9 @@ def reproject(
     """
 
 def reset_uvs(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Reset UV transformation to default values
 
@@ -1258,7 +1345,7 @@ def sculpt_paint(
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
         :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
-        :param pen_flip: Pen Flip, Whether a tablet's eraser mode is being used
+        :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :type pen_flip: bool | None
     """
 
@@ -1338,7 +1425,9 @@ def select_ends(
     """
 
 def select_less(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Shrink the selection by one point
 
@@ -1347,7 +1436,9 @@ def select_less(
     """
 
 def select_linked(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Select all points in curves with any point selection
 
@@ -1356,7 +1447,9 @@ def select_linked(
     """
 
 def select_more(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Grow the selection by one point
 
@@ -1435,7 +1528,9 @@ def separate(
     """
 
 def set_active_material(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Set the selected stroke material as the active material
 
@@ -1481,14 +1576,30 @@ def set_handle_type(
     undo: bool | None = None,
     /,
     *,
-    type: bpy.stub_internal.rna_enums.CurvesHandleTypeItems | None = "AUTO",
+    type: typing.Literal["AUTO", "VECTOR", "ALIGN", "FREE_ALIGN", "TOGGLE_FREE_ALIGN"]
+    | None = "AUTO",
 ) -> None:
     """Set the handle type for bezier curves
 
-    :type execution_context: int | str | None
-    :type undo: bool | None
-    :param type: Type
-    :type type: bpy.stub_internal.rna_enums.CurvesHandleTypeItems | None
+        :type execution_context: int | str | None
+        :type undo: bool | None
+        :param type: Type
+
+    AUTO
+    Auto -- The location is automatically calculated to be smooth.
+
+    VECTOR
+    Vector -- The location is calculated to point to the next/previous control point.
+
+    ALIGN
+    Align -- The location is constrained to point in the opposite direction as the other handle.
+
+    FREE_ALIGN
+    Free -- The handle can be moved anywhere, and does not influence the points other handle.
+
+    TOGGLE_FREE_ALIGN
+    Toggle Free/Align -- Replace Free handles with Align, and all Align with Free handles.
+        :type type: typing.Literal['AUTO','VECTOR','ALIGN','FREE_ALIGN','TOGGLE_FREE_ALIGN'] | None
     """
 
 def set_material(
@@ -1522,7 +1633,9 @@ def set_selection_mode(
     """
 
 def set_start_point(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Select which point is the beginning of the curve
 
@@ -1564,7 +1677,9 @@ def set_uniform_thickness(
     """
 
 def snap_cursor_to_selected(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Snap cursor to center of selected points
 
@@ -1588,7 +1703,9 @@ def snap_to_cursor(
     """
 
 def snap_to_grid(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Snap selected points to the nearest grid points
 
@@ -1717,7 +1834,9 @@ def stroke_smooth(
     """
 
 def stroke_split(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Split selected points to a new stroke
 
@@ -1762,7 +1881,9 @@ def stroke_subdivide_smooth(
     """
 
 def stroke_switch_direction(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Change direction of the points of the selected strokes
 
@@ -1917,7 +2038,7 @@ def vertex_brush_stroke(
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
         :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
-        :param pen_flip: Pen Flip, Whether a tablet's eraser mode is being used
+        :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :type pen_flip: bool | None
     """
 
@@ -2021,7 +2142,9 @@ def vertex_color_set(
     """
 
 def vertex_group_normalize(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Normalize weights of the active vertex group
 
@@ -2107,12 +2230,14 @@ def weight_brush_stroke(
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
         :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
-        :param pen_flip: Pen Flip, Whether a tablet's eraser mode is being used
+        :param pen_flip: Pen Flip, Whether a tablets eraser mode is being used
         :type pen_flip: bool | None
     """
 
 def weight_invert(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Invert the weight of active vertex group
 
@@ -2121,7 +2246,9 @@ def weight_invert(
     """
 
 def weight_sample(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Set the weight of the Draw tool to the weight of the vertex under the mouse cursor
 
@@ -2130,7 +2257,9 @@ def weight_sample(
     """
 
 def weight_toggle_direction(
-    execution_context: int | str | None = None, undo: bool | None = None
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    /,
 ) -> None:
     """Toggle Add/Subtract for the weight paint draw tool