PathScripts.PathDeburr.ObjectDeburr Class Reference

Public Member Functions
def	initOperation (self, obj)
def	opExecute (self, obj)
def	opFeatures (self, obj)
def	opOnDocumentRestored (self, obj)
def	opRejectAddBase (self, obj, base, sub)
def	opSetDefaultValues (self, obj, job)
def	propertyEnumerations (self, dataType="data")
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	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
	adjusted_basewires
	basewires
	edges
	printInfo
	wires
Public Attributes inherited from PathScripts.PathOp.ObjectOp
	addNewProps
	commandlist
	horizFeed
	horizRapid
	job
	model
	radius
	stock
	tool
	vertFeed
	vertRapid

Detailed Description

Proxy class for Deburr operation.

Member Function Documentation

initOperation()

def PathScripts.PathDeburr.ObjectDeburr.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.PathDeburr.ObjectDeburr.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.

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

opFeatures()

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

opRejectAddBase()

def PathScripts.PathDeburr.ObjectDeburr.opRejectAddBase	(		self,
			obj,
			base,
			sub
	)

The chamfer op can only deal with features of the base model, all others are rejected.

Reimplemented from PathScripts.PathOp.ObjectOp.

References Gui::VectorListEditor.model, ArchMaterial._ArchMultiMaterialTaskPanel.model, PartGui::TaskCheckGeometryResults.model, PathScripts.PathFeatureExtensionsGui.TaskPanelExtensionPage.model, PathScripts.PathJobDlg.JobCreate.model, PathScripts.PathOp.ObjectOp.model, PathScripts.PathPropertyBagGui.TaskPanel.model, PathScripts.PathSetupSheetGui.OpTaskPanel.model, PathScripts.PathToolBitEdit.ToolBitEditor.model, and SpreadsheetGui::SheetView.model.

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

opSetDefaultValues()

def PathScripts.PathDeburr.ObjectDeburr.opSetDefaultValues	(		self,
			obj,
			job
	)

opSetDefaultValues(obj) ... set depths for engraving

Reimplemented from PathScripts.PathEngraveBase.ObjectOp.

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

propertyEnumerations()

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

opPropertyEnumerations(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

adjusted_basewires

PathScripts.PathDeburr.ObjectDeburr.adjusted_basewires

basewires

PathScripts.PathDeburr.ObjectDeburr.basewires

edges

PathScripts.PathDeburr.ObjectDeburr.edges

Referenced by draftguitools.gui_dimensions.Dimension.action(), PathScripts.PathDressupHoldingTags.MapWireToTag.addEdge(), PathScripts.PathDressupHoldingTags.MapWireToTag.commandsForEdges(), draftguitools.gui_dimensions.Dimension.create_angle_dimension(), PathScripts.PathDressupTag.ObjectDressup.execute(), PathScripts.PathDressupTag.ObjectDressup.pointIsOnPath(), draftguitools.gui_trimex.Trimex.redraw(), draftguitools.gui_dimensions.Dimension.set_selection(), and PathScripts.PathDressupHoldingTags.MapWireToTag.shell().

printInfo

PathScripts.PathDeburr.ObjectDeburr.printInfo

wires

PathScripts.PathDeburr.ObjectDeburr.wires

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

---

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

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