FreeCAD Workbench as Python-module

freecad_workbench/Init.py

@@ -1,2 +0,0 @@
-# -*- coding: utf-8 -*-
-"""FreeCAD init script"""

freecad_workbench/InitGui.py

@@ -1,82 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2023 by brothermechanic. All Rights Reserved.
-# Based on ARBench by github/mahaarbo
-# 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 3 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, see <http://www.gnu.org/licenses/>.
-
-__title__='Frames Workbench'
-__author__ = 'brothermechanic'
-__copyright__ = 'Copyright (c) 2023 brothermechanic'
-__license__ = 'GPL-2.1'
-__version__ = "0.1"
-__email__ = 'brothermechanic@gmail.com'
-__url__ = ["https://robossembler.org"]
-__status__ = 'development'
-
-
-class Frames(Workbench):
-    MenuText = "Frames"
-    ToolTip = "Frames Workbench"
-    Icon = """"""
-
-    def __init__(self):
-        import os
-        self.Icon = os.path.join(FreeCAD.getUserAppDataDir(), "Mod",
-                                 __class__.__name__, "UI", "icons", "frame.svg")
-
-    def Initialize(self):
-        """This function is executed when FreeCAD starts"""
-        import Frames
-        self.framecommands = [
-            "BoMGeneration",
-            "FrameCommand",
-            
-            "SelectedPartFrameCommand",
-            "AllPartFramesCommand",
-            "FeatureFrameCommand"
-            
-            ]
-        self.toolcommands = [
-            "ExportPlacementAndPropertiesCommand",
-            "Export_Entities",
-            "ExportGazeboModels",
-            "InsertGraspPose",
-            "ASM4StructureParsing",
-            "PDDL_CreateTypes",
-            "PDDL_CreateParameters",
-            "PDDL_CreateAction",
-            "PDDL_CreatePredicate",
-            "PDDL_CreateDurativeAction",
-            
-            "Publish_Project"
-            ]
-        self.appendToolbar(f"{__class__.__name__} Frames", self.framecommands)
-        self.appendToolbar(f"{__class__.__name__} Tools", self.toolcommands)
-
-    def Activated(self):
-        """This function is executed when the workbench is activated."""
-        #
-        return
-
-    def Deactivated(self):
-        """This function is executed when the workbench is deactivated."""
-        #
-        return
-
-    def ContextMenu(self, recipient):
-        """This is execcuted whenever the user right-clicks on screen."""
-        pass
-
-    def GetClassName(self):
-        # This function is mandatory if this is a full python workbench
-        return "Gui::PythonWorkbench"
-
-Gui.addWorkbench(Frames())

freecad_workbench/LICENSE

@@ -6,9 +6,9 @@
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
-[This is the first released version of the Lesser GPL.  It also counts
+(This is the first released version of the Lesser GPL.  It also counts
  as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
+ the version number 2.1.)
 
                             Preamble
 
@@ -470,8 +470,8 @@ safest to attach them to the start of each source file to most effectively
 convey the exclusion of warranty; and each file should have at least the
 "copyright" line and a pointer to where the full notice is found.
 
-    <one line to give the library's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    {description}
+    Copyright (C) {year} {fullname}
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
@@ -498,7 +498,8 @@ necessary.  Here is a sample; alter the names:
   library `Frob' (a library for tweaking knobs) written by James Random
   Hacker.
 
-  <signature of Ty Coon>, 1 April 1990
+  {signature of Ty Coon}, 1 April 1990
   Ty Coon, President of Vice
 
 That's all there is to it!
+

freecad_workbench/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include freecad/robossembler/resources *

freecad_workbench/Makefile

@@ -0,0 +1,51 @@
+# Makefile for string replacement tasks
+# Replace values from starterkit to your workbench name
+
+# Define replacements as variables
+WORKBENCH_DIR_NAME = robossembler
+WORKBENCH_CLASS_NAME = Robossembler
+WORKBENCH_MENUTEXT = Robossembler
+WORKBENCH_TOOLTIP = FreeCAD Robossembler Workbench
+WORKBENCH_ICON = robossembler.svg
+WORKBENCH_TRANSLATION_CONTEXT = cool
+MAINTAINER = Mark Voltov
+EMAIL = ius.mark.alex@gmail.com
+URL = https://gitlab.com/robossembler/framework
+DESCRIPTION = FreeCAD Robossembler Workbench - Assembly Sequence Planning, Analysis
+DEPENDENCIES_LIST = []
+
+.PHONY: all replace_strings
+
+all: replace_strings
+
+replace_strings:
+	@echo -e "\033[1;34mReplacing strings\033[0m"
+	@# Update instances of 'workbench_starterkit' on different files
+	sed -i 's/workbench_starterkit/$(WORKBENCH_DIR_NAME)/g' MANIFEST.in
+	sed -i 's/workbench_starterkit/$(WORKBENCH_DIR_NAME)/g' freecad/workbench_starterkit/init_gui.py
+	sed -i 's/workbench_starterkit/$(WORKBENCH_DIR_NAME)/g' freecad/workbench_starterkit/resources/translations/update_translation.sh
+	sed -i 's/workbench_starterkit/$(WORKBENCH_DIR_NAME)/g' freecad/workbench_starterkit/resources/translations/workbench_starterkit_es-ES.ts
+	sed -i 's/workbench_starterkit/$(WORKBENCH_DIR_NAME)/g' setup.py
+	@# Rename workbench class name
+	sed -i 's/TemplateWorkbench/$(WORKBENCH_CLASS_NAME)/g' freecad/workbench_starterkit/init_gui.py
+	@# Rename workbench class properties
+	sed -i 's/template workbench/$(WORKBENCH_MENUTEXT)/g' freecad/workbench_starterkit/init_gui.py
+	sed -i 's/a simple template workbench/$(WORKBENCH_TOOLTIP)/g' freecad/workbench_starterkit/init_gui.py
+	sed -i 's/template_resource.svg/$(WORKBENCH_ICON)/g' freecad/workbench_starterkit/init_gui.py
+	@# Rename workbench icon
+	mv freecad/workbench_starterkit/resources/template_resource.svg freecad/workbench_starterkit/resources/$(WORKBENCH_ICON)
+	@# Rename context string for translation of workbench name
+	sed -i 's/starterkit/$(WORKBENCH_TRANSLATION_CONTEXT)/g' freecad/workbench_starterkit/init_gui.py
+	sed -i 's/starterkit/$(WORKBENCH_TRANSLATION_CONTEXT)/g' freecad/workbench_starterkit/resources/translations/workbench_starterkit_es-ES.ts
+	@# Rename workbench directory
+	mv freecad/workbench_starterkit freecad/$(WORKBENCH_DIR_NAME)
+	@# Update setup.py file
+	sed -i 's/looooo/$(MAINTAINER)/g' setup.py
+	sed -i 's/sppedflyer@gmail.com/$(EMAIL)/g' setup.py
+	sed -i 's|https://github.com/FreeCAD/Workbench-Starterkit|$(URL)|g' setup.py
+	sed -i 's/template for a freecad extensions\, installable with pip/$(DESCRIPTION)/g' setup.py
+	sed -i "s/\['numpy'\]/$(DEPENDENCIES_LIST)/g" setup.py
+
+self-destruction:
+	echo "Remove Makefile"
+	rm Makefile

freecad_workbench/__init__.py

@@ -1,5 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-DESCRIPTION.
-FreeCAD modules for Robosembler project pipeline.
-"""

freecad_workbench/docs/commands.md

@@ -0,0 +1,127 @@
+# Code Snippets
+There is no way to add a button, menu entry from python to a workbench which is added with c++. So here is a comparison how to do that with python and with c++.
+
+## Adding a command:
+This can be done either with python or c++.
+
+### 1. python
+
+```python
+import FreeCAD as App
+
+class MyCommand(object):
+    def IsActive(self):
+        """
+        availability of the command (eg.: check for existence of a document,...)
+        if this function returns False, the menu/ buttons are ßdisabled (gray)
+        """
+        if App.ActiveDocument is None:
+            return False
+        else:
+            return True
+
+    def GetResources(self):
+        """
+        resources which are used by buttons and menu-items
+        """
+        return {'Pixmap': 'path_to_icon.svg', 'MenuText': 'my command', 'ToolTip': 'very short description'}
+
+    def Activated(self):
+        """
+        the function to be handled, when a user starts the command
+        """
+```
+To register the command in FreeCAD:
+
+```python
+import FreeCADGui as Gui
+Gui.addCommand('MyCommand', MyCommand())
+```
+
+Adding a new toolbar/menu:
+```python
+from FreeCADGui import Workbench
+class myWorkbench(Workbench):
+    MenuText = "name_of_workbench"
+    ToolTip = "short description of workbench"
+    Icon = "path_to_icon.svg"
+
+    def GetClassName(self):
+        return "Gui::PythonWorkbench"
+
+    def Initialize(self):
+        self.appendToolbar("Gear", ["MyCommand"])
+        self.appendMenu("Gear", ["MyCommand"])
+```
+
+### 2. C++
+
+```c++
+
+#include <App/Document.h>
+#include <Gui/Command.h>
+#include <Gui/Control.h>
+#include <Gui/Document.h>
+
+using namespace std;
+
+DEF_STD_CMD_A(MyCommand)
+
+MyCommand::MyCommand()
+  : Command("MyCommand")
+{
+    sAppModule    = "module";
+    sGroup        = QT_TR_NOOP("Mesh");
+    sMenuText     = QT_TR_NOOP("my command");
+    sToolTipText  = QT_TR_NOOP("very short description");
+    sWhatsThis    = "MyCommand";
+    sStatusTip    = sToolTipText;
+}
+
+void MyCommand::activated(int)
+{
+    // the function to be handled, when a user starts the command
+}
+
+bool MyCommand::isActive(void)
+{
+    // availability of the command (eg.: check for existence of a document,...)
+    // if this function returns False, the menu/ buttons are ßdisabled (gray)
+    return (hasActiveDocument() && !Gui::Control().activeDialog());
+}
+```
+To register the command in FreeCAD:
+
+```c++
+#include <Gui/Command.h>
+
+Gui::CommandManager &rcCmdMgr = Gui::Application::Instance->commandManager();
+rcCmdMgr.addCommand(new MyCommand());
+```
+Adding a item to a menu/toolbar:
+
+if your command is added with python you have to run this code:
+in src/module/Gui/AppModuleGui.cpp add to PyMOD_INIT_FUNC:
+
+```c++
+// try to instantiate a python module
+try{
+    Base::Interpreter().runStringObject("import MyCommands");
+} catch (Base::PyException &err){
+    err.ReportException();
+}
+```
+
+and add the name of the command to a tooltip/menu in src/module/Gui/Workbench.cpp Workbench::setupToolBars
+
+
+```c++
+Gui::ToolBarItem* Workbench::setupToolBars() const
+{
+    Gui::ToolBarItem* root = StdWorkbench::setupToolBars();
+    Gui::ToolBarItem* myToolbar = new Gui::ToolBarItem(root);
+    myToolbar->setCommand("my_commands");
+    *myToolbar << "MyCommand";
+    return root;
+}
+```

freecad_workbench/freecad/robossembler/BoMList.py

@@ -1,7 +1,7 @@
-from helper.is_solid import is_object_solid
 import FreeCAD as App
 import Spreadsheet
 
+from .helper.is_solid import is_object_solid
 
 def createSpreadsheet():
 

freecad_workbench/freecad/robossembler/CHANGELOG.md

@@ -1,26 +1,19 @@
-
 # Change Log
 All notable changes to this project will be documented in this file.
  
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-
-
-
 ## [0.1] - Robbossembler FreeCAD Workbench - 2024.04.07
 
 Верстак для предподготовки CAD-модели изделия к автоматизированному производству. 
-
  
+### Added
+-
+
 ### Changed
 - Изменена компоновка в директории верстака. Все относящиеся к работе верстака элементы теперь находятся в его директории. 
 - Добавлен инструмент публикации проекта и создания всех необходимых файлов через верстак.
 
- 
 ### Fixed
-
-- 
-## ToDo
-- Функционал генерации связей между составными частями сборки. 
-- Алгоритм разбиения сборки на сборочные единицы.
+-

freecad_workbench/freecad/robossembler/Frames.py

@@ -1,23 +1,12 @@
-# -*- coding: utf-8 -*-
-# Copyright 2023 by brothermechanic. All Rights Reserved.
-# Based on ARBench by github/mahaarbo
-# 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 3 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, see <http://www.gnu.org/licenses/>.
-from BoMList import run_BoM_list
-import pddl.freecad2pddl as freecad2pddl
-from ImportExportEntities import export_coordinate_systems
 import FreeCAD
-import Tools
-from utils.freecad_processor import process_file
-from usecases.asm4parser_usecase import Asm4StructureParseUseCase
+
+from . import ICONPATH, TRANSLATIONSPATH
+from .Tools import spawnClassCommand, placement2axisvec, describeSubObject, getPrimitiveInfo #, RobossemblerFreeCadExportScenario
+from .pddl import freecad2pddl
+from .BoMList import run_BoM_list
+from .ImportExportEntities import export_coordinate_systems
+from .utils.freecad_processor import process_file
+from .usecases.asm4parser_usecase import Asm4StructureParseUseCase
 
 
 if FreeCAD.GuiUp:
@@ -27,14 +16,6 @@ if FreeCAD.GuiUp:
     import Part
     import os
 
-__title__ = 'Frames'
-__author__ = 'brothermechanic'
-__workbenchname__ = 'Frames'
-__version__ = '0.1'
-__url__ = ["https://robossembler.org"]
-__doc__ = """"""
-
-
 ############################################################
 # Frame Objects
 ############################################################
@@ -64,7 +45,7 @@ class Frame(object):
     def getDict(self):
         d = {}
         d["label"] = str(self.obj.Label)
-        d["placement"] = Tools.placement2axisvec(self.obj.Placement)
+        d["placement"] = placement2axisvec(self.obj.Placement)
         d.update(self.additional_data)
         return d
 
@@ -115,7 +96,7 @@ class FeatureFrame(PartFrame):
 
     def getDict(self):
         d = PartFrame.getDict(self)
-        d["featureplacement"] = Tools.placement2axisvec(self.obj.FeaturePlacement)
+        d["featureplacement"] = placement2axisvec(self.obj.FeaturePlacement)
         d["shapetype"] = str(self.obj.ShapeType)
         d["positioning"] = str(self.obj.Positioning)
         return d
@@ -191,11 +172,6 @@ class ViewProviderFrame(object):
     def getDefaultDisplayMode(self):
         return "Shaded"
 
-    def getIcon(self):
-        icondir = os.path.join(FreeCAD.getUserAppDataDir(),
-                               "Mod", __workbenchname__, "UI", "icons")
-        return str(os.path.join(icondir, "frame.svg"))
-
     def onChanged(self, vp, prop):
         if prop == "Scale":
             s = vp.getPropertyByName("Scale")
@@ -308,85 +284,82 @@ def spawnFeatureFrameCreator():
 ###################################################################
 # GUI Related
 ###################################################################
-uidir = os.path.join(FreeCAD.getUserAppDataDir(),
-                     "Mod", __workbenchname__, "UI")
-icondir = os.path.join(uidir, "icons")
 
-
-Tools.spawnClassCommand("BoMGeneration", 
+spawnClassCommand("BoMGeneration", 
                           run_BoM_list,
-                          {"Pixmap": str(os.path.join(icondir, "BoMList.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "BoMList.svg")),
                            "MenuText": "Generate Bill of Materials",
                            "ToolTip": "Press the button to create big BoM"})
-Tools.spawnClassCommand("FrameCommand",
+spawnClassCommand("FrameCommand",
                           makeFrame,
-                          {"Pixmap": str(os.path.join(icondir, "frame.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "frame.svg")),
                            "MenuText": "Make a free frame",
                            "ToolTip": "Make a freestanding reference frame."})
 
-Tools.spawnClassCommand("ASM4StructureParsing",
-                          Tools.RobossemblerFreeCadExportScenario().call,
-                          {"Pixmap": str(os.path.join(icondir, "assembly4.svg")),
-                           "MenuText": "Make a ASM4 parsing",
-                           "ToolTip": "Make a ASM4 1"})
-Tools.spawnClassCommand("SelectedPartFrameCommand",
+# spawnClassCommand("ASM4StructureParsing",
+#                           RobossemblerFreeCadExportScenario().call,
+#                           {"Pixmap": str(os.path.join(ICONPATH, "assembly4.svg")),
+#                            "MenuText": "Make a ASM4 parsing",
+#                            "ToolTip": "Make a ASM4 1"})
+
+spawnClassCommand("SelectedPartFrameCommand",
                           makeSelectedPartFrames,
-                          {"Pixmap": str(os.path.join(icondir, "partframe.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "partframe.svg")),
                            "MenuText": "selected parts frames",
                            "ToolTip": "Make selected parts frames."})
 
-Tools.spawnClassCommand("AllPartFramesCommand",
+spawnClassCommand("AllPartFramesCommand",
                           makeAllPartFrames,
-                          {"Pixmap": str(os.path.join(icondir, "allpartframes.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "allpartframes.svg")),
                            "MenuText": "All parts frames",
                            "ToolTip": "Make all parts frames."})
-Tools.spawnClassCommand("FeatureFrameCommand",
+spawnClassCommand("FeatureFrameCommand",
                           spawnFeatureFrameCreator,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "frame on selected primitive",
                            "ToolTip": "Create a frame on selected primitive."})
 
-Tools.spawnClassCommand("PDDL_CreateTypes",
+spawnClassCommand("PDDL_CreateTypes",
                           freecad2pddl.add_types,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "Types",
                            "ToolTip": "Add Types"})
 
-Tools.spawnClassCommand("PDDL_CreateParameters",
+spawnClassCommand("PDDL_CreateParameters",
                           freecad2pddl.add_parameters,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "Parameters",
                            "ToolTip": "Add Parameters"})
-Tools.spawnClassCommand("PDDL_CreateAction",
+spawnClassCommand("PDDL_CreateAction",
                           freecad2pddl.add_action,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "Action",
                            "ToolTip": "Add Action"})
-Tools.spawnClassCommand("PDDL_CreatePredicate",
+spawnClassCommand("PDDL_CreatePredicate",
                           freecad2pddl.add_predicate,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "Predicate",
                            "ToolTip": "Add Predicate"})
-Tools.spawnClassCommand("PDDL_CreateDurativeAction",
+spawnClassCommand("PDDL_CreateDurativeAction",
                           freecad2pddl.add_durative_action,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "DurativeAction",
                            "ToolTip": "Add Durative Action"})
-Tools.spawnClassCommand("PDDL_ExportPDDL",
+spawnClassCommand("PDDL_ExportPDDL",
                           freecad2pddl.export_to_file,
-                          {"Pixmap": str(os.path.join(icondir, "featureframecreator.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "featureframecreator.svg")),
                            "MenuText": "ExportDomain",
                            "ToolTip": "Create and Export Domain.pddl to File"})
 
-Tools.spawnClassCommand("Export_Entities",
+spawnClassCommand("Export_Entities",
                           export_coordinate_systems,
-                          {"Pixmap": str(os.path.join(icondir, "BoMList.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "BoMList.svg")),
                            "MenuText": "ExportLCS",
                            "ToolTip": "Export all the markups"})
 
-Tools.spawnClassCommand("Publish_Project",
+spawnClassCommand("Publish_Project",
                           process_file,
-                          {"Pixmap": str(os.path.join(icondir, "publish.svg")),
+                          {"Pixmap": str(os.path.join(ICONPATH, "publish.svg")),
                            "MenuText": "Publish Project",
                            "ToolTip": "Save and export project files"})
 
@@ -415,7 +388,7 @@ class FeatureFramePanel:
             self.reject()
 
         # Choices related to selection
-        so_desc = Tools.describeSubObject(selected.SubObjects[0])
+        so_desc = describeSubObject(selected.SubObjects[0])
         self.so_desc = so_desc
         shape_choices = {
             "Vertex": [],
@@ -446,7 +419,7 @@ class FeatureFramePanel:
         self.choices = self.choices + shape_choices[so_desc[1]]
         self.choices = self.choices + prim_choices[so_desc[0]]
         # Setting up QT form
-        uiform_path = os.path.join(uidir, "FeatureFrameCreator.ui")
+        uiform_path = os.path.join(UIPATH, "FeatureFrameCreator.ui")
         self.form = FreeCADGui.PySideUic.loadUi(uiform_path)
         self.form.ChoicesBox.addItems(self.choices)
         self.form.PickedTypeLabel.setText(so_desc[0])
@@ -456,7 +429,7 @@ class FeatureFramePanel:
         self.scenes = {}
         for choice in self.choices:
             sc = QtGui.QGraphicsScene()
-            icon = str(os.path.join(icondir, choice+".svg"))
+            icon = str(os.path.join(ICONPATH, choice+".svg"))
             sc.addItem(QtSvg.QGraphicsSvgItem(icon))
             self.scenes[choice] = sc
         self.choiceChanged(self.form.ChoicesBox.currentText())
@@ -516,7 +489,7 @@ class BaseFeaturePanel(object):
         self.fframe = makeFeatureFrame(self.selected.Object, self.local_ffpl)
         self.fframe.PrimitiveType = self.so_desc[0]
         self.fframe.ShapeType = self.so_desc[1]
-        ad = Tools.getPrimitiveInfo(self.so_desc[0],
+        ad = getPrimitiveInfo(self.so_desc[0],
                                       self.selected.SubObjects[0])
         self.fframe.Proxy.additional_data.update(ad)
 
@@ -549,7 +522,7 @@ class PickedPointPanel(BaseFeaturePanel):
     """Create a feature frame at the picked point."""
     # Not very clever. It just places the frame with default rotation.
     def __init__(self, selected, so_desc):
-        uiform_path = os.path.join(uidir, "FramePlacer.ui")
+        uiform_path = os.path.join(UIPATH, "FramePlacer.ui")
         self.form = FreeCADGui.PySideUic.loadUi(uiform_path)
         BaseFeaturePanel.__init__(self, selected, so_desc)
         parent_pl = selected.Object.Placement
@@ -563,7 +536,7 @@ class PickedPointPanel(BaseFeaturePanel):
 class PointOnEdgePanel(BaseFeaturePanel):
     """Create a feature frame on an edge."""
     def __init__(self, selected, so_desc):
-        uiform_path = os.path.join(uidir, "FramePlacer.ui")
+        uiform_path = os.path.join(UIPATH, "FramePlacer.ui")
         self.form = FreeCADGui.PySideUic.loadUi(uiform_path)
         # Enable the first parameter
         self.form.VLabel.setEnabled(True)
@@ -639,7 +612,7 @@ class PointOnEdgePanel(BaseFeaturePanel):
 class PointOnSurfacePanel(BaseFeaturePanel):
     """Create a feature on a surface."""
     def __init__(self, selected, so_desc):
-        uiform_path = os.path.join(uidir, "FramePlacer.ui")
+        uiform_path = os.path.join(UIPATH, "FramePlacer.ui")
         self.form = FreeCADGui.PySideUic.loadUi(uiform_path)
         # Enable both parameters
         self.form.ULabel.setVisible(True)
@@ -729,7 +702,7 @@ class PointOnSurfacePanel(BaseFeaturePanel):
 class CenterPanel(BaseFeaturePanel):
     """Create a feature frame on center."""
     def __init__(self, selected, so_desc):
-        uiform_path = os.path.join(uidir, "FramePlacer.ui")
+        uiform_path = os.path.join(UIPATH, "FramePlacer.ui")
         self.form = FreeCADGui.PySideUic.loadUi(uiform_path)
         BaseFeaturePanel.__init__(self, selected, so_desc)
         edge_curve_list = ["ArcOfCircle",
@@ -768,7 +741,7 @@ class CenterPanel(BaseFeaturePanel):
 class PointOnCenterlinePanel(BaseFeaturePanel):
     """Create a point on centerline of primitive."""
     def __init__(self, selected, so_desc):
-        uiform_path = os.path.join(uidir, "FramePlacer.ui")
+        uiform_path = os.path.join(UIPATH, "FramePlacer.ui")
         self.form = FreeCADGui.PySideUic.loadUi(uiform_path)
         BaseFeaturePanel.__init__(self, selected, so_desc)
         # Enable the along line parameter

freecad_workbench/freecad/robossembler/GraspPose.py

@@ -1,8 +1,8 @@
 import FreeCAD
-from FreeCAD import Base, Placement
 import Part
-from time import sleep
 import PySide
+from FreeCAD import Base, Placement
+from time import sleep
 
 # MACRO 1:
 # Select part and run it to insert gripper pose (red)

freecad_workbench/freecad/robossembler/LICENSE

@@ -0,0 +1,504 @@
+                  GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL.  It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+  This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it.  You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+  When we speak of free software, we are referring to freedom of use,
+not price.  Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+  To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights.  These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+  For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you.  You must make sure that they, too, receive or can get the source
+code.  If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it.  And you must show them these terms so they know their rights.
+
+  We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+  To protect each distributor, we want to make it very clear that
+there is no warranty for the free library.  Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+  Finally, software patents pose a constant threat to the existence of
+any free program.  We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder.  Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+  Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License.  This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License.  We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+  When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library.  The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom.  The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+  We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License.  It also provides other free software developers Less
+of an advantage over competing non-free programs.  These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries.  However, the Lesser license provides advantages in certain
+special circumstances.
+
+  For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard.  To achieve this, non-free programs must be
+allowed to use the library.  A more frequent case is that a free
+library does the same job as widely used non-free libraries.  In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+  In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software.  For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+  Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.  Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library".  The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+                  GNU LESSER GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+  A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+  The "Library", below, refers to any such software library or work
+which has been distributed under these terms.  A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language.  (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+  "Source code" for a work means the preferred form of the work for
+making modifications to it.  For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+  Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it).  Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+  1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+  You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+  2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) The modified work must itself be a software library.
+
+    b) You must cause the files modified to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    c) You must cause the whole of the work to be licensed at no
+    charge to all third parties under the terms of this License.
+
+    d) If a facility in the modified Library refers to a function or a
+    table of data to be supplied by an application program that uses
+    the facility, other than as an argument passed when the facility
+    is invoked, then you must make a good faith effort to ensure that,
+    in the event an application does not supply such function or
+    table, the facility still operates, and performs whatever part of
+    its purpose remains meaningful.
+
+    (For example, a function in a library to compute square roots has
+    a purpose that is entirely well-defined independent of the
+    application.  Therefore, Subsection 2d requires that any
+    application-supplied function or table used by this function must
+    be optional: if the application does not supply it, the square
+    root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library.  To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License.  (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.)  Do not make any other change in
+these notices.
+
+  Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+  This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+  4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+  If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library".  Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+  However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library".  The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+  When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library.  The
+threshold for this to be true is not precisely defined by law.
+
+  If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work.  (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+  Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+  6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+  You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License.  You must supply a copy of this License.  If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License.  Also, you must do one
+of these things:
+
+    a) Accompany the work with the complete corresponding
+    machine-readable source code for the Library including whatever
+    changes were used in the work (which must be distributed under
+    Sections 1 and 2 above); and, if the work is an executable linked
+    with the Library, with the complete machine-readable "work that
+    uses the Library", as object code and/or source code, so that the
+    user can modify the Library and then relink to produce a modified
+    executable containing the modified Library.  (It is understood
+    that the user who changes the contents of definitions files in the
+    Library will not necessarily be able to recompile the application
+    to use the modified definitions.)
+
+    b) Use a suitable shared library mechanism for linking with the
+    Library.  A suitable mechanism is one that (1) uses at run time a
+    copy of the library already present on the user's computer system,
+    rather than copying library functions into the executable, and (2)
+    will operate properly with a modified version of the library, if
+    the user installs one, as long as the modified version is
+    interface-compatible with the version that the work was made with.
+
+    c) Accompany the work with a written offer, valid for at
+    least three years, to give the same user the materials
+    specified in Subsection 6a, above, for a charge no more
+    than the cost of performing this distribution.
+
+    d) If distribution of the work is made by offering access to copy
+    from a designated place, offer equivalent access to copy the above
+    specified materials from the same place.
+
+    e) Verify that the user has already received a copy of these
+    materials or that you have already sent this user a copy.
+
+  For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it.  However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+  It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system.  Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+  7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+    a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities.  This must be distributed under the terms of the
+    Sections above.
+
+    b) Give prominent notice with the combined library of the fact
+    that part of it is a work based on the Library, and explaining
+    where to find the accompanying uncombined form of the same work.
+
+  8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License.  Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License.  However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+  9. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Library or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+  10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+  11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded.  In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+  13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation.  If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+  14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission.  For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this.  Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+                            NO WARRANTY
+
+  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Libraries
+
+  If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change.  You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+  To apply these terms, attach the following notices to the library.  It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the library's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+    USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  library `Frob' (a library for tweaking knobs) written by James Random
+  Hacker.
+
+  <signature of Ty Coon>, 1 April 1990
+  Ty Coon, President of Vice
+
+That's all there is to it!

freecad_workbench/freecad/robossembler/Tools.py

@@ -1,39 +1,22 @@
-# -*- coding: utf-8 -*-
-# Copyright 2023 by brothermechanic. All Rights Reserved.
-# Based on ARBench by github/mahaarbo
-# 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 3 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, see <http://www.gnu.org/licenses/>.
 import FreeCAD
 import Part
-import json  # For exporting part infos
-import os    # for safer path handling
-import GazeboExport
-import GraspPose
-from scenarios.robossembler_freecad_export_scenario import RobossemblerFreeCadExportScenario
+import json
+import os
+import time
+
+from .GazeboExport import export_collada, export_sdf, config
+from .GraspPose import insert
+from . import ICONPATH, UIPATH
+# from .scenarios.robossembler_freecad_export_scenario import RobossemblerFreeCadExportScenario
+
 if FreeCAD.GuiUp:
     import FreeCADGui
     from PySide import QtGui
-import time
-__title__ = 'Tools'
-__author__ = 'brothermechanic'
-__workbenchname__ = 'Frames'
-__version__ = '0.1'
-__url__ = ["https://robossembler.org"]
-__doc__ = """
-Useful tools for the Annotations for Robotics workbench."""
-
 
 ###################################################################
 # Module functions
 ###################################################################
+
 def vector2list(vec, scale=1e-3):
     """Gives the vector as a list, set scale for scaling factor.
     default scale = 1e-3 for units in m."""
@@ -547,33 +530,30 @@ def exportPlacementAndProperties():
 ###################################################################
 # GUI Commands
 ###################################################################
-uidir = os.path.join(FreeCAD.getUserAppDataDir(),
-                     "Mod", __workbenchname__, "UI")
-icondir = os.path.join(uidir, "icons")
 
 spawnClassCommand("ExportPlacementAndPropertiesCommand",
                   exportPlacementAndProperties,
-                  {"Pixmap": str(os.path.join(icondir, "parttojson.svg")),
+                  {"Pixmap": str(os.path.join(ICONPATH, "parttojson.svg")),
                    "MenuText": "Export placement and properties",
                    "ToolTip": "Export object placement and properties and feature frames"})
 
 spawnClassCommand("ExportGazeboModels",
                   exportGazeboModels,
-                  {"Pixmap": str(os.path.join(icondir, "gazeboexport.svg")),
+                  {"Pixmap": str(os.path.join(ICONPATH, "gazeboexport.svg")),
                    "MenuText": "Export SDF-models to Gazebo",
                    "ToolTip": "Export SDF-models for all solid parts"})
 
 spawnClassCommand("InsertGraspPose",
-                  GraspPose.insert,
-                  {"Pixmap": str(os.path.join(icondir, "addgrasppose.svg")),
+                  insert,
+                  {"Pixmap": str(os.path.join(ICONPATH, "addgrasppose.svg")),
                    "MenuText": "Insert Grasp Pose",
                    "ToolTip": "Insert Grasp Pose for Selected Part"})
 
-spawnClassCommand("ASM4StructureParsing",
-                          RobossemblerFreeCadExportScenario().call,
-                          {"Pixmap":  str(os.path.join(icondir, "assembly4.svg")),
-                           "MenuText": "Make a ASM4 parsing",
-                           "ToolTip": "Make a ASM4 1"})
+# spawnClassCommand("ASM4StructureParsing",
+#                           RobossemblerFreeCadExportScenario().call,
+#                           {"Pixmap":  str(os.path.join(ICONPATH, "assembly4.svg")),
+#                            "MenuText": "Make a ASM4 parsing",
+#                            "ToolTip": "Make a ASM4 1"})
 
 
 ###################################################################

freecad_workbench/freecad/robossembler/TranslateUtils.py

@@ -0,0 +1,37 @@
+# -*- coding: utf8 -*-
+
+#***************************************************************************
+#*                                                                         *
+#*   Copyright (c) 2020 kbwbe                                              *
+#*                                                                         *
+#*                                                                         *
+#*   This program is free software; you can redistribute it and/or modify  *
+#*   it under the terms of the GNU Lesser General Public License (LGPL)    *
+#*   as published by the Free Software Foundation; either version 2 of     *
+#*   the License, or (at your option) any later version.                   *
+#*   for detail see the LICENCE text file.                                 *
+#*                                                                         *
+#*   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 Library General Public License for more details.                  *
+#*                                                                         *
+#*   You should have received a copy of the GNU Library General Public     *
+#*   License along with this program; if not, write to the Free Software   *
+#*   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
+#*   USA                                                                   *
+#*                                                                         *
+#***************************************************************************
+
+import FreeCAD
+
+
+if FreeCAD.GuiUp:
+    from PySide.QtCore import QT_TRANSLATE_NOOP
+    from DraftGui import translate
+else:
+    def QT_TRANSLATE_NOOP(context, text):
+        return text
+
+    def translate(context, text):
+        return text

freecad_workbench/freecad/robossembler/__init__.py

@@ -0,0 +1,6 @@
+import os
+from .version import __version__
+
+UIPATH = os.path.join(os.path.dirname(__file__), "UI")
+ICONPATH = os.path.join(os.path.dirname(__file__), "resources/icons")
+TRANSLATIONSPATH = os.path.join(os.path.dirname(__file__), "resources/translations")

freecad_workbench/freecad/robossembler/freecad_to_json.py

@@ -1,22 +1,10 @@
-# coding: utf-8
-# Copyright (C) 2023 Ilia Kurochkin <brothermechanic@yandex.com>
-#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU 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 General Public License for more details.
 '''
 DESCRIPTION.
 - Reads a FreeCAD .FCStd file.
 - Set tesselation parts to mesh.
 - Return scene as JSON dictionary.
 '''
-__version__ = '0.1'
+
 import json
 import FreeCAD
 import Part
@@ -24,9 +12,9 @@ import Mesh
 import MeshPart
 import logging
 import math
-from utils.is_object_solid import is_object_solid
-from utils.processor import process_file
-from utils.custom_parser import CustomArgumentParser
+from freecad.robossembler.utils.is_object_solid import is_object_solid
+from freecad.robossembler.utils.processor import process_file
+from freecad.robossembler.utils.custom_parser import CustomArgumentParser
 
 logger = logging.getLogger(__name__)
 

freecad_workbench/freecad/robossembler/init_gui.py

@@ -0,0 +1,89 @@
+import os
+import FreeCADGui as Gui
+import FreeCAD as App
+
+from .TranslateUtils import translate
+from . import ICONPATH, TRANSLATIONSPATH, Frames
+from .version import __version__
+
+__title__='Robossembler Workbench'
+__author__ = 'brothermechanic, Mark Voltov, IDONTSUDO, Igor Brylyov'
+__copyright__ = 'Copyright (c) 2023 brothermechanic'
+__license__ = 'GPL-2.1'
+__email__ = 'brothermechanic@gmail.com, ius.mark.alex@gmail.com'
+__url__ = ["https://robossembler.org"]
+__status__ = 'development'
+
+
+class Robossembler(Gui.Workbench):
+    """
+    class which gets initiated at startup of the gui
+    """
+    MenuText = "Robossembler" # translate("cool", "Robossembler")
+    ToolTip = "Robossembler Workbench" # translate("cool", "a simple Robossembler")
+    Icon = os.path.join(ICONPATH, "robossembler.svg")
+    toolbox = []
+
+    def GetClassName(self):
+        return "Gui::PythonWorkbench"
+
+    def Initialize(self):
+        """
+        This function is called at the first activation of the workbench.
+        here is the place to import all the commands
+        """
+        # Add translations path
+        Gui.addLanguagePath(TRANSLATIONSPATH)
+        Gui.updateLocale()
+
+        self.framecommands = [
+            "BoMGeneration",
+            "FrameCommand",
+            
+            "SelectedPartFrameCommand",
+            "AllPartFramesCommand",
+            "FeatureFrameCommand"
+            ]
+        self.toolcommands = [
+            "ExportPlacementAndPropertiesCommand",
+            "Export_Entities",
+            "ExportGazeboModels",
+            "InsertGraspPose",
+            # "ASM4StructureParsing",
+            "PDDL_CreateTypes",
+            "PDDL_CreateParameters",
+            "PDDL_CreateAction",
+            "PDDL_CreatePredicate",
+            "PDDL_CreateDurativeAction",
+            
+            "Publish_Project"
+            ]
+        self.appendToolbar(f"{__class__.__name__} Frames", self.framecommands)
+        self.appendToolbar(f"{__class__.__name__} Tools", self.toolcommands)
+
+        App.Console.PrintMessage(translate("Console",
+            "Switching to robossembler") + "\n")
+
+        App.Console.PrintMessage(translate("Console",
+            "Switching to robossembler") + "\n")
+
+        # self.appendToolbar(translate("Toolbar", "Tools"), self.toolbox)
+        # self.appendMenu(translate("Menu", "Tools"), self.toolbox)
+
+    def Activated(self):
+        '''
+        code which should be computed when a user switch to this workbench
+        '''
+        pass
+
+    def Deactivated(self):
+        '''
+        code which should be computed when this workbench is deactivated
+        '''
+        pass
+    
+    def ContextMenu(self, recipient):
+        """This is execcuted whenever the user right-clicks on screen."""
+        pass
+
+Gui.addWorkbench(Robossembler())

freecad_workbench/freecad/robossembler/is_object_solid.py

@@ -14,7 +14,7 @@
 DESCRIPTION.
 Simple FreeCAD's object test for manifold mawater-tight surface.
 '''
-__version__ = '0.2'
+
 import FreeCAD
 
 

freecad_workbench/freecad/robossembler/markupEntities.py

@@ -3,9 +3,6 @@ import FreeCADGui as Gui
 
 doc = App.ActiveDocument
 
-
-
-
 print('lcs - локальная система координат')
 print('grip - позиция захвата')
 print('area - плоскость')

freecad_workbench/freecad/robossembler/resources/icons/robossembler.svg

@@ -0,0 +1,166 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.1"
+   width="64.1875"
+   height="64.1875"
+   id="svg3799"
+   inkscape:version="0.91 r13725"
+   sodipodi:docname="my_resources.svg">
+  <sodipodi:namedview
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1"
+     objecttolerance="10"
+     gridtolerance="10"
+     guidetolerance="10"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:window-width="1855"
+     inkscape:window-height="1056"
+     id="namedview3241"
+     showgrid="false"
+     inkscape:zoom="3.2883564"
+     inkscape:cx="103.51645"
+     inkscape:cy="-10.131949"
+     inkscape:window-x="65"
+     inkscape:window-y="24"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg3799" />
+  <defs
+     id="defs3801">
+    <marker
+       refX="0"
+       refY="0"
+       orient="auto"
+       id="EmptyTriangleOutL"
+       style="overflow:visible">
+      <path
+         d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
+         transform="matrix(0.8,0,0,0.8,-4.8,0)"
+         id="path4487"
+         style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1pt" />
+    </marker>
+    <marker
+       refX="0"
+       refY="0"
+       orient="auto"
+       id="DotS"
+       style="overflow:visible">
+      <path
+         d="m -2.5,-1 c 0,2.76 -2.24,5 -5,5 -2.76,0 -5,-2.24 -5,-5 0,-2.76 2.24,-5 5,-5 2.76,0 5,2.24 5,5 z"
+         transform="matrix(0.2,0,0,0.2,1.48,0.2)"
+         id="path4394"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt" />
+    </marker>
+    <marker
+       refX="0"
+       refY="0"
+       orient="auto"
+       id="DotL"
+       style="overflow:visible">
+      <path
+         d="m -2.5,-1 c 0,2.76 -2.24,5 -5,5 -2.76,0 -5,-2.24 -5,-5 0,-2.76 2.24,-5 5,-5 2.76,0 5,2.24 5,5 z"
+         transform="matrix(0.8,0,0,0.8,5.92,0.8)"
+         id="path4388"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt" />
+    </marker>
+    <marker
+       refX="0"
+       refY="0"
+       orient="auto"
+       id="Tail"
+       style="overflow:visible">
+      <g
+         transform="scale(-1.2,-1.2)"
+         id="g4363">
+        <path
+           d="M -3.8048674,-3.9585227 0.54352094,0"
+           id="path4365"
+           style="fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round" />
+        <path
+           d="M -1.2866832,-3.9585227 3.0617053,0"
+           id="path4367"
+           style="fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round" />
+        <path
+           d="M 1.3053582,-3.9585227 5.6537466,0"
+           id="path4369"
+           style="fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round" />
+        <path
+           d="M -3.8048674,4.1775838 0.54352094,0.21974226"
+           id="path4371"
+           style="fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round" />
+        <path
+           d="M -1.2866832,4.1775838 3.0617053,0.21974226"
+           id="path4373"
+           style="fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round" />
+        <path
+           d="M 1.3053582,4.1775838 5.6537466,0.21974226"
+           id="path4375"
+           style="fill:none;stroke:#000000;stroke-width:0.80000001;stroke-linecap:round" />
+      </g>
+    </marker>
+    <marker
+       refX="0"
+       refY="0"
+       orient="auto"
+       id="Arrow1Sstart"
+       style="overflow:visible">
+      <path
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         transform="matrix(0.2,0,0,0.2,1.2,0)"
+         id="path4339"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt" />
+    </marker>
+    <marker
+       refX="0"
+       refY="0"
+       orient="auto"
+       id="Arrow1Lstart"
+       style="overflow:visible">
+      <path
+         d="M 0,0 5,-5 -12.5,0 5,5 0,0 z"
+         transform="matrix(0.8,0,0,0.8,10,0)"
+         id="path4327"
+         style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt" />
+    </marker>
+  </defs>
+  <metadata
+     id="metadata3804">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <rect
+     style="fill:none;stroke:#ff0000;stroke-width:10"
+     id="rect4592"
+     width="43.182667"
+     height="47.440113"
+     x="10.643615"
+     y="8.2324944" />
+  <text
+     xml:space="preserve"
+     style="font-style:normal;font-weight:normal;font-size:40px;line-height:125%;font-family:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+     x="19.766714"
+     y="45.637199"
+     id="text4594"
+     sodipodi:linespacing="125%"><tspan
+       sodipodi:role="line"
+       id="tspan4596"
+       x="19.766714"
+       y="45.637199">T</tspan></text>
+</svg>

freecad_workbench/freecad/robossembler/resources/translations/update_translation.sh

@@ -0,0 +1,112 @@
+#!/usr/bin/env bash
+
+# --------------------------------------------------------------------------------------------------
+#
+# Update translation files
+#
+# Supported locales on FreeCAD <2024-01-20, FreeCADGui.supportedLocales(), total=40>:
+# 	{'English': 'en', 'Afrikaans': 'af', 'Arabic': 'ar', 'Basque': 'eu', 'Belarusian': 'be',
+# 	'Bulgarian': 'bg', 'Catalan': 'ca', 'Chinese Simplified': 'zh-CN',
+# 	'Chinese Traditional': 'zh-TW', 'Croatian': 'hr', 'Czech': 'cs', 'Dutch': 'nl',
+# 	'Filipino': 'fil', 'Finnish': 'fi', 'French': 'fr', 'Galician': 'gl', 'Georgian': 'ka',
+# 	'German': 'de', 'Greek': 'el', 'Hungarian': 'hu', 'Indonesian': 'id', 'Italian': 'it',
+# 	'Japanese': 'ja', 'Kabyle': 'kab', 'Korean': 'ko', 'Lithuanian': 'lt', 'Norwegian': 'no',
+# 	'Polish': 'pl', 'Portuguese': 'pt-PT', 'Portuguese, Brazilian': 'pt-BR', 'Romanian': 'ro',
+# 	'Russian': 'ru', 'Serbian': 'sr', 'Serbian, Latin': 'sr-CS', 'Slovak': 'sk',
+# 	'Slovenian': 'sl', 'Spanish': 'es-ES', 'Spanish, Argentina': 'es-AR', 'Swedish': 'sv-SE',
+# 	'Turkish': 'tr', 'Ukrainian': 'uk', 'Valencian': 'val-ES', 'Vietnamese': 'vi'}
+#
+# NOTE: WORKFLOW
+# 0. Install Qt tools
+# 	Debian-based (e.g., Ubuntu): $ sudo apt-get install qttools5-dev-tools pyqt5-dev-tools
+# 	Fedora-based: $ sudo dnf install qt5-linguist qt5-devel
+# 	Arch-based: $ sudo pacman -S qt5-tools python-pyqt5
+# 1. Make the script executable
+# 	$ chmod +x update_translation.sh
+# 2. Execute the script passing the locale code as first parameter
+# 	The script has to be executed within the `resources/translations` directory
+# 	Only update the files you're translating!
+# 	$ ./update_translation.sh es-ES
+# 3. Do the translation via Qt Linguist and use `File>Release`
+# 4. If releasing with the script execute the script passing the locale code as first parameter
+# 	and use '-r' flag next
+# 	$ ./update_translation.sh es-ES -r
+#
+# --------------------------------------------------------------------------------------------------
+
+supported_locales=(
+	"en" "af" "ar" "eu" "be" "bg" "ca" "zh-CN" "zh-TW" "hr"
+	"cs" "nl" "fil" "fi" "fr" "gl" "ka" "de" "el" "hu"
+	"id" "it" "ja" "kab" "ko" "lt" "no" "pl" "pt-PT" "pt-BR"
+	"ro" "ru" "sr" "es-ES" "es-AR" "sv-SE" "tr" "uk" "val-ES" "vi"
+)
+
+is_locale_supported() {
+	local locale="$1"
+	for supported_locale in "${supported_locales[@]}"; do
+		if [[ "$supported_locale" == "$locale" ]]; then
+			return 0
+		fi
+	done
+	return 1
+}
+
+get_strings() {
+	# Get translatable strings from ../ui/*.ui Qt Designer files
+	# lupdate ../ui/*.ui -ts uifiles.ts -no-obsolete
+	# Get translatable strings from ../../*.py Python files
+	pylupdate5 ../../*.py -ts pyfiles.ts -verbose
+}
+
+delete_files() {
+	# Delete files that are no longer needed
+	# rm uifiles.ts
+	rm pyfiles.ts
+	rm -f ${WB}.ts
+}
+
+add_new_locale() {
+	echo -e "\033[1;33m\n\t<<< Creating '${WB}_${LOCALE}.ts' file >>>\n\033[m"
+	get_strings
+	# Join strings from Qt Designer and Python files
+	# lconvert -i uifiles.ts pyfiles.ts -o ${WB}_${LOCALE}.ts
+	lconvert -source-language en -target-language $LOCALE \
+		-i pyfiles.ts -o ${WB}_${LOCALE}.ts
+}
+
+update_locale() {
+	echo -e "\033[1;32m\n\t<<< Updating '${WB}_${LOCALE}.ts' file >>>\n\033[m"
+	get_strings
+	# Join strings from Qt Designer and Python files
+	# lconvert -i uifiles.ts pyfiles.ts -o ${WB}.ts
+	lconvert -i pyfiles.ts -o ${WB}.ts
+	# Join newly created file with older file ( -no-obsolete)
+	lconvert -source-language en -target-language $LOCALE \
+		-i ${WB}.ts ${WB}_${LOCALE}.ts -o ${WB}_${LOCALE}.ts
+}
+
+release_translation() {
+	# Release translation (creation of *.qm file from *.ts file)
+	lrelease ${WB}_${LOCALE}.ts
+}
+
+# Main function ------------------------------------------------------------------------------------
+
+WB="robossembler"
+LOCALE="$1"
+
+if is_locale_supported "$LOCALE"; then
+	if [ "$2" == "-r" ]; then
+		release_translation
+	else
+		if [ ! -f "${WB}_${LOCALE}.ts" ]; then
+			add_new_locale
+		else
+			update_locale
+		fi
+		delete_files
+	fi
+else
+	echo "Verify your language code. Case sensitive."
+	echo "If it's correct ask a maintainer to add support for your language on FreeCAD."
+fi

freecad_workbench/freecad/robossembler/resources/translations/workbench_starterkit_es-ES.ts

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE TS>
+<TS version="2.1" language="es_ES" sourcelanguage="en">
+<context>
+    <name>Console</name>
+    <message>
+        <location filename="../../init_gui.py" line="30"/>
+        <source>Switching to robossembler</source>
+        <translation>Cambiando a entorno de trabajo cool</translation>
+    </message>
+    <message>
+        <location filename="../../init_gui.py" line="32"/>
+        <source>Run a numpy function:</source>
+        <translation>Ejecutar una función de numpy</translation>
+    </message>
+</context>
+<context>
+    <name>Menu</name>
+    <message>
+        <location filename="../../init_gui.py" line="36"/>
+        <source>Tools</source>
+        <translation>Herramientas</translation>
+    </message>
+</context>
+<context>
+    <name>Toolbar</name>
+    <message>
+        <location filename="../../init_gui.py" line="35"/>
+        <source>Tools</source>
+        <translation>Herramientas</translation>
+    </message>
+</context>
+<context>
+    <name>cool</name>
+    <message>
+        <location filename="../../init_gui.py" line="12"/>
+        <source>template workbench</source>
+        <translation>Entorno de trabajo plantilla</translation>
+    </message>
+    <message>
+        <location filename="../../init_gui.py" line="13"/>
+        <source>a simple template workbench</source>
+        <translation>Una plantilla simple de entorno de trabajo</translation>
+    </message>
+</context>
+</TS>