PathScripts.PathHelix.ObjectHelix Class Reference

Public Member Functions
def	circularHoleExecute (self, obj, holes)
def	circularHoleFeatures (self, obj)
def	helixOpPropertyEnumerations (self, dataType="data")
def	initCircularHoleOperation (self, obj)
def	opOnDocumentRestored (self, obj)
Public Member Functions inherited from PathScripts.PathCircularHoleBase.ObjectOp
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

Proxy class for Helix operations.

Member Function Documentation

circularHoleExecute()

def PathScripts.PathHelix.ObjectHelix.circularHoleExecute	(		self,
			obj,
			holes
	)

circularHoleExecute(obj, holes) ... generate helix commands for each hole in holes

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

References PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathVcarve.ObjectVcarve.commandlist, PathTests.TestPathHelpers.TestPathHelpers.commandlist, helix_generator.generate(), and PathFeedRate.setFeedRate().

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

circularHoleFeatures()

def PathScripts.PathHelix.ObjectHelix.circularHoleFeatures	(		self,
			obj
	)

circularHoleFeatures(obj) ... enable features supported by Helix.

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

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

helixOpPropertyEnumerations()

def PathScripts.PathHelix.ObjectHelix.helixOpPropertyEnumerations	(		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.PathHelix.ObjectHelix.initCircularHoleOperation().

initCircularHoleOperation()

def PathScripts.PathHelix.ObjectHelix.initCircularHoleOperation	(		self,
			obj
	)

initCircularHoleOperation(obj) ... create helix specific properties.

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

References PathScripts.PathHelix.ObjectHelix.helixOpPropertyEnumerations(), and draftutils.translate.QT_TRANSLATE_NOOP.

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

opOnDocumentRestored()

def PathScripts.PathHelix.ObjectHelix.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 draftutils.translate.QT_TRANSLATE_NOOP.

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

---

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

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