FreeCAD Python
Public Member Functions | List of all members
PathScripts.PathHelix.ObjectHelix Class Reference

Detailed Description

Proxy class for Helix operations.

Public Member Functions

def circularHoleFeatures (self, obj)
 
def initCircularHoleOperation (self, obj)
 
def circularHoleExecute (self, obj, holes)
 
def helix_cut (self, obj, x0, y0, r_out, r_in, dr)
 
- Public Member Functions inherited from PathScripts.PathCircularHoleBase.ObjectOp
def opFeatures (self, obj)
 
def initOperation (self, obj)
 
def baseIsArchPanel (self, obj, base)
 
def getArchPanelEdge (self, obj, base, sub)
 
def holeDiameter (self, obj, base, sub)
 
def holePosition (self, obj, base, sub)
 
def isHoleEnabled (self, obj, base, sub)
 
def opExecute (self, obj)
 
def findHoles (self, obj, baseobject)
 
- Public Member Functions inherited from PathScripts.PathOp.ObjectOp
def setEditorModes (self, obj, features)
 
def __getstate__ (self)
 
def __setstate__ (self, state)
 
def opOnDocumentRestored (self, obj)
 
def opOnChanged (self, obj, prop)
 
def opUpdateDepths (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

◆ 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.

◆ 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

◆ initCircularHoleOperation()

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

Reimplemented from PathScripts.PathCircularHoleBase.ObjectOp.