PathScripts.PathAdaptive.PathAdaptive Class Reference

Public Member Functions
def	initOperation (self, obj)
def	opExecute (self, obj)
def	opFeatures (self, obj)
def	opOnDocumentRestored (self, obj)
def	opSetDefaultValues (self, obj, job)
def	propertyEnumerations (self, dataType="data")
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)

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

Member Function Documentation

initOperation()

def PathScripts.PathAdaptive.PathAdaptive.initOperation	(		self,
			obj
	)

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

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathSurface.ObjectSurface.propertyEnumerations(), PathScripts.PathPropertyBagGui.PropertyCreate.propertyEnumerations(), PathScripts.PathAdaptive.PathAdaptive.propertyEnumerations(), PathScripts.PathDeburr.ObjectDeburr.propertyEnumerations(), PathScripts.PathDressupRampEntry.ObjectDressup.propertyEnumerations(), PathScripts.PathDrilling.ObjectDrilling.propertyEnumerations(), PathScripts.PathJob.ObjectJob.propertyEnumerations(), PathScripts.PathMillFace.ObjectFace.propertyEnumerations(), PathScripts.PathPocket.ObjectPocket.propertyEnumerations(), PathScripts.PathSlot.ObjectSlot.propertyEnumerations(), PathScripts.PathThreadMilling.ObjectThreadMilling.propertyEnumerations(), PathScripts.PathToolController.ToolController.propertyEnumerations(), PathScripts.PathWaterline.ObjectWaterline.propertyEnumerations(), and draftutils.translate.QT_TRANSLATE_NOOP.

opExecute()

def PathScripts.PathAdaptive.PathAdaptive.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.execute().

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

opFeatures()

def PathScripts.PathAdaptive.PathAdaptive.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().

opOnDocumentRestored()

def PathScripts.PathAdaptive.PathAdaptive.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.

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

opSetDefaultValues()

def PathScripts.PathAdaptive.PathAdaptive.opSetDefaultValues	(		self,
			obj,
			job
	)

opSetDefaultValues(obj, job) ... overwrite to set initial default values.
Called after the receiver has been fully created with all properties.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOp.ObjectOp.

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

propertyEnumerations()

def PathScripts.PathAdaptive.PathAdaptive.propertyEnumerations	(		self,
			dataType = "data"
	)

helixOpPropertyEnumerations(dataType="data")... return property enumeration lists of specified dataType.
Args:
    dataType = 'data', 'raw', 'translated'
Notes:
'data' is list of internal string literals used in code
'raw' is list of (translated_text, data_string) tuples
'translated' is list of translated string literals

Referenced by PathScripts.PathDrilling.ObjectDrilling.initCircularHoleOperation(), PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation(), PathScripts.PathAdaptive.PathAdaptive.initOperation(), PathScripts.PathDeburr.ObjectDeburr.initOperation(), PathScripts.PathMillFace.ObjectFace.initPocketOp(), PathScripts.PathPocket.ObjectPocket.initPocketOp(), PathScripts.PathJob.ObjectJob.onDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

Member Data Documentation

pathArray

PathScripts.PathAdaptive.PathAdaptive.pathArray

---

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

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