PathScripts.PathMillFace.ObjectFace Class Reference

Public Member Functions

def areaOpOnChanged (self, obj, prop)
 
def areaOpSetDefaultValues (self, obj, job)
 
def areaOpShapes (self, obj)
 
def getAllIncludedFaces (self, base, env, faceZ)
 
def initPocketOp (self, obj)
 
def isPocket (self, b, f, w)
 
def pocketInvertExtraOffset (self)
 
def propertyEnumerations (self, dataType="data")
 
- Public Member Functions inherited from PathScripts.PathPocketBase.ObjectPocket
def areaOpAreaParams (self, obj, isHole)
 
def areaOpFeatures (self, obj)
 
def areaOpPathParams (self, obj, isHole)
 
def areaOpRetractTool (self, obj)
 
def areaOpSetDefaultValues (self, obj, job)
 
def areaOpUseProjection (self, obj)
 
def initAreaOp (self, obj)
 
def initPocketOp (self, obj)
 
def opOnDocumentRestored (self, obj)
 
def pocketInvertExtraOffset (self)
 
def pocketOpFeatures (self, obj)
 
def pocketPropertyEnumerations (cls, dataType="data")
 
- Public Member Functions inherited from PathScripts.PathAreaOp.ObjectOp
def areaOpAreaParams (self, obj, isHole)
 
def areaOpFeatures (self, obj)
 
def areaOpOnChanged (self, obj, prop)
 
def areaOpOnDocumentRestored (self, obj)
 
def areaOpPathParams (self, obj, isHole)
 
def areaOpRetractTool (self, obj)
 
def areaOpSetDefaultValues (self, obj, job)
 
def areaOpShapeForDepths (self, obj, job)
 
def areaOpShapes (self, obj)
 
def areaOpUseProjection (self, obj)
 
def initAreaOp (self, obj)
 
def initOperation (self, obj)
 
def opExecute (self, obj, getsim=False)
 
def opFeatures (self, obj)
 
def opOnChanged (self, obj, prop)
 
def opOnDocumentRestored (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

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

Detailed Description

Proxy object for Mill Facing operation.

Member Function Documentation

◆ areaOpOnChanged()

def PathScripts.PathMillFace.ObjectFace.areaOpOnChanged (   self,
  obj,
  prop 
)
areaOpOnChanged(obj, prop) ... facing specific depths calculation.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

Referenced by PathScripts.PathAreaOp.ObjectOp.opOnChanged().

◆ areaOpSetDefaultValues()

def PathScripts.PathMillFace.ObjectFace.areaOpSetDefaultValues (   self,
  obj,
  job 
)
areaOpSetDefaultValues(obj, job) ... initialize mill facing properties

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), and PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues().

◆ areaOpShapes()

def PathScripts.PathMillFace.ObjectFace.areaOpShapes (   self,
  obj 
)
areaOpShapes(obj) ... return top face

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

◆ getAllIncludedFaces()

def PathScripts.PathMillFace.ObjectFace.getAllIncludedFaces (   self,
  base,
  env,
  faceZ 
)
getAllIncludedFaces(base, env, faceZ)...
Return all `base` faces extending above `faceZ` whose boundboxes overlap with the `env` boundbox.

◆ initPocketOp()

◆ isPocket()

def PathScripts.PathMillFace.ObjectFace.isPocket (   self,
  b,
  f,
  w 
)

◆ pocketInvertExtraOffset()

def PathScripts.PathMillFace.ObjectFace.pocketInvertExtraOffset (   self)
pocketInvertExtraOffset() ... return True if ExtraOffset's direction is inward.
Can safely be overwritten by subclass.

Reimplemented from PathScripts.PathPocketBase.ObjectPocket.

Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams().

◆ propertyEnumerations()

def PathScripts.PathMillFace.ObjectFace.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().

Member Data Documentation

◆ removalshapes

PathScripts.PathMillFace.ObjectFace.removalshapes

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