kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Consistent black formatting of all Path python files

Browse Source
This commit is contained in:
Markus Lampert
2022-02-28 21:06:16 -08:00
parent 122fd49b37
commit 37095fbf78
93 changed files with 5216 additions and 3118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
src/Mod/Path/PathScripts/PathGetPoint.py
View File

@@ -26,7 +26,8 @@ import PathScripts.PathLog as PathLog
# lazily loaded modules
from lazy_loader.lazy_loader import LazyLoader
Draft = LazyLoader('Draft', globals(), 'Draft')
Draft = LazyLoader("Draft", globals(), "Draft")
from PySide import QtCore, QtGui
from pivy import coin
@@ -37,17 +38,19 @@ __url__ = "https://www.freecadweb.org"
__doc__ = "Helper class to use FreeCADGUi.Snapper to let the user enter arbitrary points while the task panel is active."
PathLog.setLevel(PathLog.Level.INFO, PathLog.thisModule())
#PathLog.track(PathLog.thisModule())
# PathLog.track(PathLog.thisModule())
class TaskPanel:
'''Use an instance of this class in another TaskPanel to invoke the snapper.
"""Use an instance of this class in another TaskPanel to invoke the snapper.
Create the instance in the TaskPanel's constructors and invoke getPoint(whenDone, start) whenever a new point is
required or an existing point needs to be edited. The receiver is expected to have the same lifespan as the form
provided in the constructor.
The (only) public API function other than the constructor is getPoint(whenDone, start).
'''
"""
def __init__(self, form, onPath=False):
'''__init___(form) ... form will be replaced by PointEdit.ui while the Snapper is active.'''
"""__init___(form) ... form will be replaced by PointEdit.ui while the Snapper is active."""
self.formOrig = form
self.formPoint = FreeCADGui.PySideUic.loadUi(":/panels/PointEdit.ui")
@@ -69,7 +72,7 @@ class TaskPanel:
self.view = None
def setupUi(self):
'''setupUi() ... internal function - do not call.'''
"""setupUi() ... internal function - do not call."""
self.formPoint.buttonBox.accepted.connect(self.pointAccept)
self.formPoint.buttonBox.rejected.connect(self.pointReject)
@@ -77,44 +80,52 @@ class TaskPanel:
self.formPoint.globalY.editingFinished.connect(self.updatePoint)
self.formPoint.globalZ.editingFinished.connect(self.updatePoint)
self.formPoint.globalX.setProperty('unit', FreeCAD.Units.MilliMetre.getUserPreferred()[2])
self.formPoint.globalY.setProperty('unit', FreeCAD.Units.MilliMetre.getUserPreferred()[2])
self.formPoint.globalZ.setProperty('unit', FreeCAD.Units.MilliMetre.getUserPreferred()[2])
self.formPoint.globalX.setProperty(
"unit", FreeCAD.Units.MilliMetre.getUserPreferred()[2]
)
self.formPoint.globalY.setProperty(
"unit", FreeCAD.Units.MilliMetre.getUserPreferred()[2]
)
self.formPoint.globalZ.setProperty(
"unit", FreeCAD.Units.MilliMetre.getUserPreferred()[2]
)
def addEscapeShortcut(self):
'''addEscapeShortcut() ... internal function - do not call.'''
"""addEscapeShortcut() ... internal function - do not call."""
# The only way I could get to intercept the escape key, or really any key was
# by creating an action with a shortcut .....
self.escape = QtGui.QAction(self.formPoint)
self.escape.setText('Done')
self.escape.setShortcut(QtGui.QKeySequence.fromString('Esc'))
QtCore.QObject.connect(self.escape, QtCore.SIGNAL('triggered()'), self.pointDone)
self.escape.setText("Done")
self.escape.setShortcut(QtGui.QKeySequence.fromString("Esc"))
QtCore.QObject.connect(
self.escape, QtCore.SIGNAL("triggered()"), self.pointDone
)
self.formPoint.addAction(self.escape)
def removeEscapeShortcut(self):
'''removeEscapeShortcut() ... internal function - do not call.'''
"""removeEscapeShortcut() ... internal function - do not call."""
if self.escape:
self.formPoint.removeAction(self.escape)
self.escape = None
def getPoint(self, whenDone, start=None):
'''getPoint(whenDone, start=None) ... invoke Snapper and call whenDone when a point is entered or the user cancels the operation.
"""getPoint(whenDone, start=None) ... invoke Snapper and call whenDone when a point is entered or the user cancels the operation.
whenDone(point, obj) is called either with a point and the object on which the point lies if the user set the point,
or None and None if the user cancelled the operation.
start is an optional Vector indicating from where to start Snapper. This is mostly used when editing existing points. Snapper also
creates a dotted line indicating from where the original point started from.
If start is specified the Snapper UI is closed on the first point the user enters. If start remains None, then Snapper is kept open
until the user explicitly closes Snapper. This lets the user enter multiple points in quick succession.'''
until the user explicitly closes Snapper. This lets the user enter multiple points in quick succession."""
# there's no get point without Snapper, if it's not loaded, need to do that explicitly
if not hasattr(FreeCADGui, 'Snapper'):
if not hasattr(FreeCADGui, "Snapper"):
import DraftTools
def displayPoint(p):
self.point = p
self.formPoint.globalX.setProperty('rawValue', p.x)
self.formPoint.globalY.setProperty('rawValue', p.y)
self.formPoint.globalZ.setProperty('rawValue', p.z)
self.formPoint.globalX.setProperty("rawValue", p.x)
self.formPoint.globalY.setProperty("rawValue", p.y)
self.formPoint.globalZ.setProperty("rawValue", p.z)
self.formPoint.globalX.setFocus()
self.formPoint.globalX.selectAll()
@@ -129,10 +140,10 @@ class TaskPanel:
screenpos = tuple(pos.getValue())
snapInfo = Draft.get3DView().getObjectInfo(screenpos)
if snapInfo:
obj = FreeCAD.ActiveDocument.getObject(snapInfo['Object'])
if hasattr(obj, 'Path'):
obj = FreeCAD.ActiveDocument.getObject(snapInfo["Object"])
if hasattr(obj, "Path"):
self.obj = obj
p = FreeCAD.Vector(snapInfo['x'], snapInfo['y'], snapInfo['z'])
p = FreeCAD.Vector(snapInfo["x"], snapInfo["y"], snapInfo["z"])
self.pt = p
else:
self.obj = None
@@ -140,7 +151,9 @@ class TaskPanel:
# Snapper handles regular objects just fine
cntrl = event.wasCtrlDown()
shift = event.wasShiftDown()
self.pt = FreeCADGui.Snapper.snap(pos, lastpoint=start, active=cntrl, constrain=shift)
self.pt = FreeCADGui.Snapper.snap(
pos, lastpoint=start, active=cntrl, constrain=shift
)
plane = FreeCAD.DraftWorkingPlane
p = plane.getLocalCoords(self.pt)
self.obj = FreeCADGui.Snapper.lastSnappedObject
@@ -150,7 +163,10 @@ class TaskPanel:
def click(cb):
event = cb.getEvent()
if event.getButton() == 1 and event.getState() == coin.SoMouseButtonEvent.DOWN:
if (
event.getButton() == 1
and event.getState() == coin.SoMouseButtonEvent.DOWN
):
if self.obj:
accept()
@@ -173,16 +189,20 @@ class TaskPanel:
displayPoint(FreeCAD.Vector(0, 0, 0))
self.view = Draft.get3DView()
self.pointCbClick = self.view.addEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), click)
self.pointCbMove = self.view.addEventCallbackPivy(coin.SoLocation2Event.getClassTypeId(), mouseMove)
self.pointCbClick = self.view.addEventCallbackPivy(
coin.SoMouseButtonEvent.getClassTypeId(), click
)
self.pointCbMove = self.view.addEventCallbackPivy(
coin.SoLocation2Event.getClassTypeId(), mouseMove
)
if self.buttonBox:
self.buttonBox.setEnabled(False)
FreeCADGui.Snapper.forceGridOff=True
FreeCADGui.Snapper.forceGridOff = True
def pointFinish(self, ok, cleanup = True):
'''pointFinish(ok, cleanup=True) ... internal function - do not call.'''
def pointFinish(self, ok, cleanup=True):
"""pointFinish(ok, cleanup=True) ... internal function - do not call."""
if cleanup:
self.removeGlobalCallbacks()
@@ -201,34 +221,38 @@ class TaskPanel:
self.pointWhenDone(None, None)
def pointDone(self):
'''pointDone() ... internal function - do not call.'''
"""pointDone() ... internal function - do not call."""
self.pointFinish(False)
def pointReject(self):
'''pointReject() ... internal function - do not call.'''
"""pointReject() ... internal function - do not call."""
self.pointFinish(False)
def pointAccept(self):
'''pointAccept() ... internal function - do not call.'''
"""pointAccept() ... internal function - do not call."""
self.pointFinish(True)
def pointAcceptAndContinue(self):
'''pointAcceptAndContinue() ... internal function - do not call.'''
"""pointAcceptAndContinue() ... internal function - do not call."""
self.pointFinish(True, False)
def removeGlobalCallbacks(self):
'''removeGlobalCallbacks() ... internal function - do not call.'''
if hasattr(self, 'view') and self.view:
"""removeGlobalCallbacks() ... internal function - do not call."""
if hasattr(self, "view") and self.view:
if self.pointCbClick:
self.view.removeEventCallbackPivy(coin.SoMouseButtonEvent.getClassTypeId(), self.pointCbClick)
self.view.removeEventCallbackPivy(
coin.SoMouseButtonEvent.getClassTypeId(), self.pointCbClick
)
self.pointCbClick = None
if self.pointCbMove:
self.view.removeEventCallbackPivy(coin.SoLocation2Event.getClassTypeId(), self.pointCbMove)
self.view.removeEventCallbackPivy(
coin.SoLocation2Event.getClassTypeId(), self.pointCbMove
)
self.pointCbMove = None
self.view = None
def updatePoint(self, usePoint = True):
'''updatePoint() ... internal function - do not call.'''
def updatePoint(self, usePoint=True):
"""updatePoint() ... internal function - do not call."""
if usePoint and self.point:
self.pt = self.point
else:
@@ -236,4 +260,3 @@ class TaskPanel:
y = FreeCAD.Units.Quantity(self.formPoint.globalY.text()).Value
z = FreeCAD.Units.Quantity(self.formPoint.globalZ.text()).Value
self.pt = FreeCAD.Vector(x, y, z)