PathScripts.PathCircularHoleBase.ObjectOp Class Reference

Public Member Functions
def	circularHoleExecute (self, obj, holes)
def	circularHoleFeatures (self, obj)
def	findAllHoles (self, obj)
def	holeDiameter (self, obj, base, sub)
def	holePosition (self, obj, base, sub)
def	initCircularHoleOperation (self, obj)
def	initOperation (self, obj)
def	isHoleEnabled (self, obj, base, sub)
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

Detailed Description

Base class for proxy objects of all operations on circular holes.

Member Function Documentation

circularHoleExecute()

def PathScripts.PathCircularHoleBase.ObjectOp.circularHoleExecute	(		self,
			obj,
			holes
	)

circularHoleExecute(obj, holes) ... implement processing of holes.
holes is a list of dictionaries with 'x', 'y' and 'r' specified for each hole.
Note that for Vertexes, non-circular Edges and Locations r=0.
Must be overwritten by subclasses.

Reimplemented in PathScripts.PathDrilling.ObjectDrilling, PathScripts.PathHelix.ObjectHelix, and PathScripts.PathThreadMilling.ObjectThreadMilling.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.opExecute().

circularHoleFeatures()

def PathScripts.PathCircularHoleBase.ObjectOp.circularHoleFeatures	(		self,
			obj
	)

circularHoleFeatures(obj) ... overwrite to add operations specific features.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathDrilling.ObjectDrilling, PathScripts.PathHelix.ObjectHelix, and PathScripts.PathThreadMilling.ObjectThreadMilling.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.opFeatures().

findAllHoles()

def PathScripts.PathCircularHoleBase.ObjectOp.findAllHoles	(		self,
			obj
	)

findAllHoles(obj) ... find all holes of all base models and assign as features.

References PathScripts.PathOp.ObjectOp.getJob(), 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.

holeDiameter()

def PathScripts.PathCircularHoleBase.ObjectOp.holeDiameter	(		self,
			obj,
			base,
			sub
	)

holeDiameter(obj, base, sub) ... returns the diameter of the specified hole.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.opExecute().

holePosition()

def PathScripts.PathCircularHoleBase.ObjectOp.holePosition	(		self,
			obj,
			base,
			sub
	)

holePosition(obj, base, sub) ... returns a Vector for the position defined by the given features.
Note that the value for Z is set to 0.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.opExecute().

initCircularHoleOperation()

def PathScripts.PathCircularHoleBase.ObjectOp.initCircularHoleOperation	(		self,
			obj
	)

initCircularHoleOperation(obj) ... overwrite if the subclass needs initialisation.
Can safely be overwritten by subclasses.

Reimplemented in PathScripts.PathDrilling.ObjectDrilling, PathScripts.PathHelix.ObjectHelix, and PathScripts.PathThreadMilling.ObjectThreadMilling.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.initOperation().

initOperation()

def PathScripts.PathCircularHoleBase.ObjectOp.initOperation	(		self,
			obj
	)

initOperation(obj) ... adds Disabled properties and calls initCircularHoleOperation(obj).
Do not overwrite, implement initCircularHoleOperation(obj) instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathCircularHoleBase.ObjectOp.initCircularHoleOperation(), PathScripts.PathDrilling.ObjectDrilling.initCircularHoleOperation(), PathScripts.PathHelix.ObjectHelix.initCircularHoleOperation(), PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation(), and draftutils.translate.QT_TRANSLATE_NOOP.

isHoleEnabled()

def PathScripts.PathCircularHoleBase.ObjectOp.isHoleEnabled	(		self,
			obj,
			base,
			sub
	)

isHoleEnabled(obj, base, sub) ... return true if hole is enabled.

Referenced by PathScripts.PathCircularHoleBase.ObjectOp.opExecute().

opExecute()

def PathScripts.PathCircularHoleBase.ObjectOp.opExecute	(		self,
			obj
	)

opExecute(obj) ... processes all Base features and Locations and collects
them in a list of positions and radii which is then passed to circularHoleExecute(obj, holes).
If no Base geometries and no Locations are present, the job's Base is inspected and all
drillable features are added to Base. In this case appropriate values for depths are also
calculated and assigned.
Do not overwrite, implement circularHoleExecute(obj, holes) instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathCircularHoleBase.ObjectOp.circularHoleExecute(), PathScripts.PathDrilling.ObjectDrilling.circularHoleExecute(), PathScripts.PathHelix.ObjectHelix.circularHoleExecute(), PathScripts.PathThreadMilling.ObjectThreadMilling.circularHoleExecute(), PathScripts.PathCircularHoleBase.ObjectOp.holeDiameter(), PathScripts.PathCircularHoleBase.ObjectOp.holePosition(), PathScripts.PathCircularHoleBase.ObjectOp.isHoleEnabled(), 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.PathOp.ObjectOp.execute().

opFeatures()

def PathScripts.PathCircularHoleBase.ObjectOp.opFeatures	(		self,
			obj
	)

opFeatures(obj) ... calls circularHoleFeatures(obj) and ORs in the standard features required for processing circular holes.
Do not overwrite, implement circularHoleFeatures(obj) instead

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathCircularHoleBase.ObjectOp.circularHoleFeatures(), PathScripts.PathDrilling.ObjectDrilling.circularHoleFeatures(), PathScripts.PathHelix.ObjectHelix.circularHoleFeatures(), and PathScripts.PathThreadMilling.ObjectThreadMilling.circularHoleFeatures().

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/PathCircularHoleBase.py