Operations - sliptonic/FreeCAD GitHub Wiki

Operations represent the core of the CAM workbench. They hold most of the complexity and a majority of the actual source code. To manage this code and complexity, the operation logic is broken into several logical parts. The implementation of this abstraction is inconsistent.

Base.ObjectOp CircularHoleBase.ObjectOp Helix.ObjectHelix Drilling.ObjectDrilling ThreadMilling.ObjectThreadMilling Tapping.ObjectTapping EngraveBase.ObjectOp Engrave.ObjectEngrave Vcarve.ObjectVcarve Deburr.ObjectDeburr Slot.ObjectSlot Custom.ObjectCustom Probe.ObjectProbing Adaptive.PathAdaptive Area.ObjectOp PocketBase.ObjectPocket MillFace.ObjectFace Pocket.ObjectPocket PocketShape.ObjectPocket Profile.ObjectProfile Surface.ObjectSurface Waterline.ObjectWaterline

graph TD
    Base.ObjectOp

    Base.ObjectOp --> CircularHoleBase.ObjectOp
    CircularHoleBase.ObjectOp --> Helix.ObjectHelix
    CircularHoleBase.ObjectOp --> Drilling.ObjectDrilling
    CircularHoleBase.ObjectOp --> ThreadMilling.ObjectThreadMilling
    CircularHoleBase.ObjectOp --> Tapping.ObjectTapping

    Base.ObjectOp --> EngraveBase.ObjectOp
    EngraveBase.ObjectOp --> Engrave.ObjectEngrave
    EngraveBase.ObjectOp --> Vcarve.ObjectVcarve
    EngraveBase.ObjectOp --> Deburr.ObjectDeburr

    Base.ObjectOp --> Slot.ObjectSlot
    Base.ObjectOp --> Custom.ObjectCustom
    Base.ObjectOp --> Probe.ObjectProbing
    Base.ObjectOp --> Adaptive.PathAdaptive
    Base.ObjectOp --> Area.ObjectOp

    Area.ObjectOp --> PocketBase.ObjectPocket
    PocketBase.ObjectPocket --> MillFace.ObjectFace
    PocketBase.ObjectPocket --> Pocket.ObjectPocket
    PocketBase.ObjectPocket --> PocketShape.ObjectPocket
    Area.ObjectOp --> Profile.ObjectProfile

    Base.ObjectOp --> Surface.ObjectSurface
    Base.ObjectOp --> Waterline.ObjectWaterline

Notes:

• The three big groups, CircularHoleBase, EngraveBase, and PocketBase can be thought of as working on points, wires, and planar faces respectively. (In actuality, CircularHolebase works on an edge aligned with the spindle)
• Area is the oddball. It is a legacy abstraction and could be refactored out.
• Surface and Waterline are both OCL-based operations and work on faces, including curved faces. They should be refactored to inherit from a common SurfaceBase
• Adaptive should be refactored as a strategy of pocket.
• Slot has extensive logic to calculate the appropriate wire but otherwise works on a wire. It could be refactored to inherit from EngraveBase

The user facing logic when running the FreeCAD GUI. The GUI is responsible for managing the state of the taskpanels and responding to user actions. All other logic should reside in the operation. It also contains the ViewProvider of the operation which renders the Path Commands in the scenegraph.

Base.TaskPanelPage CircularHoleBaseGui.TaskPanelOpPage Helix.TaskPanelOpPage Tapping.TaskPanelOpPage ThreadMilling.TaskPanelOpPage PocketBaseGui.TaskPanelOpPage MillFace PocketShape Pocket Adaptive.TaskPanelOpPage Custom.TaskPanelOpPage Deburr.TaskPanelOpPage Drilling.TaskPanelOpPage Engrave.TaskPanelOpPage Probe.TaskPanelOpPage Vcarve.TaskPanelOpPage Waterline.TaskPanelOpPage Slot.TaskPanelOpPage Profile.TaskPanelOpPage Surface.TaskPanelOpPage FeatureExtension.TaskPanelExtensionPage Base.TaskPanelBaseGeometryPage Deburr.TaskPanelBaseGeometryPage Engrave.TaskPanelBaseGeometryPage Vcarve.TaskPanelBaseGeometryPage

graph TD
    Base.TaskPanelPage
    Base.TaskPanelBaseGeometryPage

    Base.TaskPanelPage --> CircularHoleBaseGui.TaskPanelOpPage
    CircularHoleBaseGui.TaskPanelOpPage --> Helix.TaskPanelOpPage
    CircularHoleBaseGui.TaskPanelOpPage --> Tapping.TaskPanelOpPage
    CircularHoleBaseGui.TaskPanelOpPage --> ThreadMilling.TaskPanelOpPage

    Base.TaskPanelPage --> PocketBaseGui.TaskPanelOpPage
    PocketBaseGui.TaskPanelOpPage --> MillFace
    PocketBaseGui.TaskPanelOpPage --> PocketShape
    PocketBaseGui.TaskPanelOpPage --> Pocket

    Base.TaskPanelPage --> Adaptive.TaskPanelOpPage
    Base.TaskPanelPage --> Custom.TaskPanelOpPage
    Base.TaskPanelPage --> Deburr.TaskPanelOpPage
    Base.TaskPanelPage --> Drilling.TaskPanelOpPage
    Base.TaskPanelPage --> Engrave.TaskPanelOpPage
    Base.TaskPanelPage --> Probe.TaskPanelOpPage
    Base.TaskPanelPage --> Vcarve.TaskPanelOpPage
    Base.TaskPanelPage --> Waterline.TaskPanelOpPage
    Base.TaskPanelPage --> Slot.TaskPanelOpPage
    Base.TaskPanelPage --> Profile.TaskPanelOpPage
    Base.TaskPanelPage --> Surface.TaskPanelOpPage
    Base.TaskPanelPage --> FeatureExtension.TaskPanelExtensionPage

    Base.TaskPanelBaseGeometryPage --> Deburr.TaskPanelBaseGeometryPage
    Base.TaskPanelBaseGeometryPage --> Engrave.TaskPanelBaseGeometryPage
    Base.TaskPanelBaseGeometryPage --> Vcarve.TaskPanelBaseGeometryPage

Notes:

• Array.py is non-standard and should be refactored or eliminated
• Comment.py is non-standard and should be refactored or eliminated
• Copy.py is non-standard and should be refactored or eliminated
• Stop.py is non-standard and should be refactored or eliminated
• PathShapeTC is non-standard and should be refactored or eliminated
• SimpleCopy is non-standard and should be refactored or eliminated

User-facing functionality is triggered by a GUI command that is registered when the workbench is activated. The commands should be

The task panel is the primary place where a user interacts with the operation. Task panels should be carefully designed and reviewed with DWG. Not all operation properties need to be exposed through task panels. It is perfectly acceptable to keep seldom-used or advanced feature properties only accessible through the property pane. This has the benefit of keeping the task panels clean and efficient while providing advanced users a what to fine tune operations.

The operation is responsible for managing the state (properties) of the operation and calculating the Path Commands. Specifically, it

• manages the targets (geometry to be acted upon). Determines the order to act on them.
• Calculates the linking moves to position the cutter in each target
• Computes the cutting moves to act on the target (using generators, helpers, libraries)
• Moves the cutter to an appropriate location at the end of the last cutting move.