maps4fs 0.9.3__py3-none-any.whl → 0.9.4__py3-none-any.whl

maps4fs/generator/background.py

@@ -95,11 +95,13 @@ class Background(Component):
         for tile in self.tiles:
             north, south, east, west = tile.bbox
             epsg3857_string = tile.get_epsg3857_string()
+            epsg3857_string_with_margin = tile.get_epsg3857_string(add_margin=True)
 
             tile_entry = {
                 "center_latitude": tile.coordinates[0],
                 "center_longitude": tile.coordinates[1],
                 "epsg3857_string": epsg3857_string,
+                "epsg3857_string_with_margin": epsg3857_string_with_margin,
                 "height": tile.map_height,
                 "width": tile.map_width,
                 "north": north,
@@ -115,10 +117,16 @@ class Background(Component):
     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
+            (f"Background_{tile.code}", *tile.get_espg3857_bbox()) for tile in self.tiles
         ]
+        qgis_layers_with_margin = [
+            (f"Background_{tile.code}_margin", *tile.get_espg3857_bbox(add_margin=True))
+            for tile in self.tiles
+        ]
+
+        layers = qgis_layers + qgis_layers_with_margin
 
-        self.create_qgis_scripts(qgis_layers)  # type: ignore
+        self.create_qgis_scripts(layers)
 
     def generate_obj_files(self) -> None:
         """Iterates over all tiles and generates 3D obj files based on DEM data.

maps4fs/generator/component.py

@@ -10,7 +10,7 @@ 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
+from maps4fs.generator.qgis import save_scripts
 
 if TYPE_CHECKING:
     from maps4fs.generator.game import Game
@@ -214,16 +214,17 @@ class Component:
         return west, south, east, north
 
     def get_espg3857_bbox(
-        self, bbox: tuple[int, int, int, int] | None = None
-    ) -> tuple[int, int, int, int]:
+        self, bbox: tuple[float, float, float, float] | None = None, add_margin: bool = False
+    ) -> tuple[float, float, float, float]:
         """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.
+            bbox (tuple[float, float, float, float], optional): The bounding box to convert.
+            add_margin (bool, optional): Whether to add a margin to the bounding box.
 
         Returns:
-            tuple[int, int, int, int]: The bounding box in EPSG:3857.
+            tuple[float, float, float, float]: The bounding box in EPSG:3857.
         """
         bbox = bbox or self.bbox
         north, south, east, west = bbox
@@ -231,19 +232,29 @@ class Component:
         epsg3857_north, epsg3857_west = transformer.transform(north, west)
         epsg3857_south, epsg3857_east = transformer.transform(south, east)
 
+        if add_margin:
+            MARGIN = 500  # pylint: disable=C0103
+            epsg3857_north = int(epsg3857_north - MARGIN)
+            epsg3857_south = int(epsg3857_south + MARGIN)
+            epsg3857_east = int(epsg3857_east - MARGIN)
+            epsg3857_west = int(epsg3857_west + MARGIN)
+
         return epsg3857_north, epsg3857_south, epsg3857_east, epsg3857_west
 
-    def get_epsg3857_string(self, bbox: tuple[int, int, int, int] | None = None) -> str:
+    def get_epsg3857_string(
+        self, bbox: tuple[float, float, float, float] | None = None, add_margin: bool = False
+    ) -> 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.
+            bbox (tuple[float, float, float, float], optional): The bounding box to convert.
+            add_margin (bool, optional): Whether to add a margin to the bounding box.
 
         Returns:
             str: The bounding box in EPSG:3857 string.
         """
-        north, south, east, west = self.get_espg3857_bbox(bbox)
+        north, south, east, west = self.get_espg3857_bbox(bbox, add_margin=add_margin)
         return f"{north},{south},{east},{west} [EPSG:3857]"
 
     def create_qgis_scripts(
@@ -259,17 +270,4 @@ class Component:
                 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)
+        save_scripts(qgis_layers, class_name, self.scripts_directory)

maps4fs/generator/config.py

@@ -70,11 +70,13 @@ class Config(Component):
         bbox = self.get_bbox(height_distance=self.map_height, width_distance=self.map_width)
         south, west, north, east = bbox
         epsg3857_string = self.get_epsg3857_string(bbox=bbox)
+        epsg3857_string_with_margin = self.get_epsg3857_string(bbox=bbox, add_margin=True)
 
         self.qgis_sequence()
 
         overview_data = {
             "epsg3857_string": epsg3857_string,
+            "epsg3857_string_with_margin": epsg3857_string_with_margin,
             "south": south,
             "west": west,
             "north": north,
@@ -93,7 +95,11 @@ class Config(Component):
         """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)
+        espg3857_bbox_with_margin = self.get_espg3857_bbox(bbox=bbox, add_margin=True)
 
         qgis_layers = [("Overview_bbox", *espg3857_bbox)]
+        qgis_layers_with_margin = [("Overview_bbox_with_margin", *espg3857_bbox_with_margin)]
 
-        self.create_qgis_scripts(qgis_layers)  # type: ignore
+        layers = qgis_layers + qgis_layers_with_margin
+
+        self.create_qgis_scripts(layers)

maps4fs/generator/qgis.py

@@ -1,11 +1,13 @@
 """This module contains templates for generating QGIS scripts."""
 
+import os
+
 BBOX_TEMPLATE = """
 layers = [
     {layers}
 ]
 for layer in layers:
-    name = layer[0]
+    name = "Bounding_Box_" + layer[0]
     north, south, east, west = layer[1:]
 
     # Create a rectangle geometry from the bounding box.
@@ -34,6 +36,42 @@ for layer in layers:
     layer.triggerRepaint()
 """
 
+POINT_TEMPLATE = """
+layers = [
+    {layers}
+]
+for layer in layers:
+    name = "Points_" + layer[0]
+    north, south, east, west = layer[1:]
+
+    top_left = QgsPointXY(north, west)
+    top_right = QgsPointXY(north, east)
+    bottom_right = QgsPointXY(south, east)
+    bottom_left = QgsPointXY(south, west)
+
+    points = [top_left, top_right, bottom_right, bottom_left, top_left]
+
+    # Create a new layer
+    layer = QgsVectorLayer('Point?crs=EPSG:4326', name, 'memory')
+    provider = layer.dataProvider()
+
+    # Add fields
+    provider.addAttributes([QgsField("id", QVariant.Int)])
+    layer.updateFields()
+
+    # Create and add features for each point
+    for i, point in enumerate(points):
+        feature = QgsFeature()
+        feature.setGeometry(QgsGeometry.fromPointXY(point))
+        feature.setAttributes([i + 1])
+        provider.addFeature(feature)
+
+    layer.updateExtents()
+
+    # Add the layer to the project
+    QgsProject.instance().addMapLayer(layer)
+"""
+
 RASTERIZE_TEMPLATE = """
 import processing
 
@@ -74,17 +112,18 @@ for layer in layers:
 """
 
 
-def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> str:
-    """Returns a template for creating bounding box layers in QGIS.
+def _get_template(layers: list[tuple[str, float, float, float, float]], template: str) -> str:
+    """Returns a template for creating 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.
+        template (str): The template for creating layers in QGIS.
 
     Returns:
-        str: The template for creating bounding box layers in QGIS.
+        str: The template for creating layers in QGIS.
     """
-    return BBOX_TEMPLATE.format(
+    return template.format(
         layers=",\n    ".join(
             [
                 f'("{name}", {north}, {south}, {east}, {west})'
@@ -94,6 +133,32 @@ def get_bbox_template(layers: list[tuple[str, float, float, float, float]]) -> s
     )
 
 
+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 _get_template(layers, BBOX_TEMPLATE)
+
+
+def get_point_template(layers: list[tuple[str, float, float, float, float]]) -> str:
+    """Returns a template for creating point 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 point layers in QGIS.
+    """
+    return _get_template(layers, POINT_TEMPLATE)
+
+
 def get_rasterize_template(layers: list[tuple[str, float, float, float, float]]) -> str:
     """Returns a template for rasterizing bounding box layers in QGIS.
 
@@ -104,11 +169,28 @@ def get_rasterize_template(layers: list[tuple[str, float, float, float, float]])
     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
-            ]
-        )
-    )
+    return _get_template(layers, RASTERIZE_TEMPLATE)
+
+
+def save_scripts(
+    layers: list[tuple[str, float, float, float, float]], file_prefix: str, save_directory: str
+) -> None:
+    """Saves QGIS scripts for creating bounding box, point, and raster layers.
+
+    Args:
+        layers (list[tuple[str, float, float, float, float]]): A list of tuples containing the
+            layer name and the bounding box coordinates.
+        save_dir (str): The directory to save the scripts.
+    """
+    script_files = [
+        (f"{file_prefix}_bbox.py", get_bbox_template),
+        (f"{file_prefix}_rasterize.py", get_rasterize_template),
+        (f"{file_prefix}_point.py", get_point_template),
+    ]
+
+    for script_file, process_function in script_files:
+        script_path = os.path.join(save_directory, script_file)
+        script_content = process_function(layers)  # type: ignore
+
+        with open(script_path, "w", encoding="utf-8") as file:
+            file.write(script_content)

{maps4fs-0.9.3.dist-info → maps4fs-0.9.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 0.9.3
+Version: 0.9.4
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License
@@ -23,7 +23,9 @@ Requires-Dist: imageio
 Requires-Dist: tifffile
 
 <div align="center" markdown>
-<img src="https://github.com/iwatkot/maps4fs/assets/118521851/ffd7f0a3-e317-4c3f-911f-2c2fb736fbfa">
+<a href="https://discord.gg/Sj5QKKyE42">
+<img src="https://github.com/user-attachments/assets/37043333-d6ef-4ca3-9f3c-81323d9d0b71">
+</a>
 
 <p align="center">
   <a href="#Quick-Start">Quick Start</a> •
@@ -41,6 +43,7 @@ Requires-Dist: tifffile
 </p>
 
 
+[![Join Discord](https://img.shields.io/badge/join-discord-blue)](https://discord.gg/Sj5QKKyE42)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/iwatkot/maps4fs)](https://github.com/iwatkot/maps4fs/releases)
 [![PyPI - Version](https://img.shields.io/pypi/v/maps4fs)](https://pypi.org/project/maps4fs)
 [![Docker Pulls](https://img.shields.io/docker/pulls/iwatkot/maps4fs)](https://hub.docker.com/repository/docker/iwatkot/maps4fs/general)

{maps4fs-0.9.3.dist-info → maps4fs-0.9.4.dist-info}/RECORD

@@ -1,19 +1,19 @@
 maps4fs/__init__.py,sha256=da4jmND2Ths9AffnkAKgzLHNkvKFOc_l21gJisPXqWY,155
 maps4fs/logger.py,sha256=8oZzAKJllilYrVp452LX0zx-dNFwpS6UngbTrI6KfwA,2148
 maps4fs/generator/__init__.py,sha256=zZMLEkGzb4z0xql650gOtGSvcgX58DnJ2yN3vC2daRk,43
-maps4fs/generator/background.py,sha256=M43VNwiAnL4-1iUGAFwwwl5lV5EVy4luvZZmsuGO_Co,12642
-maps4fs/generator/component.py,sha256=tLjjbrFn3v4CrUrUOgH9s8NuJhmQcBs74ShefkNg1VE,10584
-maps4fs/generator/config.py,sha256=JL7leQv8C06JQOXIbgQ-jve2re7cNsx8vKa8dfbnxPM,3896
+maps4fs/generator/background.py,sha256=6mN2xRg5XEqsLaXPUqdNGgDR1Ats60fBK93WlDeB8EI,13002
+maps4fs/generator/component.py,sha256=ZEDjChPnvqAsgnBu2f2YBOlwGOlfax4VaAYBcJerLIQ,10684
+maps4fs/generator/config.py,sha256=ZO5BWDU-S3p0-ndKDSFa8Oin3YcYy0iH8B4lqEA_07Q,4275
 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=v8OOLmhAkgqq64tQgEDbV6DmbgOVm3NXJBDDy0nJf60,4226
 maps4fs/generator/path_steps.py,sha256=yeN6hmOD8O2LMozUf4HcQMIy8WJ5sHF5pGQT_s2FfOw,3147
-maps4fs/generator/qgis.py,sha256=k19miPEFyOdu_ogBFHmFVfYQ-IgF38ufJZ5DM5NSHBQ,3400
+maps4fs/generator/qgis.py,sha256=vhV-EwZKK-p1qEV-2H_yckuktx8ezlCMnmJJfUt1HGI,6091
 maps4fs/generator/texture.py,sha256=CwaXZfAG4e3D3YR7yVR2MC677EHpbUWTboCS3G6jkhk,17723
 maps4fs/generator/tile.py,sha256=3vmfjQiPiiUZKPuIo5tg2rOKkgcP1NRVkMGK-Vo10-A,2138
-maps4fs-0.9.3.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
-maps4fs-0.9.3.dist-info/METADATA,sha256=0iPJEUJXeSqgNXqhcD2BM5lqkvX7YBK2O-UFWY5HxvM,23996
-maps4fs-0.9.3.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-0.9.3.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-0.9.3.dist-info/RECORD,,
+maps4fs-0.9.4.dist-info/LICENSE.md,sha256=-JY0v7p3dwXze61EbYiK7YEJ2aKrjaFZ8y2xYEOrmRY,1068
+maps4fs-0.9.4.dist-info/METADATA,sha256=WVUjB4PmrCnuWZNIVurx3_1XPqS2oBEwWdVaU22uX2Y,24130
+maps4fs-0.9.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-0.9.4.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-0.9.4.dist-info/RECORD,,