988 lines
41 KiB
Python
988 lines
41 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# ***************************************************************************
|
|
# * *
|
|
# * Copyright (c) 2017 sliptonic <shopinthewoods@gmail.com> *
|
|
# * *
|
|
# * 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 *
|
|
# * *
|
|
# ***************************************************************************
|
|
|
|
import FreeCAD
|
|
import FreeCADGui
|
|
import PathScripts.PathGeom as PathGeom
|
|
import PathScripts.PathGetPoint as PathGetPoint
|
|
import PathScripts.PathLog as PathLog
|
|
import PathScripts.PathSelection as PathSelection
|
|
import PathScripts.PathOp as PathOp
|
|
import PathScripts.PathUtils as PathUtils
|
|
import importlib
|
|
|
|
from PathScripts.PathGeom import PathGeom
|
|
from PySide import QtCore, QtGui
|
|
|
|
__title__ = "Path Operation UI base classes"
|
|
__author__ = "sliptonic (Brad Collette)"
|
|
__url__ = "http://www.freecadweb.org"
|
|
__doc__ = "Base classes and framework for Path operation's UI"
|
|
|
|
# TaskPanelLayout
|
|
# 0 ... existing toolbox layout
|
|
# 1 ... reverse order
|
|
# 2 ... multi panel layout
|
|
# 3 ... multi panel layout reverse
|
|
TaskPanelLayout = 0
|
|
|
|
|
|
if True:
|
|
PathLog.setLevel(PathLog.Level.DEBUG, PathLog.thisModule())
|
|
PathLog.trackModule(PathLog.thisModule())
|
|
else:
|
|
PathLog.setLevel(PathLog.Level.INFO, PathLog.thisModule())
|
|
|
|
def translate(context, text, disambig=None):
|
|
return QtCore.QCoreApplication.translate(context, text, disambig)
|
|
|
|
|
|
class ViewProvider(object):
|
|
'''Generic view provider for path objects.
|
|
Deducts the icon name from operation name, brings up the TaskPanel
|
|
with pages corresponding to the operation's opFeatures() and forwards
|
|
property change notifications to the page controllers.
|
|
'''
|
|
|
|
def __init__(self, vobj, resources):
|
|
PathLog.track()
|
|
vobj.Proxy = self
|
|
self.deleteOnReject = True
|
|
self.OpIcon = ":/icons/%s.svg" % resources.pixmap
|
|
self.OpName = resources.name
|
|
self.OpPageModule = resources.opPageClass.__module__
|
|
self.OpPageClass = resources.opPageClass.__name__
|
|
|
|
def attach(self, vobj):
|
|
PathLog.track()
|
|
self.Object = vobj.Object
|
|
self.panel = None
|
|
return
|
|
|
|
def deleteObjectsOnReject(self):
|
|
'''deleteObjectsOnReject() ... return true if all objects should
|
|
be created if the user hits cancel. This is used during the initial
|
|
edit session, if the user does not press OK, it is assumed they've
|
|
changed their mind about creating the operation.'''
|
|
PathLog.track()
|
|
return hasattr(self, 'deleteOnReject') and self.deleteOnReject
|
|
|
|
def setEdit(self, vobj, mode=0):
|
|
'''setEdit(vobj, mode=0) ... initiate editing of receivers model.'''
|
|
PathLog.track()
|
|
page = self.getTaskPanelOpPage(vobj.Object)
|
|
selection = self.getSelectionFactory()
|
|
self.setupTaskPanel(TaskPanel(vobj.Object, self.deleteObjectsOnReject(), page, selection))
|
|
self.deleteOnReject = False
|
|
return True
|
|
|
|
def setupTaskPanel(self, panel):
|
|
'''setupTaskPanel(panel) ... internal function to start the editor.'''
|
|
self.panel = panel
|
|
FreeCADGui.Control.closeDialog()
|
|
FreeCADGui.Control.showDialog(panel)
|
|
panel.setupUi()
|
|
job = self.Object.Proxy.getJob(self.Object)
|
|
if job:
|
|
job.ViewObject.Proxy.setupEditVisibility(job)
|
|
else:
|
|
PathLog.info("did not find no job")
|
|
|
|
def clearTaskPanel(self):
|
|
'''clearTaskPanel() ... internal callback function when editing has finished.'''
|
|
self.panel = None
|
|
job = self.Object.Proxy.getJob(self.Object)
|
|
if job:
|
|
job.ViewObject.Proxy.resetEditVisibility(job)
|
|
|
|
def unsetEdit(self, arg1, arg2):
|
|
if self.panel:
|
|
self.panel.reject(False)
|
|
|
|
def __getstate__(self):
|
|
'''__getstate__() ... callback before receiver is saved to a file.
|
|
Returns a dictionary with the receiver's resources as strings.'''
|
|
PathLog.track()
|
|
state = {}
|
|
state['OpName'] = self.OpName
|
|
state['OpIcon'] = self.OpIcon
|
|
state['OpPageModule'] = self.OpPageModule
|
|
state['OpPageClass'] = self.OpPageClass
|
|
return state
|
|
|
|
def __setstate__(self, state):
|
|
'''__setstate__(state) ... callback on restoring a saved instance, pendant to __getstate__()
|
|
state is the dictionary returned by __getstate__().'''
|
|
self.OpName = state['OpName']
|
|
self.OpIcon = state['OpIcon']
|
|
self.OpPageModule = state['OpPageModule']
|
|
self.OpPageClass = state['OpPageClass']
|
|
|
|
def getIcon(self):
|
|
'''getIcon() ... the icon used in the object tree'''
|
|
return self.OpIcon
|
|
|
|
def getTaskPanelOpPage(self, obj):
|
|
'''getTaskPanelOpPage(obj) ... use the stored information to instanciate the receiver op's page controller.'''
|
|
mod = importlib.import_module(self.OpPageModule)
|
|
cls = getattr(mod, self.OpPageClass)
|
|
return cls(obj, 0)
|
|
|
|
def getSelectionFactory(self):
|
|
'''getSelectionFactory() ... return a factory function that can be used to create the selection observer.'''
|
|
return PathSelection.select(self.OpName)
|
|
|
|
def updateData(self, obj, prop):
|
|
'''updateData(obj, prop) ... callback whenever a property of the receiver's model is assigned.
|
|
The callback is forwarded to the task panel - in case an editing session is ongoing.'''
|
|
# PathLog.track(obj.Label, prop) # Creates a lot of noise
|
|
if self.panel:
|
|
self.panel.updateData(obj, prop)
|
|
|
|
class TaskPanelPage(object):
|
|
'''Base class for all task panel pages.'''
|
|
|
|
# task panel interaction framework
|
|
def __init__(self, obj, features):
|
|
'''__init__(obj, features) ... framework initialisation.
|
|
Do not overwrite, implement initPage(obj) instead.'''
|
|
self.obj = obj
|
|
self.form = self.getForm()
|
|
self.signalDirtyChanged = None
|
|
self.setDirty()
|
|
self.setTitle('-')
|
|
self.features = features
|
|
|
|
def onDirtyChanged(self, callback):
|
|
'''onDirtyChanged(callback) ... set callback when dirty state changes.'''
|
|
self.signalDirtyChanged = callback
|
|
def setDirty(self):
|
|
'''setDirty() ... mark receiver as dirty, causing the model to be recalculated if OK or Apply is pressed.'''
|
|
self.isdirty = True
|
|
if self.signalDirtyChanged:
|
|
self.signalDirtyChanged(self)
|
|
def setClean(self):
|
|
'''setClean() ... mark receiver as clean, indicating there is no need to recalculate the model even if the user presses OK or Apply.'''
|
|
self.isdirty = False
|
|
if self.signalDirtyChanged:
|
|
self.signalDirtyChanged(self)
|
|
|
|
def pageGetFields(self):
|
|
'''pageGetFields() ... internal callback.
|
|
Do not overwrite, implement getFields(obj) instead.'''
|
|
self.getFields(self.obj)
|
|
self.setDirty()
|
|
|
|
def pageSetFields(self):
|
|
'''pageSetFields() ... internal callback.
|
|
Do not overwrite, implement setFields(obj) instead.'''
|
|
self.setFields(self.obj)
|
|
|
|
def pageRegisterSignalHandlers(self):
|
|
'''pageRegisterSignalHandlers() .. internal callback.
|
|
Registers a callback for all signals returned by getSignalsForUpdate(obj).
|
|
Do not overwrite, implement getSignalsForUpdate(obj) and/or registerSignalHandlers(obj) instead.'''
|
|
for signal in self.getSignalsForUpdate(self.obj):
|
|
signal.connect(self.pageGetFields)
|
|
self.registerSignalHandlers(self.obj)
|
|
|
|
def pageUpdateData(self, obj, prop):
|
|
'''pageUpdateData(obj, prop) ... internal callback.
|
|
Do not overwrite, implement updateData(obj) instaed.'''
|
|
self.updateData(obj, prop)
|
|
|
|
def setTitle(self, title):
|
|
'''setTitle(title) ... sets a title for the page.'''
|
|
self.title = title
|
|
def getTitle(self, obj):
|
|
'''getTitle(obj) ... return title to be used for the receiver page.
|
|
The default implementation returns what was previously set with setTitle(title).
|
|
Can safely be overwritten by subclasses.'''
|
|
return self.title
|
|
|
|
# subclass interface
|
|
def initPage(self, obj):
|
|
'''initPage(obj) ... overwrite to customize UI for specific model.
|
|
Note that this function is invoked after all page controllers have been created.
|
|
Should be overwritten by subclasses.'''
|
|
pass
|
|
def modifyStandardButtons(self, buttonBox):
|
|
'''modifyStandardButtons(buttonBox) ... overwrite if the task panel standard buttons need to be modified.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
def getForm(self):
|
|
'''getForm() ... return UI form for this page.
|
|
Must be overwritten by subclasses.'''
|
|
pass
|
|
def getFields(self, obj):
|
|
'''getFields(obj) ... overwrite to transfer values from UI to obj's properties.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
def setFields(self, obj):
|
|
'''setFields(obj) ... overwrite to transfer obj's property values to UI.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
def getSignalsForUpdate(self, obj):
|
|
'''getSignalsForUpdate(obj) ... return signals which, when triggered, cause the receiver to update the model.
|
|
See also registerSignalHandlers(obj)
|
|
Can safely be overwritten by subclasses.'''
|
|
return []
|
|
def registerSignalHandlers(self, obj):
|
|
'''registerSignalHandlers(obj) ... overwrite to register custom signal handlers.
|
|
In case an update of a model is not the desired operation of a signal invocation
|
|
(see getSignalsForUpdate(obj)) this function can be used to register signal handlers
|
|
manually.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
def updateData(self, obj, prop):
|
|
'''updateData(obj, prop) ... overwrite if the receiver needs to react to property changes that might not have been caused by the receiver itself.
|
|
Sometimes a model will recalculate properties based on a change of another property. In order to keep the UI up to date with such changes this
|
|
function can be used.
|
|
Please note that the callback is synchronous with the property assignment operation. Also note that the notification is invoked regardless of the
|
|
actual value of the property assignment. In other words it also fires if a property gets assigned the same value it already has.
|
|
Taking above observations into account the implementation has to take care that it doesn't overwrite modified UI values by invoking setFields(obj).
|
|
This can happen if a subclass unconditionally transfers all values in getFields(obj) to the model and just calls setFields(obj) in this callback.
|
|
In such a scenario the first property assignment will cause all changes in the UI of the other fields to be overwritten by setFields(obj).
|
|
You have been warned.'''
|
|
pass
|
|
def updateSelection(self, obj, sel):
|
|
'''updateSelection(obj, sel) ... overwrite to customize UI depending on current selection.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
|
|
# helpers
|
|
def selectInComboBox(self, name, combo):
|
|
'''selectInComboBox(name, combo) ... helper function to select a specific value in a combo box.'''
|
|
index = combo.findText(name, QtCore.Qt.MatchFixedString)
|
|
if index >= 0:
|
|
combo.blockSignals(True)
|
|
combo.setCurrentIndex(index)
|
|
combo.blockSignals(False)
|
|
|
|
def setupToolController(self, obj, combo):
|
|
'''setupToolController(obj, combo) ... helper function to setup obj's ToolController in the given combo box.'''
|
|
controllers = PathUtils.getToolControllers(self.obj)
|
|
labels = [c.Label for c in controllers]
|
|
combo.blockSignals(True)
|
|
combo.addItems(labels)
|
|
combo.blockSignals(False)
|
|
|
|
if obj.ToolController is None:
|
|
obj.ToolController = PathUtils.findToolController(obj)
|
|
if obj.ToolController is not None:
|
|
self.selectInComboBox(obj.ToolController.Label, combo)
|
|
|
|
def updateToolController(self, obj, combo):
|
|
'''updateToolController(obj, combo) ... helper function to update obj's ToolController property if a different one has been selected in the combo box.'''
|
|
tc = PathUtils.findToolController(obj, combo.currentText())
|
|
if obj.ToolController != tc:
|
|
obj.ToolController = tc
|
|
|
|
def updateInputField(self, obj, prop, widget, onBeforeChange = None):
|
|
'''updateInputField(obj, prop, widget) ... helper function to update obj's property named prop with the value from widget, if it has changed.'''
|
|
value = FreeCAD.Units.Quantity(widget.text()).Value
|
|
attr = getattr(obj, prop)
|
|
attrValue = attr.Value if hasattr(attr, 'Value') else attr
|
|
if not PathGeom.isRoughly(attrValue, value):
|
|
PathLog.debug("updateInputField(%s, %s): %.2f -> %.2f" % (obj.Label, prop, getattr(obj, prop), value))
|
|
if onBeforeChange:
|
|
onBeforeChange(obj)
|
|
setattr(obj, prop, value)
|
|
return True
|
|
return False
|
|
|
|
class TaskPanelBaseGeometryPage(TaskPanelPage):
|
|
'''Page controller for the base geometry.'''
|
|
DataObject = QtCore.Qt.ItemDataRole.UserRole
|
|
DataObjectSub = QtCore.Qt.ItemDataRole.UserRole + 1
|
|
|
|
def getForm(self):
|
|
return FreeCADGui.PySideUic.loadUi(":/panels/PageBaseGeometryEdit.ui")
|
|
def getTitle(self, obj):
|
|
return translate("PathOp", "Base Geometry")
|
|
def getFields(self, obj):
|
|
pass
|
|
|
|
def setFields(self, obj):
|
|
self.form.baseList.blockSignals(True)
|
|
self.form.baseList.clear()
|
|
for base in self.obj.Base:
|
|
for sub in base[1]:
|
|
item = QtGui.QListWidgetItem("%s.%s" % (base[0].Label, sub))
|
|
item.setData(self.DataObject, base[0])
|
|
item.setData(self.DataObjectSub, sub)
|
|
self.form.baseList.addItem(item)
|
|
self.form.baseList.blockSignals(False)
|
|
|
|
def itemActivated(self):
|
|
FreeCADGui.Selection.clearSelection()
|
|
for item in self.form.baseList.selectedItems():
|
|
obj = item.data(self.DataObject)
|
|
sub = item.data(self.DataObjectSub)
|
|
if sub:
|
|
FreeCADGui.Selection.addSelection(obj, sub)
|
|
else:
|
|
FreeCADGui.Selection.addSelection(obj)
|
|
#FreeCADGui.updateGui()
|
|
|
|
def supportsVertexes(self):
|
|
return self.features & PathOp.FeatureBaseVertexes
|
|
def supportsEdges(self):
|
|
return self.features & PathOp.FeatureBaseEdges
|
|
def supportsFaces(self):
|
|
return self.features & PathOp.FeatureBaseFaces
|
|
def supportsPanels(self):
|
|
return self.features & PathOp.FeatureBasePanels
|
|
|
|
def featureName(self):
|
|
if self.supportsEdges() and self.supportsFaces():
|
|
return 'features'
|
|
if self.supportsFaces():
|
|
return 'faces'
|
|
if self.supportsEdges():
|
|
return 'edges'
|
|
return 'nothing'
|
|
|
|
def addBaseGeometry(self, selection):
|
|
PathLog.track(selection)
|
|
if len(selection) != 1:
|
|
PathLog.error(translate("PathProject", "Please select %s from a single solid" % self.featureName()))
|
|
return False
|
|
sel = selection[0]
|
|
if sel.HasSubObjects:
|
|
if not self.supportsVertexes() and selection[0].SubObjects[0].ShapeType == "Vertex":
|
|
PathLog.error(translate("PathProject", "Vertexes are not supported"))
|
|
return False
|
|
if not self.supportsEdges() and selection[0].SubObjects[0].ShapeType == "Edge":
|
|
PathLog.error(translate("PathProject", "Edges are not supported"))
|
|
return False
|
|
if not self.supportsFaces() and selection[0].SubObjects[0].ShapeType == "Face":
|
|
PathLog.error(translate("PathProject", "Faces are not supported"))
|
|
return False
|
|
else:
|
|
if not self.supportsPanels() or not 'Panel' in sel.Object.Name:
|
|
PathLog.error(translate("PathProject", "Please select %s of a solid" % self.featureName()))
|
|
return False
|
|
|
|
for sub in sel.SubElementNames:
|
|
self.obj.Proxy.addBase(self.obj, sel.Object, sub)
|
|
return True
|
|
|
|
def addBase(self):
|
|
if self.addBaseGeometry(FreeCADGui.Selection.getSelectionEx()):
|
|
#self.obj.Proxy.execute(self.obj)
|
|
self.setFields(self.obj)
|
|
self.setDirty()
|
|
|
|
def deleteBase(self):
|
|
PathLog.track()
|
|
selected = self.form.baseList.selectedItems()
|
|
for item in selected:
|
|
self.form.baseList.takeItem(self.form.baseList.row(item))
|
|
self.setDirty()
|
|
self.updateBase()
|
|
#self.obj.Proxy.execute(self.obj)
|
|
#FreeCAD.ActiveDocument.recompute()
|
|
|
|
def updateBase(self):
|
|
newlist = []
|
|
for i in range(self.form.baseList.count()):
|
|
item = self.form.baseList.item(i)
|
|
obj = item.data(self.DataObject)
|
|
sub = str(item.data(self.DataObjectSub))
|
|
base = (obj, sub)
|
|
newlist.append(base)
|
|
PathLog.debug("Setting new base: %s -> %s" % (self.obj.Base, newlist))
|
|
self.obj.Base = newlist
|
|
|
|
#self.obj.Proxy.execute(self.obj)
|
|
#FreeCAD.ActiveDocument.recompute()
|
|
|
|
def clearBase(self):
|
|
self.obj.Base = []
|
|
self.setDirty()
|
|
|
|
def registerSignalHandlers(self, obj):
|
|
self.form.baseList.itemSelectionChanged.connect(self.itemActivated)
|
|
self.form.addBase.clicked.connect(self.addBase)
|
|
self.form.deleteBase.clicked.connect(self.deleteBase)
|
|
self.form.clearBase.clicked.connect(self.clearBase)
|
|
|
|
def pageUpdateData(self, obj, prop):
|
|
if prop in ['Base']:
|
|
self.setFields(obj)
|
|
|
|
|
|
class TaskPanelBaseLocationPage(TaskPanelPage):
|
|
'''Page controller for base locations. Uses PathGetPoint.'''
|
|
|
|
DataLocation = QtCore.Qt.ItemDataRole.UserRole
|
|
|
|
def getForm(self):
|
|
self.formLoc = FreeCADGui.PySideUic.loadUi(":/panels/PageBaseLocationEdit.ui")
|
|
if QtCore.qVersion()[0] == '4':
|
|
self.formLoc.baseList.horizontalHeader().setResizeMode(QtGui.QHeaderView.Stretch)
|
|
else:
|
|
self.formLoc.baseList.horizontalHeader().setSectionResizeMode(QtGui.QHeaderView.Stretch)
|
|
self.getPoint = PathGetPoint.TaskPanel(self.formLoc.addRemoveEdit)
|
|
return self.formLoc
|
|
|
|
def modifyStandardButtons(self, buttonBox):
|
|
self.getPoint.buttonBox = buttonBox
|
|
|
|
def getTitle(self, obj):
|
|
return translate("PathOp", "Base Location")
|
|
def getFields(self, obj):
|
|
pass
|
|
|
|
def setFields(self, obj):
|
|
self.formLoc.baseList.blockSignals(True)
|
|
self.formLoc.baseList.clearContents()
|
|
self.formLoc.baseList.setRowCount(0)
|
|
for location in self.obj.Locations:
|
|
self.formLoc.baseList.insertRow(self.formLoc.baseList.rowCount())
|
|
|
|
item = QtGui.QTableWidgetItem("%.2f" % location.x)
|
|
item.setData(self.DataLocation, location.x)
|
|
self.formLoc.baseList.setItem(self.formLoc.baseList.rowCount()-1, 0, item)
|
|
|
|
item = QtGui.QTableWidgetItem("%.2f" % location.y)
|
|
item.setData(self.DataLocation, location.y)
|
|
self.formLoc.baseList.setItem(self.formLoc.baseList.rowCount()-1, 1, item)
|
|
self.formLoc.baseList.resizeColumnToContents(0)
|
|
self.formLoc.baseList.blockSignals(False)
|
|
self.itemActivated()
|
|
|
|
def removeLocation(self):
|
|
deletedRows = []
|
|
selected = self.formLoc.baseList.selectedItems()
|
|
for item in selected:
|
|
row = self.formLoc.baseList.row(item)
|
|
if not row in deletedRows:
|
|
deletedRows.append(row)
|
|
self.formLoc.baseList.removeRow(row)
|
|
self.updateLocations()
|
|
FreeCAD.ActiveDocument.recompute()
|
|
|
|
def updateLocations(self):
|
|
PathLog.track()
|
|
locations = []
|
|
for i in range(self.formLoc.baseList.rowCount()):
|
|
x = self.formLoc.baseList.item(i, 0).data(self.DataLocation)
|
|
y = self.formLoc.baseList.item(i, 1).data(self.DataLocation)
|
|
location = FreeCAD.Vector(x, y, 0)
|
|
locations.append(location)
|
|
self.obj.Locations = locations
|
|
|
|
def addLocation(self):
|
|
self.getPoint.getPoint(self.addLocationAt)
|
|
|
|
def addLocationAt(self, point, obj):
|
|
if point:
|
|
locations = self.obj.Locations
|
|
locations.append(point)
|
|
self.obj.Locations = locations
|
|
FreeCAD.ActiveDocument.recompute()
|
|
|
|
def editLocation(self):
|
|
selected = self.formLoc.baseList.selectedItems()
|
|
if selected:
|
|
row = self.formLoc.baseList.row(selected[0])
|
|
self.editRow = row
|
|
x = self.formLoc.baseList.item(row, 0).data(self.DataLocation)
|
|
y = self.formLoc.baseList.item(row, 1).data(self.DataLocation)
|
|
start = FreeCAD.Vector(x, y, 0)
|
|
self.getPoint.getPoint(self.editLocationAt, start)
|
|
|
|
def editLocationAt(self, point, obj):
|
|
if point:
|
|
self.formLoc.baseList.item(self.editRow, 0).setData(self.DataLocation, point.x)
|
|
self.formLoc.baseList.item(self.editRow, 1).setData(self.DataLocation, point.y)
|
|
self.updateLocations()
|
|
FreeCAD.ActiveDocument.recompute()
|
|
|
|
def itemActivated(self):
|
|
if self.formLoc.baseList.selectedItems():
|
|
self.form.removeLocation.setEnabled(True)
|
|
self.form.editLocation.setEnabled(True)
|
|
else:
|
|
self.form.removeLocation.setEnabled(False)
|
|
self.form.editLocation.setEnabled(False)
|
|
|
|
def registerSignalHandlers(self, obj):
|
|
self.form.baseList.itemSelectionChanged.connect(self.itemActivated)
|
|
self.formLoc.addLocation.clicked.connect(self.addLocation)
|
|
self.formLoc.removeLocation.clicked.connect(self.removeLocation)
|
|
self.formLoc.editLocation.clicked.connect(self.editLocation)
|
|
|
|
def pageUpdateData(self, obj, prop):
|
|
if prop in ['Locations']:
|
|
self.setFields(obj)
|
|
|
|
|
|
class TaskPanelHeightsPage(TaskPanelPage):
|
|
'''Page controller for heights.'''
|
|
def getForm(self):
|
|
return FreeCADGui.PySideUic.loadUi(":/panels/PageHeightsEdit.ui")
|
|
def getTitle(self, obj):
|
|
return translate("Path", "Heights")
|
|
def getFields(self, obj):
|
|
self.updateInputField(obj, 'SafeHeight', self.form.safeHeight)
|
|
self.updateInputField(obj, 'ClearanceHeight', self.form.clearanceHeight)
|
|
def setFields(self, obj):
|
|
self.form.safeHeight.setText(FreeCAD.Units.Quantity(obj.SafeHeight.Value, FreeCAD.Units.Length).UserString)
|
|
self.form.clearanceHeight.setText(FreeCAD.Units.Quantity(obj.ClearanceHeight.Value, FreeCAD.Units.Length).UserString)
|
|
def getSignalsForUpdate(self, obj):
|
|
signals = []
|
|
signals.append(self.form.safeHeight.editingFinished)
|
|
signals.append(self.form.clearanceHeight.editingFinished)
|
|
return signals
|
|
|
|
def pageUpdateData(self, obj, prop):
|
|
if prop in ['SafeHeight', 'ClearanceHeight']:
|
|
self.setFields(obj)
|
|
|
|
|
|
class TaskPanelDepthsPage(TaskPanelPage):
|
|
'''Page controller for depths.'''
|
|
def getForm(self):
|
|
return FreeCADGui.PySideUic.loadUi(":/panels/PageDepthsEdit.ui")
|
|
|
|
def initPage(self, obj):
|
|
if PathOp.FeatureNoFinalDepth & self.features:
|
|
self.form.finalDepth.hide()
|
|
self.form.finalDepthLabel.hide()
|
|
self.form.finalDepthLock.hide()
|
|
self.form.finalDepthSet.hide()
|
|
|
|
if not PathOp.FeatureStepDown & self.features:
|
|
self.form.stepDown.hide()
|
|
self.form.stepDownLabel.hide()
|
|
|
|
if not PathOp.FeatureFinishDepth & self.features:
|
|
self.form.finishDepth.hide()
|
|
self.form.finishDepthLabel.hide()
|
|
|
|
def getTitle(self, obj):
|
|
return translate("PathOp", "Depths")
|
|
|
|
def lockStartDepth(self, obj):
|
|
if not obj.StartDepthLock:
|
|
obj.StartDepthLock = True
|
|
def lockFinalDepth(self, obj):
|
|
if not obj.FinalDepthLock:
|
|
obj.FinalDepthLock = True
|
|
|
|
def getFields(self, obj):
|
|
if obj.StartDepthLock != self.form.startDepthLock.isChecked():
|
|
obj.StartDepthLock = self.form.startDepthLock.isChecked()
|
|
if obj.FinalDepthLock != self.form.finalDepthLock.isChecked():
|
|
obj.FinalDepthLock = self.form.finalDepthLock.isChecked()
|
|
|
|
self.updateInputField(obj, 'StartDepth', self.form.startDepth, self.lockStartDepth)
|
|
if not PathOp.FeatureNoFinalDepth & self.features:
|
|
self.updateInputField(obj, 'FinalDepth', self.form.finalDepth, self.lockFinalDepth)
|
|
if PathOp.FeatureStepDown & self.features:
|
|
self.updateInputField(obj, 'StepDown', self.form.stepDown)
|
|
if PathOp.FeatureFinishDepth & self.features:
|
|
self.updateInputField(obj, 'FinishDepth', self.form.finishDepth)
|
|
|
|
def setFields(self, obj):
|
|
self.form.startDepth.setText(FreeCAD.Units.Quantity(obj.StartDepth.Value, FreeCAD.Units.Length).UserString)
|
|
self.form.startDepthLock.setChecked(obj.StartDepthLock)
|
|
if not PathOp.FeatureNoFinalDepth & self.features:
|
|
self.form.finalDepth.setText(FreeCAD.Units.Quantity(obj.FinalDepth.Value, FreeCAD.Units.Length).UserString)
|
|
self.form.finalDepthLock.setChecked(obj.FinalDepthLock)
|
|
if PathOp.FeatureStepDown & self.features:
|
|
self.form.stepDown.setText(FreeCAD.Units.Quantity(obj.StepDown.Value, FreeCAD.Units.Length).UserString)
|
|
if PathOp.FeatureFinishDepth & self.features:
|
|
self.form.finishDepth.setText(FreeCAD.Units.Quantity(obj.FinishDepth.Value, FreeCAD.Units.Length).UserString)
|
|
self.updateSelection(obj, FreeCADGui.Selection.getSelectionEx())
|
|
|
|
def getSignalsForUpdate(self, obj):
|
|
signals = []
|
|
signals.append(self.form.startDepth.editingFinished)
|
|
signals.append(self.form.startDepthLock.clicked)
|
|
if not PathOp.FeatureNoFinalDepth & self.features:
|
|
signals.append(self.form.finalDepth.editingFinished)
|
|
signals.append(self.form.finalDepthLock.clicked)
|
|
if PathOp.FeatureStepDown & self.features:
|
|
signals.append(self.form.stepDown.editingFinished)
|
|
if PathOp.FeatureFinishDepth & self.features:
|
|
signals.append(self.form.finishDepth.editingFinished)
|
|
return signals
|
|
|
|
def registerSignalHandlers(self, obj):
|
|
self.form.startDepthSet.clicked.connect(lambda: self.depthSet(obj, self.form.startDepth))
|
|
if not PathOp.FeatureNoFinalDepth & self.features:
|
|
self.form.finalDepthSet.clicked.connect(lambda: self.depthSet(obj, self.form.finalDepth))
|
|
|
|
def pageUpdateData(self, obj, prop):
|
|
if prop in ['StartDepth', 'FinalDepth', 'StepDown', 'FinishDepth', 'FinalDepthLock', 'StartDepthLock']:
|
|
self.setFields(obj)
|
|
|
|
def depthSet(self, obj, widget):
|
|
z = self.selectionZLevel(FreeCADGui.Selection.getSelectionEx())
|
|
if z is not None:
|
|
PathLog.debug("depthSet(%.2f)" % z)
|
|
widget.setText(FreeCAD.Units.Quantity(z, FreeCAD.Units.Length).UserString)
|
|
self.getFields(obj)
|
|
else:
|
|
PathLog.info("depthSet(-)")
|
|
|
|
def selectionZLevel(self, sel):
|
|
if len(sel) == 1 and len(sel[0].SubObjects) == 1:
|
|
sub = sel[0].SubObjects[0]
|
|
if 'Vertex' == sub.ShapeType:
|
|
return sub.Z
|
|
if 'Edge' == sub.ShapeType and PathGeom.isRoughly(sub.Vertexes[0].Z, sub.Vertexes[1].Z):
|
|
return sub.Vertexes[0].Z
|
|
if 'Face' == sub.ShapeType and PathGeom.isRoughly(sub.BoundBox.ZLength, 0):
|
|
return sub.BoundBox.ZMax
|
|
return None
|
|
|
|
def updateSelection(self, obj, sel):
|
|
if self.selectionZLevel(sel) is not None:
|
|
self.form.startDepthSet.setEnabled(True)
|
|
self.form.finalDepthSet.setEnabled(True)
|
|
else:
|
|
self.form.startDepthSet.setEnabled(False)
|
|
self.form.finalDepthSet.setEnabled(False)
|
|
|
|
class TaskPanel(object):
|
|
'''
|
|
Generic TaskPanel implementation handling the standard Path operation layout.
|
|
This class only implements the framework and takes care of bringing all pages up and down in a controller fashion.
|
|
It implements the standard editor behaviour for OK, Cancel and Apply and tracks if the model is still in sync with
|
|
the UI.
|
|
However, all display and processing of fields is handled by the page contollers which are managed in a list. All
|
|
event callbacks and framework actions are forwarded to the page controllers in turn and each page controller is
|
|
expected to process all events concerning the data it manages.
|
|
'''
|
|
def __init__(self, obj, deleteOnReject, opPage, selectionFactory):
|
|
PathLog.track(obj.Label, deleteOnReject, opPage, selectionFactory)
|
|
FreeCAD.ActiveDocument.openTransaction(translate("Path", "AreaOp Operation"))
|
|
self.deleteOnReject = deleteOnReject
|
|
self.featurePages = []
|
|
|
|
features = obj.Proxy.opFeatures(obj)
|
|
opPage.features = features
|
|
|
|
if PathOp.FeatureBaseGeometry & features:
|
|
if hasattr(opPage, 'taskPanelBaseGeometryPage'):
|
|
self.featurePages.append(opPage.taskPanelBaseGeometryPage(obj, features))
|
|
else:
|
|
self.featurePages.append(TaskPanelBaseGeometryPage(obj, features))
|
|
|
|
if PathOp.FeatureLocations & features:
|
|
if hasattr(opPage, 'taskPanelBaseLocationPage'):
|
|
self.featurePages.append(opPage.taskPanelBaseLocationPage(obj, features))
|
|
else:
|
|
self.featurePages.append(TaskPanelBaseLocationPage(obj, features))
|
|
|
|
if PathOp.FeatureDepths & features:
|
|
if hasattr(opPage, 'taskPanelDepthsPage'):
|
|
self.featurePages.append(opPage.taskPanelDepthsPage(obj, features))
|
|
else:
|
|
self.featurePages.append(TaskPanelDepthsPage(obj, features))
|
|
|
|
if PathOp.FeatureHeights & features:
|
|
if hasattr(opPage, 'taskPanelHeightsPage'):
|
|
self.featurePages.append(opPage.taskPanelHeightsPage(obj, features))
|
|
else:
|
|
self.featurePages.append(TaskPanelHeightsPage(obj, features))
|
|
|
|
opPage.setTitle(translate('PathOp', 'Operation'))
|
|
self.featurePages.append(opPage)
|
|
|
|
for page in self.featurePages:
|
|
page.initPage(obj)
|
|
page.onDirtyChanged(self.pageDirtyChanged)
|
|
|
|
if TaskPanelLayout < 2:
|
|
toolbox = QtGui.QToolBox()
|
|
if TaskPanelLayout == 0:
|
|
for page in self.featurePages:
|
|
toolbox.addItem(page.form, page.getTitle(obj))
|
|
toolbox.setCurrentIndex(len(self.featurePages)-1)
|
|
else:
|
|
for page in reversed(self.featurePages):
|
|
toolbox.addItem(page.form, page.getTitle(obj))
|
|
self.form = toolbox
|
|
elif TaskPanelLayout == 2:
|
|
forms = []
|
|
for page in self.featurePages:
|
|
page.form.setWindowTitle(page.getTitle(obj))
|
|
forms.append(page.form)
|
|
self.form = forms
|
|
elif TaskPanelLayout == 3:
|
|
forms = []
|
|
for page in reversed(self.featurePages):
|
|
page.form.setWindowTitle(page.getTitle(obj))
|
|
forms.append(page.form)
|
|
self.form = forms
|
|
|
|
self.selectionFactory = selectionFactory
|
|
self.obj = obj
|
|
self.isdirty = True
|
|
|
|
def isDirty(self):
|
|
'''isDirty() ... returns true if the model is not in sync with the UI anymore.'''
|
|
for page in self.featurePages:
|
|
if page.isdirty:
|
|
return True
|
|
return self.isdirty
|
|
|
|
def setClean(self):
|
|
'''setClean() ... set the receiver and all its pages clean.'''
|
|
self.isdirty = False
|
|
for page in self.featurePages:
|
|
page.setClean()
|
|
|
|
def accept(self, resetEdit=True):
|
|
'''accept() ... callback invoked when user presses the task panel OK button.'''
|
|
self.preCleanup()
|
|
if self.isDirty:
|
|
self.panelGetFields()
|
|
FreeCAD.ActiveDocument.commitTransaction()
|
|
self.cleanup(resetEdit)
|
|
|
|
def reject(self, resetEdit=True):
|
|
'''reject() ... callback invoked when user presses the task panel Cancel button.'''
|
|
self.preCleanup()
|
|
FreeCAD.ActiveDocument.abortTransaction()
|
|
if self.deleteOnReject:
|
|
FreeCAD.ActiveDocument.openTransaction(translate("Path", "Uncreate AreaOp Operation"))
|
|
FreeCAD.ActiveDocument.removeObject(self.obj.Name)
|
|
FreeCAD.ActiveDocument.commitTransaction()
|
|
self.cleanup(resetEdit)
|
|
return True
|
|
|
|
def preCleanup(self):
|
|
for page in self.featurePages:
|
|
page.onDirtyChanged(None)
|
|
FreeCADGui.Selection.removeObserver(self)
|
|
FreeCADGui.Selection.removeObserver(self.s)
|
|
self.obj.ViewObject.Proxy.clearTaskPanel()
|
|
|
|
def cleanup(self, resetEdit):
|
|
'''cleanup() ... implements common cleanup tasks.'''
|
|
FreeCADGui.Control.closeDialog()
|
|
if resetEdit:
|
|
FreeCADGui.ActiveDocument.resetEdit()
|
|
FreeCAD.ActiveDocument.recompute()
|
|
|
|
def pageDirtyChanged(self, page):
|
|
'''pageDirtyChanged(page) ... internal callback'''
|
|
self.buttonBox.button(QtGui.QDialogButtonBox.Apply).setEnabled(self.isDirty())
|
|
|
|
def clicked(self, button):
|
|
'''clicked(button) ... callback invoked when the user presses any of the task panel buttons.'''
|
|
if button == QtGui.QDialogButtonBox.Apply:
|
|
self.panelGetFields()
|
|
self.setClean()
|
|
FreeCAD.ActiveDocument.recompute()
|
|
|
|
def modifyStandardButtons(self, buttonBox):
|
|
'''modifyStandarButtons(buttonBox) ... callback in case the task panel buttons need to be modified.'''
|
|
self.buttonBox = buttonBox
|
|
for page in self.featurePages:
|
|
page.modifyStandardButtons(buttonBox)
|
|
|
|
def panelGetFields(self):
|
|
'''panelGetFields() ... invoked to trigger a complete transfer of UI data to the model.'''
|
|
PathLog.track()
|
|
for page in self.featurePages:
|
|
page.pageGetFields()
|
|
|
|
def panelSetFields(self):
|
|
'''panelSetFields() ... invoked to trigger a complete transfer of the model's propeties to the UI.'''
|
|
PathLog.track()
|
|
for page in self.featurePages:
|
|
page.pageSetFields()
|
|
|
|
def open(self):
|
|
'''open() ... callback invoked when the task panel is opened.'''
|
|
self.s = SelObserver(self.selectionFactory)
|
|
FreeCADGui.Selection.addObserver(self.s)
|
|
FreeCADGui.Selection.addObserver(self)
|
|
|
|
def getStandardButtons(self):
|
|
'''getStandardButtons() ... returns the Buttons for the task panel.'''
|
|
return int(QtGui.QDialogButtonBox.Ok | QtGui.QDialogButtonBox.Apply | QtGui.QDialogButtonBox.Cancel)
|
|
|
|
def setupUi(self):
|
|
'''setupUi() ... internal function to initialise all pages.'''
|
|
PathLog.track(self.deleteOnReject)
|
|
|
|
if self.deleteOnReject and PathOp.FeatureBaseGeometry & self.obj.Proxy.opFeatures(self.obj):
|
|
sel = FreeCADGui.Selection.getSelectionEx()
|
|
if len(sel) == 1 and sel[0].Object != self.obj:
|
|
for page in self.featurePages:
|
|
if hasattr(page, 'addBase'):
|
|
page.addBaseGeometry(sel)
|
|
|
|
self.panelSetFields()
|
|
for page in self.featurePages:
|
|
page.pageRegisterSignalHandlers()
|
|
|
|
def updateData(self, obj, prop):
|
|
'''updateDate(obj, prop) ... callback invoked whenever a model's property is assigned a value.'''
|
|
# PathLog.track(obj.Label, prop) # creates a lot of noise
|
|
for page in self.featurePages:
|
|
page.pageUpdateData(obj, prop)
|
|
|
|
def needsFullSpace(self):
|
|
return True
|
|
|
|
def updateSelection(self):
|
|
sel = FreeCADGui.Selection.getSelectionEx()
|
|
for page in self.featurePages:
|
|
page.updateSelection(self.obj, sel)
|
|
|
|
# SelectionObserver interface
|
|
def addSelection(self, doc, obj, sub, pnt):
|
|
self.updateSelection()
|
|
def removeSelection(self, doc, obj, sub):
|
|
self.updateSelection()
|
|
def setSelection(self, doc):
|
|
self.updateSelection()
|
|
def clearSelection(self, doc):
|
|
self.updateSelection()
|
|
|
|
|
|
class SelObserver:
|
|
'''Implementation of the selection observer used by the task panel.
|
|
Its specific behaviour is determined by the factory function.'''
|
|
def __init__(self, factory):
|
|
factory()
|
|
|
|
def __del__(self):
|
|
PathSelection.clear()
|
|
|
|
def addSelection(self, doc, obj, sub, pnt):
|
|
FreeCADGui.doCommand('Gui.Selection.addSelection(FreeCAD.ActiveDocument.' + obj + ')')
|
|
FreeCADGui.updateGui()
|
|
|
|
class CommandSetStartPoint:
|
|
'''Command to set the start point for an operation.'''
|
|
def GetResources(self):
|
|
return {'Pixmap': 'Path-StartPoint',
|
|
'MenuText': QtCore.QT_TRANSLATE_NOOP("Path", "Pick Start Point"),
|
|
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Path", "Pick Start Point")}
|
|
|
|
def IsActive(self):
|
|
if FreeCAD.ActiveDocument is None:
|
|
return False
|
|
sel = FreeCADGui.Selection.getSelection()
|
|
if not sel:
|
|
return False
|
|
obj = sel[0]
|
|
return obj and hasattr(obj, 'StartPoint')
|
|
|
|
def setpoint(self, point, o):
|
|
obj = FreeCADGui.Selection.getSelection()[0]
|
|
obj.StartPoint.x = point.x
|
|
obj.StartPoint.y = point.y
|
|
obj.StartPoint.z = obj.ClearanceHeight.Value
|
|
|
|
def Activated(self):
|
|
FreeCADGui.Snapper.getPoint(callback=self.setpoint)
|
|
|
|
def Create(res):
|
|
'''Create(res) ... generic implementation of a create function.
|
|
res is an instance of CommandResources. It is not expected that the user invokes
|
|
this function directly, but calls the Activated() function of the Command object
|
|
that is created in each operations Gui implementation.'''
|
|
FreeCAD.ActiveDocument.openTransaction("Create %s" % res.name)
|
|
obj = res.objFactory(res.name)
|
|
vobj = ViewProvider(obj.ViewObject, res)
|
|
|
|
FreeCAD.ActiveDocument.commitTransaction()
|
|
obj.ViewObject.startEditing()
|
|
return obj
|
|
|
|
class CommandPathOp:
|
|
'''Generic, data driven implementation of a Path operation creation command.
|
|
Instances of this class are stored in all Path operation Gui modules and can
|
|
be used to create said operations with view providers and all.'''
|
|
|
|
def __init__(self, resources):
|
|
self.res = resources
|
|
|
|
def GetResources(self):
|
|
ress = {'Pixmap': self.res.pixmap,
|
|
'MenuText': self.res.menuText,
|
|
'ToolTip': self.res.toolTip}
|
|
if self.res.accelKey:
|
|
ress['Accel'] = self.res.accelKey
|
|
return ress
|
|
|
|
def IsActive(self):
|
|
if FreeCAD.ActiveDocument is not None:
|
|
for o in FreeCAD.ActiveDocument.Objects:
|
|
if o.Name[:3] == "Job":
|
|
return True
|
|
return False
|
|
|
|
def Activated(self):
|
|
return Create(self.res)
|
|
|
|
class CommandResources:
|
|
'''POD class to hold command specific resources.'''
|
|
def __init__(self, name, objFactory, opPageClass, pixmap, menuText, accelKey, toolTip):
|
|
self.name = name
|
|
self.objFactory = objFactory
|
|
self.opPageClass = opPageClass
|
|
self.pixmap = pixmap
|
|
self.menuText = menuText
|
|
self.accelKey = accelKey
|
|
self.toolTip = toolTip
|
|
|
|
def SetupOperation(name,
|
|
objFactory,
|
|
opPageClass,
|
|
pixmap,
|
|
menuText,
|
|
toolTip,
|
|
accelKey = None):
|
|
'''SetupOperation(name, objFactory, opPageClass, pixmap, menuText, toolTip, accelKey=None)
|
|
Creates an instance of CommandPathOp with the given parameters and registers the command with FreeCAD.
|
|
When activated it creates a model with proxy (by invoking objFactory), assigns a view provider to it
|
|
(see ViewProvider in this module) and starts the editor specifically for this operation (driven by opPageClass).
|
|
This is an internal function that is automatically called by the intialisation code for each operation.
|
|
It is not expected to be called manually.
|
|
'''
|
|
|
|
res = CommandResources(name, objFactory, opPageClass, pixmap, menuText, accelKey, toolTip)
|
|
|
|
command = CommandPathOp(res)
|
|
FreeCADGui.addCommand("Path_%s" % name.replace(' ', '_'), command)
|
|
return command
|
|
|
|
|
|
FreeCADGui.addCommand('Set_StartPoint', CommandSetStartPoint())
|
|
|
|
FreeCAD.Console.PrintLog("Loading PathOpGui... done\n")
|