Public Member Functions
def	getActiveEnumerations (self, obj)

def	initOperation (self, obj)

def	initOpProperties (self, obj, warn=False)

def	onChanged (self, obj, prop)

def	opApplyPropertyDefaults (self, obj, job, propList)

def	opApplyPropertyLimits (self, obj)

def	opExecute (self, obj)

def	opFeatures (self, obj)

def	opOnDocumentRestored (self, obj)

def	opPropertyDefaults (self, obj, job)

def	opPropertyDefinitions (self)

def	opSetDefaultValues (self, obj, job)

def	opSetEditorModes (self, obj)

def	opUpdateDepths (self, obj)

def	propertyEnumerations (self, dataType="data")

def	updateEnumerations (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)

Public Attributes
	addNewProps

	arcCenter

	arcMidPnt

	arcRadius

	base

	bottomEdges

	depthParams

	dYdX1

	dYdX2

	featureDetails

	isArc

	isDebug

	module

	newRadius

	propertiesReady

	shape1

	shape2

	shapeLength1

	shapeLength2

	shapeType1

	shapeType2

	showDebugObjects

	stockZMin

	tmpGrp

Public Attributes inherited from PathScripts.PathOp.ObjectOp
	addNewProps

	commandlist

	horizFeed

	horizRapid

	job

	model

	radius

	stock

	tool

	vertFeed

	vertRapid

Detailed Description

Proxy object for Slot operation.

Member Function Documentation

◆ getActiveEnumerations()

def PathScripts.PathSlot.ObjectSlot.getActiveEnumerations	(	self,
		obj
	)

getActiveEnumerations(obj) ...
Method returns dictionary of property enumerations based on
active conditions in the operation.

References PathScripts.PathSlot.ObjectSlot._makeReference1Enumerations(), and PathScripts.PathSlot.ObjectSlot._makeReference2Enumerations().

Referenced by PathScripts.PathSlot.ObjectSlot.updateEnumerations().

◆ initOperation()

def PathScripts.PathSlot.ObjectSlot.initOperation	(	self,
		obj
	)

initOperation(obj) ... Initialize the operation by
managing property creation and property editor status.

Reimplemented from PathScripts.PathOp.ObjectOp.

◆ initOpProperties()

def PathScripts.PathSlot.ObjectSlot.initOpProperties	(	self,
		obj,
		warn = `False`
	)

initOpProperties(obj) ... create operation specific properties

Referenced by PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

◆ onChanged()

def PathScripts.PathSlot.ObjectSlot.onChanged	(	self,
		obj,
		prop
	)

onChanged(obj, prop) ... base implementation of the FC notification framework.
Do not overwrite, overwrite opOnChanged() instead.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathSlot.ObjectSlot.opSetEditorModes(), PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathSlot.ObjectSlot.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathWaterline.ObjectWaterline.propertiesReady, and PathScripts.PathSlot.ObjectSlot.updateEnumerations().

Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftviewproviders.view_base.ViewProviderDraft.attach(), ArchSite.Compass.buildCoordinates(), draftobjects.wire.Wire.execute(), ArchBuildingPart.ViewProviderBuildingPart.updateData(), ArchPanel.ViewProviderPanelCut.updateData(), ArchPanel.ViewProviderPanelSheet.updateData(), draftviewproviders.view_label.ViewProviderLabel.updateData(), draftviewproviders.view_layer.ViewProviderLayer.updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy.updateData().

◆ opApplyPropertyDefaults()

def PathScripts.PathSlot.ObjectSlot.opApplyPropertyDefaults	(	self,
		obj,
		job,
		propList
	)

References PathScripts.PathSlot.ObjectSlot.opPropertyDefaults(), PathScripts.PathSurface.ObjectSurface.opPropertyDefaults(), and PathScripts.PathWaterline.ObjectWaterline.opPropertyDefaults().

Referenced by PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored(), PathScripts.PathSlot.ObjectSlot.opSetDefaultValues(), PathScripts.PathSurface.ObjectSurface.opSetDefaultValues(), and PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues().

◆ opApplyPropertyLimits()

def PathScripts.PathSlot.ObjectSlot.opApplyPropertyLimits	(	self,
		obj
	)

opApplyPropertyLimits(obj) ... Apply necessary limits to user input property values before performing main operation.

◆ opExecute()

def PathScripts.PathSlot.ObjectSlot.opExecute	(	self,
		obj
	)

opExecute(obj) ... process surface operation

Reimplemented from PathScripts.PathOp.ObjectOp.

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

◆ opFeatures()

def PathScripts.PathSlot.ObjectSlot.opFeatures	(	self,
		obj
	)

opFeatures(obj) ... return all standard features

Reimplemented from PathScripts.PathOp.ObjectOp.

◆ opOnDocumentRestored()

def PathScripts.PathSlot.ObjectSlot.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.PathOp.ObjectOp.addNewProps, PathScripts.PathProfile.ObjectProfile.addNewProps, PathScripts.PathSlot.ObjectSlot.addNewProps, PathScripts.PathSurface.ObjectSurface.addNewProps, PathScripts.PathWaterline.ObjectWaterline.addNewProps, PathScripts.PathSlot.ObjectSlot.initOpProperties(), PathScripts.PathSurface.ObjectSurface.initOpProperties(), PathScripts.PathWaterline.ObjectWaterline.initOpProperties(), PathScripts.PathSlot.ObjectSlot.opApplyPropertyDefaults(), PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults(), PathScripts.PathSlot.ObjectSlot.opSetEditorModes(), PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathSlot.ObjectSlot.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathWaterline.ObjectWaterline.propertiesReady, and PathScripts.PathSlot.ObjectSlot.updateEnumerations().

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

◆ opPropertyDefaults()

def PathScripts.PathSlot.ObjectSlot.opPropertyDefaults	(	self,
		obj,
		job
	)

opPropertyDefaults(obj, job) ... returns a dictionary of default values
for the operation's properties.

Referenced by PathScripts.PathSlot.ObjectSlot.opApplyPropertyDefaults(), PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), and PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults().

◆ opPropertyDefinitions()

def PathScripts.PathSlot.ObjectSlot.opPropertyDefinitions ( self )

opPropertyDefinitions(obj) ... Store operation specific properties

◆ opSetDefaultValues()

def PathScripts.PathSlot.ObjectSlot.opSetDefaultValues	(	self,
		obj,
		job
	)

opSetDefaultValues(obj, job) ... initialize defaults

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathOp.ObjectOp.addNewProps, PathScripts.PathProfile.ObjectProfile.addNewProps, PathScripts.PathSlot.ObjectSlot.addNewProps, PathScripts.PathSurface.ObjectSurface.addNewProps, PathScripts.PathWaterline.ObjectWaterline.addNewProps, PathScripts.PathSlot.ObjectSlot.opApplyPropertyDefaults(), PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), and PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults().

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

◆ opSetEditorModes()

def PathScripts.PathSlot.ObjectSlot.opSetEditorModes	(	self,
		obj
	)

Referenced by PathScripts.PathSlot.ObjectSlot.onChanged(), and PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored().

◆ opUpdateDepths()

def PathScripts.PathSlot.ObjectSlot.opUpdateDepths	(	self,
		obj
	)

opUpdateDepths(obj) ... overwrite to implement special depths calculation.
Can safely be overwritten by subclass.

Reimplemented from PathScripts.PathOp.ObjectOp.

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

◆ propertyEnumerations()

def PathScripts.PathSlot.ObjectSlot.propertyEnumerations	(	self,
		dataType = `"data"`
	)

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

◆ updateEnumerations()

def PathScripts.PathSlot.ObjectSlot.updateEnumerations	(	self,
		obj
	)

updateEnumerations(obj) ...
Method updates property enumerations based on active conditions
in the operation.  Returns the updated enumerations dictionary.
Existing property values must be stored, and then restored after
the assignment of updated enumerations.

References PathScripts.PathSlot.ObjectSlot.getActiveEnumerations().

Referenced by PathScripts.PathSlot.ObjectSlot.onChanged(), and PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored().

Member Data Documentation

◆ addNewProps

PathScripts.PathSlot.ObjectSlot.addNewProps

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpSetDefaultValues(), PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored(), PathScripts.PathSlot.ObjectSlot.opSetDefaultValues(), PathScripts.PathSurface.ObjectSurface.opSetDefaultValues(), and PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues().

◆ arcCenter

PathScripts.PathSlot.ObjectSlot.arcCenter

◆ arcMidPnt

PathScripts.PathSlot.ObjectSlot.arcMidPnt

◆ arcRadius

PathScripts.PathSlot.ObjectSlot.arcRadius

◆ base

PathScripts.PathSlot.ObjectSlot.base

Referenced by automotive_design.mechanism_base_placement.representation_relationship_rep_2(), PathTests.TestPathStock.TestPathStock.test12(), automotive_design.alternate_product_relationship.wr1(), config_control_design.alternate_product_relationship.wr1(), automotive_design.assembly_component_usage_substitute.wr2(), and config_control_design.assembly_component_usage_substitute.wr2().

◆ bottomEdges

PathScripts.PathSlot.ObjectSlot.bottomEdges

Referenced by PathScripts.PathDressupHoldingTags.PathData.pointIsOnPath(), PathScripts.PathDressupHoldingTags.PathData.shortestAndLongestPathEdge(), and PathScripts.PathDressupHoldingTags.PathData.sortedTags().

◆ depthParams

PathScripts.PathSlot.ObjectSlot.depthParams

Referenced by PathScripts.PathSurfaceSupport.ProcessSelectedFaces.preProcessModel().

◆ dYdX1

PathScripts.PathSlot.ObjectSlot.dYdX1

◆ dYdX2

PathScripts.PathSlot.ObjectSlot.dYdX2

◆ featureDetails

PathScripts.PathSlot.ObjectSlot.featureDetails

◆ isArc

PathScripts.PathSlot.ObjectSlot.isArc

◆ isDebug

PathScripts.PathSlot.ObjectSlot.isDebug

◆ module

PathScripts.PathSlot.ObjectSlot.module

Referenced by Mod.PartDesign.WizardShaft.SegmentFunction.TranslationFunction.evaluate(), and PathScripts.PathSurfaceSupport.ProcessSelectedFaces.preProcessModel().

◆ newRadius

PathScripts.PathSlot.ObjectSlot.newRadius

◆ propertiesReady

PathScripts.PathSlot.ObjectSlot.propertiesReady

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnChanged(), PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), PathScripts.PathSlot.ObjectSlot.onChanged(), PathScripts.PathSurface.ObjectSurface.onChanged(), PathScripts.PathWaterline.ObjectWaterline.onChanged(), PathScripts.PathSlot.ObjectSlot.opOnDocumentRestored(), PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().

◆ shape1

PathScripts.PathSlot.ObjectSlot.shape1

◆ shape2

PathScripts.PathSlot.ObjectSlot.shape2

◆ shapeLength1

PathScripts.PathSlot.ObjectSlot.shapeLength1

◆ shapeLength2

PathScripts.PathSlot.ObjectSlot.shapeLength2

◆ shapeType1

PathScripts.PathSlot.ObjectSlot.shapeType1

◆ shapeType2

PathScripts.PathSlot.ObjectSlot.shapeType2

◆ showDebugObjects

PathScripts.PathSlot.ObjectSlot.showDebugObjects

Referenced by PathScripts.PathSurfaceSupport.ProcessSelectedFaces.findUnifiedRegions(), PathScripts.PathSurfaceSupport.ProcessSelectedFaces.preProcessModel(), PathScripts.PathSurfaceSupport.ProcessSelectedFaces.setShowDebugObjects(), PathScripts.PathSurface.ObjectSurface.showDebugObject(), and PathScripts.PathWaterline.ObjectWaterline.showDebugObject().

◆ stockZMin

PathScripts.PathSlot.ObjectSlot.stockZMin

◆ tmpGrp

PathScripts.PathSlot.ObjectSlot.tmpGrp

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

FreeCAD/src/Mod/Path/PathScripts/PathSlot.py

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ getActiveEnumerations()

◆ initOperation()

◆ initOpProperties()

◆ onChanged()

◆ opApplyPropertyDefaults()

◆ opApplyPropertyLimits()

◆ opExecute()

◆ opFeatures()

◆ opOnDocumentRestored()

◆ opPropertyDefaults()

◆ opPropertyDefinitions()

◆ opSetDefaultValues()

◆ opSetEditorModes()

◆ opUpdateDepths()

◆ propertyEnumerations()

◆ updateEnumerations()

Member Data Documentation

◆ addNewProps

◆ arcCenter

◆ arcMidPnt

◆ arcRadius

◆ base

◆ bottomEdges

◆ depthParams

◆ dYdX1

◆ dYdX2

◆ featureDetails

◆ isArc

◆ isDebug

◆ module

◆ newRadius

◆ propertiesReady

◆ shape1

◆ shape2

◆ shapeLength1

◆ shapeLength2

◆ shapeType1

◆ shapeType2

◆ showDebugObjects

◆ stockZMin

◆ tmpGrp