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 | opPropertyEnumerations (self) |
def | opSetDefaultValues (self, obj, job) |
def | opUpdateDepths (self, obj) |
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 | onDocumentRestored (self, obj) |
def | opOnChanged (self, obj, prop) |
def | opRejectAddBase (self, obj, base, sub) |
def | setDefaultValues (self, obj) |
def | setEditorModes (self, obj, features) |
def | updateDepths (self, obj, ignoreErrors=False) |
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.PathCircularHoleBase.ObjectOp.axialFeed, PathScripts.PathAreaOp.ObjectOp.axialFeed, PathScripts.PathSurface.ObjectSurface.axialFeed, PathScripts.PathCircularHoleBase.ObjectOp.axialRapid, PathScripts.PathAreaOp.ObjectOp.axialRapid, PathScripts.PathSurface.ObjectSurface.axialRapid, PathScripts.PathSurface.ObjectSurface.bbRadius, PathScripts.PathCircularHoleBase.ObjectOp.clearHeight, PathScripts.PathSurface.ObjectSurface.clearHeight, PathScripts.PathSurface.ObjectSurface.ClearHeightOffset, PathScripts.PathSurface.ObjectSurface.cutOut, PathScripts.PathSurface.ObjectSurface.cutter, PathScripts.PathSurface.ObjectSurface.faceZMax, PathScripts.PathSurface.ObjectSurface.FinalDepth, PathScripts.PathSurface.ObjectSurface.fullSTL, PathScripts.PathSurface.ObjectSurface.holdPntCnt, PathScripts.PathSurface.ObjectSurface.holdPoint, PathScripts.PathSurface.ObjectSurface.layerEndPnt, PathScripts.PathSurface.ObjectSurface.layerEndzMax, PathScripts.PathSurface.ObjectSurface.onHold, 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.PathSurface.ObjectSurface.resetTolerance, PathScripts.PathDressupPathBoundary.DressupPathBoundary.safeHeight, PathScripts.PathCircularHoleBase.ObjectOp.safeHeight, PathScripts.PathOpGui.TaskPanelHeightsPage.safeHeight, PathScripts.PathOpGui.TaskPanel.safeHeight, PathScripts.PathSurface.ObjectSurface.safeHeight, PathScripts.PathSetupSheet.Template.SafeHeightOffset, PathScripts.PathSurface.ObjectSurface.SafeHeightOffset, PathScripts.PathSurface.ObjectSurface.stl, and PathScripts.PathSurface.ObjectSurface.useTiltCutter.
◆ holdStopCmds()
def PathScripts.PathSurface.ObjectSurface.holdStopCmds | ( | self, | |
obj, | |||
zMax, | |||
pd, | |||
p2, | |||
txt | |||
) |
holdStopCmds(obj, zMax, pd, p2, txt) ... Gcode commands to be executed at beginning of hold.
References PathScripts.PathOp.ObjectOp.horizRapid, PathScripts.PathOp.ObjectOp.vertFeed, and PathScripts.PathOp.ObjectOp.vertRapid.
◆ 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 |
|||
) |
initOpProperties(obj) ... create operation specific properties
Referenced by PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), and PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored().
◆ onChanged()
def PathScripts.PathSurface.ObjectSurface.onChanged | ( | self, | |
obj, | |||
prop | |||
) |
onChanged(obj, prop) ... base implementation of the FC notification framework. Do not overwrite, overwrite opOnChanged() instead.
Reimplemented from PathScripts.PathOp.ObjectOp.
References PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathArray.ObjectArray.setEditorProperties(), PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), PathScripts.PathSurface.ObjectSurface.setEditorProperties(), and PathScripts.PathPocketShape.ObjectPocket.setEditorProperties().
Referenced by ArchSite.Compass.buildCoordinates(), and ArchAxis.CommandArchGrid.IsActive().
◆ opApplyPropertyDefaults()
def PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults | ( | self, | |
obj, | |||
job, | |||
propList | |||
) |
References PathScripts.PathSurface.ObjectSurface.opPropertyDefaults().
Referenced by PathScripts.PathSurface.ObjectSurface.opOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.opOnDocumentRestored(), PathScripts.PathWaterline.ObjectWaterline.opSetDefaultValues(), and PathScripts.PathSurface.ObjectSurface.opSetDefaultValues().
◆ 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.
◆ opFeatures()
def PathScripts.PathSurface.ObjectSurface.opFeatures | ( | self, | |
obj | |||
) |
opFeatures(obj) ... return all standard features
Reimplemented from PathScripts.PathOp.ObjectOp.
◆ opOnDocumentRestored()
def PathScripts.PathSurface.ObjectSurface.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.
References PathScripts.PathOp.ObjectOp.addNewProps, PathScripts.PathSurface.ObjectSurface.initOpProperties(), PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults(), PathScripts.PathSurface.ObjectSurface.opPropertyEnumerations(), PathScripts.PathProfile.ObjectProfile.propertiesReady, PathScripts.PathSurface.ObjectSurface.propertiesReady, PathScripts.PathArray.ObjectArray.setEditorProperties(), PathScripts.PathDressupRampEntry.ObjectDressup.setEditorProperties(), PathScripts.PathSurface.ObjectSurface.setEditorProperties(), and PathScripts.PathPocketShape.ObjectPocket.setEditorProperties().
◆ 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.PathSurface.ObjectSurface.opApplyPropertyDefaults(), and PathScripts.PathWaterline.ObjectWaterline.opApplyPropertyDefaults().
◆ opPropertyDefinitions()
def PathScripts.PathSurface.ObjectSurface.opPropertyDefinitions | ( | self | ) |
opPropertyDefinitions(obj) ... Store operation specific properties
◆ opPropertyEnumerations()
def PathScripts.PathSurface.ObjectSurface.opPropertyEnumerations | ( | self | ) |
◆ opSetDefaultValues()
def PathScripts.PathSurface.ObjectSurface.opSetDefaultValues | ( | self, | |
obj, | |||
job | |||
) |
opSetDefaultValues(obj, job) ... initialize defaults
Reimplemented from PathScripts.PathOp.ObjectOp.
References PathScripts.PathOp.ObjectOp.addNewProps, and PathScripts.PathSurface.ObjectSurface.opApplyPropertyDefaults().
◆ opUpdateDepths()
def PathScripts.PathSurface.ObjectSurface.opUpdateDepths | ( | self, | |
obj | |||
) |
opUpdateDepths(obj) ... overwrite to implement special depths calculation. Can safely be overwritten by subclass.
Reimplemented from PathScripts.PathOp.ObjectOp.
◆ resetOpVariables()
def PathScripts.PathSurface.ObjectSurface.resetOpVariables | ( | self, | |
all = True |
|||
) |
resetOpVariables() ... Reset class variables used for instance of operation.
References PathScripts.PathSurface.ObjectSurface.ClearHeightOffset, PathScripts.PathSurface.ObjectSurface.holdPoint, PathScripts.PathSurface.ObjectSurface.layerEndPnt, PathScripts.PathSurface.ObjectSurface.layerEndzMax, PathScripts.PathSurface.ObjectSurface.onHold, PathScripts.PathSurface.ObjectSurface.resetTolerance, PathScripts.PathSetupSheet.Template.SafeHeightOffset, and PathScripts.PathSurface.ObjectSurface.SafeHeightOffset.
◆ setEditorProperties()
def PathScripts.PathSurface.ObjectSurface.setEditorProperties | ( | self, | |
obj | |||
) |
◆ 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._optimizeLinearSegments(), PathScripts.PathSurface.ObjectSurface._planarDropCutScan(), and PathScripts.PathSurface.ObjectSurface.useTiltCutter.
◆ showDebugObject()
def PathScripts.PathSurface.ObjectSurface.showDebugObject | ( | self, | |
objShape, | |||
objName | |||
) |
Member Data Documentation
◆ addNewProps
PathScripts.PathSurface.ObjectSurface.addNewProps |
◆ avoidShapes
PathScripts.PathSurface.ObjectSurface.avoidShapes |
◆ axialFeed
PathScripts.PathSurface.ObjectSurface.axialFeed |
◆ axialRapid
PathScripts.PathSurface.ObjectSurface.axialRapid |
◆ basePlacement
PathScripts.PathSurface.ObjectSurface.basePlacement |
◆ bbRadius
PathScripts.PathSurface.ObjectSurface.bbRadius |
◆ boundBoxes
PathScripts.PathSurface.ObjectSurface.boundBoxes |
◆ cancelOperation
PathScripts.PathSurface.ObjectSurface.cancelOperation |
◆ clearHeight
PathScripts.PathSurface.ObjectSurface.clearHeight |
◆ ClearHeightOffset
PathScripts.PathSurface.ObjectSurface.ClearHeightOffset |
◆ closedGap
PathScripts.PathSurface.ObjectSurface.closedGap |
◆ collectiveShapes
PathScripts.PathSurface.ObjectSurface.collectiveShapes |
◆ CutClimb
PathScripts.PathSurface.ObjectSurface.CutClimb |
◆ cutOut
PathScripts.PathSurface.ObjectSurface.cutOut |
◆ cutter
PathScripts.PathSurface.ObjectSurface.cutter |
◆ depthParams
PathScripts.PathSurface.ObjectSurface.depthParams |
◆ faceZMax
PathScripts.PathSurface.ObjectSurface.faceZMax |
◆ FinalDepth
PathScripts.PathSurface.ObjectSurface.FinalDepth |
◆ fullSTL
PathScripts.PathSurface.ObjectSurface.fullSTL |
◆ gaps
PathScripts.PathSurface.ObjectSurface.gaps |
◆ holdPntCnt
PathScripts.PathSurface.ObjectSurface.holdPntCnt |
◆ holdPoint
PathScripts.PathSurface.ObjectSurface.holdPoint |
◆ individualShapes
PathScripts.PathSurface.ObjectSurface.individualShapes |
◆ JOB
PathScripts.PathSurface.ObjectSurface.JOB |
◆ layerEndPnt
PathScripts.PathSurface.ObjectSurface.layerEndPnt |
◆ layerEndzMax
PathScripts.PathSurface.ObjectSurface.layerEndzMax |
◆ midDep
PathScripts.PathSurface.ObjectSurface.midDep |
◆ modelSTLs
PathScripts.PathSurface.ObjectSurface.modelSTLs |
◆ modelTypes
PathScripts.PathSurface.ObjectSurface.modelTypes |
◆ module
PathScripts.PathSurface.ObjectSurface.module |
◆ onHold
PathScripts.PathSurface.ObjectSurface.onHold |
◆ preOLP
PathScripts.PathSurface.ObjectSurface.preOLP |
◆ profileShapes
PathScripts.PathSurface.ObjectSurface.profileShapes |
◆ propertiesReady
PathScripts.PathSurface.ObjectSurface.propertiesReady |
◆ radius
PathScripts.PathSurface.ObjectSurface.radius |
◆ resetTolerance
PathScripts.PathSurface.ObjectSurface.resetTolerance |
◆ safeHeight
PathScripts.PathSurface.ObjectSurface.safeHeight |
◆ SafeHeightOffset
PathScripts.PathSurface.ObjectSurface.SafeHeightOffset |
◆ safeSTLs
PathScripts.PathSurface.ObjectSurface.safeSTLs |
◆ showDebugObjects
PathScripts.PathSurface.ObjectSurface.showDebugObjects |
◆ stl
PathScripts.PathSurface.ObjectSurface.stl |
◆ stockZMin
PathScripts.PathSurface.ObjectSurface.stockZMin |
◆ tempGroup
PathScripts.PathSurface.ObjectSurface.tempGroup |
Referenced by PathScripts.PathSurfaceSupport.ProcessSelectedFaces.preProcessModel(), PathScripts.PathSurfaceSupport.ProcessSelectedFaces.setShowDebugObjects(), PathScripts.PathSurfaceSupport.FindUnifiedRegions.setTempGroup(), PathScripts.PathWaterline.ObjectWaterline.showDebugObject(), and PathScripts.PathSurface.ObjectSurface.showDebugObject().
◆ tmpCOM
PathScripts.PathSurface.ObjectSurface.tmpCOM |
◆ toolDiam
PathScripts.PathSurface.ObjectSurface.toolDiam |
◆ useTiltCutter
PathScripts.PathSurface.ObjectSurface.useTiltCutter |
The documentation for this class was generated from the following file:
- src/Mod/Path/PathScripts/PathSurface.py