maps4fs 1.8.172__tar.gz → 1.8.174__tar.gz

{maps4fs-1.8.172 → maps4fs-1.8.174}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.8.172
+Version: 1.8.174
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -582,7 +582,7 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Resize factor - the factor by which the background terrain will be resized. It will be used as 1 / resize_factor while generating the models. Which means that the larger the value the more the terrain will be resized. The lowest value is 1, in this case background terrain will not be resized. Note, than low values will lead to long processing and enormous size of the obj files.
 
-- Remove center - if enabled, the playable region (map terrain) will be removed from the background terrain. Note, that it will require low resize factors, to avoid gaps between the map and the background terrain.
+- Remove center - if enabled, the playable region (map terrain) will be removed from the background terrain. By default, it's set to True.
 
 - Apply decimation - if enabled, the mesh will be simplified to reduce the number of faces.
 

{maps4fs-1.8.172 → maps4fs-1.8.174}/README.md

@@ -556,7 +556,7 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Resize factor - the factor by which the background terrain will be resized. It will be used as 1 / resize_factor while generating the models. Which means that the larger the value the more the terrain will be resized. The lowest value is 1, in this case background terrain will not be resized. Note, than low values will lead to long processing and enormous size of the obj files.
 
-- Remove center - if enabled, the playable region (map terrain) will be removed from the background terrain. Note, that it will require low resize factors, to avoid gaps between the map and the background terrain.
+- Remove center - if enabled, the playable region (map terrain) will be removed from the background terrain. By default, it's set to True.
 
 - Apply decimation - if enabled, the mesh will be simplified to reduce the number of faces.
 

{maps4fs-1.8.172 → maps4fs-1.8.174}/maps4fs/generator/component/background.py

@@ -235,24 +235,16 @@ class Background(MeshComponent, ImageComponent):
                 This setting is used for a Background Terrain, where the center part where the
                 playable area is will be cut out.
         """
-        resize_factor = 1 / self.map.background_settings.resize_factor
-        dem_data = cv2.resize(dem_data, (0, 0), fx=resize_factor, fy=resize_factor)
-        if remove_center:
-            half_size = int(self.map_size // 2 * resize_factor)
-            dem_data = self.cut_out_np(dem_data, half_size, set_zeros=True)
-            self.logger.debug("Center removed from DEM data.")
-        self.logger.debug(
-            "DEM data resized to shape: %s with factor: %s", dem_data.shape, resize_factor
-        )
-
         mesh = self.mesh_from_np(
             dem_data,
             include_zeros=include_zeros,
             z_scaling_factor=self.get_z_scaling_factor(),
-            resize_factor=resize_factor,
+            resize_factor=self.map.background_settings.resize_factor,
             apply_decimation=self.map.background_settings.apply_decimation,
             decimation_percent=self.map.background_settings.decimation_percent,
             decimation_agression=self.map.background_settings.decimation_agression,
+            remove_center=remove_center,
+            remove_size=self.map_size,
         )
 
         mesh.export(save_path)
@@ -440,6 +432,12 @@ class Background(MeshComponent, ImageComponent):
 
         # Single channeled 8 bit image, where the water have values of 255, and the rest 0.
         plane_water = cv2.imread(self.water_resources_path, cv2.IMREAD_UNCHANGED)
+
+        # Check if the image contains non-zero values.
+        if not np.any(plane_water):
+            self.logger.warning("Water resources image is empty, skipping water generation.")
+            return
+
         dilated_plane_water = cv2.dilate(
             plane_water.astype(np.uint8), np.ones((5, 5), np.uint8), iterations=5
         ).astype(np.uint8)

maps4fs-1.8.174/maps4fs/generator/component/base/component_mesh.py

@@ -0,0 +1,242 @@
+"""Base class for all components that primarily used to work with meshes."""
+
+import cv2
+import numpy as np
+import trimesh
+from tqdm import tqdm
+
+from maps4fs.generator.component.base.component import Component
+from maps4fs.generator.settings import Parameters
+
+
+class MeshComponent(Component):
+    """Base class for all components that primarily used to work with meshes."""
+
+    @staticmethod
+    def validate_np_for_mesh(image_path: str, map_size: int) -> None:
+        """Checks if the given image is a valid for mesh generation.
+
+        Arguments:
+            image_path (str): The path to the custom background image.
+            map_size (int): The size of the map.
+
+        Raises:
+            ValueError: If the custom background image does not meet the requirements.
+        """
+        image = cv2.imread(image_path, cv2.IMREAD_UNCHANGED)
+        if image.shape[0] != image.shape[1]:
+            raise ValueError("The custom background image must be a square.")
+
+        if image.shape[0] != map_size + Parameters.BACKGROUND_DISTANCE * 2:
+            raise ValueError("The custom background image must have the size of the map + 4096.")
+
+        if len(image.shape) != 2:
+            raise ValueError("The custom background image must be a grayscale image.")
+
+        if image.dtype != np.uint16:
+            raise ValueError("The custom background image must be a 16-bit grayscale image.")
+
+    @staticmethod
+    def mesh_to_stl(mesh: trimesh.Trimesh, save_path: str) -> None:
+        """Converts the mesh to an STL file and saves it in the previews directory.
+        Uses powerful simplification to reduce the size of the file since it will be used
+        only for the preview.
+
+        Arguments:
+            mesh (trimesh.Trimesh) -- The mesh to convert to an STL file.
+        """
+        mesh = mesh.simplify_quadric_decimation(face_count=len(mesh.faces) // 2**6)
+        mesh.export(save_path)
+
+    @staticmethod
+    def mesh_from_np(
+        image: np.ndarray,
+        include_zeros: bool,
+        z_scaling_factor: float,
+        resize_factor: int,
+        apply_decimation: bool,
+        decimation_percent: int,
+        decimation_agression: int,
+        remove_center: bool,
+        remove_size: int,
+    ) -> trimesh.Trimesh:
+        """Generates a mesh from the given numpy array.
+
+        Arguments:
+            image (np.ndarray): The numpy array to generate the mesh from.
+            include_zeros (bool): Whether to include zero values in the mesh.
+            z_scaling_factor (float): The scaling factor for the Z-axis.
+            resize_factor (int): The resizing factor.
+            apply_decimation (bool): Whether to apply decimation to the mesh.
+            decimation_percent (int): The percent of the decimation.
+            decimation_agression (int): The agression of the decimation.
+            remove_center (bool): Whether to remove the center from the mesh.
+            remove_size (int): The size of the center to remove.
+
+        Returns:
+            trimesh.Trimesh: The generated mesh.
+        """
+        output_x_size, _ = image.shape
+        image = image.max() - image
+
+        image = image[::resize_factor, ::resize_factor]
+
+        rows, cols = image.shape
+        x = np.linspace(0, cols - 1, cols)
+        y = np.linspace(0, rows - 1, rows)
+        x, y = np.meshgrid(x, y)
+        z = image
+
+        ground = z.max()
+
+        vertices = np.column_stack([x.ravel(), y.ravel(), z.ravel()])
+        faces = []
+
+        skipped = 0
+
+        for i in tqdm(range(rows - 1), desc="Generating mesh", unit="row"):
+            for j in range(cols - 1):
+                top_left = i * cols + j
+                top_right = top_left + 1
+                bottom_left = top_left + cols
+                bottom_right = bottom_left + 1
+
+                if (
+                    ground in [z[i, j], z[i, j + 1], z[i + 1, j], z[i + 1, j + 1]]
+                    and not include_zeros
+                ):
+                    skipped += 1
+                    continue
+
+                faces.append([top_left, bottom_left, bottom_right])
+                faces.append([top_left, bottom_right, top_right])
+
+        faces_np = np.array(faces)
+        mesh = trimesh.Trimesh(vertices=vertices, faces=faces_np)
+        mesh = MeshComponent.rotate_mesh(mesh)
+
+        if apply_decimation:
+            percent = decimation_percent / 100
+            mesh = mesh.simplify_quadric_decimation(
+                percent=percent, aggression=decimation_agression
+            )
+
+        try:
+            if not mesh.is_watertight:
+                mesh = MeshComponent.fix_mesh(mesh)
+        except Exception:
+            pass
+
+        mesh = MeshComponent.mesh_to_output_size(
+            mesh,
+            resize_factor,
+            z_scaling_factor,
+            output_x_size,
+            skip_resize_to_expected_size=not include_zeros,
+        )
+
+        if remove_center:
+            mesh = MeshComponent.remove_center_from_mesh(mesh, remove_size)
+
+        return mesh
+
+    @staticmethod
+    def rotate_mesh(mesh: trimesh.Trimesh) -> trimesh.Trimesh:
+        """Rotates the given mesh by 180 degrees around the Y-axis and Z-axis.
+
+        Arguments:
+            mesh (trimesh.Trimesh): The mesh to rotate.
+
+        Returns:
+            trimesh.Trimesh: The rotated mesh.
+        """
+        mesh_copy = mesh.copy()
+
+        rotation_matrices = [
+            trimesh.transformations.rotation_matrix(np.pi, [0, 1, 0]),
+            trimesh.transformations.rotation_matrix(np.pi, [0, 0, 1]),
+        ]
+
+        for rotation_matrix in tqdm(rotation_matrices, desc="Rotating mesh", unit="rotation"):
+            mesh_copy.apply_transform(rotation_matrix)
+
+        return mesh_copy
+
+    @staticmethod
+    def fix_mesh(mesh: trimesh.Trimesh) -> trimesh.Trimesh:
+        """Fixes the given mesh by filling holes, fixing normals, fixing winding, fixing inversion,
+        fixing broken faces, and stitching.
+
+        Arguments:
+            mesh (trimesh.Trimesh): The mesh to fix.
+
+        Returns:
+            trimesh.Trimesh: The fixed mesh.
+        """
+        mesh_copy = mesh.copy()
+
+        fix_methods = [
+            trimesh.repair.fill_holes,
+            trimesh.repair.fix_normals,
+            trimesh.repair.fix_winding,
+            trimesh.repair.fix_inversion,
+            trimesh.repair.broken_faces,
+            trimesh.repair.stitch,
+        ]
+
+        for method in tqdm(fix_methods, desc="Fixing mesh", unit="method"):
+            method(mesh_copy)  # type: ignore
+
+        return mesh_copy
+
+    @staticmethod
+    def mesh_to_output_size(
+        mesh: trimesh.Trimesh,
+        resize_factor: int,
+        z_scaling_factor: float,
+        expected_size: int,
+        skip_resize_to_expected_size: bool = False,
+    ) -> trimesh.Trimesh:
+        """Resizes the given mesh to the expected size.
+
+        Arguments:
+            mesh (trimesh.Trimesh): The mesh to resize.
+            resize_factor (int): The resizing factor.
+            z_scaling_factor (float): The scaling factor for the Z-axis.
+            expected_size (int): The expected size.
+            skip_resize_to_expected_size (bool): Whether to skip resizing to the expected size.
+
+        Returns:
+            trimesh.Trimesh: The resized mesh.
+        """
+        mesh_copy = mesh.copy()
+
+        mesh_copy.apply_scale([resize_factor / 1, resize_factor / 1, z_scaling_factor])
+
+        if not skip_resize_to_expected_size:
+            x_size, y_size, _ = mesh_copy.extents
+            x_resize_factor = expected_size / x_size
+            y_resize_factor = expected_size / y_size
+
+            mesh_copy.apply_scale([x_resize_factor, y_resize_factor, 1])
+        return mesh_copy
+
+    @staticmethod
+    def remove_center_from_mesh(mesh: trimesh.Trimesh, remove_size: int) -> trimesh.Trimesh:
+        """Removes the center from the given mesh.
+
+        Arguments:
+            mesh (trimesh.Trimesh): The mesh to remove the center from.
+            remove_size (int): The size of the center to remove.
+
+        Returns:
+            trimesh.Trimesh: The mesh with the center removed.
+        """
+        mesh_copy = mesh.copy()
+
+        _, _, z_size = mesh_copy.extents
+
+        cube_mesh = trimesh.creation.box([remove_size, remove_size, z_size * 4])
+        cube_mesh.apply_translation(mesh_copy.centroid - cube_mesh.centroid)
+
+        return trimesh.boolean.difference([mesh_copy, cube_mesh], check_volume=False)

{maps4fs-1.8.172 → maps4fs-1.8.174}/maps4fs/generator/settings.py

@@ -133,7 +133,7 @@ class BackgroundSettings(SettingsModel):
     generate_background: bool = False
     generate_water: bool = False
     resize_factor: int = 8
-    remove_center: bool = False
+    remove_center: bool = True
     apply_decimation: bool = False
     decimation_percent: int = 25
     decimation_agression: int = 3

{maps4fs-1.8.172 → maps4fs-1.8.174}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.8.172
+Version: 1.8.174
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -582,7 +582,7 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Resize factor - the factor by which the background terrain will be resized. It will be used as 1 / resize_factor while generating the models. Which means that the larger the value the more the terrain will be resized. The lowest value is 1, in this case background terrain will not be resized. Note, than low values will lead to long processing and enormous size of the obj files.
 
-- Remove center - if enabled, the playable region (map terrain) will be removed from the background terrain. Note, that it will require low resize factors, to avoid gaps between the map and the background terrain.
+- Remove center - if enabled, the playable region (map terrain) will be removed from the background terrain. By default, it's set to True.
 
 - Apply decimation - if enabled, the mesh will be simplified to reduce the number of faces.
 

{maps4fs-1.8.172 → maps4fs-1.8.174}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "1.8.172"
+version = "1.8.174"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "MIT License"}

{maps4fs-1.8.172 → maps4fs-1.8.174}/tests/test_generator.py

@@ -39,6 +39,14 @@ dtm_provider = DTMProvider.get_provider_by_code(dtm_provider_code)
 dtm_settings = SRTM30ProviderSettings()
 
 
+background_settings = BackgroundSettings(
+    generate_background=True,
+    generate_water=True,
+    resize_factor=16,
+    remove_center=False,
+)
+
+
 def get_random_size() -> tuple[int, int]:
     """Return random size.
 
@@ -85,10 +93,13 @@ def test_map():
             height, width = get_random_size()
             directory = map_directory(game_code)
 
+            print(f"Generating map for {game_code} at {coordinates} with size {height}x{width}...")
+
             map = Map(
                 game=game,
                 dtm_provider=dtm_provider,
                 dtm_provider_settings=dtm_settings,
+                background_settings=background_settings,
                 coordinates=coordinates,
                 size=height,
                 rotation=0,
@@ -151,6 +162,7 @@ def test_map_preview():
         game=game,
         dtm_provider=dtm_provider,
         dtm_provider_settings=dtm_settings,
+        background_settings=background_settings,
         coordinates=case,
         size=height,
         rotation=0,
@@ -178,9 +190,6 @@ def test_map_pack():
 
     dem_settings = DEMSettings(multiplier=2, blur_radius=15, plateau=1000, water_depth=500)
 
-    background_settings = BackgroundSettings(
-        generate_background=True, generate_water=True, resize_factor=16
-    )
     satellite_settings = SatelliteSettings(download_images=True, satellite_margin=0, zoom_level=14)
 
     directory = map_directory(game_code)

maps4fs-1.8.172/maps4fs/generator/component/base/component_mesh.py

@@ -1,125 +0,0 @@
-"""Base class for all components that primarily used to work with meshes."""
-
-import cv2
-import numpy as np
-import trimesh
-from tqdm import tqdm
-
-from maps4fs.generator.component.base.component import Component
-from maps4fs.generator.settings import Parameters
-
-
-class MeshComponent(Component):
-    """Base class for all components that primarily used to work with meshes."""
-
-    @staticmethod
-    def validate_np_for_mesh(image_path: str, map_size: int) -> None:
-        """Checks if the given image is a valid for mesh generation.
-
-        Arguments:
-            image_path (str): The path to the custom background image.
-            map_size (int): The size of the map.
-
-        Raises:
-            ValueError: If the custom background image does not meet the requirements.
-        """
-        image = cv2.imread(image_path, cv2.IMREAD_UNCHANGED)
-        if image.shape[0] != image.shape[1]:
-            raise ValueError("The custom background image must be a square.")
-
-        if image.shape[0] != map_size + Parameters.BACKGROUND_DISTANCE * 2:
-            raise ValueError("The custom background image must have the size of the map + 4096.")
-
-        if len(image.shape) != 2:
-            raise ValueError("The custom background image must be a grayscale image.")
-
-        if image.dtype != np.uint16:
-            raise ValueError("The custom background image must be a 16-bit grayscale image.")
-
-    @staticmethod
-    def mesh_to_stl(mesh: trimesh.Trimesh, save_path: str) -> None:
-        """Converts the mesh to an STL file and saves it in the previews directory.
-        Uses powerful simplification to reduce the size of the file since it will be used
-        only for the preview.
-
-        Arguments:
-            mesh (trimesh.Trimesh) -- The mesh to convert to an STL file.
-        """
-        mesh = mesh.simplify_quadric_decimation(face_count=len(mesh.faces) // 2**6)
-        mesh.export(save_path)
-
-    @staticmethod
-    def mesh_from_np(
-        image: np.ndarray,
-        include_zeros: bool,
-        z_scaling_factor: float,
-        resize_factor: float,
-        apply_decimation: bool,
-        decimation_percent: int,
-        decimation_agression: int,
-    ) -> trimesh.Trimesh:
-        """Generates a mesh from the given numpy array.
-
-        Arguments:
-            image (np.ndarray): The numpy array to generate the mesh from.
-            include_zeros (bool): Whether to include zero values in the mesh.
-            z_scaling_factor (float): The scaling factor for the Z-axis.
-            resize_factor (float): The resizing factor.
-            apply_decimation (bool): Whether to apply decimation to the mesh.
-            decimation_percent (int): The percent of the decimation.
-            decimation_agression (int): The agression of the decimation.
-
-        Returns:
-            trimesh.Trimesh: The generated mesh.
-        """
-        image = image.max() - image
-
-        rows, cols = image.shape
-        x = np.linspace(0, cols - 1, cols)
-        y = np.linspace(0, rows - 1, rows)
-        x, y = np.meshgrid(x, y)
-        z = image
-
-        ground = z.max()
-
-        vertices = np.column_stack([x.ravel(), y.ravel(), z.ravel()])
-        faces = []
-
-        skipped = 0
-
-        for i in tqdm(range(rows - 1), desc="Generating mesh", unit="row"):
-            for j in range(cols - 1):
-                top_left = i * cols + j
-                top_right = top_left + 1
-                bottom_left = top_left + cols
-                bottom_right = bottom_left + 1
-
-                if (
-                    ground in [z[i, j], z[i, j + 1], z[i + 1, j], z[i + 1, j + 1]]
-                    and not include_zeros
-                ):
-                    skipped += 1
-                    continue
-
-                faces.append([top_left, bottom_left, bottom_right])
-                faces.append([top_left, bottom_right, top_right])
-
-        faces_np = np.array(faces)
-        mesh = trimesh.Trimesh(vertices=vertices, faces=faces_np)
-
-        # Apply rotation: 180 degrees around Y-axis and Z-axis
-        rotation_matrix_y = trimesh.transformations.rotation_matrix(np.pi, [0, 1, 0])
-        rotation_matrix_z = trimesh.transformations.rotation_matrix(np.pi, [0, 0, 1])
-        mesh.apply_transform(rotation_matrix_y)
-        mesh.apply_transform(rotation_matrix_z)
-
-        # if not include_zeros:
-        mesh.apply_scale([1 / resize_factor, 1 / resize_factor, z_scaling_factor])
-
-        if apply_decimation:
-            percent = decimation_percent / 100
-            mesh = mesh.simplify_quadric_decimation(
-                percent=percent, aggression=decimation_agression
-            )
-
-        return mesh