# SPDX-License-Identifier: LGPL-2.1-or-later # *************************************************************************** # * Copyright (c) 2018 sliptonic * # * * # * 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 * # * * # *************************************************************************** from PySide import QtCore, QtGui from collections import Counter import FreeCAD import FreeCADGui import Path import Path.Base.Util as PathUtil import Path.Main.Job as PathJob import Path.Main.Stock as PathStock import glob import os translate = FreeCAD.Qt.translate if False: Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule()) Path.Log.trackModule(Path.Log.thisModule()) else: Path.Log.setLevel(Path.Log.Level.INFO, Path.Log.thisModule()) class _ItemDelegate(QtGui.QStyledItemDelegate): def __init__(self, controller, parent): self.controller = controller QtGui.QStyledItemDelegate.__init__(self, parent) def createEditor(self, parent, option, index): editor = QtGui.QSpinBox(parent) self.controller.setupColumnEditor(index, editor) return editor class JobCreate: DataObject = QtCore.Qt.ItemDataRole.UserRole def __init__(self, parent=None, sel=None): self._warnUserIfNotUsingMinutes() self.dialog = FreeCADGui.PySideUic.loadUi(":/panels/DlgJobCreate.ui") self.itemsSolid = QtGui.QStandardItem(translate("CAM_Job", "Solids")) self.items2D = QtGui.QStandardItem(translate("CAM_Job", "2D")) self.itemsJob = QtGui.QStandardItem(translate("CAM_Job", "Jobs")) self.dialog.templateGroup.hide() self.dialog.modelGroup.hide() # debugging support self.candidates = None self.delegate = None self.index = None self.model = None def _getMinuteBasedSchemas(self): """Dynamically discover which unit schemas support velocity in minutes.""" internal_names = FreeCAD.Units.listSchemas() minute_based_schemes = [] # Create a test velocity quantity q = FreeCAD.Units.Quantity(1, FreeCAD.Units.Velocity) for i, key in enumerate(internal_names): try: label = FreeCAD.Units.listSchemas(i) r = FreeCAD.Units.schemaTranslate(q, i) if "/min" in r[2]: minute_based_schemes.append({"id": i, "label": label}) except (IndexError, TypeError): # Skip invalid schema indices continue return minute_based_schemes def _currentSchemaUsesMinutes(self): """Test if the current unit schema uses minutes for velocity.""" try: # Create a test velocity quantity q = FreeCAD.Units.Quantity(1, FreeCAD.Units.Velocity) # Get current schema's representation of velocity current_representation = q.getUserPreferred()[2] # Check if the current representation contains '/min' return "/min" in current_representation except Exception: # If we can't determine, assume it doesn't use minutes return False def _warnUserIfNotUsingMinutes(self): # Warn user if current schema doesn't use minute for time in velocity if Path.Preferences.suppressVelocity(): return # Test if current schema uses minutes for velocity if self._currentSchemaUsesMinutes(): return # Get all minute-based schemas for the dialog minute_based_schemes = self._getMinuteBasedSchemas() # Create custom dialog with unit schema selection dialog = QtGui.QDialog() dialog.setWindowTitle(translate("CAM_Job", "Warning: Incompatible Unit Schema")) dialog.setModal(True) dialog.resize(500, 400) layout = QtGui.QVBoxLayout(dialog) # Warning message warning_label = QtGui.QLabel() warning_label.setText( translate( "CAM_Job", "This document uses an improper unit schema which can result in " "dangerous situations and machine crashes!", ) ) warning_label.setWordWrap(True) warning_label.setStyleSheet("color: red; font-weight: bold; margin-bottom: 10px;") layout.addWidget(warning_label) # Current schema info current_info = QtGui.QLabel() current_info.setText( translate( "CAM_Job", "Current unit schema '{}' expresses velocity in values per second.", ).format(FreeCAD.ActiveDocument.UnitSystem) ) current_info.setWordWrap(True) layout.addWidget(current_info) # Recommendation recommendation = QtGui.QLabel() recommendation.setText( translate( "CAM_Job", "Please select a unit schema that expresses feed rates per minute instead:", ) ) recommendation.setWordWrap(True) layout.addWidget(recommendation) # Unit schema selection schema_group = QtGui.QGroupBox(translate("CAM_Job", "Recommended Unit Schemas")) schema_layout = QtGui.QVBoxLayout(schema_group) self.schema_buttons = [] for i, schema in enumerate(minute_based_schemes): radio = QtGui.QRadioButton(schema["label"]) radio.setProperty("schema_id", schema["id"]) # Store the schema ID if i == 0: # Select first (most preferred) by default radio.setChecked(True) self.schema_buttons.append(radio) schema_layout.addWidget(radio) layout.addWidget(schema_group) # Additional info info_label = QtGui.QLabel() info_label.setText( translate( "CAM_Job", "Keeping the current unit schema can result in dangerous G-code errors. " "For details please refer to the " "Units section " "of the CAM Workbench's wiki page.", ) ) info_label.setWordWrap(True) info_label.setOpenExternalLinks(True) layout.addWidget(info_label) # Buttons button_layout = QtGui.QHBoxLayout() change_button = QtGui.QPushButton(translate("CAM_Job", "Change Unit Schema")) change_button.setDefault(True) change_button.clicked.connect(lambda: self._applyUnitSchema(dialog)) keep_button = QtGui.QPushButton(translate("CAM_Job", "Keep Current Schema")) keep_button.clicked.connect(dialog.reject) dont_show_button = QtGui.QPushButton(translate("CAM_Job", "Don't Show Again")) dont_show_button.clicked.connect(lambda: self._suppressWarning(dialog)) button_layout.addWidget(change_button) button_layout.addWidget(keep_button) button_layout.addWidget(dont_show_button) layout.addLayout(button_layout) dialog.exec_() def _applyUnitSchema(self, dialog): """Apply the selected unit schema to the document.""" selected_schema_id = None selected_schema_label = None for button in self.schema_buttons: if button.isChecked(): selected_schema_id = button.property("schema_id") selected_schema_label = button.text() break if selected_schema_id is not None: try: FreeCAD.ActiveDocument.UnitSystem = selected_schema_id FreeCAD.ActiveDocument.recompute() # Show success message QtGui.QMessageBox.information( dialog, translate("CAM_Job", "Unit Schema Changed"), translate("CAM_Job", "Unit schema successfully changed to '{}'.").format( selected_schema_label ), ) dialog.accept() except Exception as e: QtGui.QMessageBox.critical( dialog, translate("CAM_Job", "Error"), translate("CAM_Job", "Failed to change unit schema: {}").format(str(e)), ) else: QtGui.QMessageBox.warning( dialog, translate("CAM_Job", "No Selection"), translate("CAM_Job", "Please select a unit schema."), ) def _suppressWarning(self, dialog): """Suppress future warnings and close dialog.""" Path.Preferences.preferences().SetBool(Path.Preferences.WarningSuppressVelocity, True) dialog.reject() def setupTitle(self, title): self.dialog.setWindowTitle(title) def setupModel(self, job=None): if job: preSelected = Counter( [ PathUtil.getPublicObject(job.Proxy.baseObject(job, obj)).Label for obj in job.Model.Group ] ) jobResources = job.Model.Group + [job.Stock] else: preSelected = Counter([obj.Label for obj in FreeCADGui.Selection.getSelection()]) jobResources = [] self.candidates = sorted(PathJob.ObjectJob.baseCandidates(), key=lambda o: o.Label) # If there is only one possibility we might as well make sure it's selected if not preSelected and 1 == len(self.candidates): preSelected = Counter([self.candidates[0].Label]) expandSolids = False expand2Ds = False expandJobs = False for base in self.candidates: if ( base not in jobResources and not PathJob.isResourceClone(job, base, None) and not hasattr(base, "StockType") and base.ViewObject.ShowInTree and base.TypeId != "App::DocumentObjectGroup" ): item0 = QtGui.QStandardItem() item1 = QtGui.QStandardItem() item0.setData(base.Label, QtCore.Qt.EditRole) item0.setData(base, self.DataObject) item0.setCheckable(True) item0.setEditable(False) item1.setEnabled(True) item1.setEditable(True) if base.Label in preSelected: itemSelected = True item0.setCheckState(QtCore.Qt.CheckState.Checked) item1.setData(preSelected[base.Label], QtCore.Qt.EditRole) else: itemSelected = False item0.setCheckState(QtCore.Qt.CheckState.Unchecked) item1.setData(0, QtCore.Qt.EditRole) if PathUtil.isSolid(base): self.itemsSolid.appendRow([item0, item1]) if itemSelected: expandSolids = True else: self.items2D.appendRow([item0, item1]) if itemSelected: expand2Ds = True for j in sorted(PathJob.Instances(), key=lambda x: x.Label): if j != job: item0 = QtGui.QStandardItem() item1 = QtGui.QStandardItem() item0.setData(j.Label, QtCore.Qt.EditRole) item0.setData(j, self.DataObject) item0.setCheckable(True) item0.setEditable(False) item1.setEnabled(True) item1.setEditable(True) if j.Label in preSelected: expandJobs = True item0.setCheckState(QtCore.Qt.CheckState.Checked) item1.setData(preSelected[j.Label], QtCore.Qt.EditRole) else: item0.setCheckState(QtCore.Qt.CheckState.Unchecked) item1.setData(0, QtCore.Qt.EditRole) self.itemsJob.appendRow([item0, item1]) self.delegate = _ItemDelegate(self, self.dialog.modelTree) self.model = QtGui.QStandardItemModel(self.dialog) self.model.setHorizontalHeaderLabels( [translate("CAM_Job", "Model"), translate("CAM_Job", "Count")] ) if self.itemsSolid.hasChildren(): self.model.appendRow(self.itemsSolid) if expandSolids or not (expand2Ds or expandJobs): expandSolids = True if self.items2D.hasChildren(): self.model.appendRow(self.items2D) if self.itemsJob.hasChildren(): self.model.appendRow(self.itemsJob) self.dialog.modelTree.setModel(self.model) self.dialog.modelTree.setItemDelegateForColumn(1, self.delegate) self.dialog.modelTree.expandAll() self.dialog.modelTree.resizeColumnToContents(0) self.dialog.modelTree.resizeColumnToContents(1) self.dialog.modelTree.collapseAll() if expandSolids: self.dialog.modelTree.setExpanded(self.itemsSolid.index(), True) if expand2Ds: self.dialog.modelTree.setExpanded(self.items2D.index(), True) if expandJobs: self.dialog.modelTree.setExpanded(self.itemsJob.index(), True) self.dialog.modelTree.setEditTriggers(QtGui.QAbstractItemView.AllEditTriggers) self.dialog.modelTree.setSelectionBehavior(QtGui.QAbstractItemView.SelectItems) self.dialog.modelGroup.show() def updateData(self, topLeft, bottomRight): if topLeft.column() == bottomRight.column() == 0: item0 = self.model.itemFromIndex(topLeft) item1 = self.model.itemFromIndex(topLeft.sibling(topLeft.row(), 1)) if item0.checkState() == QtCore.Qt.Checked: if item1.data(QtCore.Qt.EditRole) == 0: item1.setData(1, QtCore.Qt.EditRole) else: item1.setData(0, QtCore.Qt.EditRole) if topLeft.column() == bottomRight.column() == 1: item0 = self.model.itemFromIndex(topLeft.sibling(topLeft.row(), 0)) item1 = self.model.itemFromIndex(topLeft) if item1.data(QtCore.Qt.EditRole) == 0: item0.setCheckState(QtCore.Qt.CheckState.Unchecked) else: item0.setCheckState(QtCore.Qt.CheckState.Checked) def item1ValueChanged(self, v): item0 = self.model.itemFromIndex(self.index.sibling(self.index.row(), 0)) if 0 == v: item0.setCheckState(QtCore.Qt.CheckState.Unchecked) else: item0.setCheckState(QtCore.Qt.CheckState.Checked) def setupColumnEditor(self, index, editor): editor.setMinimum(0) editor.setMaximum(999999) self.index = index editor.valueChanged.connect(self.item1ValueChanged) def setupTemplate(self): templateFiles = [] for path in Path.Preferences.searchPaths(): cleanPaths = [ f.replace("\\", "/") for f in self.templateFilesIn(path) ] # Standardize slashes used across os platforms templateFiles.extend(cleanPaths) template = {} for tFile in templateFiles: name = os.path.split(os.path.splitext(tFile)[0])[1][4:] if name in template: basename = name i = 0 while name in template: i = i + 1 name = basename + " (%s)" % i Path.Log.track(name, tFile) template[name] = tFile selectTemplate = Path.Preferences.defaultJobTemplate() index = 0 self.dialog.jobTemplate.addItem(translate("CAM_Job", ""), "") for name in sorted(template): if template[name] == selectTemplate: index = self.dialog.jobTemplate.count() self.dialog.jobTemplate.addItem(name, template[name]) self.dialog.jobTemplate.setCurrentIndex(index) self.dialog.templateGroup.show() def templateFilesIn(self, path): """templateFilesIn(path) ... answer all file in the given directory which fit the job template naming convention. PathJob template files are name job_*.json""" Path.Log.track(path) return glob.glob(path + "/job_*.json") def getModels(self): models = [] for i in range(self.itemsSolid.rowCount()): for j in range(self.itemsSolid.child(i, 1).data(QtCore.Qt.EditRole)): models.append(self.itemsSolid.child(i).data(self.DataObject)) for i in range(self.items2D.rowCount()): for j in range(self.items2D.child(i, 1).data(QtCore.Qt.EditRole)): models.append(self.items2D.child(i).data(self.DataObject)) for i in range(self.itemsJob.rowCount()): for j in range(self.itemsJob.child(i, 1).data(QtCore.Qt.EditRole)): # Note that we do want to use the models (resource clones) of the # source job as base objects for the new job in order to get the # identical placement, and anything else that's been customized. models.extend(self.itemsJob.child(i, 0).data(self.DataObject).Model.Group) return models def getTemplate(self): """answer the file name of the template to be assigned""" return self.dialog.jobTemplate.itemData(self.dialog.jobTemplate.currentIndex()) def exec_(self): # ml: For some reason the callback has to be unregistered, otherwise there is a # segfault when python is shutdown. To keep it symmetric I also put the callback # registration here self.model.dataChanged.connect(self.updateData) rc = self.dialog.exec_() self.model.dataChanged.disconnect() return rc class JobTemplateExport: DataObject = QtCore.Qt.ItemDataRole.UserRole def __init__(self, job, parent=None): self.job = job self.dialog = FreeCADGui.PySideUic.loadUi(":/panels/DlgJobTemplateExport.ui") if parent: self.dialog.setParent(parent) parent.layout().addWidget(self.dialog) self.dialog.dialogButtonBox.hide() else: self.dialog.exportButtonBox.hide() self.updateUI() self.dialog.toolsGroup.clicked.connect(self.checkUncheckTools) def exportButton(self): return self.dialog.exportButton def updateUI(self): job = self.job if job.PostProcessor: ppHint = "%s %s %s" % ( job.PostProcessor, job.PostProcessorArgs, job.PostProcessorOutputFile, ) self.dialog.postProcessingHint.setText(ppHint) else: self.dialog.postProcessingGroup.setEnabled(False) self.dialog.postProcessingGroup.setChecked(False) if job.Stock and not PathJob.isResourceClone(job, "Stock", "Stock"): stockType = PathStock.StockType.FromStock(job.Stock) if stockType == PathStock.StockType.FromBase: seHint = translate("CAM_Job", "Base -/+ %.2f/%.2f %.2f/%.2f %.2f/%.2f") % ( job.Stock.ExtXneg, job.Stock.ExtXpos, job.Stock.ExtYneg, job.Stock.ExtYpos, job.Stock.ExtZneg, job.Stock.ExtZpos, ) self.dialog.stockPlacement.setChecked(False) elif stockType == PathStock.StockType.CreateBox: seHint = translate("CAM_Job", "Box: %.2f x %.2f x %.2f") % ( job.Stock.Length, job.Stock.Width, job.Stock.Height, ) elif stockType == PathStock.StockType.CreateCylinder: seHint = translate("CAM_Job:", "Cylinder: %.2f x %.2f") % ( job.Stock.Radius, job.Stock.Height, ) elif stockType == PathStock.StockType.Unknown: seHint = "-" else: # Existing Solid seHint = "-" Path.Log.error(translate("CAM_Job", "Unsupported stock type")) self.dialog.stockExtentHint.setText(seHint) spHint = "%s" % job.Stock.Placement self.dialog.stockPlacementHint.setText(spHint) rapidChanged = not job.SetupSheet.Proxy.hasDefaultToolRapids() depthsChanged = not job.SetupSheet.Proxy.hasDefaultOperationDepths() heightsChanged = not job.SetupSheet.Proxy.hasDefaultOperationHeights() coolantChanged = not job.SetupSheet.Proxy.hasDefaultCoolantMode() opsWithSettings = job.SetupSheet.Proxy.operationsWithSettings() settingsChanged = ( rapidChanged or depthsChanged or heightsChanged or coolantChanged or 0 != len(opsWithSettings) ) self.dialog.settingsGroup.setChecked(settingsChanged) self.dialog.settingToolRapid.setChecked(rapidChanged) self.dialog.settingOperationDepths.setChecked(depthsChanged) self.dialog.settingOperationHeights.setChecked(heightsChanged) self.dialog.settingCoolant.setChecked(coolantChanged) self.dialog.settingsOpsList.clear() for op in opsWithSettings: item = QtGui.QListWidgetItem(op) item.setCheckState(QtCore.Qt.CheckState.Checked) self.dialog.settingsOpsList.addItem(item) self.dialog.toolsList.clear() for tc in sorted(job.Tools.Group, key=lambda o: o.Label): item = QtGui.QListWidgetItem(tc.Label) item.setData(self.DataObject, tc) item.setCheckState(QtCore.Qt.CheckState.Checked) self.dialog.toolsList.addItem(item) def checkUncheckTools(self): state = ( QtCore.Qt.CheckState.Checked if self.dialog.toolsGroup.isChecked() else QtCore.Qt.CheckState.Unchecked ) for i in range(self.dialog.toolsList.count()): self.dialog.toolsList.item(i).setCheckState(state) def includePostProcessing(self): return self.dialog.postProcessingGroup.isChecked() def includeToolControllers(self): tcs = [] for i in range(self.dialog.toolsList.count()): item = self.dialog.toolsList.item(i) if item.checkState() == QtCore.Qt.CheckState.Checked: tcs.append(item.data(self.DataObject)) return tcs def includeStock(self): return self.dialog.stockGroup.isChecked() def includeStockExtent(self): return self.dialog.stockExtent.isChecked() def includeStockPlacement(self): return self.dialog.stockPlacement.isChecked() def includeSettings(self): return self.dialog.settingsGroup.isChecked() def includeSettingToolRapid(self): return self.dialog.settingToolRapid.isChecked() def includeSettingOperationHeights(self): return self.dialog.settingOperationHeights.isChecked() def includeSettingOperationDepths(self): return self.dialog.settingOperationDepths.isChecked() def includeSettingCoolant(self): return self.dialog.settingCoolant.isChecked() def includeSettingOpsSettings(self): ops = [] for i in range(self.dialog.settingsOpsList.count()): item = self.dialog.settingsOpsList.item(i) if item.checkState() == QtCore.Qt.CheckState.Checked: ops.append(item.text()) return ops def exec_(self): return self.dialog.exec_()