maps4fs 1.5.2__py3-none-any.whl → 1.5.3__py3-none-any.whl

maps4fs/generator/component.py

@@ -68,6 +68,7 @@ class Component:
         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)
+        os.makedirs(self.satellite_directory, exist_ok=True)
 
         self.save_bbox()
         self.preprocess()
@@ -123,6 +124,15 @@ class Component:
         """
         return os.path.join(self.map_directory, "scripts")
 
+    @property
+    def satellite_directory(self) -> str:
+        """The directory where the satellite images are stored.
+
+        Returns:
+            str: The directory where the satellite images are stored.
+        """
+        return os.path.join(self.map_directory, "satellite")
+
     @property
     def generation_info_path(self) -> str:
         """The path to the generation info JSON file.

maps4fs/generator/game.py

@@ -10,6 +10,7 @@ from maps4fs.generator.background import Background
 from maps4fs.generator.config import Config
 from maps4fs.generator.grle import GRLE
 from maps4fs.generator.i3d import I3d
+from maps4fs.generator.satellite import Satellite
 from maps4fs.generator.texture import Texture
 
 working_directory = os.getcwd()
@@ -39,7 +40,7 @@ class Game:
     _tree_schema: str | None = None
 
     # Order matters! Some components depend on others.
-    components = [Texture, GRLE, Background, I3d, Config]
+    components = [Texture, GRLE, Background, I3d, Config, Satellite]
 
     def __init__(self, map_template_path: str | None = None):
         if map_template_path:

maps4fs/generator/map.py

@@ -146,6 +146,19 @@ class SplineSettings(SettingsModel):
     spline_density: int = 2
 
 
+class SatelliteSettings(SettingsModel):
+    """Represents the advanced settings for satellite component.
+
+    Attributes:
+        download_images (bool): download satellite images.
+        margin (int): margin around the map.
+    """
+
+    download_images: bool = False
+    satellite_margin: int = 100
+    zoom_level: int = 14
+
+
 # pylint: disable=R0913, R0902, R0914
 class Map:
     """Class used to generate map using all components.
@@ -173,6 +186,7 @@ class Map:
         i3d_settings: I3DSettings = I3DSettings(),
         texture_settings: TextureSettings = TextureSettings(),
         spline_settings: SplineSettings = SplineSettings(),
+        satellite_settings: SatelliteSettings = SatelliteSettings(),
         **kwargs,
     ):
         if not logger:
@@ -217,6 +231,7 @@ class Map:
         self.logger.info("Texture settings: %s", texture_settings)
         self.spline_settings = spline_settings
         self.logger.info("Spline settings: %s", spline_settings)
+        self.satellite_settings = satellite_settings
 
         os.makedirs(self.map_directory, exist_ok=True)
         self.logger.debug("Map directory created: %s", self.map_directory)
@@ -228,6 +243,7 @@ class Map:
             i3d_settings,
             texture_settings,
             spline_settings,
+            satellite_settings,
         ]
 
         settings_json = {}

maps4fs/generator/satellite.py

@@ -0,0 +1,92 @@
+"""This module contains the Satellite class for the maps4fs package to download satellite images
+for the map."""
+
+import os
+
+import cv2
+from pygmdl import save_image  # type: ignore
+
+from maps4fs.generator.background import DEFAULT_DISTANCE
+from maps4fs.generator.component import Component
+from maps4fs.generator.texture import PREVIEW_MAXIMUM_SIZE
+
+
+# pylint: disable=W0223
+class Satellite(Component):
+    """Component for to download satellite images for the map.
+
+    Arguments:
+        game (Game): The game instance for which the map is generated.
+        coordinates (tuple[float, float]): The latitude and longitude of the center of the map.
+        map_size (int): The size of the map in pixels.
+        map_rotated_size (int): The size of the map in pixels after rotation.
+        rotation (int): The rotation angle of the map.
+        map_directory (str): The directory where the map files are stored.
+        logger (Any, optional): The logger to use. Must have at least three basic methods: debug,
+            info, warning. If not provided, default logging will be used.
+    """
+
+    def preprocess(self) -> None:
+        """This component does not require any preprocessing."""
+        return
+
+    def process(self) -> None:
+        """Downloads the satellite images for the map."""
+        self.image_paths = []  # pylint: disable=W0201
+        if not self.map.satellite_settings.download_images:
+            self.logger.info("Satellite images download is disabled.")
+            return
+
+        margin = self.map.satellite_settings.satellite_margin
+        overview_size = (self.map_size + margin) * 2
+        overwiew_path = os.path.join(self.satellite_directory, "satellite_overview.png")
+
+        background_size = self.map_size + (DEFAULT_DISTANCE + margin) * 2
+        background_path = os.path.join(self.satellite_directory, "satellite_background.png")
+
+        sizes = [overview_size, background_size]
+        self.image_paths = [overwiew_path, background_path]  # pylint: disable=W0201
+
+        for size, path in zip(sizes, self.image_paths):
+            try:
+                lat, lon = self.coordinates
+                zoom = self.map.satellite_settings.zoom_level
+                save_image(
+                    lat,
+                    lon,
+                    size,
+                    output_path=path,
+                    rotation=self.rotation,
+                    zoom=zoom,
+                    from_center=True,
+                    logger=self.logger,
+                )
+            except Exception as e:  # pylint: disable=W0718
+                self.logger.error(f"Failed to download satellite image: {e}")
+                continue
+
+    # pylint: disable=no-member
+    def previews(self) -> list[str]:
+        """Returns the paths to the preview images.
+
+        Returns:
+            list[str]: List of paths to the preview images.
+        """
+        previews = []
+        for image_path in self.image_paths:
+            if not os.path.isfile(image_path):
+                self.logger.warning(f"File {image_path} does not exist.")
+                continue
+            image = cv2.imread(image_path)
+            if image is None:
+                self.logger.warning(f"Failed to read image from {image_path}")
+                continue
+
+            if image.shape[0] > PREVIEW_MAXIMUM_SIZE or image.shape[1] > PREVIEW_MAXIMUM_SIZE:
+                image = cv2.resize(image, (PREVIEW_MAXIMUM_SIZE, PREVIEW_MAXIMUM_SIZE))
+
+            preview_path = os.path.join(self.previews_directory, os.path.basename(image_path))
+            cv2.imwrite(preview_path, image)
+            previews.append(preview_path)
+
+        return previews

{maps4fs-1.5.2.dist-info → maps4fs-1.5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.5.2
+Version: 1.5.3
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -75,6 +75,7 @@ Requires-Dist: pydantic
 🌲 Automatically generates forests 🆕<br>
 🌊 Automatically generates water planes 🆕<br>
 📈 Automatically generates splines 🆕<br>
+🛰️ Automatically downloads high resolution satellite images 🆕<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>
@@ -511,10 +512,16 @@ You can also apply some advanced settings to the map generation process. Note th
 
 - 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.
 
-## Splines Advanced settings
+### 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.
 
+### Satellite Advanced settings
+
+- Download images - if enabled, the tool will download the satellite images for the background terrain and the overview image. If you already have the images, you can turn it off.
+- Satellite margin - the margin around the map in meters. It's useful when you want to have some space around the map on the satellite images. By default, it's set to 100.
+- Zoom level - the zoom level of the satellite images. The higher the value, the more detailed the images will be. By default, it's set to 14 and this option is disabled on a public version of the app.
+
 ## Expert Settings
 The tool also supports the expert settings. Do not use them until you read the documentation and understand what they do. Here's the list of the expert settings:
 
@@ -555,3 +562,4 @@ But also, I want to thank the people who helped me with the project in some way,
 - [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.
+- [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.

{maps4fs-1.5.2.dist-info → maps4fs-1.5.3.dist-info}/RECORD

@@ -2,20 +2,21 @@ maps4fs/__init__.py,sha256=LMzzORK3Q3OjXmmRJ03CpS2SMP6zTwKNnUUei3P7s40,300
 maps4fs/logger.py,sha256=B-NEYpMjPAAqlV4VpfTi6nbBFnEABVtQOaYe6nMpidg,1489
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/generator/background.py,sha256=ySABP9HLji8R0aXi1BwjUQtP2uDqZPkrlmugowa9Gkk,22836
-maps4fs/generator/component.py,sha256=58UQgdR-7KlWHTfwLesNNK76BTRsiVngRa6B64OKjhc,20065
+maps4fs/generator/component.py,sha256=RtXruvT4Fxfr7_xo9Bi-i3IIWcPd5QQOSpYJ_cNC49o,20408
 maps4fs/generator/config.py,sha256=0QmK052B8bxyHVhg3jzCORLfOBMMmqVfhhbqXKf6OMk,4383
 maps4fs/generator/dem.py,sha256=MZf3ZjawJ977TxqB1q9nNpvPZUNwfmm2EaJDtVU-eCU,15939
-maps4fs/generator/game.py,sha256=jjo7CTwHHSkRpeD_QgRXkhR_NxI09C4kMxz-nYOTM4A,7931
+maps4fs/generator/game.py,sha256=QHgVnyGYvEnfwGZ84-u-dpbCRr3UeVVqBbrwr5WG8dE,7992
 maps4fs/generator/grle.py,sha256=u8ZwSs313PIOkH_0B_O2tVTaZ-eYNkc30eKGtBxWzTM,17846
 maps4fs/generator/i3d.py,sha256=qeZYqfuhbhRPlSAuQHXaq6RmIO7314oMN68Ivebp1YQ,24786
-maps4fs/generator/map.py,sha256=jIdekpiymhHqKx4FaAwjtq3hMnRdKYo6TvJLX1fSD0k,12814
+maps4fs/generator/map.py,sha256=-3oqAKXVD_lMkJgDrZEun9kRnvOpjoTPcd82kRajmls,13296
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
+maps4fs/generator/satellite.py,sha256=Qnb6XxmXKnHdHKVMb9mJ3vDGtGkDHCOv_81hrrXdx3k,3660
 maps4fs/generator/texture.py,sha256=sErusfv1AqQfP-veMrZ921Tz8DnGEhfB4ucggMmKrD4,31231
 maps4fs/toolbox/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
 maps4fs/toolbox/background.py,sha256=9BXWNqs_n3HgqDiPztWylgYk_QM4YgBpe6_ZNQAWtSc,2154
 maps4fs/toolbox/dem.py,sha256=z9IPFNmYbjiigb3t02ZenI3Mo8odd19c5MZbjDEovTo,3525
-maps4fs-1.5.2.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.5.2.dist-info/METADATA,sha256=Hj01MkOYD87umoXLB2iwwjcS2eGxuUdYGv4SyYWO9Xw,35026
-maps4fs-1.5.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-1.5.2.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.5.2.dist-info/RECORD,,
+maps4fs-1.5.3.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.5.3.dist-info/METADATA,sha256=AQDfDzRNJVcvRq68ntu5n3XuB6gWZWV2O9-AuSzntBQ,35937
+maps4fs-1.5.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-1.5.3.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.5.3.dist-info/RECORD,,