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

bpy/ops/ui/__init__.pyi

@@ -275,7 +275,10 @@ def eyedropper_driver(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mapping_type: str | None = "SINGLE_MANY",
+    mapping_type: typing.Literal[
+        "SINGLE_MANY", "DIRECT", "MATCH", "NONE_ALL", "NONE_SINGLE"
+    ]
+    | None = "SINGLE_MANY",
 ):
     """Pick a property to use as a driver target
 
@@ -298,7 +301,7 @@ def eyedropper_driver(
 
     NONE_SINGLE
     Manually Create Later (Single) -- Create driver for this property only and without assigning any targets yet.
-        :type mapping_type: str | None
+        :type mapping_type: typing.Literal['SINGLE_MANY','DIRECT','MATCH','NONE_ALL','NONE_SINGLE'] | None
     """
 
     ...
@@ -308,7 +311,7 @@ def eyedropper_gpencil_color(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "MATERIAL",
+    mode: typing.Literal["MATERIAL", "PALETTE"] | None = "MATERIAL",
 ):
     """Sample a color from the Blender Window and create Grease Pencil material
 
@@ -316,7 +319,7 @@ def eyedropper_gpencil_color(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param mode: Mode
-    :type mode: str | None
+    :type mode: typing.Literal['MATERIAL','PALETTE'] | None
     """
 
     ...
@@ -429,7 +432,7 @@ def override_type_set_button(
     undo: bool | None = None,
     *,
     all: bool | None = True,
-    type: str | None = "REPLACE",
+    type: typing.Literal["NOOP", "REPLACE", "DIFFERENCE", "FACTOR"] | None = "REPLACE",
 ):
     """Create an override operation, or set the type of an existing one
 
@@ -451,7 +454,7 @@ def override_type_set_button(
 
     FACTOR
     Factor -- Store factor to linked data value (useful e.g. for scale).
-        :type type: str | None
+        :type type: typing.Literal['NOOP','REPLACE','DIFFERENCE','FACTOR'] | None
     """
 
     ...

bpy/ops/uilist/__init__.pyi

@@ -34,7 +34,7 @@ def entry_move(
     *,
     list_path: str = "",
     active_index_path: str = "",
-    direction: str | None = "UP",
+    direction: typing.Literal["UP", "DOWN"] | None = "UP",
 ):
     """Move an entry in the list up or down
 
@@ -52,7 +52,7 @@ def entry_move(
 
     DOWN
     DOWN -- DOWN.
-        :type direction: str | None
+        :type direction: typing.Literal['UP','DOWN'] | None
     """
 
     ...

bpy/ops/uv/__init__.pyi

@@ -13,7 +13,10 @@ def align(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    axis: str | None = "ALIGN_AUTO",
+    axis: typing.Literal[
+        "ALIGN_S", "ALIGN_T", "ALIGN_U", "ALIGN_AUTO", "ALIGN_X", "ALIGN_Y"
+    ]
+    | None = "ALIGN_AUTO",
 ):
     """Aligns selected UV vertices on a line
 
@@ -39,7 +42,7 @@ def align(
 
     ALIGN_Y
     Align Horizontally -- Align UV vertices on a horizontal line.
-        :type axis: str | None
+        :type axis: typing.Literal['ALIGN_S','ALIGN_T','ALIGN_U','ALIGN_AUTO','ALIGN_X','ALIGN_Y'] | None
     """
 
     ...
@@ -49,8 +52,8 @@ def align_rotation(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    method: str | None = "AUTO",
-    axis: str | None = "X",
+    method: typing.Literal["AUTO", "EDGE", "GEOMETRY"] | None = "AUTO",
+    axis: typing.Literal["X", "Y", "Z"] | None = "X",
     correct_aspect: bool | None = False,
 ):
     """Align the UV island's rotation
@@ -68,7 +71,7 @@ def align_rotation(
 
     GEOMETRY
     Geometry -- Align to Geometry axis.
-        :type method: str | None
+        :type method: typing.Literal['AUTO','EDGE','GEOMETRY'] | None
         :param axis: Axis, Axis to align to
 
     X
@@ -79,7 +82,7 @@ def align_rotation(
 
     Z
     Z -- Z axis.
-        :type axis: str | None
+        :type axis: typing.Literal['X','Y','Z'] | None
         :param correct_aspect: Correct Aspect, Take image aspect ratio into account
         :type correct_aspect: bool | None
     """
@@ -171,9 +174,10 @@ def cylinder_project(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "VIEW_ON_EQUATOR",
-    align: str | None = "POLAR_ZX",
-    pole: str | None = "PINCH",
+    direction: typing.Literal["VIEW_ON_EQUATOR", "VIEW_ON_POLES", "ALIGN_TO_OBJECT"]
+    | None = "VIEW_ON_EQUATOR",
+    align: typing.Literal["POLAR_ZX", "POLAR_ZY"] | None = "POLAR_ZX",
+    pole: typing.Literal["PINCH", "FAN"] | None = "PINCH",
     seam: bool | None = False,
     radius: float | None = 1.0,
     correct_aspect: bool | None = True,
@@ -195,7 +199,7 @@ def cylinder_project(
 
     ALIGN_TO_OBJECT
     Align to Object -- Align according to object transform.
-        :type direction: str | None
+        :type direction: typing.Literal['VIEW_ON_EQUATOR','VIEW_ON_POLES','ALIGN_TO_OBJECT'] | None
         :param align: Align, How to determine rotation around the pole
 
     POLAR_ZX
@@ -203,7 +207,7 @@ def cylinder_project(
 
     POLAR_ZY
     Polar ZY -- Polar 0 is Y.
-        :type align: str | None
+        :type align: typing.Literal['POLAR_ZX','POLAR_ZY'] | None
         :param pole: Pole, How to handle faces at the poles
 
     PINCH
@@ -211,7 +215,7 @@ def cylinder_project(
 
     FAN
     Fan -- UVs are fanned at the poles.
-        :type pole: str | None
+        :type pole: typing.Literal['PINCH','FAN'] | None
         :param seam: Preserve Seams, Separate projections by islands isolated by seams
         :type seam: bool | None
         :param radius: Radius, Radius of the sphere or cylinder
@@ -233,9 +237,9 @@ def export_layout(
     *,
     filepath: str = "",
     export_all: bool | None = False,
-    export_tiles: str | None = "NONE",
+    export_tiles: typing.Literal["NONE", "UDIM", "UV"] | None = "NONE",
     modified: bool | None = False,
-    mode: str | None = "PNG",
+    mode: typing.Literal["SVG", "EPS", "PNG"] | None = "PNG",
     size: collections.abc.Iterable[int] | None = (1024, 1024),
     opacity: float | None = 0.25,
     check_existing: bool | None = True,
@@ -259,7 +263,7 @@ def export_layout(
 
     UV
     UVTILE -- Export tiles in the UVTILE numbering scheme: u(u_tile + 1)_v(v_tile + 1).
-        :type export_tiles: str | None
+        :type export_tiles: typing.Literal['NONE','UDIM','UV'] | None
         :param modified: Modified, Exports UVs from the modified mesh
         :type modified: bool | None
         :param mode: Format, File format to export the UV layout to
@@ -272,7 +276,7 @@ def export_layout(
 
     PNG
     PNG Image (.png) -- Export the UV layout to a bitmap image.
-        :type mode: str | None
+        :type mode: typing.Literal['SVG','EPS','PNG'] | None
         :param size: Size, Dimensions of the exported file
         :type size: collections.abc.Iterable[int] | None
         :param opacity: Fill Opacity, Set amount of opacity for exported UV layout
@@ -288,7 +292,7 @@ def follow_active_quads(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    mode: str | None = "LENGTH_AVERAGE",
+    mode: typing.Literal["EVEN", "LENGTH", "LENGTH_AVERAGE"] | None = "LENGTH_AVERAGE",
 ):
     """Follow UVs from active quads along continuous face loops
 
@@ -305,7 +309,7 @@ def follow_active_quads(
 
     LENGTH_AVERAGE
     Length Average -- Average space UVs edge length of each loop.
-        :type mode: str | None
+        :type mode: typing.Literal['EVEN','LENGTH','LENGTH_AVERAGE'] | None
     """
 
     ...
@@ -333,7 +337,7 @@ def lightmap_pack(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    PREF_CONTEXT: str | None = "SEL_FACES",
+    PREF_CONTEXT: typing.Literal["SEL_FACES", "ALL_FACES"] | None = "SEL_FACES",
     PREF_PACK_IN_ONE: bool | None = True,
     PREF_NEW_UVLAYER: bool | None = False,
     PREF_BOX_DIV: int | None = 12,
@@ -351,7 +355,7 @@ def lightmap_pack(
 
     ALL_FACES
     All Faces -- Average space UVs edge length of each loop.
-        :type PREF_CONTEXT: str | None
+        :type PREF_CONTEXT: typing.Literal['SEL_FACES','ALL_FACES'] | None
         :param PREF_PACK_IN_ONE: Share Texture Space, Objects share texture space, map all objects into a single UV map
         :type PREF_PACK_IN_ONE: bool | None
         :param PREF_NEW_UVLAYER: New UV Map, Create a new UV map for every mesh packed
@@ -411,16 +415,21 @@ def pack_islands(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    udim_source: str | None = "CLOSEST_UDIM",
+    udim_source: typing.Literal["CLOSEST_UDIM", "ACTIVE_UDIM", "ORIGINAL_AABB"]
+    | None = "CLOSEST_UDIM",
     rotate: bool | None = True,
-    rotate_method: str | None = "ANY",
+    rotate_method: typing.Literal[
+        "ANY", "CARDINAL", "AXIS_ALIGNED", "AXIS_ALIGNED_X", "AXIS_ALIGNED_Y"
+    ]
+    | None = "ANY",
     scale: bool | None = True,
     merge_overlap: bool | None = False,
-    margin_method: str | None = "SCALED",
+    margin_method: typing.Literal["SCALED", "ADD", "FRACTION"] | None = "SCALED",
     margin: float | None = 0.001,
     pin: bool | None = False,
-    pin_method: str | None = "LOCKED",
-    shape_method: str | None = "CONCAVE",
+    pin_method: typing.Literal["SCALE", "ROTATION", "ROTATION_SCALE", "LOCKED"]
+    | None = "LOCKED",
+    shape_method: typing.Literal["CONCAVE", "CONVEX", "AABB"] | None = "CONCAVE",
 ):
     """Transform all islands so that they fill up the UV/UDIM space as much as possible
 
@@ -437,7 +446,7 @@ def pack_islands(
 
     ORIGINAL_AABB
     Original bounding box -- Pack to starting bounding box of islands.
-        :type udim_source: str | None
+        :type udim_source: typing.Literal['CLOSEST_UDIM','ACTIVE_UDIM','ORIGINAL_AABB'] | None
         :param rotate: Rotate, Rotate islands to improve layout
         :type rotate: bool | None
         :param rotate_method: Rotation Method
@@ -456,7 +465,7 @@ def pack_islands(
 
     AXIS_ALIGNED_Y
     Axis-aligned (Vertical) -- Rotate islands to be aligned vertically.
-        :type rotate_method: str | None
+        :type rotate_method: typing.Literal['ANY','CARDINAL','AXIS_ALIGNED','AXIS_ALIGNED_X','AXIS_ALIGNED_Y'] | None
         :param scale: Scale, Scale islands to fill unit square
         :type scale: bool | None
         :param merge_overlap: Merge Overlapping, Overlapping islands stick together
@@ -471,7 +480,7 @@ def pack_islands(
 
     FRACTION
     Fraction -- Specify a precise fraction of final UV output.
-        :type margin_method: str | None
+        :type margin_method: typing.Literal['SCALED','ADD','FRACTION'] | None
         :param margin: Margin, Space between islands
         :type margin: float | None
         :param pin: Lock Pinned Islands, Constrain islands containing any pinned UV's
@@ -489,7 +498,7 @@ def pack_islands(
 
     LOCKED
     All -- Pinned islands are locked in place.
-        :type pin_method: str | None
+        :type pin_method: typing.Literal['SCALE','ROTATION','ROTATION_SCALE','LOCKED'] | None
         :param shape_method: Shape Method
 
     CONCAVE
@@ -500,7 +509,7 @@ def pack_islands(
 
     AABB
     Bounding Box -- Uses bounding boxes.
-        :type shape_method: str | None
+        :type shape_method: typing.Literal['CONCAVE','CONVEX','AABB'] | None
     """
 
     ...
@@ -769,7 +778,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",
 ):
     """Change selection of all UV vertices
 
@@ -789,7 +798,7 @@ def select_all(
 
     INVERT
     Invert -- Invert selection of all elements.
-        :type action: str | None
+        :type action: typing.Literal['TOGGLE','SELECT','DESELECT','INVERT'] | None
     """
 
     ...
@@ -805,7 +814,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 UV vertices using box selection
 
@@ -834,7 +843,7 @@ def select_box(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -848,7 +857,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 UV vertices using circle selection
 
@@ -873,7 +882,7 @@ def select_circle(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -908,7 +917,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",
 ):
     """Select UVs using lasso selection
 
@@ -933,7 +942,7 @@ def select_lasso(
 
     SUB
     Subtract -- Subtract existing selection.
-        :type mode: str | None
+        :type mode: typing.Literal['SET','ADD','SUB'] | None
     """
 
     ...
@@ -1016,7 +1025,7 @@ def select_mode(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "VERTEX",
+    type: typing.Literal["VERTEX", "EDGE", "FACE", "ISLAND"] | None = "VERTEX",
 ):
     """Change UV selection mode
 
@@ -1024,7 +1033,7 @@ def select_mode(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['VERTEX', 'EDGE', 'FACE', 'ISLAND'] | None
     """
 
     ...
@@ -1080,8 +1089,20 @@ def select_similar(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    type: str | None = "PIN",
-    compare: str | None = "EQUAL",
+    type: typing.Literal[
+        "PIN",
+        "LENGTH",
+        "LENGTH_3D",
+        "AREA",
+        "AREA_3D",
+        "MATERIAL",
+        "OBJECT",
+        "SIDES",
+        "WINDING",
+        "FACE",
+    ]
+    | None = "PIN",
+    compare: typing.Literal["EQUAL", "GREATER", "LESS"] | None = "EQUAL",
     threshold: float | None = 0.0,
 ):
     """Select similar UVs by property types
@@ -1090,9 +1111,9 @@ def select_similar(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param type: Type
-    :type type: str | None
+    :type type: typing.Literal['PIN','LENGTH','LENGTH_3D','AREA','AREA_3D','MATERIAL','OBJECT','SIDES','WINDING','FACE'] | None
     :param compare: Compare
-    :type compare: str | None
+    :type compare: typing.Literal['EQUAL','GREATER','LESS'] | None
     :param threshold: Threshold
     :type threshold: float | None
     """
@@ -1189,8 +1210,9 @@ def smart_project(
     undo: bool | None = None,
     *,
     angle_limit: float | None = 1.15192,
-    margin_method: str | None = "SCALED",
-    rotate_method: str | None = "AXIS_ALIGNED_Y",
+    margin_method: typing.Literal["SCALED", "ADD", "FRACTION"] | None = "SCALED",
+    rotate_method: typing.Literal["AXIS_ALIGNED", "AXIS_ALIGNED_X", "AXIS_ALIGNED_Y"]
+    | None = "AXIS_ALIGNED_Y",
     island_margin: float | None = 0.0,
     area_weight: float | None = 0.0,
     correct_aspect: bool | None = True,
@@ -1213,7 +1235,7 @@ def smart_project(
 
     FRACTION
     Fraction -- Specify a precise fraction of final UV output.
-        :type margin_method: str | None
+        :type margin_method: typing.Literal['SCALED','ADD','FRACTION'] | None
         :param rotate_method: Rotation Method
 
     AXIS_ALIGNED
@@ -1224,7 +1246,7 @@ def smart_project(
 
     AXIS_ALIGNED_Y
     Axis-aligned (Vertical) -- Rotate islands to be aligned vertically.
-        :type rotate_method: str | None
+        :type rotate_method: typing.Literal['AXIS_ALIGNED','AXIS_ALIGNED_X','AXIS_ALIGNED_Y'] | None
         :param island_margin: Island Margin, Margin to reduce bleed from adjacent islands
         :type island_margin: float | None
         :param area_weight: Area Weight, Weight projection's vector by faces with larger areas
@@ -1242,7 +1264,7 @@ def snap_cursor(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    target: str | None = "PIXELS",
+    target: typing.Literal["PIXELS", "SELECTED", "ORIGIN"] | None = "PIXELS",
 ):
     """Snap cursor to target type
 
@@ -1250,7 +1272,7 @@ def snap_cursor(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param target: Target, Target to snap the selected UVs to
-    :type target: str | None
+    :type target: typing.Literal['PIXELS','SELECTED','ORIGIN'] | None
     """
 
     ...
@@ -1260,7 +1282,8 @@ def snap_selected(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    target: str | None = "PIXELS",
+    target: typing.Literal["PIXELS", "CURSOR", "CURSOR_OFFSET", "ADJACENT_UNSELECTED"]
+    | None = "PIXELS",
 ):
     """Snap selected UV vertices to target type
 
@@ -1268,7 +1291,7 @@ def snap_selected(
     :type execution_context: int | str | None
     :type undo: bool | None
     :param target: Target, Target to snap the selected UVs to
-    :type target: str | None
+    :type target: typing.Literal['PIXELS','CURSOR','CURSOR_OFFSET','ADJACENT_UNSELECTED'] | None
     """
 
     ...
@@ -1278,9 +1301,10 @@ def sphere_project(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    direction: str | None = "VIEW_ON_EQUATOR",
-    align: str | None = "POLAR_ZX",
-    pole: str | None = "PINCH",
+    direction: typing.Literal["VIEW_ON_EQUATOR", "VIEW_ON_POLES", "ALIGN_TO_OBJECT"]
+    | None = "VIEW_ON_EQUATOR",
+    align: typing.Literal["POLAR_ZX", "POLAR_ZY"] | None = "POLAR_ZX",
+    pole: typing.Literal["PINCH", "FAN"] | None = "PINCH",
     seam: bool | None = False,
     correct_aspect: bool | None = True,
     clip_to_bounds: bool | None = False,
@@ -1301,7 +1325,7 @@ def sphere_project(
 
     ALIGN_TO_OBJECT
     Align to Object -- Align according to object transform.
-        :type direction: str | None
+        :type direction: typing.Literal['VIEW_ON_EQUATOR','VIEW_ON_POLES','ALIGN_TO_OBJECT'] | None
         :param align: Align, How to determine rotation around the pole
 
     POLAR_ZX
@@ -1309,7 +1333,7 @@ def sphere_project(
 
     POLAR_ZY
     Polar ZY -- Polar 0 is Y.
-        :type align: str | None
+        :type align: typing.Literal['POLAR_ZX','POLAR_ZY'] | None
         :param pole: Pole, How to handle faces at the poles
 
     PINCH
@@ -1317,7 +1341,7 @@ def sphere_project(
 
     FAN
     Fan -- UVs are fanned at the poles.
-        :type pole: str | None
+        :type pole: typing.Literal['PINCH','FAN'] | None
         :param seam: Preserve Seams, Separate projections by islands isolated by seams
         :type seam: bool | None
         :param correct_aspect: Correct Aspect, Map UVs taking image aspect ratio into account
@@ -1342,8 +1366,8 @@ def stitch(
     active_object_index: int | None = 0,
     midpoint_snap: bool | None = False,
     clear_seams: bool | None = True,
-    mode: str | None = "VERTEX",
-    stored_mode: str | None = "VERTEX",
+    mode: typing.Literal["VERTEX", "EDGE"] | None = "VERTEX",
+    stored_mode: typing.Literal["VERTEX", "EDGE"] | None = "VERTEX",
     selection: bpy.types.bpy_prop_collection[bpy.types.SelectedUvElement] | None = None,
     objects_selection_count: collections.abc.Iterable[int] | None = (0, 0, 0, 0, 0, 0),
 ):
@@ -1367,9 +1391,9 @@ def stitch(
     :param clear_seams: Clear Seams, Clear seams of stitched edges
     :type clear_seams: bool | None
     :param mode: Operation Mode, Use vertex or edge stitching
-    :type mode: str | None
+    :type mode: typing.Literal['VERTEX','EDGE'] | None
     :param stored_mode: Stored Operation Mode, Use vertex or edge stitching
-    :type stored_mode: str | None
+    :type stored_mode: typing.Literal['VERTEX','EDGE'] | None
     :param selection: Selection
     :type selection: bpy.types.bpy_prop_collection[bpy.types.SelectedUvElement] | None
     :param objects_selection_count: Objects Selection Count
@@ -1383,11 +1407,11 @@ def unwrap(
     execution_context: int | str | None = None,
     undo: bool | None = None,
     *,
-    method: str | None = "ANGLE_BASED",
+    method: typing.Literal["ANGLE_BASED", "CONFORMAL"] | None = "ANGLE_BASED",
     fill_holes: bool | None = True,
     correct_aspect: bool | None = True,
     use_subsurf_data: bool | None = False,
-    margin_method: str | None = "SCALED",
+    margin_method: typing.Literal["SCALED", "ADD", "FRACTION"] | None = "SCALED",
     margin: float | None = 0.001,
 ):
     """Unwrap the mesh of the object being edited
@@ -1396,7 +1420,7 @@ def unwrap(
         :type execution_context: int | str | None
         :type undo: bool | None
         :param method: Method, Unwrapping method (Angle Based usually gives better results than Conformal, while being somewhat slower)
-        :type method: str | None
+        :type method: typing.Literal['ANGLE_BASED','CONFORMAL'] | None
         :param fill_holes: Fill Holes, Virtually fill holes in mesh before unwrapping, to better avoid overlaps and preserve symmetry
         :type fill_holes: bool | None
         :param correct_aspect: Correct Aspect, Map UVs taking image aspect ratio into account
@@ -1413,7 +1437,7 @@ def unwrap(
 
     FRACTION
     Fraction -- Specify a precise fraction of final UV output.
-        :type margin_method: str | None
+        :type margin_method: typing.Literal['SCALED','ADD','FRACTION'] | None
         :param margin: Margin, Space between islands
         :type margin: float | None
     """