Files
create/src/Mod/Path/InitGui.py
2022-02-28 21:02:45 -08:00

335 lines
13 KiB
Python

# ***************************************************************************
# * Copyright (c) 2014 Yorik van Havre <yorik@uncreated.net> *
# * *
# * This file is part of the FreeCAD CAx development system. *
# * *
# * 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. *
# * *
# * FreeCAD 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 Library General Public *
# * License along with FreeCAD; if not, write to the Free Software *
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
# * USA *
# * *
# ***************************************************************************
class PathCommandGroup:
def __init__(self, cmdlist, menu, tooltip=None):
self.cmdlist = cmdlist
self.menu = menu
if tooltip is None:
self.tooltip = menu
else:
self.tooltip = tooltip
def GetCommands(self):
return tuple(self.cmdlist)
def GetResources(self):
return {"MenuText": self.menu, "ToolTip": self.tooltip}
def IsActive(self):
if FreeCAD.ActiveDocument is not None:
for o in FreeCAD.ActiveDocument.Objects:
if o.Name[:3] == "Job":
return True
return False
class PathWorkbench(Workbench):
"Path workbench"
def __init__(self):
self.__class__.Icon = (
FreeCAD.getResourceDir() + "Mod/Path/Resources/icons/PathWorkbench.svg"
)
self.__class__.MenuText = "Path"
self.__class__.ToolTip = "Path workbench"
def Initialize(self):
global PathCommandGroup
# Add preferences pages - before loading PathGui to properly order pages of Path group
from PathScripts import PathPreferencesPathJob, PathPreferencesPathDressup
translate = FreeCAD.Qt.translate
FreeCADGui.addPreferencePage(PathPreferencesPathJob.JobPreferencesPage, "Path")
FreeCADGui.addPreferencePage(
PathPreferencesPathDressup.DressupPreferencesPage, "Path"
)
# Check enablement of experimental features
from PathScripts import PathPreferences
# load the builtin modules
import Path
import PathScripts
import PathGui
from PySide import QtCore, QtGui
FreeCADGui.addLanguagePath(":/translations")
FreeCADGui.addIconPath(":/icons")
from PathScripts import PathGuiInit
from PathScripts import PathJobCmd
from PathScripts import PathToolBitCmd
from PathScripts import PathToolBitLibraryCmd
from PySide.QtCore import QT_TRANSLATE_NOOP
import PathCommands
PathGuiInit.Startup()
# build commands list
projcmdlist = ["Path_Job", "Path_Post"]
toolcmdlist = [
"Path_Inspect",
"Path_Simulator",
"Path_SelectLoop",
"Path_OpActiveToggle",
]
prepcmdlist = [
"Path_Fixture",
"Path_Comment",
"Path_Stop",
"Path_Custom",
"Path_Probe",
]
twodopcmdlist = [
"Path_Profile",
"Path_Pocket_Shape",
"Path_Drilling",
"Path_MillFace",
"Path_Helix",
"Path_Adaptive",
]
threedopcmdlist = ["Path_Pocket3D"]
engravecmdlist = ["Path_Engrave", "Path_Deburr", "Path_Vcarve"]
modcmdlist = ["Path_OperationCopy", "Path_Array", "Path_SimpleCopy"]
dressupcmdlist = [
"Path_DressupAxisMap",
"Path_DressupPathBoundary",
"Path_DressupDogbone",
"Path_DressupDragKnife",
"Path_DressupLeadInOut",
"Path_DressupRampEntry",
"Path_DressupTag",
"Path_DressupZCorrect",
]
extracmdlist = []
# modcmdmore = ["Path_Hop",]
# remotecmdlist = ["Path_Remote"]
specialcmdlist = []
if PathPreferences.toolsUseLegacyTools():
toolcmdlist.append("Path_ToolLibraryEdit")
toolbitcmdlist = []
else:
toolcmdlist.extend(PathToolBitLibraryCmd.BarList)
toolbitcmdlist = PathToolBitLibraryCmd.MenuList
engravecmdgroup = ["Path_EngraveTools"]
FreeCADGui.addCommand(
"Path_EngraveTools",
PathCommandGroup(
engravecmdlist,
QT_TRANSLATE_NOOP("Path_EngraveTools", "Engraving Operations"),
),
)
threedcmdgroup = threedopcmdlist
if PathPreferences.experimentalFeaturesEnabled():
projcmdlist.append("Path_Sanity")
prepcmdlist.append("Path_Shape")
extracmdlist.extend(["Path_Area", "Path_Area_Workplane"])
specialcmdlist.append("Path_ThreadMilling")
twodopcmdlist.append("Path_Slot")
if PathPreferences.advancedOCLFeaturesEnabled():
try:
import ocl
from PathScripts import PathSurfaceGui
from PathScripts import PathWaterlineGui
threedopcmdlist.extend(["Path_Surface", "Path_Waterline"])
threedcmdgroup = ["Path_3dTools"]
FreeCADGui.addCommand(
"Path_3dTools",
PathCommandGroup(
threedopcmdlist,
QT_TRANSLATE_NOOP("Path_3dTools", "3D Operations"),
),
)
except ImportError:
if not PathPreferences.suppressOpenCamLibWarning():
FreeCAD.Console.PrintError("OpenCamLib is not working!\n")
self.appendToolbar(QT_TRANSLATE_NOOP("Workbench", "Project Setup"), projcmdlist)
self.appendToolbar(QT_TRANSLATE_NOOP("Workbench", "Tool Commands"), toolcmdlist)
self.appendToolbar(
QT_TRANSLATE_NOOP("Workbench", "New Operations"),
twodopcmdlist + engravecmdgroup + threedcmdgroup,
)
self.appendToolbar(
QT_TRANSLATE_NOOP("Workbench", "Path Modification"), modcmdlist
)
if extracmdlist:
self.appendToolbar(
QT_TRANSLATE_NOOP("Workbench", "Helpful Tools"), extracmdlist
)
self.appendMenu(
[QT_TRANSLATE_NOOP("Workbench", "&Path")],
projcmdlist
+ ["Path_ExportTemplate", "Separator"]
+ toolcmdlist
+ toolbitcmdlist
+ ["Separator"]
+ twodopcmdlist
+ engravecmdlist
+ ["Separator"]
+ threedopcmdlist
+ ["Separator"],
)
self.appendMenu(
[
QT_TRANSLATE_NOOP("Workbench", "&Path"),
QT_TRANSLATE_NOOP("Workbench", "Path Dressup"),
],
dressupcmdlist,
)
self.appendMenu(
[
QT_TRANSLATE_NOOP("Workbench", "&Path"),
QT_TRANSLATE_NOOP("Workbench", "Supplemental Commands"),
],
prepcmdlist,
)
self.appendMenu(
[
QT_TRANSLATE_NOOP("Workbench", "&Path"),
QT_TRANSLATE_NOOP("Workbench", "Path Modification"),
],
modcmdlist,
)
if specialcmdlist:
self.appendMenu(
[
QT_TRANSLATE_NOOP("Workbench", "&Path"),
QT_TRANSLATE_NOOP("Workbench", "Specialty Operations"),
],
specialcmdlist,
)
if extracmdlist:
self.appendMenu([QT_TRANSLATE_NOOP("Workbench", "&Path")], extracmdlist)
self.appendMenu([QT_TRANSLATE_NOOP("Workbench", "&Path")], ["Separator"])
self.appendMenu(
[
QT_TRANSLATE_NOOP("Workbench", "&Path"),
QT_TRANSLATE_NOOP("Workbench", "Utils"),
],
["Path_PropertyBag"],
)
self.dressupcmds = dressupcmdlist
curveAccuracy = PathPreferences.defaultLibAreaCurveAccuracy()
if curveAccuracy:
Path.Area.setDefaultParams(Accuracy=curveAccuracy)
# keep this one the last entry in the preferences
import PathScripts.PathPreferencesAdvanced as PathPreferencesAdvanced
FreeCADGui.addPreferencePage(
PathPreferencesAdvanced.AdvancedPreferencesPage, "Path"
)
Log("Loading Path workbench... done\n")
# Warn user if current schema doesn't use minute for time in velocity
if not PathPreferences.suppressVelocity():
velString = FreeCAD.Units.Quantity(
1, FreeCAD.Units.Velocity
).getUserPreferred()[2][3:]
if velString != "min":
current_schema = FreeCAD.Units.listSchemas(FreeCAD.Units.getSchema())
msg = translate(
"Path",
f"The currently selected unit schema: \n '{current_schema}'\n Does not use 'minutes' for velocity values. \n \nCNC machines require feed rate to be expressed in \nunit/minute. To ensure correct gcode: \nSelect a minute-based schema in preferences.\nFor example:\n 'Metric, Small Parts & CNC'\n 'US Customary'\n 'Imperial Decimal'",
)
header = translate("Path", "Warning")
msgbox = QtGui.QMessageBox(QtGui.QMessageBox.Warning, header, msg)
msgbox.addButton(translate("Path", "Ok"), QtGui.QMessageBox.AcceptRole)
msgbox.exec_()
def GetClassName(self):
return "Gui::PythonWorkbench"
def Activated(self):
# update the translation engine
FreeCADGui.updateLocale()
# Msg("Path workbench activated\n")
def Deactivated(self):
# Msg("Path workbench deactivated\n")
pass
def ContextMenu(self, recipient):
import PathScripts
menuAppended = False
if len(FreeCADGui.Selection.getSelection()) == 1:
obj = FreeCADGui.Selection.getSelection()[0]
if obj.isDerivedFrom("Path::Feature"):
self.appendContextMenu("", "Separator")
self.appendContextMenu("", ["Path_Inspect"])
selectedName = obj.Name
if "Remote" in selectedName:
self.appendContextMenu("", ["Refresh_Path"])
if "Job" in selectedName:
self.appendContextMenu(
"", ["Path_ExportTemplate"] + self.toolbitctxmenu
)
menuAppended = True
if isinstance(obj.Proxy, PathScripts.PathOp.ObjectOp):
self.appendContextMenu(
"", ["Path_OperationCopy", "Path_OpActiveToggle"]
)
menuAppended = True
if obj.isDerivedFrom("Path::Feature"):
if (
"Profile" in selectedName
or "Contour" in selectedName
or "Dressup" in selectedName
):
self.appendContextMenu("", "Separator")
# self.appendContextMenu("", ["Set_StartPoint"])
# self.appendContextMenu("", ["Set_EndPoint"])
for cmd in self.dressupcmds:
self.appendContextMenu("", [cmd])
menuAppended = True
if isinstance(obj.Proxy, PathScripts.PathToolBit.ToolBit):
self.appendContextMenu("", ["Path_ToolBitSave", "Path_ToolBitSaveAs"])
menuAppended = True
if menuAppended:
self.appendContextMenu("", "Separator")
Gui.addWorkbench(PathWorkbench())
FreeCAD.addImportType("GCode (*.nc *.gc *.ncc *.ngc *.cnc *.tap *.gcode)", "PathGui")