PathScripts.PathPocketBase.ObjectPocket Class Reference

Public Member Functions

def areaOpAreaParams (self, obj, isHole)
 
def areaOpFeatures (self, obj)
 
def areaOpPathParams (self, obj, isHole)
 
def areaOpRetractTool (self, obj)
 
def areaOpUseProjection (self, obj)
 
def initAreaOp (self, obj)
 
def initPocketOp (self, obj)
 
def pocketInvertExtraOffset (self)
 
def pocketOpFeatures (self, obj)
 
- Public Member Functions inherited from PathScripts.PathAreaOp.ObjectOp
def applyInverseAngle (self, obj, clnBase, clnStock, axis, angle)
 
def applyRotationalAnalysis (self, obj, base, angle, axis, subCount)
 
def areaOpOnChanged (self, obj, prop)
 
def areaOpOnDocumentRestored (self, obj)
 
def areaOpSetDefaultValues (self, obj, job)
 
def areaOpShapeForDepths (self, obj, job)
 
def areaOpShapes (self, obj)
 
def cloneBaseAndStock (self, obj, base, angle, axis, subCount)
 
def faceRotationAnalysis (self, obj, norm, surf)
 
def getFaceNormAndSurf (self, face)
 
def guiMessage (self, title, msg, show=False)
 
def initOperation (self, obj)
 
def isFaceUp (self, base, face)
 
def opDetermineRotationRadii (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)
 
def setupAdditionalProperties (self, obj)
 
def sortTuplesByIndex (self, TupleList, tagIdx)
 
def useTempJobClones (self, cloneName)
 
def visualAxis (self)
 
def warnDisabledAxis (self, obj, axis, sub='')
 
- 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 onChanged (self, obj, prop)
 
def onDocumentRestored (self, obj)
 
def opExecute (self, obj)
 
def opRejectAddBase (self, obj, base, sub)
 
def opUpdateDepths (self, obj)
 
def setDefaultValues (self, obj)
 
def setEditorModes (self, obj, features)
 
def updateDepths (self, obj, ignoreErrors=False)
 

Additional Inherited Members

- Public Attributes inherited from PathScripts.PathAreaOp.ObjectOp
 axialFeed
 
 axialRapid
 
 cloneNames
 
 depthparams
 
 endVector
 
 guiMsgs
 
 initWithRotation
 
 leadIn
 
 rotateFlag
 
 rotStartDepth
 
 stockBB
 
 tempObjectNames
 
- Public Attributes inherited from PathScripts.PathOp.ObjectOp
 addNewProps
 
 commandlist
 
 horizFeed
 
 horizRapid
 
 job
 
 model
 
 radius
 
 stock
 
 tool
 
 vertFeed
 
 vertRapid
 

Detailed Description

Base class for proxy objects of all pocket operations.

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.

References PathScripts.PathPocketBase.ObjectPocket.pocketInvertExtraOffset(), PathScripts.PathMillFace.ObjectFace.pocketInvertExtraOffset(), PathScripts.PathPocket.ObjectPocket.pocketInvertExtraOffset(), PathScripts.PathDressupTag.TagSolid.radius, draftguitools.gui_snapper.Snapper.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PartGui::DimensionAngular.radius, MeshCore::CylinderSurfaceFit.radius, PartGui::ArcEngine.radius, PathScripts.PathOp.ObjectOp.radius, MeshCore::SphereSurfaceFit.radius, DraftGui.DraftToolBar.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, Inspection::DistanceInspection.radius, ifc2x3.ifccranerailashapeprofiledef.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, ifc2x3.ifcroundededgefeature.radius, config_control_design.conical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ifc4.ifcsweptdisksolid.radius, ifc2x3.ifcrightcircularcylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ifc4.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc4.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, automotive_design.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ifc2x3.ifccircle.radius, ifc4.ifclightsourcepositional.radius, ifc2x3.ifcsphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ifc4.ifccircle.radius, automotive_design.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, ifc4.ifccylindricalsurface.radius, automotive_design.conical_surface.radius, and ifc4.ifcsphere.radius.

◆ areaOpFeatures()

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

Reimplemented in PathScripts.PathPocketShape.ObjectPocket.

References PathScripts.PathPocketBase.ObjectPocket.pocketOpFeatures(), and PathScripts.PathPocket.ObjectPocket.pocketOpFeatures().

◆ areaOpPathParams()

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

Reimplemented from PathScripts.PathAreaOp.ObjectOp.

References PathScripts.PathDressupTag.TagSolid.radius, draftguitools.gui_snapper.Snapper.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PartGui::DimensionAngular.radius, MeshCore::CylinderSurfaceFit.radius, PartGui::ArcEngine.radius, PathScripts.PathOp.ObjectOp.radius, MeshCore::SphereSurfaceFit.radius, DraftGui.DraftToolBar.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, Inspection::DistanceInspection.radius, ifc2x3.ifccranerailashapeprofiledef.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, ifc2x3.ifcroundededgefeature.radius, config_control_design.conical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, automotive_design.spherical_surface.radius, automotive_design.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ifc4.ifcsweptdisksolid.radius, ifc2x3.ifcrightcircularcylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ifc4.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc4.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, automotive_design.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ifc2x3.ifccircle.radius, ifc4.ifclightsourcepositional.radius, ifc2x3.ifcsphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cone.radius, ifc4.ifccircle.radius, automotive_design.right_circular_cone.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.sphere.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.cylindrical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.solid_with_constant_radius_edge_blend.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.conical_surface.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, ifc4.ifccylindricalsurface.radius, automotive_design.conical_surface.radius, and ifc4.ifcsphere.radius.

◆ areaOpRetractTool()

def PathScripts.PathPocketBase.ObjectPocket.areaOpRetractTool (   self,
  obj 
)
areaOpRetractTool(obj) ... return False to keep the tool at current level between shapes. Default is True.

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.

References PathScripts.PathPocketBase.ObjectPocket.initPocketOp(), PathScripts.PathMillFace.ObjectFace.initPocketOp(), and PathScripts.PathPocket.ObjectPocket.initPocketOp().

◆ initPocketOp()

def PathScripts.PathPocketBase.ObjectPocket.initPocketOp (   self,
  obj 
)

◆ pocketInvertExtraOffset()

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

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

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

◆ pocketOpFeatures()

def PathScripts.PathPocketBase.ObjectPocket.pocketOpFeatures (   self,
  obj 
)

The documentation for this class was generated from the following file:
  • src/Mod/Path/PathScripts/PathPocketBase.py