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

bpy/ops/view3d/__init__.pyi

@@ -170,7 +170,7 @@ def cursor3d(
     undo: bool | None = None,
     *,
     use_depth: bool | None = True,
-    orientation: str | None = "VIEW",
+    orientation: typing.Literal["NONE", "VIEW", "XFORM", "GEOM"] | None = "VIEW",
 ):
     """Set the location of the 3D cursor
 
@@ -192,7 +192,7 @@ def cursor3d(
 
     GEOM
     Geometry -- Match the surface normal.
-        :type orientation: str | None
+        :type orientation: typing.Literal['NONE','VIEW','XFORM','GEOM'] | None
     """
 
     ...
@@ -324,11 +324,14 @@ def interactive_add(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    primitive_type: str | None = "CUBE",
-    plane_origin_base: str | None = "EDGE",
-    plane_origin_depth: str | None = "EDGE",
-    plane_aspect_base: str | None = "FREE",
-    plane_aspect_depth: str | None = "FREE",
+    primitive_type: typing.Literal[
+        "CUBE", "CYLINDER", "CONE", "SPHERE_UV", "SPHERE_ICO"
+    ]
+    | None = "CUBE",
+    plane_origin_base: typing.Literal["EDGE", "CENTER"] | None = "EDGE",
+    plane_origin_depth: typing.Literal["EDGE", "CENTER"] | None = "EDGE",
+    plane_aspect_base: typing.Literal["FREE", "FIXED"] | None = "FREE",
+    plane_aspect_depth: typing.Literal["FREE", "FIXED"] | None = "FREE",
     wait_for_input: bool | None = True,
 ):
     """Interactively add an object
@@ -337,7 +340,7 @@ def interactive_add(
         :type execution_context: int | str | None
         :type undo: bool | None
         :param primitive_type: Primitive
-        :type primitive_type: str | None
+        :type primitive_type: typing.Literal['CUBE','CYLINDER','CONE','SPHERE_UV','SPHERE_ICO'] | None
         :param plane_origin_base: Origin, The initial position for placement
 
     EDGE
@@ -345,7 +348,7 @@ def interactive_add(
 
     CENTER
     Center -- Start placing the center position.
-        :type plane_origin_base: str | None
+        :type plane_origin_base: typing.Literal['EDGE','CENTER'] | None
         :param plane_origin_depth: Origin, The initial position for placement
 
     EDGE
@@ -353,7 +356,7 @@ def interactive_add(
 
     CENTER
     Center -- Start placing the center position.
-        :type plane_origin_depth: str | None
+        :type plane_origin_depth: typing.Literal['EDGE','CENTER'] | None
         :param plane_aspect_base: Aspect, The initial aspect setting
 
     FREE
@@ -361,7 +364,7 @@ def interactive_add(
 
     FIXED
     Fixed -- Use a fixed 1:1 aspect.
-        :type plane_aspect_base: str | None
+        :type plane_aspect_base: typing.Literal['FREE','FIXED'] | None
         :param plane_aspect_depth: Aspect, The initial aspect setting
 
     FREE
@@ -369,7 +372,7 @@ def interactive_add(
 
     FIXED
     Fixed -- Use a fixed 1:1 aspect.
-        :type plane_aspect_depth: str | None
+        :type plane_aspect_depth: typing.Literal['FREE','FIXED'] | None
         :param wait_for_input: Wait for Input
         :type wait_for_input: bool | None
     """
@@ -673,7 +676,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", "XOR", "AND"] | None = "SET",
 ):
     """Select items using box selection
 
@@ -706,7 +709,7 @@ def select_box(
 
     AND
     Intersect -- Intersect existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
     """
 
     ...
@@ -720,7 +723,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",
 ):
     """Select items using circle selection
 
@@ -745,7 +748,7 @@ def select_circle(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -759,7 +762,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", "XOR", "AND"] | None = "SET",
 ):
     """Select items using lasso selection
 
@@ -790,7 +793,7 @@ def select_lasso(
 
     AND
     Intersect -- Intersect existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB','XOR','AND'] | None
     """
 
     ...
@@ -957,7 +960,8 @@ def toggle_shading(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "WIREFRAME",
+    type: typing.Literal["WIREFRAME", "SOLID", "MATERIAL", "RENDERED"]
+    | None = "WIREFRAME",
 ):
     """Toggle shading type in 3D viewport
 
@@ -977,7 +981,7 @@ def toggle_shading(
 
     RENDERED
     Rendered -- Toggle rendered shading.
-        :type type: str | None
+        :type type: typing.Literal['WIREFRAME','SOLID','MATERIAL','RENDERED'] | None
     """
 
     ...
@@ -1002,7 +1006,7 @@ def transform_gizmo_set(
     undo: bool | None = None,
     *,
     extend: bool | None = False,
-    type: set[str] | None = {},
+    type: set[typing.Literal["TRANSLATE", "ROTATE", "SCALE"]] | None = {},
 ):
     """Set the current transform gizmo
 
@@ -1012,7 +1016,7 @@ def transform_gizmo_set(
     :param extend: Extend
     :type extend: bool | None
     :param type: Type
-    :type type: set[str] | None
+    :type type: set[typing.Literal['TRANSLATE','ROTATE','SCALE']] | None
     """
 
     ...
@@ -1043,7 +1047,8 @@ def view_axis(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "LEFT",
+    type: typing.Literal["LEFT", "RIGHT", "BOTTOM", "TOP", "FRONT", "BACK"]
+    | None = "LEFT",
     align_active: bool | None = False,
     relative: bool | None = False,
 ):
@@ -1071,7 +1076,7 @@ def view_axis(
 
     BACK
     Back -- View from the back.
-        :type type: str | None
+        :type type: typing.Literal['LEFT','RIGHT','BOTTOM','TOP','FRONT','BACK'] | None
         :param align_active: Align Active, Align to the active object's axis
         :type align_active: bool | None
         :param relative: Relative, Rotate relative to the current orientation
@@ -1184,7 +1189,8 @@ def view_orbit(
     undo: bool | None = None,
     *,
     angle: float | None = 0.0,
-    type: str | None = "ORBITLEFT",
+    type: typing.Literal["ORBITLEFT", "ORBITRIGHT", "ORBITUP", "ORBITDOWN"]
+    | None = "ORBITLEFT",
 ):
     """Orbit the view
 
@@ -1206,7 +1212,7 @@ def view_orbit(
 
     ORBITDOWN
     Orbit Down -- Orbit the view down.
-        :type type: str | None
+        :type type: typing.Literal['ORBITLEFT','ORBITRIGHT','ORBITUP','ORBITDOWN'] | None
     """
 
     ...
@@ -1216,7 +1222,7 @@ def view_pan(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "PANLEFT",
+    type: typing.Literal["PANLEFT", "PANRIGHT", "PANUP", "PANDOWN"] | None = "PANLEFT",
 ):
     """Pan the view in a given direction
 
@@ -1236,7 +1242,7 @@ def view_pan(
 
     PANDOWN
     Pan Down -- Pan the view down.
-        :type type: str | None
+        :type type: typing.Literal['PANLEFT','PANRIGHT','PANUP','PANDOWN'] | None
     """
 
     ...
@@ -1261,7 +1267,7 @@ def view_roll(
     undo: bool | None = None,
     *,
     angle: float | None = 0.0,
-    type: str | None = "ANGLE",
+    type: typing.Literal["ANGLE", "LEFT", "RIGHT"] | None = "ANGLE",
 ):
     """Roll the view
 
@@ -1280,7 +1286,7 @@ def view_roll(
 
     RIGHT
     Roll Right -- Roll the view around to the right.
-        :type type: str | None
+        :type type: typing.Literal['ANGLE','LEFT','RIGHT'] | None
     """
 
     ...