maps4fs 0.9.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

maps4fs/generator/background.py

@@ -50,7 +50,8 @@ class Background(Component):
                 tile_code=path_step.code,
                 auto_process=False,
                 blur_radius=self.kwargs.get("blur_radius"),
-                multiplier=1,
+                multiplier=self.kwargs.get("multiplier", 1),
+                plateau=self.kwargs.get("plateau", 0),
             )
 
             # Update the origin for the next tile.
@@ -80,6 +81,8 @@ class Background(Component):
             dict[str, dict[str, float | int]] -- A dictionary with information about the tiles.
         """
         data = {}
+        self.qgis_sequence()
+
         for tile in self.tiles:
             north, south, east, west = tile.bbox
             epsg3857_string = tile.get_epsg3857_string()
@@ -100,6 +103,14 @@ class Background(Component):
 
         return data  # type: ignore
 
+    def qgis_sequence(self) -> None:
+        """Generates QGIS scripts for creating bounding box layers and rasterizing them."""
+        qgis_layers = [
+            (f"Background_bbox_{tile.code}", *tile.get_espg3857_bbox()) for tile in self.tiles
+        ]
+
+        self.create_qgis_scripts(qgis_layers)  # type: ignore
+
     def generate_obj_files(self) -> None:
         """Iterates over all tiles and generates 3D obj files based on DEM data.
         If at least one DEM file is missing, the generation will be stopped at all.

maps4fs/generator/component.py

@@ -10,6 +10,8 @@ from typing import TYPE_CHECKING, Any
 import osmnx as ox  # type: ignore
 from pyproj import Transformer
 
+from maps4fs.generator.qgis import get_bbox_template, get_rasterize_template
+
 if TYPE_CHECKING:
     from maps4fs.generator.game import Game
 
@@ -47,6 +49,7 @@ class Component:
         self.kwargs = kwargs
 
         os.makedirs(self.previews_directory, exist_ok=True)
+        os.makedirs(self.scripts_directory, exist_ok=True)
 
         self.save_bbox()
         self.preprocess()
@@ -84,6 +87,15 @@ class Component:
         """
         return os.path.join(self.map_directory, "previews")
 
+    @property
+    def scripts_directory(self) -> str:
+        """The directory where the scripts are stored.
+
+        Returns:
+            str: The directory where the scripts are stored.
+        """
+        return os.path.join(self.map_directory, "scripts")
+
     @property
     def generation_info_path(self) -> str:
         """The path to the generation info JSON file.
@@ -187,15 +199,31 @@ class Component:
         self.bbox = self.get_bbox(project_utm=False)
         self.logger.debug("Saved bounding box: %s", self.bbox)
 
-    def get_epsg3857_string(self, bbox: tuple[int, int, int, int] | None = None) -> str:
-        """Converts the bounding box to EPSG:3857 string.
+    @property
+    def new_bbox(self) -> tuple[float, float, float, float]:
+        """This property is used for a new version of osmnx library, where the order of coordinates
+        has been changed to (left, bottom, right, top).
+
+        Returns:
+            tuple[float, float, float, float]: The bounding box of the map in the new order:
+                (left, bottom, right, top).
+        """
+        # FutureWarning: The expected order of coordinates in `bbox`
+        # will change in the v2.0.0 release to `(left, bottom, right, top)`.
+        north, south, east, west = self.bbox
+        return west, south, east, north
+
+    def get_espg3857_bbox(
+        self, bbox: tuple[int, int, int, int] | None = None
+    ) -> tuple[int, int, int, int]:
+        """Converts the bounding box to EPSG:3857.
         If the bounding box is not provided, the instance variable is used.
 
         Args:
             bbox (tuple[int, int, int, int], optional): The bounding box to convert.
 
         Returns:
-            str: The bounding box in EPSG:3857 string.
+            tuple[int, int, int, int]: The bounding box in EPSG:3857.
         """
         bbox = bbox or self.bbox
         north, south, east, west = bbox
@@ -203,4 +231,45 @@ class Component:
         epsg3857_north, epsg3857_west = transformer.transform(north, west)
         epsg3857_south, epsg3857_east = transformer.transform(south, east)
 
-        return f"{epsg3857_north},{epsg3857_south},{epsg3857_east},{epsg3857_west} [EPSG:3857]"
+        return epsg3857_north, epsg3857_south, epsg3857_east, epsg3857_west
+
+    def get_epsg3857_string(self, bbox: tuple[int, int, int, int] | None = None) -> str:
+        """Converts the bounding box to EPSG:3857 string.
+        If the bounding box is not provided, the instance variable is used.
+
+        Args:
+            bbox (tuple[int, int, int, int], optional): The bounding box to convert.
+
+        Returns:
+            str: The bounding box in EPSG:3857 string.
+        """
+        north, south, east, west = self.get_espg3857_bbox(bbox)
+        return f"{north},{south},{east},{west} [EPSG:3857]"
+
+    def create_qgis_scripts(
+        self, qgis_layers: list[tuple[str, float, float, float, float]]
+    ) -> None:
+        """Creates QGIS scripts from the given layers.
+        Each layer is a tuple where the first element is a name of the layer and the rest are the
+        bounding box coordinates in EPSG:3857.
+        For filenames, the class name is used as a prefix.
+
+        Args:
+            qgis_layers (list[tuple[str, float, float, float, float]]): The list of layers to
+                create scripts for.
+        """
+        class_name = self.__class__.__name__.lower()
+
+        script_files = [
+            (f"{class_name}_bbox.py", get_bbox_template),
+            (f"{class_name}_rasterize.py", get_rasterize_template),
+        ]
+
+        for script_file, process_function in script_files:
+            script_path = os.path.join(self.scripts_directory, script_file)
+            script_content = process_function(qgis_layers)  # type: ignore
+
+            with open(script_path, "w", encoding="utf-8") as file:
+                file.write(script_content)
+
+            self.logger.info("QGIS script saved: %s", script_path)

maps4fs/generator/config.py

@@ -71,6 +71,8 @@ class Config(Component):
         south, west, north, east = bbox
         epsg3857_string = self.get_epsg3857_string(bbox=bbox)
 
+        self.qgis_sequence()
+
         overview_data = {
             "epsg3857_string": epsg3857_string,
             "south": south,
@@ -86,3 +88,12 @@ class Config(Component):
         }
 
         return data  # type: ignore
+
+    def qgis_sequence(self) -> None:
+        """Generates QGIS scripts for creating bounding box layers and rasterizing them."""
+        bbox = self.get_bbox(height_distance=self.map_height, width_distance=self.map_width)
+        espg3857_bbox = self.get_espg3857_bbox(bbox=bbox)
+
+        qgis_layers = [("Overview_bbox", *espg3857_bbox)]
+
+        self.create_qgis_scripts(qgis_layers)  # type: ignore

maps4fs/generator/qgis.py

@@ -0,0 +1,114 @@
+"""This module contains templates for generating QGIS scripts."""
+
+BBOX_TEMPLATE = """
+layers = [
+    {layers}
+]
+for layer in layers:
+    name = layer[0]
+    north, south, east, west = layer[1:]
+
+    # Create a rectangle geometry from the bounding box.
+    rect = QgsRectangle(north, east, south, west)
+
+    # Create a new memory layer to hold the bounding box.
+    layer = QgsVectorLayer("Polygon?crs=EPSG:3857", name, "memory")
+    provider = layer.dataProvider()
+
+    # Add the rectangle as a feature to the layer.
+    feature = QgsFeature()
+    feature.setGeometry(QgsGeometry.fromRect(rect))
+    provider.addFeatures([feature])
+
+    # Add the layer to the map.
+    QgsProject.instance().addMapLayer(layer)
+
+    # Set the fill opacity.
+    symbol = layer.renderer().symbol()
+    symbol_layer = symbol.symbolLayer(0)
+
+    # Set the stroke color and width.
+    symbol_layer.setStrokeColor(QColor(0, 255, 0))
+    symbol_layer.setStrokeWidth(0.2)
+    symbol_layer.setFillColor(QColor(0, 0, 255, 0))
+    layer.triggerRepaint()
+"""
+
+RASTERIZE_TEMPLATE = """
+import processing
+
+############################################################
+####### ADD THE DIRECTORY FOR THE FILES TO SAVE HERE #######
+############################################################
+############### IT MUST END WITH A SLASH (/) ###############
+############################################################
+
+SAVE_DIR = "C:/Users/iwatk/OneDrive/Desktop/"
+
+############################################################
+
+layers = [
+    {layers}
+]
+
+for layer in layers:
+    name = layer[0]
+    north, south, east, west = layer[1:]
+
+    epsg3857_string = str(north) + "," + str(south) + "," + str(east) + "," + str(west) + " [EPSG:3857]"
+    file_path = SAVE_DIR + name + ".tif"
+
+    processing.run(
+        "native:rasterize",
+        {{
+            "EXTENT": epsg3857_string,
+            "EXTENT_BUFFER": 0,
+            "TILE_SIZE": 64,
+            "MAP_UNITS_PER_PIXEL": 1,
+            "MAKE_BACKGROUND_TRANSPARENT": False,
+            "MAP_THEME": None,
+            "LAYERS": None,
+            "OUTPUT": file_path,
+        }},
+)
+"""
+
+
+def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> str:
+    """Returns a template for creating bounding box layers in QGIS.
+
+    Args:
+        layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
+            layer name and the bounding box coordinates.
+
+    Returns:
+        str: The template for creating bounding box layers in QGIS.
+    """
+    return BBOX_TEMPLATE.format(
+        layers=",\n    ".join(
+            [
+                f'("{name}", {north}, {south}, {east}, {west})'
+                for name, north, south, east, west in layers
+            ]
+        )
+    )
+
+
+def get_rasterize_template(layers: list[tuple[str, float, float, float, float]]) -> str:
+    """Returns a template for rasterizing bounding box layers in QGIS.
+
+    Args:
+        layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
+            layer name and the bounding box coordinates.
+
+    Returns:
+        str: The template for rasterizing bounding box layers in QGIS.
+    """
+    return RASTERIZE_TEMPLATE.format(
+        layers=",\n    ".join(
+            [
+                f'("{name}", {north}, {south}, {east}, {west})'
+                for name, north, south, east, west in layers
+            ]
+        )
+    )

maps4fs/generator/texture.py

@@ -167,14 +167,6 @@ class Texture(Component):
         self.logger.debug("Map minimum coordinates (XxY): %s x %s.", self.minimum_x, self.minimum_y)
         self.logger.debug("Map maximum coordinates (XxY): %s x %s.", self.maximum_x, self.maximum_y)
 
-        self.height = abs(north - south)
-        self.width = abs(east - west)
-        self.logger.info("Map dimensions (HxW): %s x %s.", self.height, self.width)
-
-        self.height_coef = self.height / self.map_height
-        self.width_coef = self.width / self.map_width
-        self.logger.debug("Map coefficients (HxW): %s x %s.", self.height_coef, self.width_coef)
-
     def info_sequence(self) -> dict[str, Any]:
         """Returns the JSON representation of the generation info for textures."""
         useful_attributes = [
@@ -186,10 +178,6 @@ class Texture(Component):
             "minimum_y",
             "maximum_x",
             "maximum_y",
-            "height",
-            "width",
-            "height_coef",
-            "width_coef",
         ]
         return {attr: getattr(self, attr, None) for attr in useful_attributes}
 
@@ -321,8 +309,7 @@ class Texture(Component):
         Returns:
             int: Relative X coordinate in map image.
         """
-        raw_x = x - self.minimum_x
-        return int(raw_x * self.height_coef)
+        return int(self.map_width * (x - self.minimum_x) / (self.maximum_x - self.minimum_x))
 
     def get_relative_y(self, y: float) -> int:
         """Converts UTM Y coordinate to relative Y coordinate in map image.
@@ -333,8 +320,7 @@ class Texture(Component):
         Returns:
             int: Relative Y coordinate in map image.
         """
-        raw_y = y - self.minimum_y
-        return self.height - int(raw_y * self.width_coef)
+        return int(self.map_height * (1 - (y - self.minimum_y) / (self.maximum_y - self.minimum_y)))
 
     # pylint: disable=W0613
     def _to_np(self, geometry: shapely.geometry.polygon.Polygon, *args) -> np.ndarray:

{maps4fs-0.9.0.dist-info → maps4fs-0.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.0
+Version: 0.9.2
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -59,8 +59,8 @@ Requires-Dist: tifffile
 🏞️ Generates height using SRTM dataset<br>
 📦 Provides a ready-to-use map template for the Giants Editor<br>
 🚜 Supports Farming Simulator 22 and 25<br>
-🔷 Generates *.obj files for background terrain based on the real-world height map 🆕<br>
-📄 Generates commands to obtain high-resolution satellite images from [QGIS](https://qgis.org/download/) 🆕<br>
+🔷 Generates *.obj files for background terrain based on the real-world height map<br>
+📄 Generates scripts to download high-resolution satellite images from [QGIS](https://qgis.org/download/) in one click<br>
 
 <p align="center">
 <img src="https://github.com/user-attachments/assets/cf8f5752-9c69-4018-bead-290f59ba6976"><br>
@@ -266,10 +266,6 @@ Example of the `Texture` component:
     "minimum_y": 5013940.540089059,
     "maximum_x": 441233.5397821935,
     "maximum_y": 5016006.074349126,
-    "height": 2065.5342600671574,
-    "width": 2072.295804702677,
-    "height_coef": 1.0085616504234167,
-    "width_coef": 1.011863185889979
 },
 ```
 
@@ -282,12 +278,7 @@ And here's the list of the fields:
 - `"minimum_x"` - the minimum x coordinate of the map (UTM projection),<br>
 - `"minimum_y"` - the minimum y coordinate of the map (UTM projection),<br>
 - `"maximum_x"` - the maximum x coordinate of the map (UTM projection),<br>
-- `"maximum_y"` - the maximum y coordinate of the map (UTM projection),<br>
-- `"height"` - the height of the map in meters (it won't be equal to the parameters above since the Earth is not flat, sorry flat-earthers),<br>
-- `"width"` - the width of the map in meters (same as above),<br>
-- `"height_coef"` - since we need a texture of exact size, the height of the map is multiplied by this coefficient,<br>
-- `"width_coef"` - same as above but for the width,<br>
-- `"tile_name"` - the name of the SRTM tile which was used to generate the height map, e.g. "N52E013"<br>
+- `"maximum_y"` - the maximum y coordinate of the map (UTM projection),
 
 ### Background
 
@@ -373,9 +364,9 @@ If you're willing to create a background terrain, you will need: Blender, the Bl
 
 If you're afraid of this task, please don't be. It's really simple and I've prepaired detailed step-by-step instructions for you, you'll find them in the separate README files. Here are the steps you need to follow:
 
-1. [Download high-resolution satellite images](README_satellite_images.md).
-2. [Prepare the i3d files](README_i3d.md).
-3. [Import the i3d files to Giants Editor](README_giants_editor.md).
+1. [Download high-resolution satellite images](tutorials/README_satellite_images.md).
+2. [Prepare the i3d files](tutorials/README_i3d.md).
+3. [Import the i3d files to Giants Editor](tutorials/README_giants_editor.md).
 
 ## Overview image
 The overview image is an image that is used as in-game map. No matter what the size of the map, this file is always `4096x4096 pixels`, while the region of your map is `2048x2048 pixels` in center of this file. The rest of the image is just here for nice view, but you still may add satellite pictures to this region.<br>

{maps4fs-0.9.0.dist-info → maps4fs-0.9.2.dist-info}/RECORD

@@ -1,18 +1,19 @@
 maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
 maps4fs/logger.py,sha256=CneeHxQywjNUJXqQrUUSeiDxu95FfrfyK_Si1v0gMZ8,1477
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=YZbTSijKgNQOvpWJHqCJNHeoV5GxUjp79b8PoQwRQH0,10778
-maps4fs/generator/component.py,sha256=g3IBC8ul9zmcG9tHvyPJIg8hxBHFR8kB8Smw9yMW3qA,7864
-maps4fs/generator/config.py,sha256=JkRexT_ZclRa_x0w6ojgG-Tsu4NoshFTUGycRFdfrVk,3463
+maps4fs/generator/background.py,sha256=2BUgn12t-FgijPTY7hvwTaYQrVzYdnZqhoz76KSBcKs,11216
+maps4fs/generator/component.py,sha256=tLjjbrFn3v4CrUrUOgH9s8NuJhmQcBs74ShefkNg1VE,10584
+maps4fs/generator/config.py,sha256=JL7leQv8C06JQOXIbgQ-jve2re7cNsx8vKa8dfbnxPM,3896
 maps4fs/generator/dem.py,sha256=p7THncPUdYWtNR2HrTXe0bCuJ8psUV8rRpYPJkzL2gA,15220
 maps4fs/generator/game.py,sha256=94HjPNOyy6XSSOnBp-uxrkBglKyC-X3ULIrrucfdlKw,6825
 maps4fs/generator/i3d.py,sha256=UuQiQRusPQ2f6PvGKxJ_UZeXsx3uG15efmy8Ysnm3F8,3597
 maps4fs/generator/map.py,sha256=BS8ylTCRlHRmbImg73wnHMpBB2ODckVyVZq5KJhCMfM,4236
 maps4fs/generator/path_steps.py,sha256=rKslIiG9mriCVL9_0i8Oet2p0DITrpBWi0pECpvuyUM,2707
-maps4fs/generator/texture.py,sha256=0gkohGmamZbmqc9VpPqt8pli_x9w9SnUh2JjYGaiI3I,18170
+maps4fs/generator/qgis.py,sha256=k19miPEFyOdu_ogBFHmFVfYQ-IgF38ufJZ5DM5NSHBQ,3400
+maps4fs/generator/texture.py,sha256=CwaXZfAG4e3D3YR7yVR2MC677EHpbUWTboCS3G6jkhk,17723
 maps4fs/generator/tile.py,sha256=3vmfjQiPiiUZKPuIo5tg2rOKkgcP1NRVkMGK-Vo10-A,2138
-maps4fs-0.9.0.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.9.0.dist-info/METADATA,sha256=HZffexpblrgCEHi3ThLJ3FbmCT8HDxbetbJZUFnPToI,24031
-maps4fs-0.9.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.9.0.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.9.0.dist-info/RECORD,,
+maps4fs-0.9.2.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.9.2.dist-info/METADATA,sha256=J9SVncLGsj5Le0QQu-mfSyrsQJc0EkO7tdDs1HFd8vQ,23427
+maps4fs-0.9.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-0.9.2.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.9.2.dist-info/RECORD,,