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 | areaOpSetDefaultValues (self, obj, job) |
| def | areaOpUseProjection (self, obj) |
| def | initAreaOp (self, obj) |
| def | initPocketOp (self, obj) |
| def | opOnDocumentRestored (self, obj) |
| def | pocketInvertExtraOffset (self) |
| def | pocketOpFeatures (self, obj) |
| def | pocketPropertyEnumerations (cls, dataType="data") |
 Public Member Functions inherited from PathScripts.PathAreaOp.ObjectOp | |
| def | areaOpAreaParams (self, obj, isHole) |
| def | areaOpFeatures (self, obj) |
| def | areaOpOnChanged (self, obj, prop) |
| def | areaOpOnDocumentRestored (self, obj) |
| def | areaOpPathParams (self, obj, isHole) |
| def | areaOpRetractTool (self, obj) |
| def | areaOpSetDefaultValues (self, obj, job) |
| def | areaOpShapeForDepths (self, obj, job) |
| def | areaOpShapes (self, obj) |
| def | areaOpUseProjection (self, obj) |
| def | initAreaOp (self, obj) |
| def | initOperation (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) |
| 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) |
Additional Inherited Members | |
| Public Attributes inherited from PathScripts.PathAreaOp.ObjectOp | |
| depthparams | |
| endVector | |
| leadIn | |
| 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.PathMillFace.ObjectFace.pocketInvertExtraOffset(), PathScripts.PathPocket.ObjectPocket.pocketInvertExtraOffset(), PathScripts.PathPocketBase.ObjectPocket.pocketInvertExtraOffset(), PathScripts.PathPocketShape.ObjectPocket.pocketInvertExtraOffset(), 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, and TechDraw::Circle.radius.
Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues().
◆ 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.PathPocket.ObjectPocket.pocketOpFeatures(), and PathScripts.PathPocketBase.ObjectPocket.pocketOpFeatures().
Referenced by PathScripts.PathAreaOp.ObjectOp.opFeatures().
◆ 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 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, and TechDraw::Circle.radius.
Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues().
◆ 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.
Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues().
◆ areaOpSetDefaultValues()
| def PathScripts.PathPocketBase.ObjectPocket.areaOpSetDefaultValues | ( | self, | |
| obj, | |||
| job | |||
| ) |
areaOpSetDefaultValues(obj, job) ... overwrite to set initial values of operation specific properties. Can safely be overwritten by subclasses.
Reimplemented from PathScripts.PathAreaOp.ObjectOp.
Reimplemented in PathScripts.PathMillFace.ObjectFace, PathScripts.PathPocket.ObjectPocket, and PathScripts.PathPocketShape.ObjectPocket.
Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), and PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues().
◆ areaOpUseProjection()
| def PathScripts.PathPocketBase.ObjectPocket.areaOpUseProjection | ( | self, | |
| obj | |||
| ) |
areaOpUseProjection(obj) ... return False
Reimplemented from PathScripts.PathAreaOp.ObjectOp.
Referenced by PathScripts.PathAreaOp.ObjectOp.areaOpSetDefaultValues().
◆ 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.PathMillFace.ObjectFace.initPocketOp(), PathScripts.PathPocket.ObjectPocket.initPocketOp(), PathScripts.PathPocketBase.ObjectPocket.initPocketOp(), PathScripts.PathPocketShape.ObjectPocket.initPocketOp(), PathScripts.PathPocketBase.ObjectPocket.pocketPropertyEnumerations(), and draftutils.translate.QT_TRANSLATE_NOOP.
Referenced by PathScripts.PathAreaOp.ObjectOp.initOperation().
◆ initPocketOp()
| def PathScripts.PathPocketBase.ObjectPocket.initPocketOp | ( | self, | |
| obj | |||
| ) |
initPocketOp(obj) ... overwrite to initialize subclass. Can safely be overwritten by subclass.
Reimplemented in PathScripts.PathMillFace.ObjectFace, PathScripts.PathPocket.ObjectPocket, and PathScripts.PathPocketShape.ObjectPocket.
Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpOnDocumentRestored(), PathScripts.PathPocketBase.ObjectPocket.initAreaOp(), and PathScripts.PathPocket.ObjectPocket.opOnDocumentRestored().
◆ opOnDocumentRestored()
| def PathScripts.PathPocketBase.ObjectPocket.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.PathAreaOp.ObjectOp.
Reimplemented in PathScripts.PathPocket.ObjectPocket.
References PathScripts.PathPocketBase.ObjectPocket.opOnDocumentRestored(), and draftutils.translate.QT_TRANSLATE_NOOP.
Referenced by PathScripts.PathOp.ObjectOp.onDocumentRestored(), and PathScripts.PathPocketBase.ObjectPocket.opOnDocumentRestored().
◆ 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.PathMillFace.ObjectFace, PathScripts.PathPocket.ObjectPocket, and PathScripts.PathPocketShape.ObjectPocket.
Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams().
◆ pocketOpFeatures()
| def PathScripts.PathPocketBase.ObjectPocket.pocketOpFeatures | ( | self, | |
| obj | |||
| ) |
Reimplemented in PathScripts.PathPocket.ObjectPocket.
Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpFeatures().
◆ pocketPropertyEnumerations()
| def PathScripts.PathPocketBase.ObjectPocket.pocketPropertyEnumerations | ( | cls, | |
dataType = "data" |
|||
| ) |
pocketPropertyEnumerations(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.PathPocketBase.ObjectPocket.initAreaOp().
The documentation for this class was generated from the following file:
- FreeCAD/src/Mod/Path/PathScripts/PathPocketBase.py
