PathScripts.PathHelix.ObjectHelix Class Reference

Public Member Functions

def circularHoleExecute (self, obj, holes)
 
def circularHoleFeatures (self, obj)
 
def helix_cut (self, obj, x0, y0, r_out, r_in, dr)
 
def initCircularHoleOperation (self, obj)
 
def opOnDocumentRestored (self, obj)
 
def opSetDefaultValues (self, obj, job)
 
- Public Member Functions inherited from PathScripts.PathCircularHoleBase.ObjectOp
def applyInverseAngle (self, obj, clnBase, clnStock, axis, angle)
 
def applyRotationalAnalysis (self, obj, base, angle, axis, subCount)
 
def baseIsArchPanel (self, obj, base)
 
def cloneBaseAndStock (self, obj, base, angle, axis, subCount)
 
def faceRotationAnalysis (self, obj, norm, surf)
 
def findAllHoles (self, obj)
 
def findHoles (self, obj, baseobject)
 
def getArchPanelEdge (self, obj, base, sub)
 
def getFaceNormAndSurf (self, face)
 
def guiMessage (self, title, msg, show=False)
 
def holeDiameter (self, obj, base, sub)
 
def holePosition (self, obj, base, sub)
 
def initOperation (self, obj)
 
def isHoleEnabled (self, obj, base, sub)
 
def opDetermineRotationRadii (self, obj)
 
def opExecute (self, obj)
 
def opFeatures (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 opOnChanged (self, obj, prop)
 
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.PathCircularHoleBase.ObjectOp
 axialFeed
 
 axialRapid
 
 clearHeight
 
 cloneNames
 
 guiMsgs
 
 rotateFlag
 
 safeHeight
 
 stockBB
 
- Public Attributes inherited from PathScripts.PathOp.ObjectOp
 addNewProps
 
 commandlist
 
 horizFeed
 
 horizRapid
 
 job
 
 model
 
 radius
 
 stock
 
 tool
 
 vertFeed
 
 vertRapid
 
- Static Public Attributes inherited from PathScripts.PathCircularHoleBase.ObjectOp
 defValsSet
 
 docRestored
 
 initOpFinalDepth
 
 initOpStartDepth
 
 initWithRotation
 

Detailed Description

Proxy class for Helix operations.

Member Function Documentation

◆ circularHoleExecute()

def PathScripts.PathHelix.ObjectHelix.circularHoleExecute (   self,
  obj,
  holes 
)
circularHoleExecute(obj, holes) ... generate helix commands for each hole in holes

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

References PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathHelix.ObjectHelix.helix_cut(), 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, ifc4.ifcsphere.radius, and PathScripts.PathOp.ObjectOp.vertRapid.

◆ circularHoleFeatures()

def PathScripts.PathHelix.ObjectHelix.circularHoleFeatures (   self,
  obj 
)
circularHoleFeatures(obj) ... enable features supported by Helix.

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

◆ helix_cut()

def PathScripts.PathHelix.ObjectHelix.helix_cut (   self,
  obj,
  x0,
  y0,
  r_out,
  r_in,
  dr 
)
helix_cut(obj, x0, y0, r_out, r_in, dr) ... generate helix commands for specified hole.
    x0, y0: coordinates of center
    r_out, r_in: outer and inner radius of the hole
    dr: step over radius value

References PathScripts.PathOp.ObjectOp.commandlist, PathScripts.PathOp.ObjectOp.horizFeed, PathScripts.PathOp.ObjectOp.horizRapid, 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, ifc4.ifcsphere.radius, PathScripts.PathOp.ObjectOp.vertFeed, and PathScripts.PathOp.ObjectOp.vertRapid.

Referenced by PathScripts.PathHelix.ObjectHelix.circularHoleExecute().

◆ initCircularHoleOperation()

def PathScripts.PathHelix.ObjectHelix.initCircularHoleOperation (   self,
  obj 
)
initCircularHoleOperation(obj) ... create helix specific properties.

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.

◆ opOnDocumentRestored()

def PathScripts.PathHelix.ObjectHelix.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.

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

◆ opSetDefaultValues()

def PathScripts.PathHelix.ObjectHelix.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.

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


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