fake-bpy-module 20240803__py3-none-any.whl → 20240805__py3-none-any.whl

bpy/ops/graph/__init__.pyi

@@ -262,7 +262,7 @@ def decimate(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "RATIO",
+    mode: typing.Literal["RATIO", "ERROR"] | None = "RATIO",
     factor: float | None = 0.333333,
     remove_error_margin: float | None = 0.0,
 ):
@@ -278,7 +278,7 @@ def decimate(
 
     ERROR
     Error Margin -- Use an error margin to specify how much the curve is allowed to deviate from the original path.
-        :type mode: str | None
+        :type mode: typing.Literal['RATIO','ERROR'] | None
         :param factor: Remove, The ratio of remaining keyframes after the operation
         :type factor: float | None
         :param remove_error_margin: Max Error Margin, How much the new decimated curve is allowed to deviate from the original
@@ -356,7 +356,42 @@ def duplicate(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "TRANSLATION",
+    mode: typing.Literal[
+        "INIT",
+        "DUMMY",
+        "TRANSLATION",
+        "ROTATION",
+        "RESIZE",
+        "SKIN_RESIZE",
+        "TOSPHERE",
+        "SHEAR",
+        "BEND",
+        "SHRINKFATTEN",
+        "TILT",
+        "TRACKBALL",
+        "PUSHPULL",
+        "CREASE",
+        "VERTEX_CREASE",
+        "MIRROR",
+        "BONE_SIZE",
+        "BONE_ENVELOPE",
+        "BONE_ENVELOPE_DIST",
+        "CURVE_SHRINKFATTEN",
+        "MASK_SHRINKFATTEN",
+        "GPENCIL_SHRINKFATTEN",
+        "BONE_ROLL",
+        "TIME_TRANSLATE",
+        "TIME_SLIDE",
+        "TIME_SCALE",
+        "TIME_EXTEND",
+        "BAKE_TIME",
+        "BWEIGHT",
+        "ALIGN",
+        "EDGESLIDE",
+        "SEQSLIDE",
+        "GPENCIL_OPACITY",
+    ]
+    | None = "TRANSLATION",
 ):
     """Make a copy of all selected keyframes
 
@@ -364,7 +399,7 @@ def duplicate(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['INIT', 'DUMMY', 'TRANSLATION', 'ROTATION', 'RESIZE', 'SKIN_RESIZE', 'TOSPHERE', 'SHEAR', 'BEND', 'SHRINKFATTEN', 'TILT', 'TRACKBALL', 'PUSHPULL', 'CREASE', 'VERTEX_CREASE', 'MIRROR', 'BONE_SIZE', 'BONE_ENVELOPE', 'BONE_ENVELOPE_DIST', 'CURVE_SHRINKFATTEN', 'MASK_SHRINKFATTEN', 'GPENCIL_SHRINKFATTEN', 'BONE_ROLL', 'TIME_TRANSLATE', 'TIME_SLIDE', 'TIME_SCALE', 'TIME_EXTEND', 'BAKE_TIME', 'BWEIGHT', 'ALIGN', 'EDGESLIDE', 'SEQSLIDE', 'GPENCIL_OPACITY'] | None
     """
 
     ...
@@ -416,7 +451,7 @@ def easing_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "AUTO",
+    type: typing.Literal["AUTO", "EASE_IN", "EASE_OUT", "EASE_IN_OUT"] | None = "AUTO",
 ):
     """Set easing type for the F-Curve segments starting from the selected keyframes
 
@@ -424,7 +459,7 @@ def easing_type(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['AUTO', 'EASE_IN', 'EASE_OUT', 'EASE_IN_OUT'] | None
     """
 
     ...
@@ -434,7 +469,7 @@ def equalize_handles(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    side: str | None = "LEFT",
+    side: typing.Literal["LEFT", "RIGHT", "BOTH"] | None = "LEFT",
     handle_length: float | None = 5.0,
     flatten: bool | None = False,
 ):
@@ -453,7 +488,7 @@ def equalize_handles(
 
     BOTH
     Both -- Equalize both of a keyframe's handles.
-        :type side: str | None
+        :type side: typing.Literal['LEFT','RIGHT','BOTH'] | None
         :param handle_length: Handle Length, Length to make selected keyframes' Bézier handles
         :type handle_length: float | None
         :param flatten: Flatten, Make the values of the selected keyframes' handles the same as their respective keyframes
@@ -481,7 +516,8 @@ def extrapolation_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CONSTANT",
+    type: typing.Literal["CONSTANT", "LINEAR", "MAKE_CYCLIC", "CLEAR_CYCLIC"]
+    | None = "CONSTANT",
 ):
     """Set extrapolation mode for selected F-Curves
 
@@ -501,7 +537,7 @@ def extrapolation_type(
 
     CLEAR_CYCLIC
     Clear Cyclic (F-Modifier) -- Remove Cycles F-Modifier if not needed anymore.
-        :type type: str | None
+        :type type: typing.Literal['CONSTANT','LINEAR','MAKE_CYCLIC','CLEAR_CYCLIC'] | None
     """
 
     ...
@@ -511,7 +547,17 @@ def fmodifier_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "NULL",
+    type: typing.Literal[
+        "NULL",
+        "GENERATOR",
+        "FNGENERATOR",
+        "ENVELOPE",
+        "CYCLES",
+        "NOISE",
+        "LIMITS",
+        "STEPPED",
+    ]
+    | None = "NULL",
     only_active: bool | None = False,
 ):
     """Add F-Modifier to the active/selected F-Curves
@@ -520,7 +566,7 @@ def fmodifier_add(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['NULL', 'GENERATOR', 'FNGENERATOR', 'ENVELOPE', 'CYCLES', 'NOISE', 'LIMITS', 'STEPPED'] | None
     :param only_active: Only Active, Only add F-Modifier to active F-Curve
     :type only_active: bool | None
     """
@@ -633,7 +679,8 @@ def handle_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "FREE",
+    type: typing.Literal["FREE", "ALIGNED", "VECTOR", "AUTO", "AUTO_CLAMPED"]
+    | None = "FREE",
 ):
     """Set type of handle for selected keyframes
 
@@ -641,7 +688,7 @@ def handle_type(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['FREE', 'ALIGNED', 'VECTOR', 'AUTO', 'AUTO_CLAMPED'] | None
     """
 
     ...
@@ -669,7 +716,22 @@ def interpolation_type(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CONSTANT",
+    type: typing.Literal[
+        "CONSTANT",
+        "LINEAR",
+        "BEZIER",
+        "SINE",
+        "QUAD",
+        "CUBIC",
+        "QUART",
+        "QUINT",
+        "EXPO",
+        "CIRC",
+        "BACK",
+        "BOUNCE",
+        "ELASTIC",
+    ]
+    | None = "CONSTANT",
 ):
     """Set interpolation mode for the F-Curve segments starting from the selected keyframes
 
@@ -677,7 +739,7 @@ def interpolation_type(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['CONSTANT', 'LINEAR', 'BEZIER', 'SINE', 'QUAD', 'CUBIC', 'QUART', 'QUINT', 'EXPO', 'CIRC', 'BACK', 'BOUNCE', 'ELASTIC'] | None
     """
 
     ...
@@ -687,7 +749,8 @@ def keyframe_insert(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "ALL",
+    type: typing.Literal["ALL", "SEL", "ACTIVE", "CURSOR_ACTIVE", "CURSOR_SEL"]
+    | None = "ALL",
 ):
     """Insert keyframes for the specified channels
 
@@ -710,7 +773,7 @@ def keyframe_insert(
 
     CURSOR_SEL
     Selected Channels at Cursor -- Insert a keyframe for selected F-Curves at the cursor point.
-        :type type: str | None
+        :type type: typing.Literal['ALL','SEL','ACTIVE','CURSOR_ACTIVE','CURSOR_SEL'] | None
     """
 
     ...
@@ -770,7 +833,7 @@ def mirror(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CFRA",
+    type: typing.Literal["CFRA", "VALUE", "YAXIS", "XAXIS", "MARKER"] | None = "CFRA",
 ):
     """Flip selected keyframes over the selected mirror line
 
@@ -793,7 +856,7 @@ def mirror(
 
     MARKER
     By Times Over First Selected Marker -- Flip times of selected keyframes using the first selected marker as the reference point.
-        :type type: str | None
+        :type type: typing.Literal['CFRA','VALUE','YAXIS','XAXIS','MARKER'] | None
     """
 
     ...
@@ -803,9 +866,13 @@ def paste(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    offset: str | None = "START",
-    value_offset: str | None = "NONE",
-    merge: str | None = "MIX",
+    offset: typing.Literal["START", "END", "RELATIVE", "NONE"] | None = "START",
+    value_offset: typing.Literal[
+        "LEFT_KEY", "RIGHT_KEY", "CURRENT_FRAME", "CURSOR_VALUE", "NONE"
+    ]
+    | None = "NONE",
+    merge: typing.Literal["MIX", "OVER_ALL", "OVER_RANGE", "OVER_RANGE_ALL"]
+    | None = "MIX",
     flipped: bool | None = False,
 ):
     """Paste keyframes from the internal clipboard for the selected channels, starting on the current frame
@@ -814,11 +881,11 @@ def paste(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param offset: Frame Offset, Paste time offset of keys
-    :type offset: str | None
+    :type offset: typing.Literal['START', 'END', 'RELATIVE', 'NONE'] | None
     :param value_offset: Value Offset, Paste keys with a value offset
-    :type value_offset: str | None
+    :type value_offset: typing.Literal['LEFT_KEY', 'RIGHT_KEY', 'CURRENT_FRAME', 'CURSOR_VALUE', 'NONE'] | None
     :param merge: Type, Method of merging pasted keys and existing
-    :type merge: str | None
+    :type merge: typing.Literal['MIX', 'OVER_ALL', 'OVER_RANGE', 'OVER_RANGE_ALL'] | None
     :param flipped: Flipped, Paste keyframes from mirrored bones if they exist
     :type flipped: bool | None
     """
@@ -913,7 +980,7 @@ def scale_from_neighbor(
     undo: bool | None = None,
     *,
     factor: float | None = 0.0,
-    anchor: str | None = "LEFT",
+    anchor: typing.Literal["LEFT", "RIGHT"] | None = "LEFT",
 ):
     """Increase or decrease the value of selected keys in relationship to the neighboring one
 
@@ -923,7 +990,7 @@ def scale_from_neighbor(
     :param factor: Factor, The factor to scale keys with
     :type factor: float | None
     :param anchor: Reference Key, Which end of the segment to use as a reference to scale from
-    :type anchor: str | None
+    :type anchor: typing.Literal['LEFT','RIGHT'] | None
     """
 
     ...
@@ -933,7 +1000,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",
 ):
     """Toggle selection of all keyframes
 
@@ -953,7 +1020,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -972,7 +1039,7 @@ def select_box(
     ymin: int | None = 0,
     ymax: int | None = 0,
     wait_for_input: bool | None = True,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
 ):
     """Select all keyframes within the specified region
 
@@ -1007,7 +1074,7 @@ def select_box(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -1021,7 +1088,7 @@ def select_circle(
     y: int | None = 0,
     radius: int | None = 25,
     wait_for_input: bool | None = True,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
     use_curve_selection: bool | None = True,
 ):
     """Select keyframe points using circle selection
@@ -1047,7 +1114,7 @@ def select_circle(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
         :param use_curve_selection: Select Curves, Allow selecting all the keyframes of a curve by selecting the curve itself
         :type use_curve_selection: bool | None
     """
@@ -1059,7 +1126,8 @@ def select_column(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "KEYS",
+    mode: typing.Literal["KEYS", "CFRA", "MARKERS_COLUMN", "MARKERS_BETWEEN"]
+    | None = "KEYS",
 ):
     """Select all keyframes on the specified frame(s)
 
@@ -1067,7 +1135,7 @@ def select_column(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['KEYS','CFRA','MARKERS_COLUMN','MARKERS_BETWEEN'] | None
     """
 
     ...
@@ -1077,9 +1145,9 @@ def select_key_handles(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    left_handle_action: str | None = "SELECT",
-    right_handle_action: str | None = "SELECT",
-    key_action: str | None = "KEEP",
+    left_handle_action: typing.Literal["SELECT", "DESELECT", "KEEP"] | None = "SELECT",
+    right_handle_action: typing.Literal["SELECT", "DESELECT", "KEEP"] | None = "SELECT",
+    key_action: typing.Literal["SELECT", "DESELECT", "KEEP"] | None = "KEEP",
 ):
     """For selected keyframes, select/deselect any combination of the key itself and its handles
 
@@ -1096,7 +1164,7 @@ def select_key_handles(
 
     KEEP
     Keep -- Leave as is.
-        :type left_handle_action: str | None
+        :type left_handle_action: typing.Literal['SELECT','DESELECT','KEEP'] | None
         :param right_handle_action: Right Handle, Effect on the right handle
 
     SELECT
@@ -1107,7 +1175,7 @@ def select_key_handles(
 
     KEEP
     Keep -- Leave as is.
-        :type right_handle_action: str | None
+        :type right_handle_action: typing.Literal['SELECT','DESELECT','KEEP'] | None
         :param key_action: Key, Effect on the key itself
 
     SELECT
@@ -1118,7 +1186,7 @@ def select_key_handles(
 
     KEEP
     Keep -- Leave as is.
-        :type key_action: str | None
+        :type key_action: typing.Literal['SELECT','DESELECT','KEEP'] | None
     """
 
     ...
@@ -1132,7 +1200,7 @@ def select_lasso(
     use_smooth_stroke: bool | None = False,
     smooth_stroke_factor: float | None = 0.75,
     smooth_stroke_radius: int | None = 35,
-    mode: str | None = "SET",
+    mode: typing.Literal["SET", "ADD", "SUB"] | None = "SET",
     use_curve_selection: bool | None = True,
 ):
     """Select keyframe points using lasso selection
@@ -1158,7 +1226,7 @@ def select_lasso(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
         :param use_curve_selection: Select Curves, Allow selecting all the keyframes of a curve by selecting the curve itself
         :type use_curve_selection: bool | None
     """
@@ -1170,7 +1238,7 @@ def select_leftright(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "CHECK",
+    mode: typing.Literal["CHECK", "LEFT", "RIGHT"] | None = "CHECK",
     extend: bool | None = False,
 ):
     """Select keyframes to the left or the right of the current frame
@@ -1179,7 +1247,7 @@ def select_leftright(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['CHECK','LEFT','RIGHT'] | None
     :param extend: Extend Select
     :type extend: bool | None
     """
@@ -1234,7 +1302,7 @@ def shear(
     undo: bool | None = None,
     *,
     factor: float | None = 0.0,
-    direction: str | None = "FROM_LEFT",
+    direction: typing.Literal["FROM_LEFT", "FROM_RIGHT"] | None = "FROM_LEFT",
 ):
     """Affect the value of the keys linearly, keeping the same relationship between them using either the left or the right key as reference
 
@@ -1250,7 +1318,7 @@ def shear(
 
     FROM_RIGHT
     From Right -- Shear the keys using the right key as reference.
-        :type direction: str | None
+        :type direction: typing.Literal['FROM_LEFT','FROM_RIGHT'] | None
     """
 
     ...
@@ -1274,7 +1342,15 @@ def snap(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "CFRA",
+    type: typing.Literal[
+        "CFRA",
+        "VALUE",
+        "NEAREST_FRAME",
+        "NEAREST_SECOND",
+        "NEAREST_MARKER",
+        "HORIZONTAL",
+    ]
+    | None = "CFRA",
 ):
     """Snap selected keyframes to the chosen times/values
 
@@ -1300,7 +1376,7 @@ def snap(
 
     HORIZONTAL
     Flatten Handles -- Flatten handles for a smoother transition.
-        :type type: str | None
+        :type type: typing.Literal['CFRA','VALUE','NEAREST_FRAME','NEAREST_SECOND','NEAREST_MARKER','HORIZONTAL'] | None
     """
 
     ...
@@ -1346,7 +1422,10 @@ def sound_to_samples(
     filemode: int | None = 9,
     show_multiview: bool | None = False,
     use_multiview: bool | None = False,
-    display_type: str | None = "DEFAULT",
+    display_type: typing.Literal[
+        "DEFAULT", "LIST_VERTICAL", "LIST_HORIZONTAL", "THUMBNAIL"
+    ]
+    | None = "DEFAULT",
     sort_method: str | None = "",
     low: float | None = 0.0,
     high: float | None = 100000.0,
@@ -1420,7 +1499,7 @@ def sound_to_samples(
 
     THUMBNAIL
     Thumbnails -- Display files as thumbnails.
-        :type display_type: str | None
+        :type display_type: typing.Literal['DEFAULT','LIST_VERTICAL','LIST_HORIZONTAL','THUMBNAIL'] | None
         :param sort_method: File sorting mode
         :type sort_method: str | None
         :param low: Lowest Frequency, Cutoff frequency of a high-pass filter that is applied to the audio data