maps4fs 2.1.0__tar.gz → 2.1.1__tar.gz

{maps4fs-2.1.0 → maps4fs-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.0
+Version: 2.1.1
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -650,6 +650,8 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
 
+- Tree limit - this value will be used to adjust the forest density value. For example, if it's possible to place 100000 trees from OSM data, and the forest density is set to 10, the expected number of trees on map will be 10000. At the same time, if you set the tree limit to 5000, the forest density will be adjusted to 20, which means that the distance between the trees will be doubled. This value is useful to prevent the Giants Editor from crashing due to too many trees on the map. By default, it's set to 0, which means that it's disabled and will use the forest density value as is. Note, that it will not lead to the exact number of trees, but will adjust the forest density value to fit the tree limit so the resulting number of trees will be more or less equal to the tree limit value.
+
 - Trees relative shift - represents the maximum possible shift of the tree from it's original position in percents of the forest density value. The higher the value, the more the trees will be shifted from their original positions. Warning: higher values can lead to overlapping trees.
 
 - 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.

{maps4fs-2.1.0 → maps4fs-2.1.1}/README.md

@@ -619,6 +619,8 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
 
+- Tree limit - this value will be used to adjust the forest density value. For example, if it's possible to place 100000 trees from OSM data, and the forest density is set to 10, the expected number of trees on map will be 10000. At the same time, if you set the tree limit to 5000, the forest density will be adjusted to 20, which means that the distance between the trees will be doubled. This value is useful to prevent the Giants Editor from crashing due to too many trees on the map. By default, it's set to 0, which means that it's disabled and will use the forest density value as is. Note, that it will not lead to the exact number of trees, but will adjust the forest density value to fit the tree limit so the resulting number of trees will be more or less equal to the tree limit value.
+
 - Trees relative shift - represents the maximum possible shift of the tree from it's original position in percents of the forest density value. The higher the value, the more the trees will be shifted from their original positions. Warning: higher values can lead to overlapping trees.
 
 - 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.

{maps4fs-2.1.0 → maps4fs-2.1.1}/maps4fs/generator/component/base/component_mesh.py

@@ -265,5 +265,5 @@ class MeshComponent(Component):
             trimesh.Trimesh: A new mesh with inverted faces.
         """
         mesh_copy = mesh.copy()
-        mesh_copy.faces = mesh_copy.faces[:, ::-1]
+        mesh_copy.faces = mesh_copy.faces[:, ::-1]  # type: ignore
         return mesh_copy

{maps4fs-2.1.0 → maps4fs-2.1.1}/maps4fs/generator/component/i3d.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import json
 import os
 from random import choice, randint, uniform
-from typing import Generator
+from typing import Any, Generator
 from xml.etree import ElementTree as ET
 
 import cv2
@@ -48,6 +48,9 @@ class I3d(XMLComponent):
         attribute. If the game does not support I3D files, the attribute is set to None."""
         self.xml_path = self.game.i3d_file_path(self.map_directory)
 
+        self.forest_info: dict[str, Any] = {}
+        self.field_info: dict[str, Any] = {}
+
     def process(self) -> None:
         """Updates the map I3D file and creates splines in a separate I3D file."""
         self.update_height_scale()
@@ -267,6 +270,8 @@ class I3d(XMLComponent):
 
         node_id = NODE_ID_STARTING_VALUE
         field_id = 1
+        added_fields = skipped_fields = 0
+        skipped_field_ids: list[int] = []
 
         for field in tqdm(fields, desc="Adding fields", unit="field"):
             try:
@@ -279,6 +284,7 @@ class I3d(XMLComponent):
                     field_id,
                     e,
                 )
+                skipped_fields += 1
                 continue
 
             field_ccs = [self.top_left_coordinates_to_center(point) for point in fitted_field]
@@ -297,6 +303,11 @@ class I3d(XMLComponent):
 
             node_id += 1
             field_id += 1
+            added_fields += 1
+
+        self.field_info["added_fields"] = added_fields
+        self.field_info["skipped_fields"] = skipped_fields
+        self.field_info["skipped_field_ids"] = skipped_field_ids
 
         self.save_tree(tree)
 
@@ -504,6 +515,8 @@ class I3d(XMLComponent):
 
         node_id = TREE_NODE_ID_STARTING_VALUE
 
+        tree_count = 0
+
         for forest_layer in forest_layers:
             weights_directory = self.game.weights_dir_path(self.map_directory)
             forest_image_path = forest_layer.get_preview_or_path(weights_directory)
@@ -542,12 +555,17 @@ class I3d(XMLComponent):
                 )
 
             forest_image = cv2.imread(forest_image_path, cv2.IMREAD_UNCHANGED)
-            for x, y in self.non_empty_pixels(
-                forest_image, step=self.map.i3d_settings.forest_density  # type: ignore
-            ):
+
+            step = self.get_step_by_limit(
+                forest_image,  # type: ignore
+                self.map.i3d_settings.tree_limit,
+                self.map.i3d_settings.forest_density,
+            )
+
+            for x, y in self.non_empty_pixels(forest_image, step=step):  # type: ignore
                 shifted_x, shifted_y = self.randomize_coordinates(
                     (x, y),
-                    self.map.i3d_settings.forest_density,
+                    step,
                     self.map.i3d_settings.trees_relative_shift,
                 )
 
@@ -573,9 +591,16 @@ class I3d(XMLComponent):
                 }
                 trees_node.append(self.create_element("ReferenceNode", data))
 
+                tree_count += 1
+
             scene_node.append(trees_node)
             self.save_tree(tree)
 
+        self.forest_info["tree_count"] = tree_count
+        self.forest_info["tree_limit"] = self.map.i3d_settings.tree_limit
+        self.forest_info["initial_step"] = self.map.i3d_settings.forest_density
+        self.forest_info["actual_step"] = step
+
         self.assets.forests = self.xml_path
 
     @staticmethod
@@ -606,19 +631,61 @@ class I3d(XMLComponent):
         image: np.ndarray, step: int = 1
     ) -> Generator[tuple[int, int], None, None]:
         """Receives numpy array, which represents single-channeled image of uint8 type.
-        Yield coordinates of non-empty pixels (pixels with value greater than 0).
+        Yield coordinates of non-empty pixels (pixels with value greater than 0), sampling about 1/step of them.
 
         Arguments:
             image (np.ndarray): The image to get non-empty pixels from.
-            step (int, optional): The step to iterate through the image. Defaults to 1.
+            step (int, optional): The step to sample non-empty pixels. Defaults to 1.
 
         Yields:
             tuple[int, int]: The coordinates of non-empty pixels.
         """
-        for y, row in enumerate(image[::step]):
-            for x, value in enumerate(row[::step]):
+        count = 0
+        for y, row in enumerate(image):
+            for x, value in enumerate(row):
                 if value > 0:
-                    yield x * step, y * step
+                    if count % step == 0:
+                        yield x, y
+                    count += 1
+
+    @staticmethod
+    def non_empty_pixels_count(image: np.ndarray) -> int:
+        """Counts the number of non-empty pixels in the image.
+
+        Arguments:
+            image (np.ndarray): The image to count non-empty pixels in.
+
+        Returns:
+            int: The number of non-empty pixels in the image.
+        """
+        result = np.count_nonzero(image > 0)
+        return result
+
+    def get_step_by_limit(
+        self, image: np.ndarray, limit: int, current_step: int | None = None
+    ) -> int:
+        """Calculates the step size for iterating through the image based on the limit based
+        on the number of non-empty pixels in the image.
+
+        Arguments:
+            image (np.ndarray): The image to calculate the step size for.
+            limit (int): The maximum number of non-empty pixels to process.
+            current_step (int | None, optional): The current step size. If provided, the method
+                will return the maximum of the recommended step and the current step.
+
+        Returns:
+            int: The recommended step size for iterating through the image.
+        """
+        available_tree_count = self.non_empty_pixels_count(image)
+        self.forest_info["available_tree_count"] = available_tree_count
+        if limit <= 0 or available_tree_count <= limit:
+            recommended_step = 1
+        else:
+            recommended_step = int(available_tree_count / limit)
+
+        self.forest_info["step_by_limit"] = recommended_step
+
+        return recommended_step if not current_step else max(recommended_step, current_step)
 
     def get_not_resized_dem(self) -> np.ndarray | None:
         """Reads the not resized DEM image from the background component.
@@ -638,3 +705,16 @@ class I3d(XMLComponent):
         not_resized_dem = cv2.imread(background_component.not_resized_path, cv2.IMREAD_UNCHANGED)
 
         return not_resized_dem
+
+    def info_sequence(self) -> dict[str, dict[str, str | float | int]]:
+        """Returns information about the component.
+
+        Returns:
+            dict[str, dict[str, str | float | int]]: Information about the component.
+        """
+        data = {
+            "Forests": self.forest_info,
+            "Fields": self.field_info,
+        }
+
+        return data

{maps4fs-2.1.0 → maps4fs-2.1.1}/maps4fs/generator/settings.py

@@ -203,6 +203,7 @@ class I3DSettings(SettingsModel):
     Attributes:
         add_trees (bool): add trees to the map.
         forest_density (int): density of the forest (distance between trees).
+        tree_limit (int): maximum number of trees to be added to the map.
         trees_relative_shift (int): relative shift of the trees.
         spline_density (int): the number of extra points that will be added between each two
             existing points.
@@ -212,6 +213,7 @@ class I3DSettings(SettingsModel):
 
     add_trees: bool = True
     forest_density: int = 10
+    tree_limit: int = 0
     trees_relative_shift: int = 20
 
     spline_density: int = 2

{maps4fs-2.1.0 → maps4fs-2.1.1}/maps4fs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maps4fs
-Version: 2.1.0
+Version: 2.1.1
 Summary: Generate map templates for Farming Simulator from real places.
 Author-email: iwatkot <iwatkot@gmail.com>
 License: Apache License 2.0
@@ -650,6 +650,8 @@ You can also apply some advanced settings to the map generation process.<br>
 
 - Forest density - the density of the forest in meters. The lower the value, the lower the distance between the trees, which makes the forest denser. Note, that low values will lead to enormous number of trees, which may cause the Giants Editor to crash or lead to performance issues. By default, it's set to 10.
 
+- Tree limit - this value will be used to adjust the forest density value. For example, if it's possible to place 100000 trees from OSM data, and the forest density is set to 10, the expected number of trees on map will be 10000. At the same time, if you set the tree limit to 5000, the forest density will be adjusted to 20, which means that the distance between the trees will be doubled. This value is useful to prevent the Giants Editor from crashing due to too many trees on the map. By default, it's set to 0, which means that it's disabled and will use the forest density value as is. Note, that it will not lead to the exact number of trees, but will adjust the forest density value to fit the tree limit so the resulting number of trees will be more or less equal to the tree limit value.
+
 - Trees relative shift - represents the maximum possible shift of the tree from it's original position in percents of the forest density value. The higher the value, the more the trees will be shifted from their original positions. Warning: higher values can lead to overlapping trees.
 
 - 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.

{maps4fs-2.1.0 → maps4fs-2.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maps4fs"
-version = "2.1.0"
+version = "2.1.1"
 description = "Generate map templates for Farming Simulator from real places."
 authors = [{name = "iwatkot", email = "iwatkot@gmail.com"}]
 license = {text = "Apache License 2.0"}