List of all members | Public Member Functions | Static Public Attributes
PathScripts.PathThreadMilling.ObjectThreadMilling Class Reference

Public Member Functions

def circularHoleExecute (self, obj, holes)
 
def circularHoleFeatures (self, obj)
 
def executeThreadMill (self, obj, loc, gcode, zStart, zFinal, pitch)
 
def initCircularHoleOperation (self, obj)
 
def isToolSupported (self, obj, tool)
 
def opSetDefaultValues (self, obj, job)
 
def propertyEnumerations (self, dataType="data")
 
def threadPassRadii (self, obj)
 
def threadSetup (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)
 

Static Public Attributes

string DirectionClimb = "Climb"
 
string DirectionConventional = "Conventional"
 
list Directions = [DirectionClimb, DirectionConventional]
 
string LeftHand = "LeftHand"
 
string RightHand = "RightHand"
 
list ThreadOrientations = [LeftHand, RightHand]
 
string ThreadTypeCustomExternal = "CustomExternal"
 
string ThreadTypeCustomInternal = "CustomInternal"
 
dictionary ThreadTypeData
 
string ThreadTypeImperialExternal2A = "ImperialExternal2A"
 
string ThreadTypeImperialExternal3A = "ImperialExternal3A"
 
string ThreadTypeImperialInternal2B = "ImperialInternal2B"
 
string ThreadTypeImperialInternal3B = "ImperialInternal3B"
 
string ThreadTypeMetricExternal4G6G = "MetricExternal4G6G"
 
string ThreadTypeMetricExternal6G = "MetricExternal6G"
 
string ThreadTypeMetricInternal6H = "MetricInternal6H"
 
list ThreadTypes = ThreadTypesInternal + ThreadTypesExternal
 
list ThreadTypesExternal
 
list ThreadTypesImperial
 
list ThreadTypesInternal
 
list ThreadTypesMetric
 

Additional Inherited Members

- Public Attributes inherited from PathScripts.PathOp.ObjectOp
 addNewProps
 
 commandlist
 
 horizFeed
 
 horizRapid
 
 job
 
 model
 
 radius
 
 stock
 
 tool
 
 vertFeed
 
 vertRapid
 

Detailed Description

Proxy object for thread milling operation.

Member Function Documentation

◆ circularHoleExecute()

def PathScripts.PathThreadMilling.ObjectThreadMilling.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 from PathScripts.PathCircularHoleBase.ObjectOp.

References PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathVcarve.ObjectVcarve.commandlist, PathTests.TestPathHelpers.TestPathHelpers.commandlist, PathScripts.PathThreadMilling.ObjectThreadMilling.executeThreadMill(), PathScripts.PathOp.ObjectOp.isToolSupported(), PathScripts.PathThreadMilling.ObjectThreadMilling.isToolSupported(), PathScripts.PathVcarve.ObjectVcarve.isToolSupported(), PathScripts.PathThreadMilling.ObjectThreadMilling.threadSetup(), PathScripts.PathInspect.GCodeEditorDialog.tool, PathScripts.PathOp.ObjectOp.tool, PathScripts.PathSimulatorGui.PathSimulation.tool, PathScripts.PathSurfaceSupport.OCL_Tool.tool, PathScripts.PathToolBitEdit.ToolBitEditor.tool, PathScripts.PathToolEdit.ToolEditor.tool, PathScripts.PathToolLibraryManager.FreeCADTooltableHandler.tool, and PathScripts.PathToolLibraryManager.HeeksTooltableHandler.tool.

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

◆ circularHoleFeatures()

def PathScripts.PathThreadMilling.ObjectThreadMilling.circularHoleFeatures (   self,
  obj 
) 
circularHoleFeatures(obj) ... overwrite to add operations specific features.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

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

◆ executeThreadMill()

def PathScripts.PathThreadMilling.ObjectThreadMilling.executeThreadMill (   self,
  obj,
  loc,
  gcode,
  zStart,
  zFinal,
  pitch 
)

References PathScripts.PathThreadMillingGui.TaskPanelOpPage._isThreadInternal(), PathScripts.PathThreadMilling.ObjectThreadMilling._isThreadInternal(), PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathVcarve.ObjectVcarve.commandlist, PathTests.TestPathHelpers.TestPathHelpers.commandlist, PathScripts.PathThreadMilling.elevatorRadius(), PathScripts.PathOp.ObjectOp.horizFeed, PathScripts.PathToolControllerGui.ToolControllerEditor.horizFeed, PathScripts.PathThreadMilling.threadPasses(), PathScripts.PathInspect.GCodeEditorDialog.tool, PathScripts.PathOp.ObjectOp.tool, PathScripts.PathSimulatorGui.PathSimulation.tool, PathScripts.PathSurfaceSupport.OCL_Tool.tool, PathScripts.PathToolBitEdit.ToolBitEditor.tool, PathScripts.PathToolEdit.ToolEditor.tool, PathScripts.PathToolLibraryManager.FreeCADTooltableHandler.tool, PathScripts.PathToolLibraryManager.HeeksTooltableHandler.tool, PathScripts.PathOp.ObjectOp.vertRapid, and PathScripts.PathToolControllerGui.ToolControllerEditor.vertRapid.

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

◆ initCircularHoleOperation()

def PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation (   self,
  obj 
) 
initCircularHoleOperation(obj) ... overwrite if the subclass needs initialisation.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

References PathScripts.PathThreadMilling.ObjectThreadMilling.DirectionClimb, PathScripts.PathSurface.ObjectSurface.propertyEnumerations(), PathScripts.PathPropertyBagGui.PropertyCreate.propertyEnumerations(), PathScripts.PathAdaptive.PathAdaptive.propertyEnumerations(), PathScripts.PathDeburr.ObjectDeburr.propertyEnumerations(), PathScripts.PathDressupRampEntry.ObjectDressup.propertyEnumerations(), PathScripts.PathDrilling.ObjectDrilling.propertyEnumerations(), PathScripts.PathJob.ObjectJob.propertyEnumerations(), PathScripts.PathMillFace.ObjectFace.propertyEnumerations(), PathScripts.PathPocket.ObjectPocket.propertyEnumerations(), PathScripts.PathSlot.ObjectSlot.propertyEnumerations(), PathScripts.PathThreadMilling.ObjectThreadMilling.propertyEnumerations(), PathScripts.PathToolController.ToolController.propertyEnumerations(), PathScripts.PathWaterline.ObjectWaterline.propertyEnumerations(), draftutils.translate.QT_TRANSLATE_NOOP, PathScripts.PathThreadMilling.ObjectThreadMilling.RightHand, and PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypesInternal.

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

◆ isToolSupported()

def PathScripts.PathThreadMilling.ObjectThreadMilling.isToolSupported (   self,
  obj,
  tool 
) 
Thread milling only supports thread milling cutters.

Reimplemented from PathScripts.PathOp.ObjectOp.

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

◆ opSetDefaultValues()

def PathScripts.PathThreadMilling.ObjectThreadMilling.opSetDefaultValues (   self,
  obj,
  job 
) 
opSetDefaultValues(obj, job) ... overwrite to set initial default values.
Called after the receiver has been fully created with all properties.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOp.ObjectOp.

References PathScripts.PathThreadMilling.ObjectThreadMilling.DirectionClimb, PathScripts.PathThreadMilling.ObjectThreadMilling.RightHand, and PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeMetricInternal6H.

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

◆ propertyEnumerations()

def PathScripts.PathThreadMilling.ObjectThreadMilling.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().

◆ threadPassRadii()

def PathScripts.PathThreadMilling.ObjectThreadMilling.threadPassRadii (   self,
  obj 
)

References PathScripts.PathInspect.GCodeEditorDialog.tool, PathScripts.PathOp.ObjectOp.tool, PathScripts.PathSimulatorGui.PathSimulation.tool, PathScripts.PathSurfaceSupport.OCL_Tool.tool, PathScripts.PathToolBitEdit.ToolBitEditor.tool, PathScripts.PathToolEdit.ToolEditor.tool, PathScripts.PathToolLibraryManager.FreeCADTooltableHandler.tool, and PathScripts.PathToolLibraryManager.HeeksTooltableHandler.tool.

◆ threadSetup()

def PathScripts.PathThreadMilling.ObjectThreadMilling.threadSetup (   self,
  obj 
)

References PathScripts.PathThreadMilling.ObjectThreadMilling._threadSetupInternal(), and PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypesInternal.

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

Member Data Documentation

◆ DirectionClimb

string PathScripts.PathThreadMilling.ObjectThreadMilling.DirectionClimb = "Climb"
static

Referenced by PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation(), and PathScripts.PathThreadMilling.ObjectThreadMilling.opSetDefaultValues().

◆ DirectionConventional

string PathScripts.PathThreadMilling.ObjectThreadMilling.DirectionConventional = "Conventional"
static

◆ Directions

list PathScripts.PathThreadMilling.ObjectThreadMilling.Directions = [DirectionClimb, DirectionConventional]
static

◆ LeftHand

string PathScripts.PathThreadMilling.ObjectThreadMilling.LeftHand = "LeftHand"
static

◆ RightHand

string PathScripts.PathThreadMilling.ObjectThreadMilling.RightHand = "RightHand"
static

Referenced by PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation(), and PathScripts.PathThreadMilling.ObjectThreadMilling.opSetDefaultValues().

◆ ThreadOrientations

list PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadOrientations = [LeftHand, RightHand]
static

◆ ThreadTypeCustomExternal

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeCustomExternal = "CustomExternal"
static

◆ ThreadTypeCustomInternal

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeCustomInternal = "CustomInternal"
static

◆ ThreadTypeData

dictionary PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeData
static
Initial value:
= {
ThreadTypeImperialExternal2A: "imperial-external-2A.csv",
ThreadTypeImperialExternal3A: "imperial-external-3A.csv",
ThreadTypeImperialInternal2B: "imperial-internal-2B.csv",
ThreadTypeImperialInternal3B: "imperial-internal-3B.csv",
ThreadTypeMetricExternal4G6G: "metric-external-4G6G.csv",
ThreadTypeMetricExternal6G: "metric-external-6G.csv",
ThreadTypeMetricInternal6H: "metric-internal-6H.csv",
}

◆ ThreadTypeImperialExternal2A

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeImperialExternal2A = "ImperialExternal2A"
static

◆ ThreadTypeImperialExternal3A

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeImperialExternal3A = "ImperialExternal3A"
static

◆ ThreadTypeImperialInternal2B

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeImperialInternal2B = "ImperialInternal2B"
static

◆ ThreadTypeImperialInternal3B

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeImperialInternal3B = "ImperialInternal3B"
static

◆ ThreadTypeMetricExternal4G6G

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeMetricExternal4G6G = "MetricExternal4G6G"
static

◆ ThreadTypeMetricExternal6G

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeMetricExternal6G = "MetricExternal6G"
static

◆ ThreadTypeMetricInternal6H

string PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypeMetricInternal6H = "MetricInternal6H"
static

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

◆ ThreadTypes

list PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypes = ThreadTypesInternal + ThreadTypesExternal
static

◆ ThreadTypesExternal

list PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypesExternal
static
Initial value:
= [
ThreadTypeCustomExternal,
ThreadTypeImperialExternal2A,
ThreadTypeImperialExternal3A,
ThreadTypeMetricExternal4G6G,
ThreadTypeMetricExternal6G,
]

◆ ThreadTypesImperial

list PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypesImperial
static
Initial value:
= [
ThreadTypeImperialExternal2A,
ThreadTypeImperialExternal3A,
ThreadTypeImperialInternal2B,
ThreadTypeImperialInternal3B,
]

◆ ThreadTypesInternal

list PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypesInternal
static
Initial value:
= [
ThreadTypeCustomInternal,
ThreadTypeImperialInternal2B,
ThreadTypeImperialInternal3B,
ThreadTypeMetricInternal6H,
]

Referenced by PathScripts.PathThreadMilling.ObjectThreadMilling.initCircularHoleOperation(), and PathScripts.PathThreadMilling.ObjectThreadMilling.threadSetup().

◆ ThreadTypesMetric

list PathScripts.PathThreadMilling.ObjectThreadMilling.ThreadTypesMetric
static
Initial value:
= [
ThreadTypeMetricExternal4G6G,
ThreadTypeMetricExternal6G,
ThreadTypeMetricInternal6H,
]
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.4