maps4fs 1.8.171__tar.gz → 1.8.173__tar.gz

{maps4fs-1.8.171 → maps4fs-1.8.173}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: maps4fs
-Version: 1.8.171
+Version: 1.8.173
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -562,13 +562,17 @@ You can also apply some advanced settings to the map generation process.<br>
 
 ### DEM Advanced settings
 
-- Multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum available value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the DEM file and the heightScale parameter in [docs](docs/dem.md). To match the in-game heights with SRTM Data provider, the recommended value is 255 (if easy mode is disabled), but depending on the place, you will need to play with both multiplier and the height scale in Giants Editor to find the best values.
+- Adjust terrain to ground level: Enabling this setting (default) will raise or lower the terrain so that it's lowest point is at ground level (taking into account the plateau and water depth settings).
 
-- Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result in a Minecraft-like map.
+- Multiplier: DEM multiplier can be used to make the terrain more pronounced. By default the DEM file will be exact copy of the real terrain. If you want to make it more steep, you can increase this value. The recommended value of the multiplier is 1.
 
-- Plateau: this value will be added to each pixel of the DEM image, making it "higher". It's useful when you want to add some negative heights on the map, that appear to be in a "low" place. By default, it's set to 0.
+- Minimum height scale: This value is used as the heightScale in your map i3d. It will automatically be set higher if the elevation in your map (plus plateau, ceiling and water depth) is higher than this value.
 
-- Water depth: this value will be subtracted from each pixel of the DEM image, where water resources are located. Pay attention that it's not in meters, instead it in the pixel value of DEM, which is 16 bit image with possible values from 0 to 65535. When this value is set, the same value will be added to the plateau setting to avoid negative heights.
+- Plateau: DEM plateau value (in meters) is used to make the whole map higher or lower. This value will be added to each pixel of the DEM image, making it higher. It can be useful if you're working on a plain area and need to add some negative height (to make rivers, for example).
+
+- Ceiling: DEM ceiling value (in meters) is used to add padding in the DEM above the highest elevation in your map area. It can be useful if you plan to manually add some height to the map by sculpting the terrain in GE.
+
+- Water depth: Water depth value (in meters) will be subtracted from the DEM image, making the water deeper. The pixel value used for this is calculated based on the heightScale value for your map.
 
 ### Background terrain Advanced settings
 
@@ -578,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.
 
@@ -703,4 +707,3 @@ But also, I want to thank the people who helped me with the project in some way,
 - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
 - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
 - [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
-

{maps4fs-1.8.171 → maps4fs-1.8.173}/README.md

@@ -536,13 +536,17 @@ You can also apply some advanced settings to the map generation process.<br>
 
 ### DEM Advanced settings
 
-- Multiplier: the height of the map is multiplied by this value. So the DEM map is just a 16-bit grayscale image, which means that the maximum available value there is 65535, while the actual difference between the deepest and the highest point on Earth is about 20 km. Just note that this setting mostly does not matter, because you can always adjust it in the Giants Editor, learn more about the DEM file and the heightScale parameter in [docs](docs/dem.md). To match the in-game heights with SRTM Data provider, the recommended value is 255 (if easy mode is disabled), but depending on the place, you will need to play with both multiplier and the height scale in Giants Editor to find the best values.
+- Adjust terrain to ground level: Enabling this setting (default) will raise or lower the terrain so that it's lowest point is at ground level (taking into account the plateau and water depth settings).
 
-- Blur radius: the radius of the Gaussian blur filter applied to the DEM map. By default, it's set to 21. This filter just makes the DEM map smoother, so the height transitions will be more natural. You can set it to 1 to disable the filter, but it will result in a Minecraft-like map.
+- Multiplier: DEM multiplier can be used to make the terrain more pronounced. By default the DEM file will be exact copy of the real terrain. If you want to make it more steep, you can increase this value. The recommended value of the multiplier is 1.
 
-- Plateau: this value will be added to each pixel of the DEM image, making it "higher". It's useful when you want to add some negative heights on the map, that appear to be in a "low" place. By default, it's set to 0.
+- Minimum height scale: This value is used as the heightScale in your map i3d. It will automatically be set higher if the elevation in your map (plus plateau, ceiling and water depth) is higher than this value.
 
-- Water depth: this value will be subtracted from each pixel of the DEM image, where water resources are located. Pay attention that it's not in meters, instead it in the pixel value of DEM, which is 16 bit image with possible values from 0 to 65535. When this value is set, the same value will be added to the plateau setting to avoid negative heights.
+- Plateau: DEM plateau value (in meters) is used to make the whole map higher or lower. This value will be added to each pixel of the DEM image, making it higher. It can be useful if you're working on a plain area and need to add some negative height (to make rivers, for example).
+
+- Ceiling: DEM ceiling value (in meters) is used to add padding in the DEM above the highest elevation in your map area. It can be useful if you plan to manually add some height to the map by sculpting the terrain in GE.
+
+- Water depth: Water depth value (in meters) will be subtracted from the DEM image, making the water deeper. The pixel value used for this is calculated based on the heightScale value for your map.
 
 ### Background terrain Advanced settings
 
@@ -552,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.
 
@@ -677,4 +681,3 @@ But also, I want to thank the people who helped me with the project in some way,
 - [kbrandwijk](https://github.com/kbrandwijk) - for providing [awesome tool](https://github.com/Paint-a-Farm/satmap_downloader) to download the satellite images from the Google Maps and giving a permission to modify it and create a Python Package.
 - [Maaslandmods](https://github.com/Maaslandmods) - for the awesome idea to edit the tree schema in UI, images and code snippets on how to do it.
 - [StrauntMaunt](https://gitlab.com/StrauntMaunt) - for developing procedural generation scripts, providing with the required updates for maps4fs and preparing the docs on how to use procedural generation.
-

{maps4fs-1.8.171 → maps4fs-1.8.173}/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)
@@ -414,10 +406,18 @@ class Background(MeshComponent, ImageComponent):
         water_resources_image = cv2.imread(self.water_resources_path, cv2.IMREAD_UNCHANGED)
         dem_image = cv2.imread(self.output_path, cv2.IMREAD_UNCHANGED)
 
+        # fall back to default value for height_scale 255, it is defined as float | None
+        # but it is always set at this point
+        z_scaling_factor: float = (
+            self.map.shared_settings.mesh_z_scaling_factor
+            if self.map.shared_settings.mesh_z_scaling_factor is not None
+            else 257
+        )
+
         dem_image = self.subtract_by_mask(
             dem_image,
             water_resources_image,
-            self.map.dem_settings.water_depth,
+            int(self.map.dem_settings.water_depth * z_scaling_factor),
         )
 
         # Save the modified dem_image back to the output path
@@ -432,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.173/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)