PathScripts.PathSurface.ObjectSurface Class Reference

Public Member Functions

def deleteOpVariables (self, all=True)
 
def holdStopCmds (self, obj, zMax, pd, p2, txt)
 
def initOperation (self, obj)
 
def initOpProperties (self, obj, warn=False)
 
def onChanged (self, obj, prop)
 
def opApplyPropertyDefaults (self, obj, job, propList)
 
def opApplyPropertyLimits (self, obj)
 
def opExecute (self, obj)
 
def opFeatures (self, obj)
 
def opOnDocumentRestored (self, obj)
 
def opPropertyDefaults (self, obj, job)
 
def opPropertyDefinitions (self)
 
def opSetDefaultValues (self, obj, job)
 
def opUpdateDepths (self, obj)
 
def propertyEnumerations (cls, dataType="data")
 
def resetOpVariables (self, all=True)
 
def setEditorProperties (self, obj)
 
def setOclCutter (self, obj, safe=False)
 
def showDebugObject (self, objShape, objName)
 
- 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

 addNewProps
 
 avoidShapes
 
 axialFeed
 
 axialRapid
 
 basePlacement
 
 bbRadius
 
 boundBoxes
 
 cancelOperation
 
 clearHeight
 
 ClearHeightOffset
 
 closedGap
 
 collectiveShapes
 
 CutClimb
 
 cutOut
 
 cutter
 
 depthParams
 
 faceZMax
 
 FinalDepth
 
 fullSTL
 
 gaps
 
 holdPntCnt
 
 holdPoint
 
 individualShapes
 
 JOB
 
 layerEndPnt
 
 layerEndzMax
 
 midDep
 
 modelSTLs
 
 modelTypes
 
 module
 
 onHold
 
 preOLP
 
 profileShapes
 
 propertiesReady
 
 radius
 
 resetTolerance
 
 safeHeight
 
 SafeHeightOffset
 
 safeSTLs
 
 showDebugObjects
 
 stl
 
 stockZMin
 
 tempGroup
 
 tmpCOM
 
 toolDiam
 
 useTiltCutter
 
- Public Attributes inherited from PathScripts.PathOp.ObjectOp
 addNewProps
 
 commandlist
 
 horizFeed
 
 horizRapid
 
 job
 
 model
 
 radius
 
 stock
 
 tool
 
 vertFeed
 
 vertRapid
 

Detailed Description

Proxy object for Surfacing operation.

Member Function Documentation

◆ deleteOpVariables()

def PathScripts.PathSurface.ObjectSurface.deleteOpVariables (   self,
  all = True 
)
deleteOpVariables() ... Reset class variables used for instance of operation.

References PathScripts.PathSurface.ObjectSurface.axialFeed, PathScripts.PathWaterline.ObjectWaterline.axialFeed, PathScripts.PathSurface.ObjectSurface.axialRapid, PathScripts.PathWaterline.ObjectWaterline.axialRapid, PathScripts.PathSurface.ObjectSurface.bbRadius, PathScripts.PathWaterline.ObjectWaterline.bbRadius, PathScripts.PathSurface.ObjectSurface.clearHeight, PathScripts.PathWaterline.ObjectWaterline.clearHeight, PathScripts.PathSurface.ObjectSurface.ClearHeightOffset, PathScripts.PathWaterline.ObjectWaterline.ClearHeightOffset, PathScripts.PathProfile.ObjectProfile.cutOut, PathScripts.PathSurface.ObjectSurface.cutOut, PathScripts.PathSurfaceSupport.PathGeometryGenerator.cutOut, PathScripts.PathWaterline.ObjectWaterline.cutOut, PathScripts.PathSurface.ObjectSurface.cutter, PathScripts.PathWaterline.ObjectWaterline.cutter, PathScripts.PathSurface.ObjectSurface.faceZMax, PathScripts.PathWaterline.ObjectWaterline.faceZMax, PathScripts.PathSurface.ObjectSurface.FinalDepth, PathScripts.PathWaterline.ObjectWaterline.FinalDepth, PathScripts.PathSurface.ObjectSurface.fullSTL, PathScripts.PathWaterline.ObjectWaterline.fullSTL, PathScripts.PathSurface.ObjectSurface.holdPntCnt, PathScripts.PathWaterline.ObjectWaterline.holdPntCnt, PathScripts.PathSurface.ObjectSurface.holdPoint, PathScripts.PathWaterline.ObjectWaterline.holdPoint, PathScripts.PathSurface.ObjectSurface.layerEndPnt, PathScripts.PathWaterline.ObjectWaterline.layerEndPnt, PathScripts.PathSurface.ObjectSurface.layerEndzMax, PathScripts.PathWaterline.ObjectWaterline.layerEndzMax, PathScripts.PathSurface.ObjectSurface.onHold, PathScripts.PathWaterline.ObjectWaterline.onHold, Ui_SphereWidget.radius, PartGui::Ui_DlgPartCylinder.radius, e57::CylindricalRepresentation.radius, DraftGui.DraftToolBar.radius, draftguitools.gui_snapper.Snapper.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.polar_complex_number_literal.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.spherical_surface.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.swept_disk_solid.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.right_circular_cylinder.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.circle.radius, ap203_configuration_controlled_3d_design_of_mechanical_parts_and_assemblies_mim_lf.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.spherical_surface.radius, automotive_design.swept_disk_solid.radius, automotive_design.right_circular_cylinder.radius, automotive_design.circle.radius, automotive_design.right_circular_cone.radius, automotive_design.sphere.radius, automotive_design.cylindrical_surface.radius, automotive_design.conical_surface.radius, config_control_design.spherical_surface.radius, config_control_design.circle.radius, config_control_design.cylindrical_surface.radius, config_control_design.conical_surface.radius, ifc2x3.ifccranerailashapeprofiledef.radius, ifc2x3.ifcroundededgefeature.radius, ifc2x3.ifcrightcircularcylinder.radius, ifc2x3.ifccircleprofiledef.radius, ifc2x3.ifccranerailfshapeprofiledef.radius, ifc2x3.ifclightsourcepositional.radius, ifc2x3.ifcsweptdisksolid.radius, ifc2x3.ifccircle.radius, ifc2x3.ifcsphere.radius, ifc4.ifcsweptdisksolid.radius, ifc4.ifcrightcircularcylinder.radius, ifc4.ifccircleprofiledef.radius, ifc4.ifclightsourcepositional.radius, ifc4.ifccircle.radius, ifc4.ifccylindricalsurface.radius, ifc4.ifcsphere.radius, Inspection::DistanceInspection.radius, Measure::Measurement.radius(), MeshCore::CylinderSurfaceFit.radius, MeshCore::SphereSurfaceFit.radius, Part::TangentialArc.radius(), PartGui::DimensionAngular.radius, PartGui::ArcEngine.radius, geoff_geometry::Circle.radius, geoff_geometry::Span.radius, PathScripts.PathDressupAxisMap.TaskPanel.radius, PathScripts.PathDressupHoldingTags.Tag.radius, PathScripts.PathDressupTag.TagSolid.radius, PathScripts.PathOp.ObjectOp.radius, PathScripts.PathSurface.ObjectSurface.radius, PathScripts.PathSurfaceSupport.ProcessSelectedFaces.radius, PathScripts.PathWaterline.ObjectWaterline.radius, cSimTool.radius, KDL::Path_Circle.radius, KDL::Path_RoundedComposite.radius, ObjectObserver.radius, SketcherGui::DrawSketchHandler3PointArc.radius, SketcherGui::DrawSketchHandler3PointCircle.radius, SketcherGui::DrawSketchHandlerOblong.radius, TechDraw::arcPoints.radius, TechDraw::Circle.radius, PathScripts.PathSurface.ObjectSurface.resetTolerance, PathScripts.PathWaterline.ObjectWaterline.resetTolerance, PathScripts.PathDressupPathBoundary.DressupPathBoundary.safeHeight, PathScripts.PathDressupPathBoundary.PathBoundary.safeHeight, PathScripts.PathOpGui.TaskPanelHeightsPage.safeHeight, PathScripts.PathOpGui.TaskPanelDiametersPage.safeHeight, PathScripts.PathOpGui.TaskPanel.safeHeight, PathScripts.PathSurface.ObjectSurface.safeHeight, PathScripts.PathWaterline.ObjectWaterline.safeHeight, PathScripts.PathSetupSheet.Template.SafeHeightOffset, PathScripts.PathSurface.ObjectSurface.SafeHeightOffset, PathScripts.PathWaterline.ObjectWaterline.SafeHeightOffset, PathScripts.PathSurface.ObjectSurface.stl, PathScripts.PathWaterline.ObjectWaterline.stl, PathScripts.PathSurface.ObjectSurface.useTiltCutter, PathScripts.PathSurfaceSupport.OCL_Tool.useTiltCutter(), and PathScripts.PathWaterline.ObjectWaterline.useTiltCutter.

◆ holdStopCmds()

def PathScripts.PathSurface.ObjectSurface.holdStopCmds (   self,
  obj,
  zMax,
  pd,
  p2,
  txt 
)

◆ initOperation()

def PathScripts.PathSurface.ObjectSurface.initOperation (   self,
  obj 
)
initOperation(obj) ... Initialize the operation by
managing property creation and property editor status.

Reimplemented from PathScripts.PathOp.ObjectOp.

◆ initOpProperties()

def PathScripts.PathSurface.ObjectSurface.initOpProperties (   self,
  obj,
  warn = False 
)

◆ onChanged()

◆ opApplyPropertyDefaults()

◆ opApplyPropertyLimits()

def PathScripts.PathSurface.ObjectSurface.opApplyPropertyLimits (   self,
  obj 
)
opApplyPropertyLimits(obj) ... Apply necessary limits to user input property values before performing main operation.

◆ opExecute()

def PathScripts.PathSurface.ObjectSurface.opExecute (   self,
  obj 
)
opExecute(obj) ... process surface operation

Reimplemented from PathScripts.PathOp.ObjectOp.

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

◆ opFeatures()

◆ opOnDocumentRestored()

◆ opPropertyDefaults()

def PathScripts.PathSurface.ObjectSurface.opPropertyDefaults (   self,
  obj,
  job 
)
opPropertyDefaults(obj, job) ... returns a dictionary of default values
for the operation's properties.

Referenced by PathScripts.PathSlot.ObjectSlot.opApplyPropertyDefaults(), PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), and PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults().

◆ opPropertyDefinitions()

def PathScripts.PathSurface.ObjectSurface.opPropertyDefinitions (   self)
opPropertyDefinitions(obj) ... Store operation specific properties

References draftutils.translate.QT_TRANSLATE_NOOP.

◆ opSetDefaultValues()

◆ opUpdateDepths()

◆ propertyEnumerations()

def PathScripts.PathSurface.ObjectSurface.propertyEnumerations (   cls,
  dataType = "data" 
)
propertyEnumerations(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().

◆ resetOpVariables()

◆ setEditorProperties()

◆ setOclCutter()

def PathScripts.PathSurface.ObjectSurface.setOclCutter (   self,
  obj,
  safe = False 
)
setOclCutter(obj) ... Translation function to convert FreeCAD tool definition to OCL formatted tool.

References PathScripts.PathSurface.ObjectSurface._planarDropCutScan(), PathScripts.PathSurface.ObjectSurface.useTiltCutter, PathScripts.PathSurfaceSupport.OCL_Tool.useTiltCutter(), and PathScripts.PathWaterline.ObjectWaterline.useTiltCutter.

◆ showDebugObject()

Member Data Documentation

◆ addNewProps

◆ avoidShapes

PathScripts.PathSurface.ObjectSurface.avoidShapes

◆ axialFeed

◆ axialRapid

◆ basePlacement

PathScripts.PathSurface.ObjectSurface.basePlacement

◆ bbRadius

◆ boundBoxes

PathScripts.PathSurface.ObjectSurface.boundBoxes

◆ cancelOperation

PathScripts.PathSurface.ObjectSurface.cancelOperation

◆ clearHeight

◆ ClearHeightOffset

◆ closedGap

PathScripts.PathSurface.ObjectSurface.closedGap

◆ collectiveShapes

PathScripts.PathSurface.ObjectSurface.collectiveShapes

◆ CutClimb

PathScripts.PathSurface.ObjectSurface.CutClimb

◆ cutOut

◆ cutter

◆ depthParams

PathScripts.PathSurface.ObjectSurface.depthParams

◆ faceZMax

◆ FinalDepth

◆ fullSTL

◆ gaps

PathScripts.PathSurface.ObjectSurface.gaps

◆ holdPntCnt

◆ holdPoint

◆ individualShapes

PathScripts.PathSurface.ObjectSurface.individualShapes

◆ JOB

PathScripts.PathSurface.ObjectSurface.JOB

◆ layerEndPnt

◆ layerEndzMax

◆ midDep

PathScripts.PathSurface.ObjectSurface.midDep

◆ modelSTLs

PathScripts.PathSurface.ObjectSurface.modelSTLs

◆ modelTypes

PathScripts.PathSurface.ObjectSurface.modelTypes

◆ module

◆ onHold

◆ preOLP

PathScripts.PathSurface.ObjectSurface.preOLP

◆ profileShapes

PathScripts.PathSurface.ObjectSurface.profileShapes

◆ propertiesReady

◆ radius

◆ resetTolerance

◆ safeHeight

◆ SafeHeightOffset

◆ safeSTLs

PathScripts.PathSurface.ObjectSurface.safeSTLs

◆ showDebugObjects

◆ stl

◆ stockZMin

PathScripts.PathSurface.ObjectSurface.stockZMin

◆ tempGroup

◆ tmpCOM

PathScripts.PathSurface.ObjectSurface.tmpCOM

◆ toolDiam

PathScripts.PathSurface.ObjectSurface.toolDiam

◆ useTiltCutter


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