fake-bpy-module 20240802__py3-none-any.whl → 20240804__py3-none-any.whl

bpy/ops/grease_pencil/__init__.pyi

@@ -7,6 +7,24 @@ import bpy.types
 GenericType1 = typing.TypeVar("GenericType1")
 GenericType2 = typing.TypeVar("GenericType2")
 
+def active_frame_delete(
+    override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
+    execution_context: int | str | None = None,
+    undo: bool | None = None,
+    *,
+    all: bool | None = False,
+):
+    """Delete the active Grease Pencil frame(s)
+
+    :type override_context: bpy.types.Context | dict[str, typing.Any] | None
+    :type execution_context: int | str | None
+    :type undo: bool | None
+    :param all: Delete all, Delete active keyframes of all layer
+    :type all: bool | None
+    """
+
+    ...
+
 def brush_stroke(
     override_context: bpy.types.Context | dict[str, typing.Any] | None = None,
     execution_context: int | str | None = None,
@@ -14,7 +32,7 @@ def brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: str | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
 ):
     """Draw a new stroke in the active Grease Pencil object
 
@@ -36,7 +54,7 @@ def brush_stroke(
 
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
-        :type mode: str | None
+        :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
     """
 
     ...
@@ -46,7 +64,7 @@ def caps_set(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ROUND",
+    type: typing.Literal["ROUND", "FLAT", "START", "END"] | None = "ROUND",
 ):
     """Change curve caps mode (rounded or flat)
 
@@ -66,7 +84,7 @@ def caps_set(
 
     END
     Toggle End.
-        :type type: str | None
+        :type type: typing.Literal['ROUND','FLAT','START','END'] | None
     """
 
     ...
@@ -108,7 +126,7 @@ def cyclical_set(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "TOGGLE",
+    type: typing.Literal["CLOSE", "OPEN", "TOGGLE"] | None = "TOGGLE",
 ):
     """Close or open the selected stroke adding a segment from last to first point
 
@@ -116,7 +134,7 @@ def cyclical_set(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['CLOSE','OPEN','TOGGLE'] | None
     """
 
     ...
@@ -140,7 +158,7 @@ def delete_frame(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ACTIVE_FRAME",
+    type: typing.Literal["ACTIVE_FRAME", "ALL_FRAMES"] | None = "ACTIVE_FRAME",
 ):
     """Delete Grease Pencil Frame(s)
 
@@ -154,7 +172,7 @@ def delete_frame(
 
     ALL_FRAMES
     All Active Frames -- Delete active frames for all layers.
-        :type type: str | None
+        :type type: typing.Literal['ACTIVE_FRAME','ALL_FRAMES'] | None
     """
 
     ...
@@ -164,7 +182,7 @@ def dissolve(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "POINTS",
+    type: typing.Literal["POINTS", "BETWEEN", "UNSELECT"] | None = "POINTS",
 ):
     """Delete selected points without splitting strokes
 
@@ -181,7 +199,7 @@ def dissolve(
 
     UNSELECT
     Dissolve Unselect -- Dissolve all unselected points.
-        :type type: str | None
+        :type type: typing.Literal['POINTS','BETWEEN','UNSELECT'] | None
     """
 
     ...
@@ -340,9 +358,9 @@ def interpolate(
     undo: bool | None = None,
     *,
     shift: float | None = 0.0,
-    layers: str | None = "ACTIVE",
+    layers: typing.Literal["ACTIVE", "ALL"] | None = "ACTIVE",
     exclude_breakdowns: bool | None = False,
-    flip: str | None = "AUTO",
+    flip: typing.Literal["NONE", "FLIP", "AUTO"] | None = "AUTO",
     smooth_steps: int | None = 1,
     smooth_factor: float | None = 0.0,
 ):
@@ -354,11 +372,11 @@ def interpolate(
     :param shift: Shift, Bias factor for which frame has more influence on the interpolated strokes
     :type shift: float | None
     :param layers: Layer, Layers included in the interpolation
-    :type layers: str | None
+    :type layers: typing.Literal['ACTIVE','ALL'] | None
     :param exclude_breakdowns: Exclude Breakdowns, Exclude existing Breakdowns keyframes as interpolation extremes
     :type exclude_breakdowns: bool | None
     :param flip: Flip Mode, Invert destination stroke to match start and end with source stroke
-    :type flip: str | None
+    :type flip: typing.Literal['NONE','FLIP','AUTO'] | None
     :param smooth_steps: Iterations, Number of times to smooth newly created strokes
     :type smooth_steps: int | None
     :param smooth_factor: Smooth, Amount of smoothing to apply to interpolated strokes, to reduce jitter/noise
@@ -427,7 +445,7 @@ def layer_duplicate_object(
     undo: bool | None = None,
     *,
     only_active: bool | None = True,
-    mode: str | None = "ALL",
+    mode: typing.Literal["ALL", "ACTIVE"] | None = "ALL",
 ):
     """Make a copy of the active Grease Pencil layer to selected object
 
@@ -437,7 +455,7 @@ def layer_duplicate_object(
     :param only_active: Only Active, Copy only active Layer, uncheck to append all layers
     :type only_active: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['ALL','ACTIVE'] | None
     """
 
     ...
@@ -465,7 +483,18 @@ def layer_group_color_tag(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    color_tag: str | None = "COLOR1",
+    color_tag: typing.Literal[
+        "NONE",
+        "COLOR1",
+        "COLOR2",
+        "COLOR3",
+        "COLOR4",
+        "COLOR5",
+        "COLOR6",
+        "COLOR7",
+        "COLOR8",
+    ]
+    | None = "COLOR1",
 ):
     """Change layer group icon
 
@@ -473,7 +502,7 @@ def layer_group_color_tag(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param color_tag: color tag
-    :type color_tag: str | None
+    :type color_tag: typing.Literal['NONE','COLOR1','COLOR2','COLOR3','COLOR4','COLOR5','COLOR6','COLOR7','COLOR8'] | None
     """
 
     ...
@@ -587,7 +616,7 @@ def layer_mask_reorder(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Reorder the active Grease Pencil mask layer up/down in the list
 
@@ -595,7 +624,7 @@ def layer_mask_reorder(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction
-    :type direction: str | None
+    :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...
@@ -620,7 +649,7 @@ def layer_reorder(
     undo: bool | None = None,
     *,
     target_layer_name: str = "Layer",
-    location: str | None = "ABOVE",
+    location: typing.Literal["ABOVE", "BELOW"] | None = "ABOVE",
 ):
     """Reorder the active Grease Pencil layer
 
@@ -630,7 +659,7 @@ def layer_reorder(
     :param target_layer_name: Target Name, Name of the target layer
     :type target_layer_name: str
     :param location: Location
-    :type location: str | None
+    :type location: typing.Literal['ABOVE','BELOW'] | None
     """
 
     ...
@@ -818,7 +847,8 @@ def primitive_arc(
     undo: bool | None = None,
     *,
     subdivision: int | None = 62,
-    type: str | None = "ARC",
+    type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
+    | None = "ARC",
 ):
     """Create predefined grease pencil stroke arcs
 
@@ -828,7 +858,7 @@ def primitive_arc(
     :param subdivision: Subdivisions, Number of subdivisions per segment
     :type subdivision: int | None
     :param type: Type, Type of shape
-    :type type: str | None
+    :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
     """
 
     ...
@@ -839,7 +869,8 @@ def primitive_box(
     undo: bool | None = None,
     *,
     subdivision: int | None = 3,
-    type: str | None = "BOX",
+    type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
+    | None = "BOX",
 ):
     """Create predefined grease pencil stroke boxes
 
@@ -849,7 +880,7 @@ def primitive_box(
     :param subdivision: Subdivisions, Number of subdivisions per segment
     :type subdivision: int | None
     :param type: Type, Type of shape
-    :type type: str | None
+    :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
     """
 
     ...
@@ -860,7 +891,8 @@ def primitive_circle(
     undo: bool | None = None,
     *,
     subdivision: int | None = 94,
-    type: str | None = "CIRCLE",
+    type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
+    | None = "CIRCLE",
 ):
     """Create predefined grease pencil stroke circles
 
@@ -870,7 +902,7 @@ def primitive_circle(
     :param subdivision: Subdivisions, Number of subdivisions per segment
     :type subdivision: int | None
     :param type: Type, Type of shape
-    :type type: str | None
+    :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
     """
 
     ...
@@ -881,7 +913,8 @@ def primitive_curve(
     undo: bool | None = None,
     *,
     subdivision: int | None = 62,
-    type: str | None = "CURVE",
+    type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
+    | None = "CURVE",
 ):
     """Create predefined grease pencil stroke curve shapes
 
@@ -891,7 +924,7 @@ def primitive_curve(
     :param subdivision: Subdivisions, Number of subdivisions per segment
     :type subdivision: int | None
     :param type: Type, Type of shape
-    :type type: str | None
+    :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
     """
 
     ...
@@ -902,7 +935,8 @@ def primitive_line(
     undo: bool | None = None,
     *,
     subdivision: int | None = 6,
-    type: str | None = "LINE",
+    type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
+    | None = "LINE",
 ):
     """Create predefined grease pencil stroke lines
 
@@ -912,7 +946,7 @@ def primitive_line(
     :param subdivision: Subdivisions, Number of subdivisions per segment
     :type subdivision: int | None
     :param type: Type, Type of shape
-    :type type: str | None
+    :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
     """
 
     ...
@@ -923,7 +957,8 @@ def primitive_polyline(
     undo: bool | None = None,
     *,
     subdivision: int | None = 6,
-    type: str | None = "POLYLINE",
+    type: typing.Literal["BOX", "LINE", "POLYLINE", "CIRCLE", "ARC", "CURVE"]
+    | None = "POLYLINE",
 ):
     """Create predefined grease pencil stroke polylines
 
@@ -933,7 +968,7 @@ def primitive_polyline(
     :param subdivision: Subdivisions, Number of subdivisions per segment
     :type subdivision: int | None
     :param type: Type, Type of shape
-    :type type: str | None
+    :type type: typing.Literal['BOX','LINE','POLYLINE','CIRCLE','ARC','CURVE'] | None
     """
 
     ...
@@ -943,7 +978,7 @@ def reorder(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "TOP",
+    direction: typing.Literal["TOP", "UP", "DOWN", "BOTTOM"] | None = "TOP",
 ):
     """Change the display order of the selected strokes
 
@@ -951,7 +986,7 @@ def reorder(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param direction: Direction
-    :type direction: str | None
+    :type direction: typing.Literal['TOP','UP','DOWN','BOTTOM'] | None
     """
 
     ...
@@ -963,7 +998,7 @@ def sculpt_paint(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: str | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
 ):
     """Draw a new stroke in the active Grease Pencil object
 
@@ -985,7 +1020,7 @@ def sculpt_paint(
 
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
-        :type mode: str | None
+        :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
     """
 
     ...
@@ -995,7 +1030,7 @@ def select_all(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    action: str | None = "TOGGLE",
+    action: typing.Literal["TOGGLE", "SELECT", "DESELECT", "INVERT"] | None = "TOGGLE",
 ):
     """(De)select all visible strokes
 
@@ -1015,7 +1050,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -1108,7 +1143,7 @@ def select_random(
     *,
     ratio: float | None = 0.5,
     seed: int | None = 0,
-    action: str | None = "SELECT",
+    action: typing.Literal["SELECT", "DESELECT"] | None = "SELECT",
 ):
     """Selects random points from the current strokes selection
 
@@ -1126,7 +1161,7 @@ def select_random(
 
     DESELECT
     Deselect -- Deselect all elements.
-        :type action: str | None
+        :type action: typing.Literal['SELECT','DESELECT'] | None
     """
 
     ...
@@ -1136,7 +1171,7 @@ def separate(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "SELECTED",
+    mode: typing.Literal["SELECTED", "MATERIAL", "LAYER"] | None = "SELECTED",
 ):
     """Separate the selected geometry into a new grease pencil object
 
@@ -1153,7 +1188,7 @@ def separate(
 
     LAYER
     By Layer -- Separate by layer.
-        :type mode: str | None
+        :type mode: typing.Literal['SELECTED','MATERIAL','LAYER'] | None
     """
 
     ...
@@ -1195,7 +1230,7 @@ def set_curve_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "POLY",
+    type: typing.Literal["CATMULL_ROM", "POLY", "BEZIER", "NURBS"] | None = "POLY",
     use_handles: bool | None = False,
 ):
     """Set type of selected curves
@@ -1204,7 +1239,7 @@ def set_curve_type(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type, Curve type
-    :type type: str | None
+    :type type: typing.Literal['CATMULL_ROM', 'POLY', 'BEZIER', 'NURBS'] | None
     :param use_handles: Handles, Take handle information into account in the conversion
     :type use_handles: bool | None
     """
@@ -1216,7 +1251,7 @@ def set_handle_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "AUTO",
+    type: typing.Literal["FREE", "AUTO", "VECTOR", "ALIGN"] | None = "AUTO",
 ):
     """Set the handle type for bezier curves
 
@@ -1224,7 +1259,7 @@ def set_handle_type(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['FREE', 'AUTO', 'VECTOR', 'ALIGN'] | None
     """
 
     ...
@@ -1252,7 +1287,7 @@ def set_selection_mode(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "POINT",
+    mode: typing.Literal["POINT", "STROKE", "SEGMENT"] | None = "POINT",
 ):
     """Change the selection mode for Grease Pencil strokes
 
@@ -1260,7 +1295,7 @@ def set_selection_mode(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['POINT', 'STROKE', 'SEGMENT'] | None
     """
 
     ...
@@ -1528,11 +1563,14 @@ def trace_image(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    target: str | None = "NEW",
+    target: typing.Literal["NEW", "SELECTED"] | None = "NEW",
     radius: float | None = 0.01,
     threshold: float | None = 0.5,
-    turnpolicy: str | None = "MINORITY",
-    mode: str | None = "SINGLE",
+    turnpolicy: typing.Literal[
+        "FOREGROUND", "BACKGROUND", "LEFT", "RIGHT", "MINORITY", "MAJORITY", "RANDOM"
+    ]
+    | None = "MINORITY",
+    mode: typing.Literal["SINGLE", "SEQUENCE"] | None = "SINGLE",
     use_current_frame: bool | None = True,
     frame_number: int | None = 0,
 ):
@@ -1542,7 +1580,7 @@ def trace_image(
         :type execution_context: int | str | None
         :type undo: bool | None
         :param target: Target Object, Target grease pencil
-        :type target: str | None
+        :type target: typing.Literal['NEW','SELECTED'] | None
         :param radius: Radius
         :type radius: float | None
         :param threshold: Color Threshold, Determine the lightness threshold above which strokes are generated
@@ -1569,7 +1607,7 @@ def trace_image(
 
     RANDOM
     Random -- Choose pseudo-randomly.
-        :type turnpolicy: str | None
+        :type turnpolicy: typing.Literal['FOREGROUND','BACKGROUND','LEFT','RIGHT','MINORITY','MAJORITY','RANDOM'] | None
         :param mode: Mode, Determines if trace simple image or full sequence
 
     SINGLE
@@ -1577,7 +1615,7 @@ def trace_image(
 
     SEQUENCE
     Sequence -- Trace full sequence.
-        :type mode: str | None
+        :type mode: typing.Literal['SINGLE','SEQUENCE'] | None
         :param use_current_frame: Start At Current Frame, Trace Image starting in current image frame
         :type use_current_frame: bool | None
         :param frame_number: Trace Frame, Used to trace only one frame of the image sequence, set to zero to trace all
@@ -1593,7 +1631,7 @@ def weight_brush_stroke(
     *,
     stroke: bpy.types.bpy_prop_collection[bpy.types.OperatorStrokeElement]
     | None = None,
-    mode: str | None = "NORMAL",
+    mode: typing.Literal["NORMAL", "INVERT", "SMOOTH", "ERASE"] | None = "NORMAL",
 ):
     """Draw weight on stroke points in the active Grease Pencil object
 
@@ -1615,7 +1653,7 @@ def weight_brush_stroke(
 
     ERASE
     Erase -- Switch brush to erase mode for duration of stroke.
-        :type mode: str | None
+        :type mode: typing.Literal['NORMAL','INVERT','SMOOTH','ERASE'] | None
     """
 
     ...