PathScripts.PathCustom.ObjectCustom Class Reference

Public Member Functions
def	initOperation (self, obj)
def	opExecute (self, obj)
def	opFeatures (self, obj)
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

Member Function Documentation

initOperation()

def PathScripts.PathCustom.ObjectCustom.initOperation	(		self,
			obj
	)

initOperation(obj) ... implement to create additional properties.
Should be overwritten by subclasses.

Reimplemented from PathScripts.PathOp.ObjectOp.

References draftutils.translate.QT_TRANSLATE_NOOP.

opExecute()

def PathScripts.PathCustom.ObjectCustom.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.

Reimplemented from PathScripts.PathOp.ObjectOp.

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

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

opFeatures()

def PathScripts.PathCustom.ObjectCustom.opFeatures	(		self,
			obj
	)

opFeatures(obj) ... returns the OR'ed list of features used and supported by the operation.
The default implementation returns "FeatureTool | FeatureDepths | FeatureHeights | FeatureStartPoint"
Should be overwritten by subclasses.

Reimplemented from PathScripts.PathOp.ObjectOp.

Referenced by PathScripts.PathOp.ObjectOp.addOpValues(), PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues(), PathScripts.PathOp.ObjectOp.execute(), PathScripts.PathOp.ObjectOp.onDocumentRestored(), PathScripts.PathCircularHoleBase.ObjectOp.opExecute(), PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues(), PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues(), PathScripts.PathVcarve.ObjectVcarve.opSetDefaultValues(), PathScripts.PathOp.ObjectOp.setDefaultValues(), and PathScripts.PathOp.ObjectOp.updateDepths().

---

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

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