489 lines
22 KiB
Python
489 lines
22 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 Path
|
|
import PathScripts.PathGeom as PathGeom
|
|
import PathScripts.PathLog as PathLog
|
|
import PathScripts.PathSetupSheet as PathSetupSheet
|
|
import PathScripts.PathUtil as PathUtil
|
|
import PathScripts.PathUtils as PathUtils
|
|
|
|
from PathScripts.PathUtils import waiting_effects
|
|
from PySide import QtCore
|
|
|
|
__title__ = "Base class for all operations."
|
|
__author__ = "sliptonic (Brad Collette)"
|
|
__url__ = "http://www.freecadweb.org"
|
|
__doc__ = "Base class and properties implementation for all Path operations."
|
|
|
|
if False:
|
|
PathLog.setLevel(PathLog.Level.DEBUG, PathLog.thisModule())
|
|
PathLog.trackModule()
|
|
else:
|
|
PathLog.setLevel(PathLog.Level.INFO, PathLog.thisModule())
|
|
|
|
|
|
# Qt tanslation handling
|
|
def translate(context, text, disambig=None):
|
|
return QtCore.QCoreApplication.translate(context, text, disambig)
|
|
|
|
FeatureTool = 0x0001 # ToolController
|
|
FeatureDepths = 0x0002 # FinalDepth, StartDepth
|
|
FeatureHeights = 0x0004 # ClearanceHeight, SafeHeight
|
|
FeatureStartPoint = 0x0008 # StartPoint
|
|
FeatureFinishDepth = 0x0010 # FinishDepth
|
|
FeatureStepDown = 0x0020 # StepDown
|
|
FeatureNoFinalDepth = 0x0040 # edit or not edit FinalDepth
|
|
FeatureBaseVertexes = 0x0100 # Base
|
|
FeatureBaseEdges = 0x0200 # Base
|
|
FeatureBaseFaces = 0x0400 # Base
|
|
FeatureBasePanels = 0x0800 # Base
|
|
FeatureLocations = 0x1000 # Locations
|
|
|
|
FeatureBaseGeometry = FeatureBaseVertexes | FeatureBaseFaces | FeatureBaseEdges | FeatureBasePanels
|
|
|
|
|
|
class ObjectOp(object):
|
|
'''
|
|
Base class for proxy objects of all Path operations.
|
|
|
|
Use this class as a base class for new operations. It provides properties
|
|
and some functionality for the standard properties each operation supports.
|
|
By OR'ing features from the feature list an operation can select which ones
|
|
of the standard features it requires and/or supports.
|
|
|
|
The currently supported features are:
|
|
FeatureTool ... Use of a ToolController
|
|
FeatureDepths ... Depths, for start, final
|
|
FeatureHeights ... Heights, safe and clearance
|
|
FeatureStartPoint ... Supports setting a start point
|
|
FeatureFinishDepth ... Operation supports a finish depth
|
|
FeatureStepDown ... Support for step down
|
|
FeatureNoFinalDepth ... Disable support for final depth modifications
|
|
FeatureBaseVertexes ... Base geometry support for vertexes
|
|
FeatureBaseEdges ... Base geometry support for edges
|
|
FeatureBaseFaces ... Base geometry support for faces
|
|
FeatureBasePanels ... Base geometry support for Arch.Panels
|
|
FeatureLocations ... Base location support
|
|
|
|
The base class handles all base API and forwards calls to subclasses with
|
|
an op prefix. For instance, an op is not expected to overwrite onChanged(),
|
|
but implement the function opOnChanged().
|
|
If a base class overwrites a base API function it should call the super's
|
|
implementation - otherwise the base functionality might be broken.
|
|
'''
|
|
|
|
def addBaseProperty(self, obj):
|
|
obj.addProperty("App::PropertyLinkSubListGlobal", "Base", "Path", QtCore.QT_TRANSLATE_NOOP("PathOp", "The base geometry for this operation"))
|
|
|
|
def addOpValues(self, obj, values):
|
|
if 'start' in values:
|
|
obj.addProperty("App::PropertyDistance", "OpStartDepth", "Op Values", QtCore.QT_TRANSLATE_NOOP("PathOp", "Holds the calculated value for the StartDepth"))
|
|
obj.setEditorMode('OpStartDepth', 1) # read-only
|
|
if 'final' in values:
|
|
obj.addProperty("App::PropertyDistance", "OpFinalDepth", "Op Values", QtCore.QT_TRANSLATE_NOOP("PathOp", "Holds the calculated value for the FinalDepth"))
|
|
obj.setEditorMode('OpFinalDepth', 1) # read-only
|
|
if 'tooldia' in values:
|
|
obj.addProperty("App::PropertyDistance", "OpToolDiameter", "Op Values", QtCore.QT_TRANSLATE_NOOP("PathOp", "Holds the diameter of the tool"))
|
|
obj.setEditorMode('OpToolDiameter', 1) # read-only
|
|
|
|
def __init__(self, obj):
|
|
PathLog.track()
|
|
|
|
obj.addProperty("App::PropertyBool", "Active", "Path", QtCore.QT_TRANSLATE_NOOP("PathOp", "Make False, to prevent operation from generating code"))
|
|
obj.addProperty("App::PropertyString", "Comment", "Path", QtCore.QT_TRANSLATE_NOOP("PathOp", "An optional comment for this Operation"))
|
|
obj.addProperty("App::PropertyString", "UserLabel", "Path", QtCore.QT_TRANSLATE_NOOP("PathOp", "User Assigned Label"))
|
|
|
|
features = self.opFeatures(obj)
|
|
|
|
if FeatureBaseGeometry & features:
|
|
self.addBaseProperty(obj)
|
|
|
|
if FeatureLocations & features:
|
|
obj.addProperty("App::PropertyVectorList", "Locations", "Path", QtCore.QT_TRANSLATE_NOOP("PathOp", "Base locations for this operation"))
|
|
|
|
if FeatureTool & features:
|
|
obj.addProperty("App::PropertyLink", "ToolController", "Path", QtCore.QT_TRANSLATE_NOOP("PathOp", "The tool controller that will be used to calculate the path"))
|
|
self.addOpValues(obj, ['tooldia'])
|
|
|
|
if FeatureDepths & features:
|
|
obj.addProperty("App::PropertyDistance", "StartDepth", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "Starting Depth of Tool- first cut depth in Z"))
|
|
obj.addProperty("App::PropertyDistance", "FinalDepth", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "Final Depth of Tool- lowest value in Z"))
|
|
if FeatureNoFinalDepth & features:
|
|
obj.setEditorMode('FinalDepth', 2) # hide
|
|
self.addOpValues(obj, ['start', 'final'])
|
|
else:
|
|
# StartDepth has become necessary for expressions on other properties
|
|
obj.addProperty("App::PropertyDistance", "StartDepth", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "Starting Depth internal use only for derived values"))
|
|
obj.setEditorMode('StartDepth', 1) # read-only
|
|
|
|
if FeatureStepDown & features:
|
|
obj.addProperty("App::PropertyDistance", "StepDown", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "Incremental Step Down of Tool"))
|
|
|
|
if FeatureFinishDepth & features:
|
|
obj.addProperty("App::PropertyDistance", "FinishDepth", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "Maximum material removed on final pass."))
|
|
|
|
if FeatureHeights & features:
|
|
obj.addProperty("App::PropertyDistance", "ClearanceHeight", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "The height needed to clear clamps and obstructions"))
|
|
obj.addProperty("App::PropertyDistance", "SafeHeight", "Depth", QtCore.QT_TRANSLATE_NOOP("PathOp", "Rapid Safety Height between locations."))
|
|
|
|
if FeatureStartPoint & features:
|
|
obj.addProperty("App::PropertyVectorDistance", "StartPoint", "Start Point", QtCore.QT_TRANSLATE_NOOP("PathOp", "The start point of this path"))
|
|
obj.addProperty("App::PropertyBool", "UseStartPoint", "Start Point", QtCore.QT_TRANSLATE_NOOP("PathOp", "make True, if specifying a Start Point"))
|
|
|
|
self.initOperation(obj)
|
|
|
|
if self.setDefaultValues(obj):
|
|
obj.Proxy = self
|
|
|
|
def setEditorModes(self, obj, features):
|
|
'''Editor modes are not preserved during document store/restore, set editor modes for all properties'''
|
|
|
|
for op in ['OpStartDepth', 'OpFinalDepth', 'OpToolDiameter']:
|
|
if hasattr(obj, op):
|
|
obj.setEditorMode(op, 1) # read-only
|
|
|
|
if FeatureDepths & features:
|
|
if FeatureNoFinalDepth & features:
|
|
obj.setEditorMode('OpFinalDepth', 2)
|
|
|
|
def onDocumentRestored(self, obj):
|
|
features = self.opFeatures(obj)
|
|
if FeatureBaseGeometry & features and 'App::PropertyLinkSubList' == obj.getTypeIdOfProperty('Base'):
|
|
PathLog.info("Replacing link property with global link (%s)." % obj.State)
|
|
base = obj.Base
|
|
obj.removeProperty('Base')
|
|
self.addBaseProperty(obj)
|
|
obj.Base = base
|
|
obj.touch()
|
|
obj.Document.recompute()
|
|
|
|
if FeatureTool & features and not hasattr(obj, 'OpToolDiameter'):
|
|
self.addOpValues(obj, ['tooldia'])
|
|
|
|
if FeatureDepths & features and not hasattr(obj, 'OpStartDepth'):
|
|
self.addOpValues(obj, ['start', 'final'])
|
|
|
|
self.setEditorModes(obj, features)
|
|
self.opOnDocumentRestored(obj)
|
|
|
|
def __getstate__(self):
|
|
'''__getstat__(self) ... called when receiver is saved.
|
|
Can safely be overwritten by subclasses.'''
|
|
return None
|
|
|
|
def __setstate__(self, state):
|
|
'''__getstat__(self) ... called when receiver is restored.
|
|
Can safely be overwritten by subclasses.'''
|
|
return None
|
|
|
|
def opFeatures(self, obj):
|
|
'''opFeatures(obj) ... returns the OR'ed list of features used and supported by the operation.
|
|
The default implementation returns "FeatureTool | FeatureDeptsh | FeatureHeights | FeatureStartPoint"
|
|
Should be overwritten by subclasses.'''
|
|
return FeatureTool | FeatureDepths | FeatureHeights | FeatureStartPoint | FeatureBaseGeometry | FeatureFinishDepth
|
|
|
|
def initOperation(self, obj):
|
|
'''initOperation(obj) ... implement to create additional properties.
|
|
Should be overwritten by subclasses.'''
|
|
pass
|
|
|
|
def opOnDocumentRestored(self, obj):
|
|
'''opOnDocumentRestored(obj) ... implement if an op needs special handling like migrating the data model.
|
|
Should be overwritten by subclasses.'''
|
|
pass
|
|
|
|
def opOnChanged(self, obj, prop):
|
|
'''opOnChanged(obj, prop) ... overwrite to process property changes.
|
|
This is a callback function that is invoked each time a property of the
|
|
receiver is assigned a value. Note that the FC framework does not
|
|
distinguish between assigning a different value and assigning the same
|
|
value again.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
|
|
def opSetDefaultValues(self, obj):
|
|
'''opSetDefaultValues(obj) ... overwrite to set initial default values.
|
|
Called after the receiver has been fully created with all properties.
|
|
Can safely be overwritten by subclasses.'''
|
|
pass
|
|
|
|
def opUpdateDepths(self, obj):
|
|
'''opUpdateDepths(obj) ... overwrite to implement special depths calculation.
|
|
Can safely be overwritten by subclass.'''
|
|
pass
|
|
|
|
def opExecute(self, obj):
|
|
'''opExecute(obj) ... called whenever the receiver needs to be recalculated.
|
|
See documentation of execute() for a list of base functionality provided.
|
|
Should be overwritten by subclasses.'''
|
|
pass
|
|
|
|
def opRejectAddBase(self, obj, base, sub):
|
|
'''opRejectAddBase(base, sub) ... if op returns True the addition of the feature is prevented.
|
|
Should be overwritten by subclasses.'''
|
|
return False
|
|
|
|
def onChanged(self, obj, prop):
|
|
'''onChanged(obj, prop) ... base implementation of the FC notification framework.
|
|
Do not overwrite, overwrite opOnChanged() instead.'''
|
|
|
|
if not 'Restore' in obj.State and prop in ['Base', 'StartDepth', 'FinalDepth']:
|
|
self.updateDepths(obj, True)
|
|
|
|
self.opOnChanged(obj, prop)
|
|
|
|
def applyExpression(self, obj, prop, expr):
|
|
'''applyExpression(obj, prop, expr) ... set expression expr on obj.prop if expr is set'''
|
|
if expr:
|
|
obj.setExpression(prop, expr)
|
|
return True
|
|
return False
|
|
|
|
def setDefaultValues(self, obj):
|
|
'''setDefaultValues(obj) ... base implementation.
|
|
Do not overwrite, overwrite opSetDefaultValues() instead.'''
|
|
job = PathUtils.addToJob(obj)
|
|
|
|
obj.Active = True
|
|
|
|
features = self.opFeatures(obj)
|
|
|
|
if FeatureTool & features:
|
|
if 1 < len(job.Operations.Group):
|
|
obj.ToolController = PathUtil.toolControllerForOp(job.Operations.Group[-2])
|
|
else:
|
|
obj.ToolController = PathUtils.findToolController(obj)
|
|
if not obj.ToolController:
|
|
return False
|
|
obj.OpToolDiameter = obj.ToolController.Tool.Diameter
|
|
|
|
if FeatureDepths & features:
|
|
if self.applyExpression(obj, 'StartDepth', job.SetupSheet.StartDepthExpression):
|
|
obj.OpStartDepth = 1.0
|
|
else:
|
|
obj.StartDepth = 1.0
|
|
if self.applyExpression(obj, 'FinalDepth', job.SetupSheet.FinalDepthExpression):
|
|
obj.OpFinalDepth = 0.0
|
|
else:
|
|
obj.FinalDepth = 0.0
|
|
else:
|
|
obj.StartDepth = 1.0
|
|
|
|
if FeatureStepDown & features:
|
|
if not self.applyExpression(obj, 'StepDown', job.SetupSheet.StepDownExpression):
|
|
obj.StepDown = '1 mm'
|
|
|
|
if FeatureHeights & features:
|
|
if job.SetupSheet.SafeHeightExpression:
|
|
if not self.applyExpression(obj, 'SafeHeight', job.SetupSheet.SafeHeightExpression):
|
|
obj.SafeHeight = '3 mm'
|
|
if job.SetupSheet.ClearanceHeightExpression:
|
|
if not self.applyExpression(obj, 'ClearanceHeight', job.SetupSheet.ClearanceHeightExpression):
|
|
obj.ClearanceHeight = '5 mm'
|
|
|
|
if FeatureStartPoint & features:
|
|
obj.UseStartPoint = False
|
|
|
|
self.opSetDefaultValues(obj)
|
|
obj.recompute()
|
|
return True
|
|
|
|
def _setBaseAndStock(self, obj, ignoreErrors=False):
|
|
job = PathUtils.findParentJob(obj)
|
|
if not job:
|
|
if not ignoreErrors:
|
|
PathLog.error(translate("Path", "No parent job found for operation."))
|
|
return False
|
|
if not job.Base:
|
|
if not ignoreErrors:
|
|
PathLog.error(translate("Path", "Parent job %s doesn't have a base object") % job.Label)
|
|
return False
|
|
self.job = job
|
|
self.baseobject = job.Base
|
|
self.stock = job.Stock
|
|
return True
|
|
|
|
def getJob(self, obj):
|
|
'''getJob(obj) ... return the job this operation is part of.'''
|
|
if not hasattr(self, 'job'):
|
|
if not self._setBaseAndStock(obj):
|
|
return None
|
|
return self.job
|
|
|
|
def updateDepths(self, obj, ignoreErrors=False):
|
|
'''updateDepths(obj) ... base implementation calculating depths depending on base geometry.
|
|
Should not be overwritten.'''
|
|
|
|
def faceZmin(bb, fbb):
|
|
if fbb.ZMax == fbb.ZMin and fbb.ZMax == bb.ZMax: # top face
|
|
return fbb.ZMin
|
|
elif fbb.ZMax > fbb.ZMin and fbb.ZMax == bb.ZMax: # vertical face, full cut
|
|
return fbb.ZMin
|
|
elif fbb.ZMax > fbb.ZMin and fbb.ZMin > bb.ZMin: # internal vertical wall
|
|
return fbb.ZMin
|
|
elif fbb.ZMax == fbb.ZMin and fbb.ZMax > bb.ZMin: # face/shelf
|
|
return fbb.ZMin
|
|
return bb.ZMin
|
|
|
|
if not self._setBaseAndStock(obj, ignoreErrors):
|
|
return False
|
|
|
|
stockBB = self.stock.Shape.BoundBox
|
|
zmin = stockBB.ZMin
|
|
zmax = stockBB.ZMax
|
|
|
|
if hasattr(obj, 'Base') and obj.Base:
|
|
for base, sublist in obj.Base:
|
|
bb = base.Shape.BoundBox
|
|
zmax = max(zmax, bb.ZMax)
|
|
for sub in sublist:
|
|
fbb = base.Shape.getElement(sub).BoundBox
|
|
zmin = max(zmin, faceZmin(bb, fbb))
|
|
zmax = max(zmax, fbb.ZMax)
|
|
else:
|
|
# clearing with stock boundaries
|
|
job = PathUtils.findParentJob(obj)
|
|
zmax = stockBB.ZMax
|
|
zmin = job.Base.Shape.BoundBox.ZMax
|
|
|
|
if FeatureDepths & self.opFeatures(obj):
|
|
# first set update final depth, it's value is not negotiable
|
|
if not PathGeom.isRoughly(obj.OpFinalDepth.Value, zmin):
|
|
obj.OpFinalDepth = zmin
|
|
zmin = obj.OpFinalDepth.Value
|
|
|
|
def minZmax(z):
|
|
if hasattr(obj, 'StepDown') and not PathGeom.isRoughly(obj.StepDown.Value, 0):
|
|
return z + obj.StepDown.Value
|
|
else:
|
|
return z + 1
|
|
|
|
# ensure zmax is higher than zmin
|
|
if (zmax - 0.0001) <= zmin:
|
|
zmax = minZmax(zmin)
|
|
|
|
# update start depth if requested and required
|
|
if not PathGeom.isRoughly(obj.OpStartDepth.Value, zmax):
|
|
obj.OpStartDepth = zmax
|
|
else:
|
|
# every obj has a StartDepth
|
|
if obj.StartDepth.Value != zmax:
|
|
obj.StartDepth = zmax
|
|
|
|
self.opUpdateDepths(obj)
|
|
|
|
@waiting_effects
|
|
def execute(self, obj):
|
|
'''execute(obj) ... base implementation - do not overwrite!
|
|
Verifies that the operation is assigned to a job and that the job also has a valid Base.
|
|
It also sets the following instance variables that can and should be safely be used by
|
|
implementation of opExecute():
|
|
self.baseobject ... Base object of the Job itself
|
|
self.stock ... Stock object fo the Job itself
|
|
self.vertFeed ... vertical feed rate of assigned tool
|
|
self.vertRapid ... vertical rapid rate of assigned tool
|
|
self.horizFeed ... horizontal feed rate of assigned tool
|
|
self.horizRapid ... norizontal rapid rate of assigned tool
|
|
self.tool ... the actual tool being used
|
|
self.radius ... the main radius of the tool being used
|
|
self.commandlist ... a list for collecting all commands produced by the operation
|
|
|
|
Once everything is validated and above variables are set the implementation calls
|
|
opExecute(obj) - which is expected to add the generated commands to self.commandlist
|
|
Finally the base implementation adds a rapid move to clearance height and assigns
|
|
the receiver's Path property from the command list.
|
|
'''
|
|
PathLog.track()
|
|
|
|
if not obj.Active:
|
|
path = Path.Path("(inactive operation)")
|
|
obj.Path = path
|
|
if obj.ViewObject:
|
|
obj.ViewObject.Visibility = False
|
|
return
|
|
|
|
if not self._setBaseAndStock(obj):
|
|
return
|
|
|
|
if FeatureTool & self.opFeatures(obj):
|
|
tc = obj.ToolController
|
|
if tc is None or tc.ToolNumber == 0:
|
|
FreeCAD.Console.PrintError("No Tool Controller is selected. We need a tool to build a Path.")
|
|
return
|
|
else:
|
|
self.vertFeed = tc.VertFeed.Value
|
|
self.horizFeed = tc.HorizFeed.Value
|
|
self.vertRapid = tc.VertRapid.Value
|
|
self.horizRapid = tc.HorizRapid.Value
|
|
tool = tc.Proxy.getTool(tc)
|
|
if not tool or tool.Diameter == 0:
|
|
FreeCAD.Console.PrintError("No Tool found or diameter is zero. We need a tool to build a Path.")
|
|
return
|
|
self.radius = tool.Diameter/2
|
|
self.tool = tool
|
|
obj.OpToolDiameter = tool.Diameter
|
|
|
|
self.updateDepths(obj)
|
|
# now that all op values are set make sure the user properties get updated accordingly,
|
|
# in case they still have an expression referencing any op values
|
|
obj.recompute()
|
|
|
|
self.commandlist = []
|
|
self.commandlist.append(Path.Command("(%s)" % obj.Label))
|
|
if obj.Comment:
|
|
self.commandlist.append(Path.Command("(%s)" % obj.Comment))
|
|
|
|
result = self.opExecute(obj)
|
|
|
|
if FeatureHeights & self.opFeatures(obj):
|
|
# Let's finish by rapid to clearance...just for safety
|
|
self.commandlist.append(Path.Command("G0", {"Z": obj.ClearanceHeight.Value}))
|
|
|
|
path = Path.Path(self.commandlist)
|
|
obj.Path = path
|
|
return result
|
|
|
|
def addBase(self, obj, base, sub):
|
|
PathLog.track(obj, base, sub)
|
|
base = PathUtil.getPublicObject(base)
|
|
|
|
if self._setBaseAndStock(obj):
|
|
if base == self.job.Proxy.baseObject(self.job):
|
|
base = self.baseobject
|
|
baselist = obj.Base
|
|
if baselist is None:
|
|
baselist = []
|
|
for p, el in baselist:
|
|
if p == base and sub in el:
|
|
PathLog.notice((translate("Path", "Base object %s.%s already in the list")+"\n") % (base.Label, sub))
|
|
return
|
|
|
|
if not self.opRejectAddBase(obj, base, sub):
|
|
baselist.append((base, sub))
|
|
obj.Base = baselist
|
|
else:
|
|
PathLog.notice((translate("Path", "Base object %s.%s rejected by operation")+"\n") % (base.Label, sub))
|