geom/src/RepairGUIAdv/locate_subshapes.py

# -*- coding: utf-8 -*-
# Copyright (C) 2014-2024  EDF
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
#
# See https://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
#
# Author : Konstantin Leontev (OpenCascade S.A.S)

import sys

from qtsalome import QGridLayout, QFrame, QApplication, \
    QComboBox, QLabel, QPushButton, QMessageBox

from salome.geom.geomrepairadv.basedlg import BaseDlg

from .geomrepairadv_common import DlgRef_1Spin_QTD
import GEOM

class LocateSubShapesDlg(BaseDlg):
    """
    Dialog for Locate Subshapes plugin that selects the sub-shapes of a compound
    by length, area or volume depending on whether it is an EDGE, a FACE or a SOLID.
    """
    def __init__(self, selection_level = GEOM.EDGE):
        # Implement widget's content here
        main_widget = QFrame()
        layout = QGridLayout(main_widget)
        layout.setContentsMargins(0, 0, 0, 0)

        # A combobox to choose measurment type
        type_label = QLabel('Shape Measurement')
        self._type_widget = QComboBox()
        type_items = ['Length (EDGE)', 'Area (FACE)', 'Volume (SOLID)']
        self._type_widget.insertItems(0, type_items)
        self._type_widget.setToolTip('Select a type of shape measurement')
        self._type_widget.currentIndexChanged.connect(self.on_measurment_type_changed)

        # Min/max values widgets
        decimals = 2
        max_value = sys.float_info.max
        self._min_widget = DlgRef_1Spin_QTD('Min', 0, decimals, max_value)
        self._max_widget = DlgRef_1Spin_QTD('Max', 100, decimals, max_value)

        # Add select button
        self._select_button = QPushButton("Show Selected Sub-shapes")
        self._select_button.clicked.connect(self.on_select_button_clicked)

        # Add the widgets to layout
        layout.addWidget(type_label, 0, 0)
        layout.addWidget(self._type_widget, 1, 0)
        layout.addWidget(self._min_widget, 2, 0)
        layout.addWidget(self._max_widget, 3, 0)
        layout.addWidget(self._select_button, 4, 0)

        # Init base dialog
        BaseDlg.__init__(
            self,
            main_widget,
            'Locate Subshapes',
            'locate_subshapes_algo.py',
            True,
            selection_level
            )


    def get_limits(self):
        """
        Returns current values for min/max limits.

        Args:
            None.

        Returns:
            List of limits [min, max].
        """

        return [self._min_widget.SpinBox_DX.value(),
                self._max_widget.SpinBox_DX.value()]


    def get_measurment_type(self, index):
        """
        Returns selection level based on current measurment type.

        Args:
            index - current combobox index.

        Returns:
            GEOM selection level value.
        """

        measurment_types = {
            0 : GEOM.EDGE,
            1 : GEOM.FACE,
            2 : GEOM.SOLID
        }

        return measurment_types[index]


    def on_measurment_type_changed(self, index):
        """
        Changes selection level on type changed.

        Args:
            index - current combobox index.

        Returns:
            None.
        """

        selection_level = self.get_measurment_type(index)
        self.set_selection_level(selection_level)

        # Clear pre selected sub-shapes list
        self.on_select_subshape()


    def on_select_button_clicked(self):
        """
        Show selection info on button click.

        Args:
            None.

        Returns:
            None.
        """

        #TODO: what are we going to do on this click?
        # Should it do a separated script?
        QMessageBox.warning(None, 'Warning', 'Not implemented yet')


    def get_args(self):
        """
        Collects arguments for a repair execution algorithm into a dictionary.

        Args:
            None.

        Returns:
            Dictionary with arguments for execution.
        """

        selected_ids = self.get_local_selection()
        current_index = self._type_widget.currentIndex()
        selection_level = self.get_measurment_type(current_index)
        limits = self.get_limits()
        min_selected = 1

        if self.is_selection_valid(selected_ids, min_selected):
            return {
                'selected_ids': selected_ids,
                'result_name': self.get_result_name(),
                'selection_level': selection_level,
                'min_limit': limits[0],
                'max_limit': limits[1]
            }

        return None


# For testing run as a module from geomrepairadv parent directory in
# Salome INSTALL, because the dialog needs a generated Ui_BaseDlg class
# that we don't have in the SOURCE.
# Example:
# $ python -m geomrepairadv.locate_subshapes
if __name__ == '__main__':
    app = QApplication(sys.argv)

    dlg = LocateSubShapesDlg(None)
    dlg.show()

    sys.exit(app.exec_())