maps4fs 1.2.4__tar.gz → 1.4.1__tar.gz

{maps4fs-1.2.4 → maps4fs-1.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.2.4
+Version: 1.4.1
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -22,6 +22,7 @@ Requires-Dist: trimesh
 Requires-Dist: imageio
 Requires-Dist: tifffile
 Requires-Dist: pympler
+Requires-Dist: pydantic
 
 <div align="center" markdown>
 <a href="https://discord.gg/Sj5QKKyE42">
@@ -60,7 +61,8 @@ Requires-Dist: pympler
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/b922fd0a7188d37e61de/test_coverage)](https://codeclimate.com/github/iwatkot/maps4fs/test_coverage)
-[![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)
+[![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)<br>
+[![Lines of code](https://tokei.rs/b1/github/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs)
 
 </div>
 
@@ -71,7 +73,9 @@ Requires-Dist: pympler
 🌿 Automatically generates decorative foliage 🆕<br>
 🌲 Automatically generates forests 🆕<br>
 🌊 Automatically generates water planes 🆕<br>
+📈 Automatically generates splines 🆕<br>
 🌍 Based on real-world data from OpenStreetMap<br>
+🗺️ Supports [custom OSM maps](/docs/custom_osm.md)<br>
 🏞️ Generates height map using SRTM dataset<br>
 📦 Provides a ready-to-use map template for the Giants Editor<br>
 🚜 Supports Farming Simulator 22 and 25<br>
@@ -79,7 +83,6 @@ Requires-Dist: pympler
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 📕 Detailed [documentation](/docs) and tutorials <br>
 🧰 Modder Toolbox to help you with various tasks <br>
-
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
 🌎 Detailed terrain based on real-world data.<br><br>
@@ -93,6 +96,8 @@ Requires-Dist: pympler
 🌲 Automatically generates forests.<br><br>
 <img src="https://github.com/user-attachments/assets/cce7d4e0-cba2-4dd2-b22d-03137fb2e860"><br>
 🌊 Automatically generates water planes.<br><br>
+<img src="https://github.com/user-attachments/assets/0b05b511-a595-48e7-a353-8298081314a4"><br>
+📈 Automatically generates splines.<br><br>
 <img src="https://github.com/user-attachments/assets/80e5923c-22c7-4dc0-8906-680902511f3a"><br>
 🗒️ True-to-life blueprints for fast and precise modding.<br><br>
 <img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
@@ -110,14 +115,7 @@ Requires-Dist: pympler
 ## Quick Start
 There are several ways to use the tool. You obviously need the **first one**, but you can choose any of the others depending on your needs.<br>
 ### 🚜 For most users
-**Option 1:** Open the [maps4fs](https://maps4fs.streamlit.app) on StreamLit and generate a map template in a few clicks.<br>
-<i>Note, that StreamLit community hosting has some limitations, such as:  <br>
-1. Maximum map size is 4096x4096 meters.  <br>
-2. Advanced settings are disabled.  <br>
-3. Texture dissolving is disabled (they will look worse).  </i><br>
-
-If you run the application locally, you won't have any of these limitations and will be able to generate maps of any size with any settings you want and nice looking textures.<br>
-So, jump to [Docker version](#option-2-docker-version) to launch the tool with one command and get the full experience.<br>
+**Option 1:** Open the [maps4fs](https://maps4fs.xyz) and generate a map template in a few clicks.<br>
 
 ![Basic WebUI](https://github.com/user-attachments/assets/52f499cc-f28a-4da3-abef-0e818abe8dbe)
 
@@ -165,13 +163,13 @@ Don't know where to start? Don't worry, just follow this [step-by-step guide](do
 
 ## How-To-Run
 
-### Option 1: StreamLit
-🟢 Recommended for all users.
+### Option 1: Public version
+🟢 Recommended for all users.  
 🛠️ Don't need to install anything.  
-🗺️ Supported map sizes: 2x2, 4x4 km.  
-⚙️ Advanced settings: disabled.  
-🖼️ Texture dissolving: disabled.  
-Using the [StreamLit](https://maps4fs.streamlit.app) version of the tool is the easiest way to generate a map template. Just open the link and follow the instructions.
+🗺️ Supported map sizes: 2x2, 4x4, 8x8 km.  
+⚙️ Advanced settings: enabled.  
+🖼️ Texture dissolving: enabled.  
+Using the public version on [maps4fs.xyz](https://maps4fs.xyz) is the easiest way to generate a map template. Just open the link and follow the instructions.
 Note: due to CPU and RAM limitations of the hosting, the generation may take some time. If you need faster processing, use the [Docker version](#option-2-docker-version).<br>
 
 Using it is easy and doesn't require any guides. Enjoy!
@@ -488,6 +486,10 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Fields padding - this value (in meters) will be applied to each field, making it smaller. It's useful when the fields are too close to each other and you want to make them smaller. By default, it's set to 0.
 
+- Texture dissolving - if enabled, the values from one layer will be splitted between different layers of texture, making it look more natural. By default, it's set to True. Can be turned of for faster processing.
+
+- Skip drains - if enabled, the tool will not generate the drains and ditches on the map. By default, it's set to False. Use this if you don't need the drains on the map.
+
 ### Farmlands Advanced settings
 
 - Farmlands margin - this value (in meters) will be applied to each farmland, making it bigger. You can use the value to adjust how much the farmland should be bigger than the actual field. By default, it's set to 3.
@@ -498,6 +500,18 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Random plants - when adding decorative foliage, enabling this option will add different species of plants to the map. If unchecked only basic grass (smallDenseMix) will be added. Defaults to True.
 
+### Background terrain Advanced settings
+
+- Generate background - if enabled, the obj files for the background terrain will be generated. You can turn it off if you already have those files or don't need them. By default, it's set to True.
+
+- Generate water - if enabled, the water planes obj files will be generated. You can turn it off if you already have those files or don't need them. By default, it's set to True.
+
+- 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.
+
+## Splines Advanced settings
+
+- Splines density - number of points, which will be added (interpolate) between each pair of existing points. The higher the value, the denser the spline will be. It can smooth the splines, but high values can in opposite make the splines look unnatural.
+
 ## Resources
 In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
 To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
@@ -522,3 +536,8 @@ But also, I want to thank the people who helped me with the project in some way,
 - [Ka5tis](https://github.com/Ka5tis) - for investigating the issue with a "spiky terrain" and finding a solution - changing the `DisplacementLayer` size to a higher value.
 - [Kalderone](https://www.youtube.com/@Kalderone_FS22) - for useful feedback, suggestions, expert advice on the map-making process and highlihting some important settings in the Giants Editor.
 - [OneSunnySunday](https://www.artstation.com/onesunnysunday) - for expert advice on Blender, help in processing background terrain, and compiling detailed tutorials on how to prepare the OBJ files for use in Giants Editor.
+- [BFernaesds](https://github.com/BFernaesds) - for the manual tests of the app.
+- [gamerdesigns](https://github.com/gamerdesigns) - for the manual tests of the app. 
+- [Tox3](https://github.com/Tox3) - for the manual tests of the app. 
+- [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
+- [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.

{maps4fs-1.2.4 → maps4fs-1.4.1}/README.md

@@ -35,7 +35,8 @@
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![Build Status](https://github.com/iwatkot/maps4fs/actions/workflows/checks.yml/badge.svg)](https://github.com/iwatkot/maps4fs/actions)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/b922fd0a7188d37e61de/test_coverage)](https://codeclimate.com/github/iwatkot/maps4fs/test_coverage)
-[![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)
+[![GitHub Repo stars](https://img.shields.io/github/stars/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/stargazers)<br>
+[![Lines of code](https://tokei.rs/b1/github/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs)
 
 </div>
 
@@ -46,7 +47,9 @@
 🌿 Automatically generates decorative foliage 🆕<br>
 🌲 Automatically generates forests 🆕<br>
 🌊 Automatically generates water planes 🆕<br>
+📈 Automatically generates splines 🆕<br>
 🌍 Based on real-world data from OpenStreetMap<br>
+🗺️ Supports [custom OSM maps](/docs/custom_osm.md)<br>
 🏞️ Generates height map using SRTM dataset<br>
 📦 Provides a ready-to-use map template for the Giants Editor<br>
 🚜 Supports Farming Simulator 22 and 25<br>
@@ -54,7 +57,6 @@
 📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 📕 Detailed [documentation](/docs) and tutorials <br>
 🧰 Modder Toolbox to help you with various tasks <br>
-
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
 🌎 Detailed terrain based on real-world data.<br><br>
@@ -68,6 +70,8 @@
 🌲 Automatically generates forests.<br><br>
 <img src="https://github.com/user-attachments/assets/cce7d4e0-cba2-4dd2-b22d-03137fb2e860"><br>
 🌊 Automatically generates water planes.<br><br>
+<img src="https://github.com/user-attachments/assets/0b05b511-a595-48e7-a353-8298081314a4"><br>
+📈 Automatically generates splines.<br><br>
 <img src="https://github.com/user-attachments/assets/80e5923c-22c7-4dc0-8906-680902511f3a"><br>
 🗒️ True-to-life blueprints for fast and precise modding.<br><br>
 <img width="480" src="https://github.com/user-attachments/assets/1a8802d2-6a3b-4bfa-af2b-7c09478e199b"><br>
@@ -85,14 +89,7 @@
 ## Quick Start
 There are several ways to use the tool. You obviously need the **first one**, but you can choose any of the others depending on your needs.<br>
 ### 🚜 For most users
-**Option 1:** Open the [maps4fs](https://maps4fs.streamlit.app) on StreamLit and generate a map template in a few clicks.<br>
-<i>Note, that StreamLit community hosting has some limitations, such as:  <br>
-1. Maximum map size is 4096x4096 meters.  <br>
-2. Advanced settings are disabled.  <br>
-3. Texture dissolving is disabled (they will look worse).  </i><br>
-
-If you run the application locally, you won't have any of these limitations and will be able to generate maps of any size with any settings you want and nice looking textures.<br>
-So, jump to [Docker version](#option-2-docker-version) to launch the tool with one command and get the full experience.<br>
+**Option 1:** Open the [maps4fs](https://maps4fs.xyz) and generate a map template in a few clicks.<br>
 
 ![Basic WebUI](https://github.com/user-attachments/assets/52f499cc-f28a-4da3-abef-0e818abe8dbe)
 
@@ -140,13 +137,13 @@ Don't know where to start? Don't worry, just follow this [step-by-step guide](do
 
 ## How-To-Run
 
-### Option 1: StreamLit
-🟢 Recommended for all users.
+### Option 1: Public version
+🟢 Recommended for all users.  
 🛠️ Don't need to install anything.  
-🗺️ Supported map sizes: 2x2, 4x4 km.  
-⚙️ Advanced settings: disabled.  
-🖼️ Texture dissolving: disabled.  
-Using the [StreamLit](https://maps4fs.streamlit.app) version of the tool is the easiest way to generate a map template. Just open the link and follow the instructions.
+🗺️ Supported map sizes: 2x2, 4x4, 8x8 km.  
+⚙️ Advanced settings: enabled.  
+🖼️ Texture dissolving: enabled.  
+Using the public version on [maps4fs.xyz](https://maps4fs.xyz) is the easiest way to generate a map template. Just open the link and follow the instructions.
 Note: due to CPU and RAM limitations of the hosting, the generation may take some time. If you need faster processing, use the [Docker version](#option-2-docker-version).<br>
 
 Using it is easy and doesn't require any guides. Enjoy!
@@ -463,6 +460,10 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Fields padding - this value (in meters) will be applied to each field, making it smaller. It's useful when the fields are too close to each other and you want to make them smaller. By default, it's set to 0.
 
+- Texture dissolving - if enabled, the values from one layer will be splitted between different layers of texture, making it look more natural. By default, it's set to True. Can be turned of for faster processing.
+
+- Skip drains - if enabled, the tool will not generate the drains and ditches on the map. By default, it's set to False. Use this if you don't need the drains on the map.
+
 ### Farmlands Advanced settings
 
 - Farmlands margin - this value (in meters) will be applied to each farmland, making it bigger. You can use the value to adjust how much the farmland should be bigger than the actual field. By default, it's set to 3.
@@ -473,6 +474,18 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - Random plants - when adding decorative foliage, enabling this option will add different species of plants to the map. If unchecked only basic grass (smallDenseMix) will be added. Defaults to True.
 
+### Background terrain Advanced settings
+
+- Generate background - if enabled, the obj files for the background terrain will be generated. You can turn it off if you already have those files or don't need them. By default, it's set to True.
+
+- Generate water - if enabled, the water planes obj files will be generated. You can turn it off if you already have those files or don't need them. By default, it's set to True.
+
+- 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.
+
+## Splines Advanced settings
+
+- Splines density - number of points, which will be added (interpolate) between each pair of existing points. The higher the value, the denser the spline will be. It can smooth the splines, but high values can in opposite make the splines look unnatural.
+
 ## Resources
 In this section, you'll find a list of the resources that you need to create a map for the Farming Simulator.<br>
 To create a basic map, you only need the Giants Editor. But if you want to create a background terrain - the world around the map, so it won't look like it's floating in the void - you also need Blender and the Blender Exporter Plugins. To create realistic textures for the background terrain, the QGIS is required to obtain high-resolution satellite images.<br>
@@ -497,3 +510,8 @@ But also, I want to thank the people who helped me with the project in some way,
 - [Ka5tis](https://github.com/Ka5tis) - for investigating the issue with a "spiky terrain" and finding a solution - changing the `DisplacementLayer` size to a higher value.
 - [Kalderone](https://www.youtube.com/@Kalderone_FS22) - for useful feedback, suggestions, expert advice on the map-making process and highlihting some important settings in the Giants Editor.
 - [OneSunnySunday](https://www.artstation.com/onesunnysunday) - for expert advice on Blender, help in processing background terrain, and compiling detailed tutorials on how to prepare the OBJ files for use in Giants Editor.
+- [BFernaesds](https://github.com/BFernaesds) - for the manual tests of the app.
+- [gamerdesigns](https://github.com/gamerdesigns) - for the manual tests of the app. 
+- [Tox3](https://github.com/Tox3) - for the manual tests of the app. 
+- [Lucandia](https://github.com/Lucandia) - for the awesome StreamLit [widget to preview STL files](https://github.com/Lucandia/streamlit_stl).
+- [H4rdB4se](https://github.com/H4rdB4se) - for investigating the issue with custom OSM files and finding a proper way to work with the files in JOSM.

maps4fs-1.4.1/maps4fs/__init__.py

@@ -0,0 +1,13 @@
+# pylint: disable=missing-module-docstring
+from maps4fs.generator.game import Game
+from maps4fs.generator.map import (
+    BackgroundSettings,
+    DEMSettings,
+    GRLESettings,
+    I3DSettings,
+    Map,
+    SettingsModel,
+    SplineSettings,
+    TextureSettings,
+)
+from maps4fs.logger import Logger

{maps4fs-1.2.4 → maps4fs-1.4.1}/maps4fs/generator/background.py

@@ -13,16 +13,10 @@ import numpy as np
 import trimesh  # type: ignore
 
 from maps4fs.generator.component import Component
-from maps4fs.generator.dem import (
-    DEFAULT_BLUR_RADIUS,
-    DEFAULT_MULTIPLIER,
-    DEFAULT_PLATEAU,
-    DEM,
-)
+from maps4fs.generator.dem import DEM
 from maps4fs.generator.texture import Texture
 
 DEFAULT_DISTANCE = 2048
-RESIZE_FACTOR = 1 / 8
 FULL_NAME = "FULL"
 FULL_PREVIEW_NAME = "PREVIEW"
 ELEMENTS = [FULL_NAME, FULL_PREVIEW_NAME]
@@ -46,8 +40,6 @@ class Background(Component):
     # pylint: disable=R0801
     def preprocess(self) -> None:
         """Registers the DEMs for the background terrain."""
-        self.light_version = self.kwargs.get("light_version", False)
-        self.water_depth = self.kwargs.get("water_depth", 0)
         self.stl_preview_path: str | None = None
         self.water_resources_path: str | None = None
 
@@ -65,11 +57,12 @@ class Background(Component):
         os.makedirs(self.background_directory, exist_ok=True)
         os.makedirs(self.water_directory, exist_ok=True)
 
-        autoprocesses = [self.kwargs.get("auto_process", False), False]
+        autoprocesses = [self.map.dem_settings.auto_process, False]
         self.output_paths = [
             os.path.join(self.background_directory, f"{name}.png") for name in ELEMENTS
         ]
         self.not_substracted_path = os.path.join(self.background_directory, "not_substracted.png")
+        self.not_resized_path = os.path.join(self.background_directory, "not_resized.png")
 
         dems = []
 
@@ -83,13 +76,12 @@ class Background(Component):
                 self.rotation,
                 self.map_directory,
                 self.logger,
-                auto_process=autoprocess,
-                blur_radius=self.kwargs.get("blur_radius", DEFAULT_BLUR_RADIUS),
-                multiplier=self.kwargs.get("multiplier", DEFAULT_MULTIPLIER),
-                plateau=self.kwargs.get("plateau", DEFAULT_PLATEAU),
             )
             dem.preprocess()
             dem.is_preview = self.is_preview(name)  # type: ignore
+            if dem.is_preview:  # type: ignore
+                dem.multiplier = 1
+            dem.auto_process = autoprocess
             dem.set_output_resolution((self.rotated_size, self.rotated_size))
             dem.set_dem_path(output_path)
             dems.append(dem)
@@ -117,8 +109,9 @@ class Background(Component):
             dem.process()
             if not dem.is_preview:  # type: ignore
                 shutil.copyfile(dem.dem_path, self.not_substracted_path)
+                self.cutout(dem.dem_path, save_path=self.not_resized_path)
 
-        if self.water_depth:
+        if self.map.dem_settings.water_depth:
             self.subtraction()
 
         for dem in self.dems:
@@ -127,11 +120,10 @@ class Background(Component):
                 if self.game.additional_dem_name is not None:
                     self.make_copy(cutted_dem_path, self.game.additional_dem_name)
 
-        if not self.light_version:
+        if self.map.background_settings.generate_background:
             self.generate_obj_files()
+        if self.map.background_settings.generate_water:
             self.generate_water_resources_obj()
-        else:
-            self.logger.info("Light version is enabled, obj files will not be generated.")
 
     def make_copy(self, dem_path: str, dem_name: str) -> None:
         """Copies DEM data to additional DEM file.
@@ -145,7 +137,7 @@ class Background(Component):
         additional_dem_path = os.path.join(dem_directory, dem_name)
 
         shutil.copyfile(dem_path, additional_dem_path)
-        self.logger.info("Additional DEM data was copied to %s.", additional_dem_path)
+        self.logger.debug("Additional DEM data was copied to %s.", additional_dem_path)
 
     def info_sequence(self) -> dict[str, str | float | int]:
         """Returns a dictionary with information about the background terrain.
@@ -207,11 +199,12 @@ class Background(Component):
             self.plane_from_np(dem_data, save_path, is_preview=dem.is_preview)  # type: ignore
 
     # pylint: disable=too-many-locals
-    def cutout(self, dem_path: str) -> str:
+    def cutout(self, dem_path: str, save_path: str | None = None) -> str:
         """Cuts out the center of the DEM (the actual map) and saves it as a separate file.
 
         Arguments:
             dem_path (str): The path to the DEM file.
+            save_path (str, optional): The path where the cutout DEM file will be saved.
 
         Returns:
             str -- The path to the cutout DEM file.
@@ -226,6 +219,11 @@ class Background(Component):
         y2 = center[1] + half_size
         dem_data = dem_data[x1:x2, y1:y2]
 
+        if save_path:
+            cv2.imwrite(save_path, dem_data)  # pylint: disable=no-member
+            self.logger.debug("Not resized DEM saved: %s", save_path)
+            return save_path
+
         output_size = self.map_size + 1
 
         main_dem_path = self.game.dem_file_path(self.map_directory)
@@ -261,11 +259,12 @@ class Background(Component):
             is_preview (bool, optional) -- If True, the preview mesh will be generated.
             include_zeros (bool, optional) -- If True, the mesh will include the zero height values.
         """
+        resize_factor = 1 / self.map.background_settings.resize_factor
         dem_data = cv2.resize(  # pylint: disable=no-member
-            dem_data, (0, 0), fx=RESIZE_FACTOR, fy=RESIZE_FACTOR
+            dem_data, (0, 0), fx=resize_factor, fy=resize_factor
         )
         self.logger.debug(
-            "DEM data resized to shape: %s with factor: %s", dem_data.shape, RESIZE_FACTOR
+            "DEM data resized to shape: %s with factor: %s", dem_data.shape, resize_factor
         )
 
         # Invert the height values.
@@ -325,13 +324,13 @@ class Background(Component):
             self.mesh_to_stl(mesh)
         else:
             if not include_zeros:
-                multiplier = self.kwargs.get("multiplier", DEFAULT_MULTIPLIER)
+                multiplier = self.map.dem_settings.multiplier
                 if multiplier != 1:
                     z_scaling_factor = 1 / multiplier
                 else:
                     z_scaling_factor = 1 / 2**5
                 self.logger.debug("Z scaling factor: %s", z_scaling_factor)
-                mesh.apply_scale([1 / RESIZE_FACTOR, 1 / RESIZE_FACTOR, z_scaling_factor])
+                mesh.apply_scale([1 / resize_factor, 1 / resize_factor, z_scaling_factor])
 
         mesh.export(save_path)
         self.logger.debug("Obj file saved: %s", save_path)
@@ -347,7 +346,7 @@ class Background(Component):
         preview_path = os.path.join(self.previews_directory, "background_dem.stl")
         mesh.export(preview_path)
 
-        self.logger.info("STL file saved: %s", preview_path)
+        self.logger.debug("STL file saved: %s", preview_path)
 
         self.stl_preview_path = preview_path  # pylint: disable=attribute-defined-outside-init
 
@@ -485,8 +484,7 @@ class Background(Component):
             rotation=self.rotation,
             map_directory=self.map_directory,
             logger=self.logger,
-            light_version=self.light_version,
-            custom_schema=background_layers,
+            texture_custom_schema=background_layers,  # type: ignore
         )
 
         self.background_texture.preprocess()
@@ -509,7 +507,7 @@ class Background(Component):
 
         background_save_path = os.path.join(self.water_directory, "water_resources.png")
         cv2.imwrite(background_save_path, background_image)
-        self.logger.info("Background texture saved: %s", background_save_path)
+        self.logger.debug("Background texture saved: %s", background_save_path)
         self.water_resources_path = background_save_path  # pylint: disable=W0201
 
     def subtraction(self) -> None:
@@ -534,7 +532,7 @@ class Background(Component):
 
             # Create a mask where water_resources_image is 255 (or not 0)
             # Subtract water_depth from dem_image where mask is True
-            dem_image[mask] = dem_image[mask] - self.water_depth
+            dem_image[mask] = dem_image[mask] - self.map.dem_settings.water_depth
 
             # Save the modified dem_image back to the output path
             cv2.imwrite(output_path, dem_image)

{maps4fs-1.2.4 → maps4fs-1.4.1}/maps4fs/generator/component.py

@@ -7,11 +7,11 @@ import os
 from copy import deepcopy
 from typing import TYPE_CHECKING, Any
 
-import cv2
+import cv2  # type: ignore
 import osmnx as ox  # type: ignore
 from pyproj import Transformer
 from shapely.affinity import rotate, translate  # type: ignore
-from shapely.geometry import Polygon, box  # type: ignore
+from shapely.geometry import LineString, Polygon, box  # type: ignore
 
 from maps4fs.generator.qgis import save_scripts
 
@@ -20,7 +20,7 @@ if TYPE_CHECKING:
     from maps4fs.generator.map import Map
 
 
-# pylint: disable=R0801, R0903, R0902, R0904
+# pylint: disable=R0801, R0903, R0902, R0904, R0913, R0917
 class Component:
     """Base class for all map generation components.
 
@@ -46,7 +46,7 @@ class Component:
         rotation: int,
         map_directory: str,
         logger: Any = None,
-        **kwargs,  # pylint: disable=W0613, R0913, R0917
+        **kwargs: dict[str, Any],
     ):
         self.game = game
         self.map = map
@@ -58,6 +58,13 @@ class Component:
         self.logger = logger
         self.kwargs = kwargs
 
+        self.logger.info(
+            "Component %s initialized. Map size: %s, map rotated size: %s",  # type: ignore
+            self.__class__.__name__,
+            self.map_size,
+            self.map_rotated_size,
+        )
+
         os.makedirs(self.previews_directory, exist_ok=True)
         os.makedirs(self.scripts_directory, exist_ok=True)
         os.makedirs(self.info_layers_directory, exist_ok=True)
@@ -331,62 +338,79 @@ class Component:
         return cs_x, cs_y
 
     # pylint: disable=R0914
-    def fit_polygon_into_bounds(
-        self, polygon_points: list[tuple[int, int]], margin: int = 0, angle: int = 0
+    def fit_object_into_bounds(
+        self,
+        polygon_points: list[tuple[int, int]] | None = None,
+        linestring_points: list[tuple[int, int]] | None = None,
+        margin: int = 0,
+        angle: int = 0,
     ) -> list[tuple[int, int]]:
         """Fits a polygon into the bounds of the map.
 
         Arguments:
             polygon_points (list[tuple[int, int]]): The points of the polygon.
+            linestring_points (list[tuple[int, int]]): The points of the linestring.
             margin (int, optional): The margin to add to the polygon. Defaults to 0.
             angle (int, optional): The angle to rotate the polygon by. Defaults to 0.
 
         Returns:
             list[tuple[int, int]]: The points of the polygon fitted into the map bounds.
         """
+        if polygon_points is None and linestring_points is None:
+            raise ValueError("Either polygon or linestring points must be provided.")
+
         min_x = min_y = 0
         max_x = max_y = self.map_size
 
-        polygon = Polygon(polygon_points)
+        object_type = Polygon if polygon_points else LineString
+
+        # polygon = Polygon(polygon_points)
+        osm_object = object_type(polygon_points or linestring_points)
 
         if angle:
             center_x = center_y = self.map_rotated_size // 2
             self.logger.debug(
-                "Rotating the polygon by %s degrees with center at %sx%s",
+                "Rotating the osm_object by %s degrees with center at %sx%s",
                 angle,
                 center_x,
                 center_y,
             )
-            polygon = rotate(polygon, -angle, origin=(center_x, center_y))
+            osm_object = rotate(osm_object, -angle, origin=(center_x, center_y))
             offset = (self.map_size / 2) - (self.map_rotated_size / 2)
-            self.logger.debug("Translating the polygon by %s", offset)
-            polygon = translate(polygon, xoff=offset, yoff=offset)
-            self.logger.debug("Rotated and translated polygon.")
+            self.logger.debug("Translating the osm_object by %s", offset)
+            osm_object = translate(osm_object, xoff=offset, yoff=offset)
+            self.logger.debug("Rotated and translated the osm_object.")
 
-        if margin:
-            polygon = polygon.buffer(margin, join_style="mitre")
-            if polygon.is_empty:
-                raise ValueError("The polygon is empty after adding the margin.")
+        if margin and object_type is Polygon:
+            osm_object = osm_object.buffer(margin, join_style="mitre")
+            if osm_object.is_empty:
+                raise ValueError("The osm_object is empty after adding the margin.")
 
         # Create a bounding box for the map bounds
         bounds = box(min_x, min_y, max_x, max_y)
 
-        # Intersect the polygon with the bounds to fit it within the map
+        # Intersect the osm_object with the bounds to fit it within the map
         try:
-            fitted_polygon = polygon.intersection(bounds)
-            self.logger.debug("Fitted the polygon into the bounds: %s", bounds)
+            fitted_osm_object = osm_object.intersection(bounds)
+            self.logger.debug("Fitted the osm_object into the bounds: %s", bounds)
         except Exception as e:
             raise ValueError(  # pylint: disable=W0707
-                f"Could not fit the polygon into the bounds: {e}"
+                f"Could not fit the osm_object into the bounds: {e}"
             )
 
-        if not isinstance(fitted_polygon, Polygon):
-            raise ValueError("The fitted polygon is not a valid polygon.")
+        if not isinstance(fitted_osm_object, object_type):
+            raise ValueError("The fitted osm_object is not valid (probably splitted into parts).")
 
         # Return the fitted polygon points
-        as_list = list(fitted_polygon.exterior.coords)
+        if object_type is Polygon:
+            as_list = list(fitted_osm_object.exterior.coords)
+        elif object_type is LineString:
+            as_list = list(fitted_osm_object.coords)
+        else:
+            raise ValueError("The object type is not supported.")
+
         if not as_list:
-            raise ValueError("The fitted polygon has no points.")
+            raise ValueError("The fitted osm_object has no points.")
         return as_list
 
     def get_infolayer_path(self, layer_name: str) -> str | None:
@@ -469,3 +493,35 @@ class Component:
         self.logger.debug("Shape of the cropped image: %s", cropped.shape)
 
         cv2.imwrite(output_path, cropped)
+
+    @staticmethod
+    def interpolate_points(
+        polyline: list[tuple[int, int]], num_points: int = 4
+    ) -> list[tuple[int, int]]:
+        """Receives a list of tuples, which represents a polyline. Add additional points
+        between the existing points to make the polyline smoother.
+
+        Arguments:
+            polyline (list[tuple[int, int]]): The list of points to interpolate.
+            num_points (int): The number of additional points to add between each pair of points.
+
+        Returns:
+            list[tuple[int, int]]: The list of points with additional points.
+        """
+        if not polyline or num_points < 1:
+            return polyline
+
+        interpolated_polyline = []
+        for i in range(len(polyline) - 1):
+            p1 = polyline[i]
+            p2 = polyline[i + 1]
+            interpolated_polyline.append(p1)
+            for j in range(1, num_points + 1):
+                new_point = (
+                    p1[0] + (p2[0] - p1[0]) * j / (num_points + 1),
+                    p1[1] + (p2[1] - p1[1]) * j / (num_points + 1),
+                )
+                interpolated_polyline.append((int(new_point[0]), int(new_point[1])))
+        interpolated_polyline.append(polyline[-1])
+
+        return interpolated_polyline

{maps4fs-1.2.4 → maps4fs-1.4.1}/maps4fs/generator/config.py

@@ -38,7 +38,7 @@ class Config(Component):
             self.logger.warning("Map XML file not found: %s.", self._map_xml_path)
             return
         tree = ET.parse(self._map_xml_path)
-        self.logger.info("Map XML file loaded from: %s.", self._map_xml_path)
+        self.logger.debug("Map XML file loaded from: %s.", self._map_xml_path)
         root = tree.getroot()
         for map_elem in root.iter("map"):
             map_elem.set("width", str(self.map_size))