PathScripts.PathEngrave.ObjectEngrave Class Reference

Public Member Functions
def initOperation (self, obj)
def opExecute (self, obj)
def opFeatures (self, obj)
def opOnDocumentRestored (self, obj)
def opUpdateDepths (self, obj)
def setupAdditionalProperties (self, obj)
Public Member Functions inherited from PathScripts.PathEngraveBase.ObjectOp
def appendCommand (self, cmd, z, relZ, feed)
def buildpathocc (self, obj, wires, zValues, relZ=False, forward=True, start_idx=0)
def getZValues (self, obj)
def opSetDefaultValues (self, obj, job)
Public Member Functions inherited from PathScripts.PathOp.ObjectOp
def addBase (self, obj, base, sub)
def addBaseProperty (self, obj)
def addOpValues (self, obj, values)
def applyExpression (self, obj, prop, expr)
def execute (self, obj)
def getCycleTimeEstimate (self, obj)
def getJob (self, obj)
def onChanged (self, obj, prop)
def onDocumentRestored (self, obj)
def opOnChanged (self, obj, prop)
def opRejectAddBase (self, obj, base, sub)
def setDefaultValues (self, obj)
def setEditorModes (self, obj, features)
def updateDepths (self, obj, ignoreErrors=False)

Public Attributes
wires
Public Attributes inherited from PathScripts.PathOp.ObjectOp
addNewProps
commandlist
horizFeed
horizRapid
job
model
radius
stock
tool
vertFeed
vertRapid

Detailed Description

Proxy class for Engrave operation.

Member Function Documentation

initOperation()

def PathScripts.PathEngrave.ObjectEngrave.initOperation	(		self,
			obj
	)

initOperation(obj) ... create engraving specific properties.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathEngrave.ObjectEngrave.setupAdditionalProperties(), and PathScripts.PathAreaOp.ObjectOp.setupAdditionalProperties().

opExecute()

def PathScripts.PathEngrave.ObjectEngrave.opExecute	(		self,
			obj
	)

opExecute(obj) ... process engraving operation

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathEngraveBase.ObjectOp.buildpathocc(), PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathEngraveBase.ObjectOp.getZValues(), PathScripts.PathJobDlg.JobCreate.model, PartGui::TaskCheckGeometryResults.model, PathScripts.PathOp.ObjectOp.model, ArchMaterial._ArchMultiMaterialTaskPanel.model, PathScripts.PathOp.ObjectOp.vertRapid, PathScripts.PathEngrave.ObjectEngrave.wires, PathScripts.PathDeburr.ObjectDeburr.wires, ArchRebar._Rebar.wires, GetWires.wires, and WireOrienter.wires.

Referenced by PathScripts.PathOp.ObjectOp.execute().

opFeatures()

def PathScripts.PathEngrave.ObjectEngrave.opFeatures	(		self,
			obj
	)

opFeatures(obj) ... return all standard features and edges based geomtries

Reimplemented from PathScripts.PathOp.ObjectOp.

Referenced by PathScripts.PathOp.ObjectOp.addOpValues(), PathScripts.PathOp.ObjectOp.execute(), PathScripts.PathOp.ObjectOp.onDocumentRestored(), PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues(), PathScripts.PathOp.ObjectOp.setDefaultValues(), and PathScripts.PathOp.ObjectOp.updateDepths().

opOnDocumentRestored()

def PathScripts.PathEngrave.ObjectEngrave.opOnDocumentRestored	(		self,
			obj
	)

opOnDocumentRestored(obj) ... implement if an op needs special handling like migrating the data model. Should be overwritten by subclasses.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathEngrave.ObjectEngrave.setupAdditionalProperties(), and PathScripts.PathAreaOp.ObjectOp.setupAdditionalProperties().

Referenced by PathScripts.PathOp.ObjectOp.onDocumentRestored().

opUpdateDepths()

def PathScripts.PathEngrave.ObjectEngrave.opUpdateDepths	(		self,
			obj
	)

updateDepths(obj) ... engraving is always done at the top most z-value

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues(), PathScripts.PathDeburr.ObjectDeburr.opSetDefaultValues(), PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues(), PathScripts.PathDrilling.ObjectDrilling.opSetDefaultValues(), and PathScripts.PathAdaptive.PathAdaptive.opSetDefaultValues().

Referenced by PathScripts.PathOp.ObjectOp.updateDepths().

setupAdditionalProperties()

def PathScripts.PathEngrave.ObjectEngrave.setupAdditionalProperties	(		self,
			obj
	)

Referenced by PathScripts.PathEngrave.ObjectEngrave.initOperation(), and PathScripts.PathEngrave.ObjectEngrave.opOnDocumentRestored().

Member Data Documentation

wires

PathScripts.PathEngrave.ObjectEngrave.wires

Referenced by PathScripts.PathEngrave.ObjectEngrave.opExecute().

---

The documentation for this class was generated from the following file:

• src/Mod/Path/PathScripts/PathEngrave.py