OsePipingCommands.py

# ***************************************************************************
# *                                                                         *
# *  This file is part of the FreeCAD_Workbench_Starter project.            *
# *                                                                         *
# *                                                                         *
# *  Copyright (C) 2017                                                     *
# *  Stephen Kaiser <freesol29@gmail.com>                                   *
# *                                                                         *
# *  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 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, If not, see                   *
# *  <http://www.gnu.org/licenses/>.                                        *
# *                                                                         *
# *                                                                         *
# ***************************************************************************

import FreeCAD
from FreeCAD import Gui
import FreeCADGui

import OsePipingBase
import OsePiping.CouplingGui as CouplingGui
import OsePiping.PipeGui as PipeGui
import OsePiping.BushingGui as BushingGui
import OsePiping.TeeGui as TeeGui
import OsePiping.CornerGui as CornerGui
import OsePiping.ElbowGui as ElbowGui
import OsePiping.CrossGui as CrossGui
import OsePiping.SweepElbowGui as SweepElbowGui
import OsePiping.Piping as Piping
import OsePiping.Modification as Modification
import OsePiping.Port as Port
import OsePiping.MoveAroundGui as MoveAroundGui
import OsePiping.MoveToGui as MoveToGui


class OsePiping_PipeClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreatePipe.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a pipe",
                'ToolTip': "Adds a pipe into the center of the document."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument == None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = PipeGui.GuiCheckTable()
 #       FreeCAD.Console.PrintMessage("Showing pipe UI.")
        form = PipeGui.MainDialog(doc, table)
        form.exec_()  # Stand-alone dialog.

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_CouplingClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateCoupling.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a coupling",
                'ToolTip': "Adds a coupling."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = CouplingGui.GuiCheckTable()
        #       FreeCAD.Console.PrintMessage("Showing outer coupling UI.")
        form = CouplingGui.MainDialog(doc, table)
        form.exec_()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_BushingClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateBushing.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a bushing",
                'ToolTip': "Adds a bushing."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = BushingGui.GuiCheckTable()
        #        FreeCAD.Console.PrintMessage("Showing outer bushing UI.")
        form = BushingGui.MainDialog(doc, table)
        form.exec_()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_ElbowClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateElbow.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add an elbow",
                'ToolTip': "Adds an elbow."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = ElbowGui.GuiCheckTable()
#        FreeCAD.Console.PrintMessage("Showing outer elbow UI.")
        form = ElbowGui.MainDialog(doc, table)
        form.exec_()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_SweepElbowClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateSweepElbow.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a sweep elbow",
                'ToolTip': "Adds a sweep elbow."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = SweepElbowGui.GuiCheckTable()
        form = SweepElbowGui.MainDialog(doc, table)
        form.exec_()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_TeeClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateTee.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a tee",
                'ToolTip': "Adds a tee."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = TeeGui.GuiCheckTable()
#        FreeCAD.Console.PrintMessage("Showing outer tee UI.")
        form = TeeGui.MainDialog(doc, table)
        form.exec_()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_CornerClass():

    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateCorner.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a outer corner",
                'ToolTip': "Adds a outer corner."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = CornerGui.GuiCheckTable()
#        FreeCAD.Console.PrintMessage("Showing outer corner UI.")
        form = CornerGui.MainDialog(doc, table)
        form.showForCreation()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_CrossClass():
    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/CreateCross.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Add a cross",
                'ToolTip': "Adds a cross."}

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        doc = FreeCAD.activeDocument()
        # Open a CSV file, check its content, and return it as a CsvTable object.
        table = CrossGui.GuiCheckTable()
#        FreeCAD.Console.PrintMessage("Showing outer corner UI.")
        form = CrossGui.MainDialog(doc, table)
        form.exec_()

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return True


class OsePiping_MoveToClass():
    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/MoveTo.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Move",
                'ToolTip': "Move one Dodo-part to another Dodo-part."}

    def getPort(self, sel):
        obj = sel.Object
        sub = sel.SubObjects[-1]
        ports = Port.extractAdvancedPorts(obj)

        closest_port = Port.getNearestPort(
            obj.Placement, ports, sub.CenterOfMass)
        return closest_port

    def Activated(self):
        "Do something here when button is clicked"
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        # Get the port of the moved object. It is the last but one.
        if len(Gui.Selection.getSelectionEx()) < 2:
            FreeCAD.Console.PrintWarning("Select at least two objects.\n")
            return
        if not Modification.all_selected_parts_have_ports():
            FreeCAD.Console.PrintWarning("All objects must be OSE-Piping objects.\n")
            return
        # Move next to last object to the last object.
        dest_sel = Gui.Selection.getSelectionEx()[-1]
        movable_sel = Gui.Selection.getSelectionEx()[-2]
        FreeCAD.Console.PrintMessage("Trying to move {} to {}...\n".format(
                                     movable_sel.Object.Name, dest_sel.Object.Name))

#        if len(dest_sel.SubObjects) == 0:
#            FreeCAD.Console.PrintWarning("Select a surface or an edge for a destination port.\n")
#            return
#        if len(movable_sel.SubObjects) == 0:
#            FreeCAD.Console.PrintWarning("Select a surface or on edge of a movable part.\n")
#            return

#        dest_port = self.getPort(dest_sel)
#        moveble_port = self.getPort(movable_sel)

#        movable_sel.Object.Placement = moveble_port.getPartPlacement(dest_sel.Object.Placement, dest_port)

        panel = MoveToGui.MoveToPanel()
        Gui.Control.showDialog(panel)
        panel.setupUi()
        return panel

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return (Piping.HasDodoSupport() or Piping.HasFlamingoSupport()) \
            and len(Gui.Selection.getSelectionEx()) >= 2 \
            and Modification.all_selected_parts_have_ports()


class OsePiping_MoveAroundClass():
    def GetResources(self):
        return {'Pixmap': OsePipingBase.ICON_PATH + '/MoveAround.svg',  # the name of a svg file available in the resources
                #                'Accel' : "Shift+S", # a default shortcut (optional)
                'MenuText': "Move Around",
                'ToolTip': "Move around a Dodo-part."}

    def Activated(self):
        # Do something here when button is clicked.
        if Gui.ActiveDocument is None:
            FreeCAD.newDocument()
        panel = MoveAroundGui.MoveAroundPanel()
        Gui.Control.showDialog(panel)
        panel.setupUi()
        return panel

    def IsActive(self):
        """Here you can define if the command must be active or not (greyed) if certain conditions
        are met or not. This function is optional."""
        return len(Gui.Selection.getSelectionEx()) >= 1


Gui.addCommand('OsePiping_Pipe', OsePiping_PipeClass())
Gui.addCommand('OsePiping_Coupling', OsePiping_CouplingClass())
Gui.addCommand('OsePiping_Bushing', OsePiping_BushingClass())
Gui.addCommand('OsePiping_Elbow', OsePiping_ElbowClass())
Gui.addCommand('OsePiping_SweepElbow', OsePiping_SweepElbowClass())
Gui.addCommand('OsePiping_Tee', OsePiping_TeeClass())
Gui.addCommand('OsePiping_Corner', OsePiping_CornerClass())
Gui.addCommand('OsePiping_Cross', OsePiping_CrossClass())
Gui.addCommand('OsePiping_MoveAround', OsePiping_MoveAroundClass())
Gui.addCommand('OsePiping_MoveTo', OsePiping_MoveToClass())