added edit mode with task panel UI

Author: chbergmann

Feature1.py Feature1/Feature1.py

@@ -5,13 +5,12 @@
 __license__ = "LGPL 2.1"
 __doc__ = "An example for a workbench feature"
 
-import PythonWorkbenchTemplate
 import os
 import FreeCADGui
 import FreeCAD
-from FreeCAD import Vector
-import Part
 
+__dir__ = os.path.dirname(__file__)
+__iconpath__ = os.path.join(__dir__, 'feature1.svg')
 
 class Feature1Worker:
     def __init__(self, 
@@ -44,7 +43,7 @@ def __init__(self, vobj):
 
     def getIcon(self):
         '''Return the icon which will appear in the tree view. This method is optional and if not defined a default icon is shown.'''
-        return (os.path.join(PythonWorkbenchTemplate.get_module_path(), "Resources", "icons", "feature1.svg"))
+        return __iconpath__
 
     def attach(self, vobj):
         '''Setup the scene sub-graph of the view provider, this method is mandatory'''
@@ -67,29 +66,79 @@ def onChanged(self, fp, prop):
         '''Here we can do something when a single property got changed'''
         pass
 
+    def setEdit(self, vobj=None, mode=0):
+        '''Enter edit mode when double clicking onto the feature. Optional.'''
+        # Create a task panel UI
+        self.panel = Feature1TaskPanel(self.Object)
+        FreeCADGui.Control.showDialog(self.panel)
+        return True
+        
     def __getstate__(self):
         '''When saving the document this object gets stored using Python's json module.\
                 Since we have some un-serializable parts here -- the Coin stuff -- we must define this method\
                 to return a tuple of all serializable objects or None.'''
         return None
 
-    def __setstate__(self,state):
+    def __setstate__(self, state):
         '''When restoring the serialized object from document we have the chance to set some internals here.\
                 Since no data were serialized nothing needs to be done here.'''
         return None
+    
 
+class Feature1TaskPanel:
+    def __init__(self, fp):
+        self.fp = fp
+        # this will create a Qt widget from our ui file
+        self.form = FreeCADGui.PySideUic.loadUi(os.path.join(__dir__, 'feature1.ui'))
+        # connect controls from the .ui file to class methods
+        self.form.pushButtonSelect.pressed.connect(self._selectPart)
+        self.form.radioButtonRed.released.connect(self._changeColor)
+        self.form.radioButtonGreen.released.connect(self._changeColor)
+        if self.fp.Base:
+            self.form.labelSelected.setText(self.fp.Base.Name)
 
+    def accept(self):
+        '''called when the OK button in the task panel is pressed'''
+        self.fp.Base = FreeCAD.ActiveDocument.getObject(self.form.labelSelected.text())
+        self.fp.Green = self.form.radioButtonGreen.isChecked()
+        
+        redrawFeature1(self.fp)
+        FreeCADGui.ActiveDocument.resetEdit()
+        return True
+        
+    def reject(self):
+        '''called when the Cancel button in the task panel is pressed'''
+        FreeCADGui.ActiveDocument.resetEdit()
+        return True
+    
+    def _selectPart(self):
+        '''called when the Select Part button defined in the .ui file is pressed'''
+        selection = FreeCADGui.Selection.getSelectionEx()
+        if len(selection) > 0:
+            self.fp.Base = FreeCAD.ActiveDocument.getObject(selection[0].ObjectName)
+            self.form.labelSelected.setText(selection[0].ObjectName)
+            
+    def _changeColor(self):
+        '''called when a radio button defined in the .ui file is pressed'''
+        self.fp.Green = self.form.radioButtonGreen.isChecked()
+        changeFeature1Color(self.fp)
+        
+       
 def redrawFeature1(fp):
     # check plausibility of all parameters
     if not fp.Base:
         return
 
     # fp.Shape contains the newly created object
     fp.Shape = fp.Base.Shape.copy()
+    fp.Placement = fp.Base.Placement
+    # place the new object on top of the selected one
+    fp.Placement.Base.z += fp.Base.Shape.BoundBox.ZLength
+    
     changeFeature1Color(fp)
 
 
-def changeFeature1Color(fp):       
+def changeFeature1Color(fp):   
     if fp.Green:
         fp.ViewObject.ShapeColor = (0.00, 1.00, 0.00)
     else:
@@ -122,9 +171,9 @@ def IsActive(self):
 
     def GetResources(self):
         '''Return the icon which will appear in the tree view. This method is optional and if not defined a default icon is shown.'''
-        return {'Pixmap'  : os.path.join(PythonWorkbenchTemplate.get_module_path(), "Resources", "icons", "feature1.svg"),
+        return {'Pixmap'  : __iconpath__,
                 'Accel' : "", # a default shortcut (optional)
                 'MenuText': "Feature1",
-                'ToolTip' : "A template for a workbench feature" }
+                'ToolTip' : __doc__ }
 
 FreeCADGui.addCommand('Feature1', Feature1())

Resources/icons/feature1.svg Feature1/feature1.svg

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Form</class>
+ <widget class="QWidget" name="Form">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>287</width>
+    <height>90</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <widget class="QPushButton" name="pushButtonSelect">
+     <property name="text">
+      <string>Select Part</string>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QLabel" name="labelSelected">
+     <property name="text">
+      <string>&lt;nothing selected&gt;</string>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QRadioButton" name="radioButtonRed">
+     <property name="text">
+      <string>red</string>
+     </property>
+     <property name="checked">
+      <bool>true</bool>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QRadioButton" name="radioButtonGreen">
+     <property name="text">
+      <string>green</string>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

Feature1/feature1.ui

@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
 
-__title__ = "FreeCAD Default Workbench - Init file"
+__title__ = "FreeCAD Python Workbench Template - Init file"
 __author__ = "Christian Bergmann"
 __url__ = ["http://www.freecadweb.org"]
+__doc__ = "A template for a new workbench"
 __version__ = "0.0.1"
 
 
@@ -12,16 +13,16 @@ def __init__(self):
         import PythonWorkbenchTemplate
         self.__class__.MenuText = "PythonWorkbenchTemplate"
         self.__class__.ToolTip = "A template for a new workbench"
-        self.__class__.Icon = os.path.join(PythonWorkbenchTemplate.get_module_path(), "Resources", "icons", "freecad.svg")
+        self.__class__.Icon = os.path.join(PythonWorkbenchTemplate.get_module_path(), "freecad.svg")
 
     def Initialize(self):
         "This function is executed when FreeCAD starts"
         # import here all the needed files that create your FreeCAD commands
-        import Feature1
+        from Feature1 import Feature1
 
         self.list = ["Feature1"] # A list of command names created in the line above
-        self.appendToolbar("Curved Shapes", self.list) # creates a new toolbar with your commands
-        self.appendMenu("Curved Shapes", self.list) # creates a new menu
+        self.appendToolbar("PythonWorkbenchTemplate", self.list) # creates a new toolbar with your commands
+        self.appendMenu("PythonWorkbenchTemplate", self.list) # creates a new menu
 
     def Activated(self):
         "This function is executed when the workbench is activated"
@@ -34,10 +35,11 @@ def Deactivated(self):
     def ContextMenu(self, recipient):
         "This is executed whenever the user right-clicks on screen"
         # "recipient" will be either "view" or "tree"
-        self.appendContextMenu("Curved Shapes", self.list) # add commands to the context menu
+        self.appendContextMenu(self.__class__.MenuText, self.list) # add commands to the context menu
 
     def GetClassName(self): 
         # this function is mandatory if this is a full python workbench
         return "Gui::PythonWorkbench"
+    
 
-Gui.addWorkbench(PythonWorkbenchTemplate())
+Gui.addWorkbench(PythonWorkbenchTemplate())

InitGui.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 import os
 import FreeCAD
 from importlib import reload
@@ -12,12 +14,13 @@ def get_module_path():
 
 
 def makeFeature1(base = None, green = False):
-    '''Python command to create a Feature1'''
-    import Feature1      
-    reload(Feature1)     # causes FreeCAD to reload Feature1.py every time a new Feature1 is created.       
+    '''Python command to create a Feature1.'''
+    from Feature1 import Feature1      
+    reload(Feature1)     # causes FreeCAD to reload Feature1.py every time a new Feature1 is created. Useful while developping the feature.      
     fp = FreeCAD.ActiveDocument.addObject("Part::FeaturePython", "Feature1")
     Feature1.Feature1Worker(fp, base, green)
-    Feature1.Feature1ViewProvider(fp.ViewObject)
+    vp = Feature1.Feature1ViewProvider(fp.ViewObject)
     FreeCAD.ActiveDocument.recompute()
+    vp.setEdit(fp)
     return fp
 

PythonWorkbenchTemplate.py

@@ -25,6 +25,7 @@ When you restart FreeCAD, "Python Workbench Template" workbench should now show
 - Edit InitGui.py. Delete Feature1 and add your new feature instead. Edit the \__title\__, \__author\__, \__url\__ and \__version\__ tags.
 - Write your new feature and test it well.
 - Write a documentation in README.md. Explain the purpose of your workbench. Explain your features. Screenshots are great.
+- Draw a .svg icon for the workbench and for each feature. You can export FreeCAD designs to .svg.
 - Announce your workbench in the [FreeCAD forum](https://forum.freecadweb.org/index.php). Add the link of your new thread in README.md
 - Add your workbench to the [Addon manager](https://github.com/FreeCAD/FreeCAD-addons)