maps4fs 1.5.4__py3-none-any.whl → 1.5.6__py3-none-any.whl

maps4fs/__init__.py

@@ -1,12 +1,12 @@
 # pylint: disable=missing-module-docstring
 from maps4fs.generator.dtm import DTMProvider
 from maps4fs.generator.game import Game
-from maps4fs.generator.map import (
+from maps4fs.generator.map import Map
+from maps4fs.generator.settings import (
     BackgroundSettings,
     DEMSettings,
     GRLESettings,
     I3DSettings,
-    Map,
     SettingsModel,
     SplineSettings,
     TextureSettings,

maps4fs/generator/dem.py

@@ -61,6 +61,7 @@ class DEM(Component):
 
         self.dtm_provider: DTMProvider = self.map.dtm_provider(  # type: ignore
             coordinates=self.coordinates,
+            user_settings=self.map.dtm_provider_settings,
             size=self.map_rotated_size,
             directory=self.temp_dir,
             logger=self.logger,

maps4fs/generator/dtm.py

@@ -14,10 +14,15 @@ import numpy as np
 import osmnx as ox  # type: ignore
 import rasterio  # type: ignore
 import requests
+from pydantic import BaseModel
 
 from maps4fs.logger import Logger
 
 
+class DTMProviderSettings(BaseModel):
+    """Base class for DTM provider settings models."""
+
+
 class DTMProvider:
     """Base class for DTM providers."""
 
@@ -29,8 +34,23 @@ class DTMProvider:
 
     _url: str | None = None
 
-    def __init__(self, coordinates: tuple[float, float], size: int, directory: str, logger: Logger):
+    _author: str | None = None
+    _is_community: bool = False
+    _settings: Type[DTMProviderSettings] | None = None
+
+    _instructions: str | None = None
+
+    # pylint: disable=R0913, R0917
+    def __init__(
+        self,
+        coordinates: tuple[float, float],
+        user_settings: DTMProviderSettings | None,
+        size: int,
+        directory: str,
+        logger: Logger,
+    ):
         self._coordinates = coordinates
+        self._user_settings = user_settings
         self._size = size
 
         if not self._code:
@@ -69,6 +89,51 @@ class DTMProvider:
             raise ValueError("URL must be defined.")
         return self.url.format(**kwargs)
 
+    @classmethod
+    def author(cls) -> str | None:
+        """Author of the provider.
+
+        Returns:
+            str: Author of the provider.
+        """
+        return cls._author
+
+    @classmethod
+    def is_community(cls) -> bool:
+        """Is the provider a community-driven project.
+
+        Returns:
+            bool: True if the provider is a community-driven project, False otherwise.
+        """
+        return cls._is_community
+
+    @classmethod
+    def settings(cls) -> Type[DTMProviderSettings] | None:
+        """Settings model of the provider.
+
+        Returns:
+            Type[DTMProviderSettings]: Settings model of the provider.
+        """
+        return cls._settings
+
+    @classmethod
+    def instructions(cls) -> str | None:
+        """Instructions for using the provider.
+
+        Returns:
+            str: Instructions for using the provider.
+        """
+        return cls._instructions
+
+    @property
+    def user_settings(self) -> DTMProviderSettings | None:
+        """User settings of the provider.
+
+        Returns:
+            DTMProviderSettings: User settings of the provider.
+        """
+        return self._user_settings
+
     @classmethod
     def description(cls) -> str:
         """Description of the provider.
@@ -211,6 +276,8 @@ class SRTM30Provider(DTMProvider):
 
     _url = "https://elevation-tiles-prod.s3.amazonaws.com/skadi/{latitude_band}/{tile_name}.hgt.gz"
 
+    _author = "[iwatkot](https://github.com/iwatkot)"
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.hgt_directory = os.path.join(self._tile_directory, "hgt")

maps4fs/generator/map.py

@@ -7,159 +7,21 @@ import os
 import shutil
 from typing import Any, Generator
 
-from pydantic import BaseModel
-
 from maps4fs.generator.component import Component
-from maps4fs.generator.dtm import DTMProvider
+from maps4fs.generator.dtm import DTMProvider, DTMProviderSettings
 from maps4fs.generator.game import Game
+from maps4fs.generator.settings import (
+    BackgroundSettings,
+    DEMSettings,
+    GRLESettings,
+    I3DSettings,
+    SatelliteSettings,
+    SplineSettings,
+    TextureSettings,
+)
 from maps4fs.logger import Logger
 
 
-class SettingsModel(BaseModel):
-    """Base class for settings models. It provides methods to convert settings to and from JSON."""
-
-    @classmethod
-    def all_settings_to_json(cls) -> dict[str, dict[str, Any]]:
-        """Get all settings of the current class and its subclasses as a dictionary.
-
-        Returns:
-            dict[str, dict[str, Any]]: Dictionary with settings of the current class and its
-                subclasses.
-        """
-        all_settings = {}
-        for subclass in cls.__subclasses__():
-            all_settings[subclass.__name__] = subclass().model_dump()
-
-        return all_settings
-
-    @classmethod
-    def all_settings_from_json(cls, data: dict) -> dict[str, SettingsModel]:
-        """Create settings instances from JSON data.
-
-        Arguments:
-            data (dict): JSON data.
-
-        Returns:
-            dict[str, Type[SettingsModel]]: Dictionary with settings instances.
-        """
-        settings = {}
-        for subclass in cls.__subclasses__():
-            settings[subclass.__name__] = subclass(**data[subclass.__name__])
-
-        return settings
-
-    @classmethod
-    def all_settings(cls) -> list[SettingsModel]:
-        """Get all settings of the current class and its subclasses.
-
-        Returns:
-            list[SettingsModel]: List with settings of the current class and its subclasses.
-        """
-        settings = []
-        for subclass in cls.__subclasses__():
-            settings.append(subclass())
-
-        return settings
-
-
-class DEMSettings(SettingsModel):
-    """Represents the advanced settings for DEM component.
-
-    Attributes:
-        auto_process (bool): use the auto preset to change the multiplier.
-        multiplier (int): multiplier for the heightmap, every pixel will be multiplied by this
-            value.
-        blur_radius (int): radius of the blur filter.
-        plateau (int): plateau height, will be added to each pixel.
-        water_depth (int): water depth, will be subtracted from each pixel where the water
-            is present.
-    """
-
-    auto_process: bool = True
-    multiplier: int = 1
-    blur_radius: int = 35
-    plateau: int = 0
-    water_depth: int = 0
-
-
-class BackgroundSettings(SettingsModel):
-    """Represents the advanced settings for background component.
-
-    Attributes:
-        generate_background (bool): generate obj files for the background terrain.
-        generate_water (bool): generate obj files for the water.
-        resize_factor (int): resize factor for the background terrain and water.
-            It will be used as 1 / resize_factor of the original size.
-    """
-
-    generate_background: bool = False
-    generate_water: bool = False
-    resize_factor: int = 8
-
-
-class GRLESettings(SettingsModel):
-    """Represents the advanced settings for GRLE component.
-
-    Attributes:
-        farmland_margin (int): margin around the farmland.
-        random_plants (bool): generate random plants on the map or use the default one.
-        add_farmyards (bool): If True, regions of frarmyards will be added to the map
-            without corresponding fields.
-    """
-
-    farmland_margin: int = 0
-    random_plants: bool = True
-    add_farmyards: bool = False
-
-
-class I3DSettings(SettingsModel):
-    """Represents the advanced settings for I3D component.
-
-    Attributes:
-        forest_density (int): density of the forest (distance between trees).
-    """
-
-    forest_density: int = 10
-
-
-class TextureSettings(SettingsModel):
-    """Represents the advanced settings for texture component.
-
-    Attributes:
-        dissolve (bool): dissolve the texture into several images.
-        fields_padding (int): padding around the fields.
-        skip_drains (bool): skip drains generation.
-    """
-
-    dissolve: bool = False
-    fields_padding: int = 0
-    skip_drains: bool = False
-
-
-class SplineSettings(SettingsModel):
-    """Represents the advanced settings for spline component.
-
-    Attributes:
-        spline_density (int): the number of extra points that will be added between each two
-            existing points.
-    """
-
-    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.
@@ -176,6 +38,7 @@ class Map:
         self,
         game: Game,
         dtm_provider: DTMProvider,
+        dtm_provider_settings: DTMProviderSettings,
         coordinates: tuple[float, float],
         size: int,
         rotation: int,
@@ -206,6 +69,7 @@ class Map:
 
         self.game = game
         self.dtm_provider = dtm_provider
+        self.dtm_provider_settings = dtm_provider_settings
         self.components: list[Component] = []
         self.coordinates = coordinates
         self.map_directory = map_directory

maps4fs/generator/settings.py

@@ -0,0 +1,152 @@
+"""This module contains settings models for all components."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class SettingsModel(BaseModel):
+    """Base class for settings models. It provides methods to convert settings to and from JSON."""
+
+    @classmethod
+    def all_settings_to_json(cls) -> dict[str, dict[str, Any]]:
+        """Get all settings of the current class and its subclasses as a dictionary.
+
+        Returns:
+            dict[str, dict[str, Any]]: Dictionary with settings of the current class and its
+                subclasses.
+        """
+        all_settings = {}
+        for subclass in cls.__subclasses__():
+            all_settings[subclass.__name__] = subclass().model_dump()
+
+        return all_settings
+
+    @classmethod
+    def all_settings_from_json(cls, data: dict) -> dict[str, SettingsModel]:
+        """Create settings instances from JSON data.
+
+        Arguments:
+            data (dict): JSON data.
+
+        Returns:
+            dict[str, Type[SettingsModel]]: Dictionary with settings instances.
+        """
+        settings = {}
+        for subclass in cls.__subclasses__():
+            settings[subclass.__name__] = subclass(**data[subclass.__name__])
+
+        return settings
+
+    @classmethod
+    def all_settings(cls) -> list[SettingsModel]:
+        """Get all settings of the current class and its subclasses.
+
+        Returns:
+            list[SettingsModel]: List with settings of the current class and its subclasses.
+        """
+        settings = []
+        for subclass in cls.__subclasses__():
+            settings.append(subclass())
+
+        return settings
+
+
+class DEMSettings(SettingsModel):
+    """Represents the advanced settings for DEM component.
+
+    Attributes:
+        auto_process (bool): use the auto preset to change the multiplier.
+        multiplier (int): multiplier for the heightmap, every pixel will be multiplied by this
+            value.
+        blur_radius (int): radius of the blur filter.
+        plateau (int): plateau height, will be added to each pixel.
+        water_depth (int): water depth, will be subtracted from each pixel where the water
+            is present.
+    """
+
+    auto_process: bool = True
+    multiplier: int = 1
+    blur_radius: int = 35
+    plateau: int = 0
+    water_depth: int = 0
+
+
+class BackgroundSettings(SettingsModel):
+    """Represents the advanced settings for background component.
+
+    Attributes:
+        generate_background (bool): generate obj files for the background terrain.
+        generate_water (bool): generate obj files for the water.
+        resize_factor (int): resize factor for the background terrain and water.
+            It will be used as 1 / resize_factor of the original size.
+    """
+
+    generate_background: bool = False
+    generate_water: bool = False
+    resize_factor: int = 8
+
+
+class GRLESettings(SettingsModel):
+    """Represents the advanced settings for GRLE component.
+
+    Attributes:
+        farmland_margin (int): margin around the farmland.
+        random_plants (bool): generate random plants on the map or use the default one.
+        add_farmyards (bool): If True, regions of frarmyards will be added to the map
+            without corresponding fields.
+    """
+
+    farmland_margin: int = 0
+    random_plants: bool = True
+    add_farmyards: bool = False
+
+
+class I3DSettings(SettingsModel):
+    """Represents the advanced settings for I3D component.
+
+    Attributes:
+        forest_density (int): density of the forest (distance between trees).
+    """
+
+    forest_density: int = 10
+
+
+class TextureSettings(SettingsModel):
+    """Represents the advanced settings for texture component.
+
+    Attributes:
+        dissolve (bool): dissolve the texture into several images.
+        fields_padding (int): padding around the fields.
+        skip_drains (bool): skip drains generation.
+    """
+
+    dissolve: bool = False
+    fields_padding: int = 0
+    skip_drains: bool = False
+
+
+class SplineSettings(SettingsModel):
+    """Represents the advanced settings for spline component.
+
+    Attributes:
+        spline_density (int): the number of extra points that will be added between each two
+            existing points.
+    """
+
+    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

{maps4fs-1.5.4.dist-info → maps4fs-1.5.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: maps4fs
-Version: 1.5.4
+Version: 1.5.6
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: MIT License

{maps4fs-1.5.4.dist-info → maps4fs-1.5.6.dist-info}/RECORD

@@ -1,23 +1,24 @@
-maps4fs/__init__.py,sha256=wXI0wsgNpS2Pr7GKPw4akJyChQzehMXNuwjF7vG81tA,346
+maps4fs/__init__.py,sha256=EJzbqRrSGltSMUI-dHgONODxKt9YvP_ElwFmXV8M_MA,380
 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=RtXruvT4Fxfr7_xo9Bi-i3IIWcPd5QQOSpYJ_cNC49o,20408
 maps4fs/generator/config.py,sha256=0QmK052B8bxyHVhg3jzCORLfOBMMmqVfhhbqXKf6OMk,4383
-maps4fs/generator/dem.py,sha256=hW9zNKX-MSUI-Cw7-x8tNMGF8NyzdVDLNjsCx4wHfuQ,12563
-maps4fs/generator/dtm.py,sha256=DsQsV4t0124-2xdr8L29JX-csD0XNOdCF0MFm1cZQF0,8872
+maps4fs/generator/dem.py,sha256=aJva77k_00SKrqnRLF_BXr8eGR5flifrh72kSBq1saI,12621
+maps4fs/generator/dtm.py,sha256=5_1e-kQcZ7c1Xg3tvuTyumzfTAcUPmDkIyZd5VagyOk,10550
 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=wLu8kexBgvHTO_RGnUupWoD-LMsoPXjNuPivgVH3zTw,13420
+maps4fs/generator/map.py,sha256=flU0b2TrVYLxj9o3v_YRvNz9YB3s4w6YFSv4Jka5ojM,9283
 maps4fs/generator/qgis.py,sha256=Es8hLuqN_KH8lDfnJE6He2rWYbAKJ3RGPn-o87S6CPI,6116
 maps4fs/generator/satellite.py,sha256=Qnb6XxmXKnHdHKVMb9mJ3vDGtGkDHCOv_81hrrXdx3k,3660
+maps4fs/generator/settings.py,sha256=gBMjXpz0hcUsCAw8MS_SsuFKHaI41RK6dclEEepsx2M,4575
 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.4.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
-maps4fs-1.5.4.dist-info/METADATA,sha256=UkTftX1zaae9QM1r7t994hyhk10dOASfocXg8KKbRRA,36012
-maps4fs-1.5.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-maps4fs-1.5.4.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
-maps4fs-1.5.4.dist-info/RECORD,,
+maps4fs-1.5.6.dist-info/LICENSE.md,sha256=pTKD_oUexcn-yccFCTrMeLkZy0ifLRa-VNcDLqLZaIw,10749
+maps4fs-1.5.6.dist-info/METADATA,sha256=0OuPPRh06Av71q90zEiVokNCHSh7QLCULKjcBNyLoYA,36012
+maps4fs-1.5.6.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+maps4fs-1.5.6.dist-info/top_level.txt,sha256=Ue9DSRlejRQRCaJueB0uLcKrWwsEq9zezfv5dI5mV1M,8
+maps4fs-1.5.6.dist-info/RECORD,,