fix plan feature digitize tool and promoted widget references after refactoring

nmaarnio · nmaarnio · commit 0088eac2bfff · 2025-01-13T12:21:18.000+02:00
- fix PlanDigitizeMapTool to reinitialize itself after layer changes
- implement similar config file fetching for regulation group libraries as for feature templates
- reorganize library files in resources folder
- deactivate selections in NewFeatureDock when PlanFeatureDigitizeMapTool finishes/deactivates
diff --git a/arho_feature_template/core/models.py b/arho_feature_template/core/models.py
@@ -21,7 +21,7 @@
 
 logger = logging.getLogger(__name__)
 
-DEFAULT_PLAN_REGULATIONS_CONFIG_PATH = Path(os.path.join(resources_path(), "kaavamaaraykset.yaml"))
+DEFAULT_PLAN_REGULATIONS_CONFIG_PATH = Path(os.path.join(resources_path(), "libraries", "kaavamaaraykset.yaml"))
 
 
 class ValueType(Enum):
diff --git a/arho_feature_template/core/plan_manager.py b/arho_feature_template/core/plan_manager.py
@@ -4,11 +4,7 @@
 import logging
 from typing import TYPE_CHECKING
 
-from qgis.core import (
-    QgsExpressionContextUtils,
-    QgsProject,
-    QgsVectorLayer,
-)
+from qgis.core import QgsExpressionContextUtils, QgsProject, QgsVectorLayer, QgsWkbTypes
 from qgis.gui import QgsMapToolDigitizeFeature
 from qgis.PyQt.QtWidgets import QDialog, QMessageBox
 
@@ -40,7 +36,8 @@
     RegulationGroupLayer,
     plan_layers,
 )
-from arho_feature_template.resources.template_libraries import library_config_files
+from arho_feature_template.resources.libraries.feature_templates import feature_template_library_config_files
+from arho_feature_template.resources.libraries.regulation_groups import regulation_group_library_config_files
 from arho_feature_template.utils.db_utils import get_existing_database_connection_names
 from arho_feature_template.utils.misc_utils import (
     check_layer_changes,
@@ -68,41 +65,61 @@
 class PlanDigitizeMapTool(QgsMapToolDigitizeFeature): ...
 
 
-class PlanFeatureDigitizeMapTool(QgsMapToolDigitizeFeature): ...
+class PlanFeatureDigitizeMapTool(QgsMapToolDigitizeFeature):
+    def __init__(self, mode: QgsMapToolDigitizeFeature.CaptureMode):
+        super().__init__(iface.mapCanvas(), iface.cadDockWidget(), mode)
 
 
 class PlanManager:
     def __init__(self):
         self.json_plan_path = None
         self.json_plan_outline_path = None
 
-        self.digitize_map_tool = PlanDigitizeMapTool(iface.mapCanvas(), iface.cadDockWidget())
-        self.digitize_map_tool.digitizingCompleted.connect(self._plan_geom_digitized)
-
-        # Initialize new feature dock
+        # Initialize libraries
         self.feature_template_libraries = [
-            FeatureTemplateLibrary.from_config_file(config_file) for config_file in library_config_files()
+            FeatureTemplateLibrary.from_config_file(file) for file in feature_template_library_config_files()
         ]
-        # self.feature_template_libraries = []
-
-        # TODO: change
-        import os
-        from pathlib import Path
-
-        from arho_feature_template.qgis_plugin_tools.tools.resources import resources_path
-
-        katja_asemakaava_path = Path(os.path.join(resources_path(), "katja_asemakaava.yaml"))
         self.regulation_group_libraries = [
-            RegulationGroupLibrary.from_config_file(katja_asemakaava_path),
-            regulation_group_library_from_active_plan(),
+            RegulationGroupLibrary.from_config_file(file) for file in regulation_group_library_config_files()
         ]
+        self.regulation_group_libraries.append(regulation_group_library_from_active_plan())
 
+        # Initialize new feature dock
         self.new_feature_dock = NewFeatureDock(self.feature_template_libraries)
-        self.new_feature_dock.start_digitize_btn.clicked.connect(self.add_new_plan_feature)
+        self.new_feature_dock.tool_activated.connect(self.add_new_plan_feature)
         self.new_feature_dock.hide()
 
-        self.feature_digitize_map_tool = PlanFeatureDigitizeMapTool(iface.mapCanvas(), iface.cadDockWidget())
+        # Initialize digitize tools
+        self.digitize_map_tool = PlanDigitizeMapTool(iface.mapCanvas(), iface.cadDockWidget())
+        self.digitize_map_tool.digitizingCompleted.connect(self._plan_geom_digitized)
+
+        self.feature_digitize_map_tool = None
+        self.initialize_feature_digitize_map_tool()
+
+    def initialize_feature_digitize_map_tool(self, layer: QgsVectorLayer | None = None):
+        # Get matcing capture mode for given layer
+        if layer is None:
+            mode = PlanFeatureDigitizeMapTool.CaptureMode.CaptureNone
+        elif layer.geometryType() == QgsWkbTypes.PointGeometry:
+            mode = PlanFeatureDigitizeMapTool.CaptureMode.CapturePoint
+        elif layer.geometryType() == QgsWkbTypes.LineGeometry:
+            mode = PlanFeatureDigitizeMapTool.CaptureMode.CaptureLine
+        elif layer.geometryType() == QgsWkbTypes.PolygonGeometry:
+            mode = PlanFeatureDigitizeMapTool.CaptureMode.CapturePolygon
+
+        # Disconnect signals first to not trigger them unwantedly
+        if self.feature_digitize_map_tool:
+            self.feature_digitize_map_tool.digitizingCompleted.disconnect()
+            self.feature_digitize_map_tool.digitizingFinished.disconnect()
+
+        # Reinitialize and reconnect signals
+        self.feature_digitize_map_tool = PlanFeatureDigitizeMapTool(mode)
         self.feature_digitize_map_tool.digitizingCompleted.connect(self._plan_feature_geom_digitized)
+        self.feature_digitize_map_tool.digitizingFinished.connect(self.new_feature_dock.deactivate_and_clear_selections)
+
+        # Set layer if given
+        if layer:
+            self.feature_digitize_map_tool.setLayer(layer)
 
     def add_new_plan(self):
         """Initiate the process to add a new plan to the Kaava layer."""
@@ -125,8 +142,6 @@ def add_new_plan(self):
         iface.mapCanvas().setMapTool(self.digitize_map_tool)
 
     def add_new_plan_feature(self):
-        self.previous_map_tool = iface.mapCanvas().mapTool()
-
         if not handle_unsaved_changes():
             return
 
@@ -141,10 +156,9 @@ def add_new_plan_feature(self):
             msg = f"Could not find plan feature layer class for layer name {layer_name}"
             raise ValueError(msg)
         layer = layer_class.get_from_project()
-
         layer.startEditing()
-        self.feature_digitize_map_tool.clean()  # Is this needed? add_new_plan does not call this
-        self.feature_digitize_map_tool.setLayer(layer)
+
+        self.initialize_feature_digitize_map_tool(layer)
         iface.mapCanvas().setMapTool(self.feature_digitize_map_tool)
 
     def _plan_geom_digitized(self, feature: QgsFeature):
@@ -187,8 +201,6 @@ def _plan_feature_geom_digitized(self, feature: QgsFeature):
         if attribute_form.exec_():
             save_plan_feature(attribute_form.model)
 
-        iface.mapCanvas().setMapTool(self.previous_map_tool)
-
     def set_active_plan(self, plan_id: str | None):
         """Update the project layers based on the selected land use plan.
 
diff --git a/arho_feature_template/gui/components/plan_regulation_group_widget.ui b/arho_feature_template/gui/components/plan_regulation_group_widget.ui
@@ -166,7 +166,7 @@
   <customwidget>
    <class>CodeComboBox</class>
    <extends>QComboBox</extends>
-   <header>arho_feature_template.gui.code_combobox</header>
+   <header>arho_feature_template.gui.components.code_combobox</header>
   </customwidget>
  </customwidgets>
  <resources/>
diff --git a/arho_feature_template/gui/dialogs/new_plan_regulation_group_form.ui b/arho_feature_template/gui/dialogs/new_plan_regulation_group_form.ui
@@ -269,7 +269,7 @@ p, li { white-space: pre-wrap; }
   <customwidget>
    <class>CodeComboBox</class>
    <extends>QComboBox</extends>
-   <header>arho_feature_template.gui.code_combobox</header>
+   <header>arho_feature_template.gui.components.code_combobox</header>
   </customwidget>
  </customwidgets>
  <resources/>
diff --git a/arho_feature_template/gui/dialogs/plan_attribute_form.ui b/arho_feature_template/gui/dialogs/plan_attribute_form.ui
@@ -377,12 +377,12 @@
   <customwidget>
    <class>CodeComboBox</class>
    <extends>QComboBox</extends>
-   <header>arho_feature_template.gui.code_combobox</header>
+   <header>arho_feature_template.gui.components.code_combobox</header>
   </customwidget>
   <customwidget>
    <class>HierarchicalCodeComboBox</class>
    <extends>QComboBox</extends>
-   <header>arho_feature_template.gui.code_combobox</header>
+   <header>arho_feature_template.gui.components.code_combobox</header>
   </customwidget>
  </customwidgets>
  <tabstops>
diff --git a/arho_feature_template/gui/dialogs/plan_feature_form.ui b/arho_feature_template/gui/dialogs/plan_feature_form.ui
@@ -197,7 +197,7 @@
   <customwidget>
    <class>CodeComboBox</class>
    <extends>QComboBox</extends>
-   <header>arho_feature_template.gui.code_combobox</header>
+   <header>arho_feature_template.gui.components.code_combobox</header>
   </customwidget>
  </customwidgets>
  <resources/>
diff --git a/arho_feature_template/gui/dialogs/plugin_settings.ui b/arho_feature_template/gui/dialogs/plugin_settings.ui
@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>300</width>
-    <height>150</height>
+    <height>205</height>
    </rect>
   </property>
   <property name="windowTitle">
diff --git a/arho_feature_template/gui/docks/new_feature_dock.py b/arho_feature_template/gui/docks/new_feature_dock.py
@@ -3,14 +3,14 @@
 
 from qgis.gui import QgsDockWidget
 from qgis.PyQt import uic
-from qgis.PyQt.QtCore import Qt
+from qgis.PyQt.QtCore import Qt, pyqtSignal
 from qgis.PyQt.QtWidgets import QListWidget, QListWidgetItem
 
 from arho_feature_template.gui.components.new_feature_grid_widget import NewFeatureGridWidget
 
 if TYPE_CHECKING:
     from qgis.gui import QgsFilterLineEdit
-    from qgis.PyQt.QtWidgets import QComboBox, QLabel, QPushButton, QWidget
+    from qgis.PyQt.QtWidgets import QComboBox, QLabel, QWidget
 
     from arho_feature_template.core.models import FeatureTemplateLibrary
 
@@ -19,6 +19,8 @@
 
 
 class NewFeatureDock(QgsDockWidget, DockClass):  # type: ignore
+    tool_activated = pyqtSignal()
+
     def __init__(self, feature_template_libraries: list):
         super().__init__()
         self.setupUi(self)
@@ -29,7 +31,6 @@ def __init__(self, feature_template_libraries: list):
         self.template_list: QListWidget
         self.txt_tip: QLabel
         self.dockWidgetContents: QWidget
-        self.start_digitize_btn: QPushButton
 
         # INIT
         # 1. New feature grid
@@ -47,11 +48,8 @@ def __init__(self, feature_template_libraries: list):
             self.set_active_feature_template_library(0)
 
         self.template_list.setSelectionMode(self.template_list.SingleSelection)
+        self.search_box.valueChanged.connect(self.filter_plan_feature_templates)
 
-        self.search_box.setShowSearchIcon(True)
-        self.search_box.valueChanged.connect(lambda _: self.filter_plan_feature_templates)
-
-        # Activate map tool when template is selected
         # NOTE: If user moves selection with arrow keys, this is not registered currently
         self.template_list.clicked.connect(self.on_template_item_clicked)
         self.new_feature_grid.active_feature_type_changed.connect(self.on_active_feature_type_changed)
@@ -60,6 +58,8 @@ def on_active_feature_type_changed(self, feature_name: str, layer_name: str):
         self.active_feature_type = feature_name if feature_name else None
         self.active_feature_layer = layer_name if layer_name else None
         self.filter_plan_feature_templates()
+        if self.active_feature_type:
+            self.tool_activated.emit()
 
     def filter_plan_feature_templates(self):
         # Consider both search text and active plan feature type
@@ -70,19 +70,28 @@ def filter_plan_feature_templates(self):
             item_text = item.text().lower()
             plan_feature = item.data(Qt.UserRole)
             text_matches = search_text in item_text
-            feature_type_matches = plan_feature.layer_name == self.active_feature_layer
+            feature_type_matches = (
+                plan_feature.layer_name == self.active_feature_layer if self.active_feature_layer else True
+            )
             item.setHidden(not (text_matches and feature_type_matches))
 
     def on_template_item_clicked(self, index: int):
         item = self.template_list.itemFromIndex(index)
         template = item.data(Qt.UserRole)
+        # Clicked new list item => activate new template
         if template != self.active_template:
             self.active_template = template
         else:
-            # If user clicks an already selected list item, clear selection
+            # Clicked selected list item => clear selection
             self.active_template = None
             self.template_list.clearSelection()
 
+    def deactivate_and_clear_selections(self):
+        self.on_active_feature_type_changed("", "")
+        self.new_feature_grid.clear_selections()
+        self.active_template = None
+        self.template_list.clearSelection()
+
     def set_active_feature_template_library(self, index: int) -> None:
         self.template_list.clear()
         library = self.feature_template_libraries[index]
diff --git a/arho_feature_template/gui/docks/new_feature_dock.ui b/arho_feature_template/gui/docks/new_feature_dock.ui
@@ -34,23 +34,42 @@
      <number>0</number>
     </property>
     <item>
-     <widget class="QPushButton" name="start_digitize_btn">
+     <widget class="QLabel" name="label">
+      <property name="font">
+       <font>
+        <pointsize>13</pointsize>
+       </font>
+      </property>
       <property name="text">
-       <string>Piirrä</string>
+       <string>Kaavakohteen tyyppi</string>
       </property>
      </widget>
     </item>
     <item>
-     <widget class="QLabel" name="label">
-      <property name="text">
-       <string>Kohteen tyyppi</string>
+     <spacer name="verticalSpacer">
+      <property name="orientation">
+       <enum>Qt::Vertical</enum>
       </property>
-     </widget>
+      <property name="sizeType">
+       <enum>QSizePolicy::Fixed</enum>
+      </property>
+      <property name="sizeHint" stdset="0">
+       <size>
+        <width>20</width>
+        <height>20</height>
+       </size>
+      </property>
+     </spacer>
     </item>
     <item>
      <widget class="QLabel" name="label_2">
+      <property name="font">
+       <font>
+        <pointsize>13</pointsize>
+       </font>
+      </property>
       <property name="text">
-       <string>Alusta kaavamääräykset templaatista</string>
+       <string>Alusta kaavakohde templaatista</string>
       </property>
      </widget>
     </item>
@@ -65,7 +84,7 @@
          </sizepolicy>
         </property>
         <property name="text">
-         <string>Kirjasto</string>
+         <string>Kaavakohdekirjasto</string>
         </property>
        </widget>
       </item>
@@ -75,7 +94,11 @@
      </layout>
     </item>
     <item>
-     <widget class="QgsFilterLineEdit" name="search_box"/>
+     <widget class="QgsFilterLineEdit" name="search_box">
+      <property name="showSearchIcon">
+       <bool>true</bool>
+      </property>
+     </widget>
     </item>
     <item>
      <widget class="QListWidget" name="template_list"/>
diff --git a/arho_feature_template/gui/docks/validation_dock.ui b/arho_feature_template/gui/docks/validation_dock.ui
@@ -45,7 +45,7 @@
   <customwidget>
    <class>ValidationTreeView</class>
    <extends>QTreeView</extends>
-   <header>arho_feature_template.gui.validation_tree_view</header>
+   <header>arho_feature_template.gui.docks.validation_tree_view</header>
   </customwidget>
  </customwidgets>
  <resources/>
diff --git a/arho_feature_template/plugin.py b/arho_feature_template/plugin.py
@@ -8,7 +8,6 @@
 from qgis.PyQt.QtWidgets import QAction, QWidget
 from qgis.utils import iface
 
-from arho_feature_template.core.feature_template_library import TemplateGeometryDigitizeMapTool
 from arho_feature_template.core.plan_manager import PlanManager
 from arho_feature_template.gui.dialogs.plugin_settings import PluginSettings
 from arho_feature_template.gui.docks.validation_dock import ValidationDock
@@ -17,7 +16,7 @@
 from arho_feature_template.qgis_plugin_tools.tools.resources import plugin_name
 
 if TYPE_CHECKING:
-    from qgis.gui import QgisInterface, QgsMapTool
+    from qgis.gui import QgisInterface
 
     iface: QgisInterface = cast("QgisInterface", iface)  # type: ignore[no-redef]
 
@@ -210,10 +209,6 @@ def initGui(self) -> None:  # noqa N802
             status_tip="Muokkaa pluginin asetuksia",
         )
 
-    def on_map_tool_changed(self, new_tool: QgsMapTool, old_tool: QgsMapTool) -> None:  # noqa: ARG002
-        if not isinstance(new_tool, TemplateGeometryDigitizeMapTool):
-            self.new_feature_dock_action.setChecked(False)
-
     def add_new_plan(self):
         self.plan_manager.add_new_plan()
 
diff --git a/arho_feature_template/resources/libraries/feature_templates/__init__.py b/arho_feature_template/resources/libraries/feature_templates/__init__.py
@@ -8,7 +8,7 @@
     from pathlib import Path
 
 
-def library_config_files() -> Iterator[Path]:
+def feature_template_library_config_files() -> Iterator[Path]:
     """Get all template library configuration files."""
 
     for resource in resources.files(__package__).iterdir():
diff --git a/arho_feature_template/resources/libraries/feature_templates/katja_asemakaava.yaml b/arho_feature_template/resources/libraries/feature_templates/katja_asemakaava.yaml
diff --git a/arho_feature_template/resources/libraries/feature_templates/schema/template_library.schema.json b/arho_feature_template/resources/libraries/feature_templates/schema/template_library.schema.json
diff --git a/arho_feature_template/resources/libraries/kaavamaaraykset.yaml b/arho_feature_template/resources/libraries/kaavamaaraykset.yaml
diff --git a/arho_feature_template/resources/libraries/regulation_groups/__init__.py b/arho_feature_template/resources/libraries/regulation_groups/__init__.py
diff --git a/arho_feature_template/resources/libraries/regulation_groups/katja_asemakaava.yaml b/arho_feature_template/resources/libraries/regulation_groups/katja_asemakaava.yaml
diff --git a/arho_feature_template/resources/omat_kaavamaaraysryhmat_placeholder.yaml b/arho_feature_template/resources/omat_kaavamaaraysryhmat_placeholder.yaml
