PathScripts.PathToolController.ToolController Class Reference

Public Member Functions
def	ensureUseLegacyTool (self, obj, legacy)
def	execute (self, obj)
def	getTool (self, obj)
def	onDelete (self, obj, arg2=None)
def	onDocumentRestored (self, obj)
def	propertyEnumerations (self, dataType="data")
def	setFromTemplate (self, obj, template)
def	templateAttrs (self, obj)
def	usesLegacyTool (self, obj)

Member Function Documentation

ensureUseLegacyTool()

def PathScripts.PathToolController.ToolController.ensureUseLegacyTool	(		self,
			obj,
			legacy
	)

References draftutils.translate.QT_TRANSLATE_NOOP, and PathScripts.PathToolController.ToolController.usesLegacyTool().

Referenced by PathScripts.PathToolController.ToolController.setFromTemplate().

execute()

def PathScripts.PathToolController.ToolController.execute	(		self,
			obj
	)

References toolchange_generator.generate().

Referenced by draftobjects.facebinder.Facebinder.addSubobjects(), PathScripts.PathDressupDogbone.ObjectDressup.boneStateList(), ArchSite.Compass.buildCoordinates(), PathScripts.PathDressupHoldingTags.ObjectTagDressup.generateTags(), ArchPanel.PanelCut.getWires(), ArchSchedule.CommandArchSchedule.IsActive(), Mod.PartDesign.Scripts.DistanceBolt.DistanceBolt.onChanged(), Mod.PartDesign.Scripts.Epitrochoid.Epitrochoid.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.Parallelepiped.onChanged(), Mod.PartDesign.Scripts.Parallelepiped.BoxCylinder.onChanged(), Mod.PartDesign.Scripts.Spring.MySpring.onChanged(), FeaturePython.DistanceBolt.onChanged(), PathScripts.PathStock.StockFromBase.onChanged(), PathScripts.PathStock.StockCreateBox.onChanged(), PathScripts.PathStock.StockCreateCylinder.onChanged(), draftobjects.draftlink.DraftLink.onDocumentRestored(), draftobjects.patharray.PathArray.onDocumentRestored(), and draftobjects.pathtwistedarray.PathTwistedArray.onDocumentRestored().

getTool()

def PathScripts.PathToolController.ToolController.getTool	(		self,
			obj
	)

returns the tool associated with this tool controller

onDelete()

def PathScripts.PathToolController.ToolController.onDelete	(		self,
			obj,
			arg2 = None
	)

References PathScripts.PathToolController.ToolController.usesLegacyTool().

onDocumentRestored()

def PathScripts.PathToolController.ToolController.onDocumentRestored	(		self,
			obj
	)

propertyEnumerations()

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

setFromTemplate()

def PathScripts.PathToolController.ToolController.setFromTemplate	(		self,
			obj,
			template
	)

setFromTemplate(obj, xmlItem) ... extract properties from xmlItem
and assign to receiver.

References PathScripts.PathToolController.ToolController.ensureUseLegacyTool(), and PathScripts.PathToolController.ToolController.setFromTemplate().

Referenced by PathScripts.PathToolController.ToolController.setFromTemplate().

templateAttrs()

def PathScripts.PathToolController.ToolController.templateAttrs	(		self,
			obj
	)

templateAttrs(obj) ... answer a dictionary with all properties that should be stored for a template.

References PathScripts.PathToolController.ToolController.usesLegacyTool().

Referenced by PathScripts.PathToolLibraryManager.ToolLibraryManager.saveMainLibrary(), PathScripts.PathToolBit.ToolBit.saveToFile(), and PathScripts.PathToolLibraryManager.ToolLibraryManager.write().

usesLegacyTool()

def PathScripts.PathToolController.ToolController.usesLegacyTool	(		self,
			obj
	)

returns True if the tool being controlled is a legacy tool

Referenced by PathScripts.PathToolController.ToolController.ensureUseLegacyTool(), PathScripts.PathToolController.ToolController.onDelete(), and PathScripts.PathToolController.ToolController.templateAttrs().

---

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

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