PathScripts.PathPocket.ObjectPocket Class Reference
Public Member Functions | |
| def | areaOpSetDefaultValues (self, obj, job) |
| def | areaOpShapes (self, obj) |
| def | calculateAdaptivePocket (self, obj, base, subObjTups) |
| def | findSharedEdges (self, subObjTups) |
| def | getMinMaxOfFaces (self, Faces) |
| def | groupConnectedEdges (self, holding) |
| def | hasCommonVertex (self, edge1, edge2, show=False) |
| def | identifyUnconnectedEdges (self, subObjTups, touching) |
| def | initPocketOp (self, obj) |
| def | opOnDocumentRestored (self, obj) |
| def | opUpdateDepths (self, obj) |
| def | orderFacesAroundCenterOfMass (self, subObjTups) |
| def | pocketInvertExtraOffset (self) |
| def | pocketOpFeatures (self, obj) |
| def | propertyEnumerations (self, dataType="data") |
 Public Member Functions inherited from PathScripts.PathPocketBase.ObjectPocket | |
| 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
Proxy object for Pocket operation.
Member Function Documentation
◆ areaOpSetDefaultValues()
| def PathScripts.PathPocket.ObjectPocket.areaOpSetDefaultValues | ( | self, | |
| obj, | |||
| job | |||
| ) |
areaOpSetDefaultValues(obj, job) ... set default values
Reimplemented from PathScripts.PathPocketBase.ObjectPocket.
Referenced by PathScripts.PathProfile.ObjectProfile.areaOpOnDocumentRestored(), and PathScripts.PathAreaOp.ObjectOp.opSetDefaultValues().
◆ areaOpShapes()
| def PathScripts.PathPocket.ObjectPocket.areaOpShapes | ( | self, | |
| obj | |||
| ) |
areaOpShapes(obj) ... return shapes representing the solids to be removed.
Reimplemented from PathScripts.PathAreaOp.ObjectOp.
References PathScripts.PathPocket.ObjectPocket.calculateAdaptivePocket(), PathScripts.PathAreaOp.ObjectOp.depthparams, PathScripts.PathPocket.ObjectPocket.getMinMaxOfFaces(), Gui::VectorListEditor.model, ArchMaterial._ArchMultiMaterialTaskPanel.model, PartGui::TaskCheckGeometryResults.model, PathScripts.PathFeatureExtensionsGui.TaskPanelExtensionPage.model, PathScripts.PathJobDlg.JobCreate.model, PathScripts.PathOp.ObjectOp.model, PathScripts.PathPropertyBagGui.TaskPanel.model, PathScripts.PathSetupSheetGui.OpTaskPanel.model, PathScripts.PathToolBitEdit.ToolBitEditor.model, and SpreadsheetGui::SheetView.model.
◆ calculateAdaptivePocket()
| def PathScripts.PathPocket.ObjectPocket.calculateAdaptivePocket | ( | self, | |
| obj, | |||
| base, | |||
| subObjTups | |||
| ) |
calculateAdaptivePocket(obj, base, subObjTups) Orient multiple faces around common facial center of mass. Identify edges that are connections for adjacent faces. Attempt to separate unconnected edges into top and bottom loops of the pocket. Trim the top and bottom of the pocket if available and requested. return: tuple with pocket shape information
References PathScripts.PathPocket.ObjectPocket.findSharedEdges(), PathScripts.PathPocket.ObjectPocket.getMinMaxOfFaces(), PathScripts.PathPocket.ObjectPocket.identifyUnconnectedEdges(), and PathScripts.PathPocket.ObjectPocket.orderFacesAroundCenterOfMass().
Referenced by PathScripts.PathPocket.ObjectPocket.areaOpShapes().
◆ findSharedEdges()
| def PathScripts.PathPocket.ObjectPocket.findSharedEdges | ( | self, | |
| subObjTups | |||
| ) |
findSharedEdges(self, subObjTups) Find connected edges given a group of faces
Referenced by PathScripts.PathPocket.ObjectPocket.calculateAdaptivePocket().
◆ getMinMaxOfFaces()
| def PathScripts.PathPocket.ObjectPocket.getMinMaxOfFaces | ( | self, | |
| Faces | |||
| ) |
getMinMaxOfFaces(Faces) return the zmin and zmax values for given set of faces or edges.
Referenced by PathScripts.PathPocket.ObjectPocket.areaOpShapes(), and PathScripts.PathPocket.ObjectPocket.calculateAdaptivePocket().
◆ groupConnectedEdges()
| def PathScripts.PathPocket.ObjectPocket.groupConnectedEdges | ( | self, | |
| holding | |||
| ) |
groupConnectedEdges(self, holding) Take edges and determine which are connected. Group connected chains/loops into: low and high
Referenced by PathScripts.PathPocket.ObjectPocket.identifyUnconnectedEdges().
◆ hasCommonVertex()
| def PathScripts.PathPocket.ObjectPocket.hasCommonVertex | ( | self, | |
| edge1, | |||
| edge2, | |||
show = False |
|||
| ) |
findCommonVertexIndexes(edge1, edge2, show=False) Compare vertexes of two edges to identify a common vertex. Returns the vertex index of edge1 to which edge2 is connected
Referenced by PathScripts.PathPocket.ObjectPocket.identifyUnconnectedEdges().
◆ identifyUnconnectedEdges()
| def PathScripts.PathPocket.ObjectPocket.identifyUnconnectedEdges | ( | self, | |
| subObjTups, | |||
| touching | |||
| ) |
identifyUnconnectedEdges(subObjTups, touching) Categorize unconnected edges into two groups, if possible: low and high
References PathScripts.PathPocket.ObjectPocket.groupConnectedEdges(), and PathScripts.PathPocket.ObjectPocket.hasCommonVertex().
Referenced by PathScripts.PathPocket.ObjectPocket.calculateAdaptivePocket().
◆ initPocketOp()
| def PathScripts.PathPocket.ObjectPocket.initPocketOp | ( | self, | |
| obj | |||
| ) |
initPocketOp(obj) ... setup receiver
Reimplemented from PathScripts.PathPocketBase.ObjectPocket.
References PathScripts.PathSurface.ObjectSurface.propertyEnumerations(), PathScripts.PathPropertyBagGui.PropertyCreate.propertyEnumerations(), PathScripts.PathAdaptive.PathAdaptive.propertyEnumerations(), PathScripts.PathDeburr.ObjectDeburr.propertyEnumerations(), PathScripts.PathDressupRampEntry.ObjectDressup.propertyEnumerations(), PathScripts.PathDrilling.ObjectDrilling.propertyEnumerations(), PathScripts.PathJob.ObjectJob.propertyEnumerations(), PathScripts.PathMillFace.ObjectFace.propertyEnumerations(), PathScripts.PathPocket.ObjectPocket.propertyEnumerations(), PathScripts.PathSlot.ObjectSlot.propertyEnumerations(), PathScripts.PathThreadMilling.ObjectThreadMilling.propertyEnumerations(), PathScripts.PathToolController.ToolController.propertyEnumerations(), PathScripts.PathWaterline.ObjectWaterline.propertyEnumerations(), and draftutils.translate.QT_TRANSLATE_NOOP.
Referenced by PathScripts.PathPocketShape.ObjectPocket.areaOpOnDocumentRestored(), PathScripts.PathPocketBase.ObjectPocket.initAreaOp(), and PathScripts.PathPocket.ObjectPocket.opOnDocumentRestored().
◆ opOnDocumentRestored()
| def PathScripts.PathPocket.ObjectPocket.opOnDocumentRestored | ( | self, | |
| obj | |||
| ) |
opOnDocumentRestored(obj) ... adds the properties if they doesn't exist.
Reimplemented from PathScripts.PathPocketBase.ObjectPocket.
References PathScripts.PathMillFace.ObjectFace.initPocketOp(), PathScripts.PathPocket.ObjectPocket.initPocketOp(), PathScripts.PathPocketBase.ObjectPocket.initPocketOp(), and PathScripts.PathPocketShape.ObjectPocket.initPocketOp().
Referenced by PathScripts.PathOp.ObjectOp.onDocumentRestored().
◆ opUpdateDepths()
| def PathScripts.PathPocket.ObjectPocket.opUpdateDepths | ( | self, | |
| obj | |||
| ) |
opUpdateDepths(obj) ... Implement special depths calculation.
Reimplemented from PathScripts.PathOp.ObjectOp.
References PathScripts.PathCamoticsGui.CamoticsSimulation.job, PathScripts.PathJobDlg.JobTemplateExport.job, PathScripts.PathOp.ObjectOp.job, PathScripts.PathOpGui.TaskPanelPage.job, PathScripts.PathOpGui.CommandResources.job, PathScripts.PathSimulatorGui.PathSimulation.job, PathScripts.PathToolLibraryEditor.EditorPanel.job, PathTests.TestPathHelix.TestPathHelix.job, PathTests.TestPathPost.TestBuildPostList.job, PathTests.TestPathPost.TestOutputNameSubstitution.job, and PathTests.TestPathStock.TestPathStock.job.
Referenced by PathScripts.PathOp.ObjectOp.updateDepths().
◆ orderFacesAroundCenterOfMass()
| def PathScripts.PathPocket.ObjectPocket.orderFacesAroundCenterOfMass | ( | self, | |
| subObjTups | |||
| ) |
orderFacesAroundCenterOfMass(subObjTups) Order list of faces by center of mass in angular order around average center of mass for all faces. Positive X-axis is zero degrees. return: subObjTups [ordered/sorted]
Referenced by PathScripts.PathPocket.ObjectPocket.calculateAdaptivePocket().
◆ pocketInvertExtraOffset()
| def PathScripts.PathPocket.ObjectPocket.pocketInvertExtraOffset | ( | self | ) |
pocketInvertExtraOffset() ... return True if ExtraOffset's direction is inward. Can safely be overwritten by subclass.
Reimplemented from PathScripts.PathPocketBase.ObjectPocket.
Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpAreaParams().
◆ pocketOpFeatures()
| def PathScripts.PathPocket.ObjectPocket.pocketOpFeatures | ( | self, | |
| obj | |||
| ) |
Reimplemented from PathScripts.PathPocketBase.ObjectPocket.
Referenced by PathScripts.PathPocketBase.ObjectPocket.areaOpFeatures().
◆ propertyEnumerations()
| def PathScripts.PathPocket.ObjectPocket.propertyEnumerations | ( | self, | |
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().
The documentation for this class was generated from the following file:
- FreeCAD/src/Mod/Path/PathScripts/PathPocket.py
