FreeCAD Python
Public Member Functions | List of all members
PathScripts.PathPocketBase.ObjectPocket Class Reference

Detailed Description

Base class for proxy objects of all pocket operations.

Public Member Functions

def areaOpFeatures (self, obj)
 
def initPocketOp (self, obj)
 
def pocketInvertExtraOffset (self)
 
def initAreaOp (self, obj)
 
def areaOpUseProjection (self, obj)
 
def areaOpAreaParams (self, obj, isHole)
 
def areaOpPathParams (self, obj, isHole)
 
- Public Member Functions inherited from PathScripts.PathAreaOp.ObjectOp
def opFeatures (self, obj)
 
def initOperation (self, obj)
 
def areaOpShapeForDepths (self, obj)
 
def areaOpOnChanged (self, obj, prop)
 
def opOnChanged (self, obj, prop)
 
def areaOpOnDocumentRestored (self, obj)
 
def opSetDefaultValues (self, obj, job)
 
def areaOpSetDefaultValues (self, obj, job)
 
def opExecute (self, obj, getsim=False)
 
def areaOpShapes (self, obj)
 
def opDetermineRotationRadii (self, obj)
 
def pocketRotationAnalysis (self, obj, objRef, sub, prnt)
 
- Public Member Functions inherited from PathScripts.PathOp.ObjectOp
def setEditorModes (self, obj, features)
 
def __getstate__ (self)
 
def __setstate__ (self, state)
 
def opUpdateDepths (self, obj)
 
def opExecute (self, obj)
 
def opRejectAddBase (self, obj, base, sub)
 
def onChanged (self, obj, prop)
 
def applyExpression (self, obj, prop, expr)
 
def setDefaultValues (self, obj)
 
def getJob (self, obj)
 
def updateDepths (self, obj, ignoreErrors=False)
 
def execute (self, obj)
 

Member Function Documentation

◆ areaOpAreaParams()

def PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams (   self,
  obj,
  isHole 
)
areaOpAreaParams(obj, isHole) ... return dictionary with pocket's area parameters

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

◆ areaOpFeatures()

def PathScripts.PathPocketBase.ObjectPocket.areaOpFeatures (   self,
  obj 
)
areaOpFeatures(obj) ... Pockets have a FinishDepth and work on Faces

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

◆ areaOpPathParams()

def PathScripts.PathPocketBase.ObjectPocket.areaOpPathParams (   self,
  obj,
  isHole 
)
areaOpAreaParams(obj, isHole) ... return dictionary with pocket's path parameters

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

◆ areaOpUseProjection()

def PathScripts.PathPocketBase.ObjectPocket.areaOpUseProjection (   self,
  obj 
)
areaOpUseProjection(obj) ... return False

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

◆ initAreaOp()

def PathScripts.PathPocketBase.ObjectPocket.initAreaOp (   self,
  obj 
)
initAreaOp(obj) ... create pocket specific properties.
Do not overwrite, implement initPocketOp(obj) instead.

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

◆ initPocketOp()

def PathScripts.PathPocketBase.ObjectPocket.initPocketOp (   self,
  obj 
)
initPocketOp(obj) ... overwrite to initialize subclass.
Can safely be overwritten by subclass.

Reimplemented in PathScripts.PathPocketShape.ObjectPocket, PathScripts.PathMillFace.ObjectFace, and PathScripts.PathPocket.ObjectPocket.

◆ pocketInvertExtraOffset()

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