Arch: Started implementing Arch Reference

src/Mod/Arch/Arch.py

@@ -63,3 +63,4 @@
 from ArchPrecast import *
 from ArchPipe import *
 from ArchBuildingPart import *
+from ArchReference import *

src/Mod/Arch/ArchReference.py

@@ -0,0 +1,295 @@
+#***************************************************************************
+#*                                                                         *
+#*   Copyright (c) 2018 Yorik van Havre <yorik@uncreated.net>              *
+#*                                                                         *
+#*   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                                                                   *
+#*                                                                         *
+#***************************************************************************
+
+__title__="FreeCAD Arch External Reference"
+__author__ = "Yorik van Havre"
+__url__ = "http://www.freecadweb.org"
+
+
+import FreeCAD,os,zipfile,re
+if FreeCAD.GuiUp:
+    import FreeCADGui
+    from PySide import QtCore, QtGui
+    from DraftTools import translate
+    from PySide.QtCore import QT_TRANSLATE_NOOP
+else:
+    # \cond
+    def translate(ctxt,txt, utf8_decode=False):
+        return txt
+    def QT_TRANSLATE_NOOP(ctxt,txt):
+        return txt
+    # \endcond
+
+## @package ArchReference
+#  \ingroup ARCH
+#  \brief The Reference object and tools
+#
+#  This module provides tools to build Reference objects.
+#  References can take a shape from a Part-based object in
+#  another file.
+
+
+
+def makeReference(filepath=None,partname=None,name="External Reference"):
+
+
+    "makeReference([filepath,partname]): Creates an Arch Reference object"
+
+    if not FreeCAD.ActiveDocument:
+        FreeCAD.Console.PrintError("No active document. Aborting\n")
+        return
+    obj = FreeCAD.ActiveDocument.addObject("Part::FeaturePython","ArchReference")
+    obj.Label = name
+    ArchReference(obj)
+    if FreeCAD.GuiUp:
+        ViewProviderArchReference(obj.ViewObject)
+    if filepath:
+        obj.File = filepath
+    if partname:
+        obj.Part = partname
+    import Draft
+    Draft.select(obj)
+    return obj
+
+
+
+class ArchReference:
+
+
+    "The Arch Reference object"
+
+    def __init__(self,obj):
+
+        obj.Proxy = self
+        ArchReference.setProperties(self,obj)
+        self.Type = "Reference"
+
+    def setProperties(self,obj):
+
+        pl = obj.PropertiesList
+        if not "File" in pl:
+            obj.addProperty("App::PropertyFile","File","Component",QT_TRANSLATE_NOOP("App::Property","The base file this component is built upon"))
+        if not "Part" in pl:
+            obj.addProperty("App::PropertyString","Part","Component",QT_TRANSLATE_NOOP("App::Property","The part to use from the base file"))
+        self.Type = "Reference"
+
+    def onDocumentRestored(self,obj):
+
+        ArchReference.setProperties(self,obj)
+
+    def __getstate__(self):
+
+        return None
+
+    def __setstate__(self,state):
+
+        return None
+
+    def execute(self,obj):
+
+        if obj.File and obj.Part:
+            self.parts = self.getPartsList(obj)
+            if self.parts:
+                zdoc = zipfile.ZipFile(obj.File)
+                if zdoc:
+                    if obj.Part in self.parts:
+                        if self.parts[obj.Part] in zdoc.namelist():
+                            f = zdoc.open(self.parts[obj.Part])
+                            shapedata = f.read()
+                            f.close()
+                            import Part
+                            shape = Part.Shape()
+                            shape.importBrepFromString(shapedata)
+                            obj.Shape = shape
+                        else:
+                            print("Part not found in file")
+        return True
+
+    def getPartsList(self,obj,filename=None):
+
+        parts = {}
+        if not filename:
+            filename = obj.File
+        if not filename:
+            return parts
+        if not filename.lower().endswith(".fcstd"):
+            return parts
+        if not os.path.exists(filename):
+            return parts
+        zdoc = zipfile.ZipFile(filename)
+        with zdoc.open("Document.xml") as docf:
+            label = None
+            part = None
+            writemode = False
+            for line in docf:
+                if "<Property name=\"Label\"" in line:
+                    writemode = True
+                elif writemode and "<String value=" in line:
+                    n = re.findall('value=\"(.*?)\"',line)
+                    if n:
+                        label = n[0]
+                        writemode = False
+                elif "<Property name=\"Shape\" type=\"Part::PropertyPartShape\"" in line:
+                    writemode = True
+                elif writemode and "<Part file=" in line:
+                    n = re.findall('file=\"(.*?)\"',line)
+                    if n:
+                        part = n[0]
+                        writemode = False
+                if label and part:
+                    parts[label] = part
+                    label = None
+                    part = None
+        return parts
+
+
+
+class ViewProviderArchReference:
+
+
+    "A View Provider for the Arch Reference object"
+
+    def __init__(self,vobj):
+
+        vobj.Proxy = self
+
+    def getIcon(self):
+
+        import Arch_rc
+        return ":/icons/Arch_Reference.svg"
+
+    def setEdit(self,vobj,mode=0):
+
+        taskd = ArchReferenceTaskPanel(vobj.Object)
+        FreeCADGui.Control.showDialog(taskd)
+        return True
+
+    def unsetEdit(self,vobj,mode):
+
+        FreeCADGui.Control.closeDialog()
+        return
+
+    def doubleClicked(self,vobj):
+
+        self.setEdit(vobj)
+
+    def __getstate__(self):
+
+        return None
+
+    def __setstate__(self,state):
+
+        return None
+
+
+
+class ArchReferenceTaskPanel:
+
+
+    '''The editmode TaskPanel for Axis objects'''
+
+    def __init__(self,obj):
+
+        self.obj = obj
+        self.filename = None
+        self.form = QtGui.QWidget()
+        self.form.setWindowTitle("External reference")
+        layout = QtGui.QVBoxLayout(self.form)
+        label1 = QtGui.QLabel("External file:")
+        layout.addWidget(label1)
+        self.fileButton = QtGui.QPushButton(self.form)
+        layout.addWidget(self.fileButton)
+        label2 = QtGui.QLabel("Part to use:")
+        layout.addWidget(label2)
+        if self.obj.File:
+            self.fileButton.setText(os.path.basename(self.obj.File))
+        else:
+            self.fileButton.setText("Choose file...")
+        self.partCombo = QtGui.QComboBox(self.form)
+        layout.addWidget(self.partCombo)
+        if hasattr(self.obj.Proxy,"parts"):
+            parts = self.obj.Proxy.parts
+        else:
+            parts = self.obj.Proxy.getPartsList(self.obj)
+            keys = parts.keys()
+        self.partCombo.addItems(keys)
+        if self.obj.Part:
+            if self.obj.Part in keys:
+                self.partCombo.setCurrentIndex(keys.index(self.obj.Part))
+        QtCore.QObject.connect(self.fileButton, QtCore.SIGNAL("clicked()"), self.chooseFile)
+
+    def chooseFile(self):
+
+        loc = QtCore.QDir.homePath()
+        if self.obj.File:
+            loc = os.path.dirname(self.obj.File)
+        f = QtGui.QFileDialog.getOpenFileName(self.form,'Choose reference file',loc,"FreeCAD standard files (*.FCStd)")
+        if f:
+            self.filename = f[0]
+            self.fileButton.setText(os.path.basename(self.filename))
+            parts = self.obj.Proxy.getPartsList(self.obj,self.filename)
+            if parts:
+                keys = parts.keys()
+                self.partCombo.clear()
+                self.partCombo.addItems(keys)
+                if self.obj.Part:
+                    if self.obj.Part in keys:
+                        self.partCombo.setCurrentIndex(keys.index(self.obj.Part))
+
+    def accept(self):
+
+        if self.filename and self.partCombo.currentText():
+            self.obj.File = self.filename
+            self.obj.Part = self.partCombo.currentText()
+            FreeCAD.ActiveDocument.recompute()
+        return True
+
+
+
+class ArchReferenceCommand:
+
+
+    "the Arch Reference command definition"
+
+    def GetResources(self):
+
+        return {'Pixmap'  : 'Arch_Reference',
+                'MenuText': QtCore.QT_TRANSLATE_NOOP("Arch_Reference","External reference"),
+                'ToolTip': QtCore.QT_TRANSLATE_NOOP("Arch_Reference","Creates an external reference object")}
+
+    def IsActive(self):
+
+        return not FreeCAD.ActiveDocument is None
+
+    def Activated(self):
+
+        FreeCADGui.Control.closeDialog()
+        FreeCAD.ActiveDocument.openTransaction(translate("Arch","Create external reference"))
+        FreeCADGui.addModule("Arch")
+        FreeCADGui.addModule("Draft")
+        FreeCADGui.doCommand("obj = Arch.makeReference()")
+        FreeCADGui.doCommand("Draft.autogroup(obj)")
+        FreeCAD.ActiveDocument.commitTransaction()
+        FreeCADGui.doCommand("obj.ViewObject.startEditing()")
+
+if FreeCAD.GuiUp:
+    FreeCADGui.addCommand('Arch_Reference', ArchReferenceCommand())

src/Mod/Arch/CMakeLists.txt

@@ -41,6 +41,7 @@ SET(Arch_SRCS
     ArchPipe.py
     ArchNesting.py
     ArchBuildingPart.py
+    ArchReference.py
 )
 
 SET(Dice3DS_SRCS

src/Mod/Arch/InitGui.py

@@ -34,7 +34,7 @@ def Initialize(self):
 
         # arch tools
         self.archtools = ["Arch_Wall","Arch_Structure","Arch_Rebar","Arch_BuildingPart",
-                     "Arch_Floor","Arch_Building","Arch_Site",
+                     "Arch_Floor","Arch_Building","Arch_Site","Arch_Reference",
                      "Arch_Window","Arch_Roof","Arch_AxisTools",
                      "Arch_SectionPlane","Arch_Space","Arch_Stairs",
                      "Arch_PanelTools","Arch_Equipment",

src/Mod/Arch/Resources/Arch.qrc

@@ -86,6 +86,7 @@
         <file>icons/Arch_BuildingPart.svg</file>
         <file>icons/Arch_BuildingPart_Tree.svg</file>
         <file>icons/Arch_Profile.svg</file>
+        <file>icons/Arch_Reference.svg</file>
         <file>ui/ParametersWindowDouble.svg</file>
         <file>ui/ParametersWindowSimple.svg</file>
         <file>ui/ParametersWindowFixed.svg</file>