pySimBlocks 0.1.0__py3-none-any.whl

pySimBlocks/gui/blocks/systems/sofa/sofa_plant.py

@@ -0,0 +1,220 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program 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 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program 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 program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+import os
+import subprocess
+import sys
+from pathlib import Path
+from typing import Literal
+
+from PySide6.QtWidgets import QFormLayout, QLabel, QLineEdit, QPushButton
+
+from pySimBlocks.gui.blocks.block_meta import BlockMeta
+from pySimBlocks.gui.blocks.parameter_meta import ParameterMeta
+from pySimBlocks.gui.blocks.port_meta import PortMeta
+from pySimBlocks.gui.models import BlockInstance, PortInstance
+
+
+class SofaPlantMeta(BlockMeta):
+
+    def __init__(self):
+        self.name = "SofaPlant"
+        self.category = "systems"
+        self.type = "sofa_plant"
+        self.summary = "SOFA-based dynamic plant."
+        self.description = (
+            "Executes a SOFA simulation in a worker process."
+        )
+
+        self.parameters = [
+            ParameterMeta(
+                name="scene_file",
+                type="string",
+                required=True,
+                description="Path to the SOFA scene file, relative to the project.yaml file."
+            ),
+            ParameterMeta(
+                name="input_keys",
+                type="list[string]",
+                required=True,
+                description="List of input keys corresponding to SOFA input ports."
+            ),
+            ParameterMeta(
+                name="output_keys",
+                type="list[string]",
+                required=True,
+                description="List of output keys corresponding to SOFA output ports."
+            ),
+            ParameterMeta(
+                name="slider_params",
+                type="dict",
+                description="Dictionary of slider parameters to be modified in the SOFA scene at runtime."
+            ),
+            ParameterMeta(
+                name="sample_time",
+                type="float"
+            )
+        ]
+
+        self.inputs = [
+            PortMeta(
+                name="sofa_inputs",
+                display_as="",
+                shape=[]
+            )
+        ]
+
+        self.outputs = [
+            PortMeta(
+                name="sofa_outputs",
+                display_as="",
+                shape=[]
+            )
+        ]
+
+    # --------------------------------------------------------------------------
+    # Port Resolution
+    # --------------------------------------------------------------------------
+    def resolve_port_group(
+        self,
+        port_meta: PortMeta,
+        direction: Literal["input", "output"],
+        instance: "BlockInstance"
+    ) -> list["PortInstance"]:
+
+        if direction == "input" and port_meta.name == "sofa_inputs":
+            keys = instance.parameters.get("input_keys", [])
+            if keys is None:
+                return []
+            return [
+                PortInstance(
+                    name=key,
+                    display_as=key,
+                    direction="input",
+                    block=instance
+                )
+                for key in keys
+            ]
+
+        if direction == "output" and port_meta.name == "sofa_outputs":
+            keys = instance.parameters.get("output_keys", [])
+            if keys is None:
+                return []
+            return [
+                PortInstance(
+                    name=key,
+                    display_as=key,
+                    direction="output",
+                    block=instance
+                )
+                for key in keys
+            ]
+
+        return super().resolve_port_group(port_meta, direction, instance)
+
+    # --------------------------------------------------------------------------
+    # Dialog Methods
+    # --------------------------------------------------------------------------
+    def build_param(
+        self,
+        session,
+        form: QFormLayout,
+        readonly: bool = False,
+    ):
+        name_edit = QLineEdit(session.instance.name)
+        name_edit.textChanged.connect(
+            lambda val: self._on_param_changed(val, "name", session, readonly)
+        )
+        form.addRow(QLabel("Block name:"), name_edit)
+        if readonly:
+            name_edit.setReadOnly(True)
+        session.name_edit = name_edit
+
+        for pmeta in self.parameters:
+            if pmeta.name == "scene_file":
+                self.build_file_param_row(
+                    session,
+                    form,
+                    pmeta,
+                    readonly=readonly,
+                    file_filter="SOFA scene files (*.py);;All files (*)",
+                )
+                continue
+
+            label, widget = self._create_param_row(session, pmeta, readonly)
+            if widget is None:
+                continue
+            if readonly:
+                self._set_readonly_style(widget)
+
+            form.addRow(label, widget)
+            session.param_widgets[pmeta.name] = widget
+            session.param_labels[pmeta.name] = label
+
+    # ------------------------------------------------------
+    def build_post_param(self, session, form: QFormLayout, readonly: bool = False):
+        open_btn = QPushButton("Open file")
+        open_btn.clicked.connect(lambda: self._open_file_from_session(session))
+        form.addRow(QLabel(""), open_btn)
+        session.open_file_btn = open_btn
+        self._refresh_open_button_state(session)
+
+    # ------------------------------------------------------
+    def refresh_form(self, session):
+        super().refresh_form(session)
+        self._refresh_open_button_state(session)
+
+    # ------------------------------------------------------
+    def _resolve_file_path(self, session) -> Path | None:
+        raw = session.local_params.get("scene_file")
+        if not raw:
+            return None
+
+        path = Path(str(raw)).expanduser()
+        if not path.is_absolute() and session.project_dir is not None:
+            path = (session.project_dir / path).resolve()
+        return path
+
+    # ------------------------------------------------------
+    def _refresh_open_button_state(self, session) -> None:
+        btn = getattr(session, "open_file_btn", None)
+        if btn is None:
+            return
+
+        target = self._resolve_file_path(session)
+        exists = target is not None and target.is_file()
+        btn.setEnabled(exists)
+        if exists:
+            btn.setToolTip(str(target))
+        else:
+            btn.setToolTip("Set a valid existing scene_file to open the file.")
+
+    # ------------------------------------------------------
+    def _open_file_from_session(self, session) -> None:
+        target = self._resolve_file_path(session)
+        if target is None or not target.is_file():
+            return
+
+        if sys.platform.startswith("darwin"):
+            subprocess.Popen(["open", str(target)])
+        elif os.name == "nt":
+            os.startfile(str(target))
+        else:
+            subprocess.Popen(["xdg-open", str(target)])

pySimBlocks/gui/dialogs/__init__.py

@@ -0,0 +1,19 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program 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 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program 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 program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************

pySimBlocks/gui/dialogs/block_dialog.py

@@ -0,0 +1,125 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program 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 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program 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 program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from typing import TYPE_CHECKING
+
+from PySide6.QtWidgets import (
+    QDialog,
+    QFormLayout,
+    QHBoxLayout,
+    QMessageBox,
+    QPushButton,
+    QVBoxLayout,
+)
+
+from pySimBlocks.gui.dialogs.help_dialog import HelpDialog
+
+if TYPE_CHECKING:
+    from pySimBlocks.gui.graphics.block_item import BlockItem
+
+
+class BlockDialog(QDialog):
+    def __init__(self,
+                 block: 'BlockItem',
+                 readonly: bool = False
+    ):
+        super().__init__()
+        self.block = block
+        self.meta = block.instance.meta
+        self.instance = block.instance
+
+        self.readonly = readonly
+        if self.readonly:
+            self.setWindowTitle(f"[{self.block.instance.name}] Information")
+        else:
+            self.setWindowTitle(f"Edit [{self.block.instance.name}] Parameters")
+        self.setMinimumWidth(300)
+
+        main_layout = QVBoxLayout(self)
+        project_dir = None
+        if hasattr(self.block, "view") and self.block.view is not None:
+            controller = getattr(self.block.view, "project_controller", None)
+            if controller is not None and controller.project_state is not None:
+                project_dir = controller.project_state.directory_path
+
+        self.session = self.meta.create_dialog_session(self.instance, project_dir)
+        self.build_meta_layout(main_layout)
+        self.build_buttons_layout(main_layout)
+
+    # --------------------------------------------------------------------------
+    # Dialog Layout Methods
+    # --------------------------------------------------------------------------
+    def build_meta_layout(self, layout: QVBoxLayout):
+        form = QFormLayout()
+        self.meta.build_description(form)
+        self.meta.build_pre_param(self.session, form, self.readonly)
+        self.meta.build_param(self.session, form, self.readonly)
+        self.meta.build_post_param(self.session, form, self.readonly)
+        layout.addLayout(form)
+        self.meta.refresh_form(self.session)
+
+    def build_buttons_layout(self, layout: QVBoxLayout):
+        buttons_layout = QHBoxLayout()
+        buttons_layout.addStretch()
+
+        ok_btn = QPushButton("Ok")
+        ok_btn.setDefault(True)
+        ok_btn.setAutoDefault(True)
+        ok_btn.clicked.connect(self.ok)
+        buttons_layout.addWidget(ok_btn)
+
+        help_btn = QPushButton("Help")
+        help_btn.clicked.connect(self.open_help)
+        buttons_layout.addWidget(help_btn)
+
+        apply_btn = QPushButton("Apply")
+        apply_btn.clicked.connect(self.apply)
+        buttons_layout.addWidget(apply_btn)
+
+        if self.readonly:
+            ok_btn.setEnabled(False)
+            apply_btn.setEnabled(False)
+
+        layout.addLayout(buttons_layout)
+
+
+    # --------------------------------------------------------------------------
+    # Button Methods
+    # --------------------------------------------------------------------------
+    def apply(self):
+        if self.readonly:
+            return
+
+        params = self.meta.gather_params(self.session)
+        self.block.view.update_block_param_event(self.block.instance, params)
+
+    # ------------------------------------------------------------
+    def ok(self):
+        self.apply()
+        self.accept()
+
+    # ------------------------------------------------------------
+    def open_help(self):
+        help_path = self.block.instance.meta.doc_path
+
+        if help_path and help_path.exists():
+            HelpDialog(help_path, self).exec()
+        else:
+            QMessageBox.information(self, "Help", "No documentation available.")

pySimBlocks/gui/dialogs/display_yaml_dialog.py

@@ -0,0 +1,89 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program 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 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program 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 program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from PySide6.QtWidgets import (
+    QDialog,
+    QVBoxLayout,
+    QTabWidget,
+    QTextEdit,
+    QPushButton,
+    QHBoxLayout,
+)
+from PySide6.QtGui import QFont
+
+from pySimBlocks.gui.models.project_state import ProjectState
+from pySimBlocks.gui.services.yaml_tools import dump_project_yaml
+from pySimBlocks.gui.widgets.diagram_view import DiagramView
+
+
+class DisplayYamlDialog(QDialog):
+    def __init__(self,
+                 project: ProjectState,
+                 view: DiagramView,
+                 parent=None):
+        super().__init__(parent)
+
+        self.setWindowTitle("project.yaml Preview")
+        self.resize(900, 600)
+
+        self.project_state = project
+        self.view = view
+
+        main_layout = QVBoxLayout(self)
+
+        # -------------------------------------------------
+        # Tabs
+        # -------------------------------------------------
+        tabs = QTabWidget()
+
+        if self.view.block_items:
+            blocks_items = self.view.block_items
+        else:
+            blocks_items = {}
+        project_text = dump_project_yaml(self.project_state, blocks_items)
+        tabs.addTab(
+            self._make_code_view(project_text),
+            "project.yaml"
+        )
+
+        main_layout.addWidget(tabs)
+
+        # -------------------------------------------------
+        # Buttons
+        # -------------------------------------------------
+        buttons = QHBoxLayout()
+        buttons.addStretch()
+
+        close_btn = QPushButton("Close")
+        close_btn.clicked.connect(self.accept)
+        buttons.addWidget(close_btn)
+
+        main_layout.addLayout(buttons)
+
+    # -------------------------------------------------
+    # Helpers
+    # -------------------------------------------------
+    def _make_code_view(self, text:str) -> QTextEdit:
+        edit = QTextEdit()
+        edit.setReadOnly(True)
+        edit.setFont(QFont("Courier New", 10))
+        edit.setPlainText(text)
+        edit.setLineWrapMode(QTextEdit.NoWrap)
+        return edit

pySimBlocks/gui/dialogs/help_dialog.py

@@ -0,0 +1,39 @@
+# ******************************************************************************
+#                                  pySimBlocks
+#                     Copyright (c) 2026 Université de Lille & INRIA
+# ******************************************************************************
+#  This program 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 3 of the License, or (at your
+#  option) any later version.
+#
+#  This program 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 program.  If not, see <https://www.gnu.org/licenses/>.
+# ******************************************************************************
+#  Authors: see Authors.txt
+# ******************************************************************************
+
+from pathlib import Path
+from PySide6.QtWidgets import  QTextBrowser, QDialog, QVBoxLayout
+
+
+class HelpDialog(QDialog):
+    def __init__(self, md_path: Path, parent=None):
+        super().__init__(parent)
+        self.setWindowTitle(md_path.name)
+        self.resize(600, 500)
+
+        layout = QVBoxLayout(self)
+
+        browser = QTextBrowser()
+        browser.setOpenExternalLinks(True)
+
+        with md_path.open("r") as f:
+            browser.setMarkdown(f.read())
+
+        layout.addWidget(browser)