PathScripts.PathVcarve.ObjectVcarve Class Reference

Public Member Functions
def	buildPathMedial (self, obj, faces)
def	initOperation (self, obj)
def	isToolSupported (self, obj, tool)
def	opExecute (self, obj)
def	opFeatures (self, obj)
def	opOnDocumentRestored (self, obj)
def	opSetDefaultValues (self, obj, job)
def	opUpdateDepths (self, obj, ignoreErrors=False)
def	setupAdditionalProperties (self, obj)
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
	commandlist
Public Attributes inherited from PathScripts.PathOp.ObjectOp
	addNewProps
	commandlist
	horizFeed
	horizRapid
	job
	model
	radius
	stock
	tool
	vertFeed
	vertRapid

Detailed Description

Proxy class for Vcarve operation.

Member Function Documentation

buildPathMedial()

def PathScripts.PathVcarve.ObjectVcarve.buildPathMedial	(		self,
			obj,
			faces
	)

constructs a medial axis path using openvoronoi

References PathScripts.PathVcarve.ObjectVcarve._getPartEdges(), 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.PathVcarve.ObjectVcarve.opExecute().

initOperation()

def PathScripts.PathVcarve.ObjectVcarve.initOperation	(		self,
			obj
	)

initOperation(obj) ... create vcarve specific properties.

Reimplemented from PathScripts.PathOp.ObjectOp.

References draftutils.translate.QT_TRANSLATE_NOOP, PathScripts.PathEngrave.ObjectEngrave.setupAdditionalProperties(), and PathScripts.PathVcarve.ObjectVcarve.setupAdditionalProperties().

isToolSupported()

def PathScripts.PathVcarve.ObjectVcarve.isToolSupported	(		self,
			obj,
			tool
	)

isToolSupported(obj, tool) ... returns True if v-carve op can work with tool.

Reimplemented from PathScripts.PathOp.ObjectOp.

Referenced by PathScripts.PathThreadMilling.ObjectThreadMilling.circularHoleExecute().

opExecute()

def PathScripts.PathVcarve.ObjectVcarve.opExecute	(		self,
			obj
	)

opExecute(obj) ... process engraving operation

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathVcarve.ObjectVcarve.buildPathMedial(), 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.execute().

opFeatures()

def PathScripts.PathVcarve.ObjectVcarve.opFeatures	(		self,
			obj
	)

opFeatures(obj) ... return all standard features and edges based geomtries

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.PathVcarve.ObjectVcarve.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.

References PathScripts.PathEngrave.ObjectEngrave.setupAdditionalProperties(), and PathScripts.PathVcarve.ObjectVcarve.setupAdditionalProperties().

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

opSetDefaultValues()

def PathScripts.PathVcarve.ObjectVcarve.opSetDefaultValues	(		self,
			obj,
			job
	)

opSetDefaultValues(obj) ... set depths for vcarving

Reimplemented from PathScripts.PathEngraveBase.ObjectOp.

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().

opUpdateDepths()

def PathScripts.PathVcarve.ObjectVcarve.opUpdateDepths	(		self,
			obj,
			ignoreErrors = False
	)

updateDepths(obj) ... engraving is always done at the top most z-value

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathAdaptive.PathAdaptive.opSetDefaultValues(), PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues(), PathScripts.PathDeburr.ObjectDeburr.opSetDefaultValues(), PathScripts.PathDrilling.ObjectDrilling.opSetDefaultValues(), PathScripts.PathEngraveBase.ObjectOp.opSetDefaultValues(), PathScripts.PathOp.ObjectOp.opSetDefaultValues(), PathScripts.PathProbe.ObjectProbing.opSetDefaultValues(), PathScripts.PathSlot.ObjectSlot.opSetDefaultValues(), PathScripts.PathSurface.ObjectSurface.opSetDefaultValues(), PathScripts.PathThreadMilling.ObjectThreadMilling.opSetDefaultValues(), PathScripts.PathVcarve.ObjectVcarve.opSetDefaultValues(), and PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues().

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

setupAdditionalProperties()

def PathScripts.PathVcarve.ObjectVcarve.setupAdditionalProperties	(		self,
			obj
	)

References draftutils.translate.QT_TRANSLATE_NOOP.

Referenced by PathScripts.PathEngrave.ObjectEngrave.initOperation(), PathScripts.PathVcarve.ObjectVcarve.initOperation(), PathScripts.PathEngrave.ObjectEngrave.opOnDocumentRestored(), and PathScripts.PathVcarve.ObjectVcarve.opOnDocumentRestored().

Member Data Documentation

commandlist

PathScripts.PathVcarve.ObjectVcarve.commandlist

Referenced by PathScripts.PathEngraveBase.ObjectOp.appendCommand(), PathScripts.PathEngraveBase.ObjectOp.buildpathocc(), PathScripts.PathDrilling.ObjectDrilling.circularHoleExecute(), PathScripts.PathHelix.ObjectHelix.circularHoleExecute(), PathScripts.PathThreadMilling.ObjectThreadMilling.circularHoleExecute(), PathScripts.PathOp.ObjectOp.execute(), PathScripts.PathThreadMilling.ObjectThreadMilling.executeThreadMill(), PathScripts.PathCustom.ObjectCustom.opExecute(), PathScripts.PathEngrave.ObjectEngrave.opExecute(), PathScripts.PathProbe.ObjectProbing.opExecute(), PathTests.TestPathHelpers.TestPathHelpers.test00(), and PathTests.TestPathHelpers.TestPathHelpers.test01().

---

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

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