PathScripts.PathEngraveBase.ObjectOp Class Reference

Public Member Functions
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	initOperation (self, obj)
def	isToolSupported (self, obj, tool)
def	onChanged (self, obj, prop)
def	onDocumentRestored (self, obj)
def	opExecute (self, obj)
def	opFeatures (self, obj)
def	opOnChanged (self, obj, prop)
def	opOnDocumentRestored (self, obj)
def	opPropertyEnumerations (self, dataType="data")
def	opRejectAddBase (self, obj, base, sub)
def	opSetDefaultValues (self, obj, job)
def	opUpdateDepths (self, obj)
def	sanitizeBase (self, obj)
def	setDefaultValues (self, obj)
def	setEditorModes (self, obj, features)
def	updateDepths (self, obj, ignoreErrors=False)

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

Detailed Description

Proxy base class for engrave operations.

Member Function Documentation

appendCommand()

def PathScripts.PathEngraveBase.ObjectOp.appendCommand	(		self,
			cmd,
			z,
			relZ,
			feed
	)

References PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathVcarve.ObjectVcarve.commandlist, and PathTests.TestPathHelpers.TestPathHelpers.commandlist.

Referenced by PathScripts.PathEngraveBase.ObjectOp.buildpathocc().

buildpathocc()

def PathScripts.PathEngraveBase.ObjectOp.buildpathocc	(		self,
			obj,
			wires,
			zValues,
			relZ = False,
			forward = True,
			start_idx = 0
	)

buildpathocc(obj, wires, zValues, relZ=False) ... internal helper function to generate engraving commands.

References PathScripts.PathEngraveBase.ObjectOp.appendCommand(), PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathVcarve.ObjectVcarve.commandlist, PathTests.TestPathHelpers.TestPathHelpers.commandlist, PathScripts.PathOp.ObjectOp.horizFeed, PathScripts.PathToolControllerGui.ToolControllerEditor.horizFeed, PathScripts.PathOp.ObjectOp.horizRapid, PathScripts.PathToolControllerGui.ToolControllerEditor.horizRapid, PathScripts.PathOp.ObjectOp.vertFeed, PathScripts.PathToolControllerGui.ToolControllerEditor.vertFeed, PathScripts.PathOp.ObjectOp.vertRapid, and PathScripts.PathToolControllerGui.ToolControllerEditor.vertRapid.

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

getZValues()

def PathScripts.PathEngraveBase.ObjectOp.getZValues	(		self,
			obj
	)

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

opSetDefaultValues()

def PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues	(		self,
			obj,
			job
	)

opSetDefaultValues(obj) ... set depths for engraving

Reimplemented from PathScripts.PathOp.ObjectOp.

Reimplemented in PathScripts.PathDeburr.ObjectDeburr, and PathScripts.PathVcarve.ObjectVcarve.

References PathScripts.PathAdaptive.PathAdaptive.opFeatures(), PathScripts.PathAreaOp.ObjectOp.opFeatures(), PathScripts.PathCircularHoleBase.ObjectOp.opFeatures(), PathScripts.PathCustom.ObjectCustom.opFeatures(), PathScripts.PathDeburr.ObjectDeburr.opFeatures(), PathScripts.PathEngrave.ObjectEngrave.opFeatures(), PathScripts.PathOp.ObjectOp.opFeatures(), PathScripts.PathProbe.ObjectProbing.opFeatures(), PathScripts.PathSlot.ObjectSlot.opFeatures(), PathScripts.PathSurface.ObjectSurface.opFeatures(), PathScripts.PathVcarve.ObjectVcarve.opFeatures(), and PathScripts.PathWaterline.ObjectWaterline.opFeatures().

Referenced by PathScripts.PathEngrave.ObjectEngrave.opUpdateDepths(), PathScripts.PathVcarve.ObjectVcarve.opUpdateDepths(), and PathScripts.PathOp.ObjectOp.setDefaultValues().

---

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

• FreeCAD/src/Mod/Path/PathScripts/PathEngraveBase.py