Path Surface/en

Description
This tool creates a new operation which is capable of generating G-Code paths for the entire top surface of a 3D model (or is able to work with selected faces) and allows for faces to be avoided. This operation offers multiple cut patterns: Line, Zigzag, Circular, Circular Zigzag, Offset, and Spiral (similar to an adaptive pattern). As of version 0.19, this operation offers many customizations to allow for greater productivity.

The operation is also capable of generating basic rotational 3D surfacing paths. The rotational capabilities are limited to the entire model, and do not allow for specific faces or regions to be isolated. The rotational paths are also limited to line cut patterns.

The 3D Surface Tool interfaces to OCL.pyd, a 3rd party Open Source module titled OpenCamLib, that generates tool paths from a 3D model. OpenCamLib is not integrated directly into FreeCAD.

Note: In order to use the 3D Surface operation you must:
 * 1) Properly install OpenCamLib.
 * 2) Enable Experimental Features for the Path Workbench.
 * 3) Check.

Usage
Usage instructions for multiple variations of the 3D Surface operation are presented here.

Basic Operation

 * 1) Press the  icon, or select  from the dropdown menu.
 * 2) Select the tool controller for the Operation from the Tool controller dialogue pop up window, if presented.
 * 3) In the Base Geometry tab, select any specific faces you wish to focus on and/or avoid for the operation.
 * 4) Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.
 * 5) Make adjustments in Heights tab if needed.
 * 6) Configure settings in the Operations tab as needed:
 * 7) * Choose your Coolant Mode.
 * 8) * Choose the BoundBox: Stock or BaseBoundBox
 * 9) * Set the Scan Type for the operation: Planar or Rotational
 * 10) * Select the Layer Mode for the operation: Single-pass or Multi-pass
 * 11) *# Single-pass is for a finishing pass
 * 12) *# Multi-pass could be used for clearing in combination with the use of Depth Offset to leave a thin surface layer for a finish pass
 * 13) * Add additional BoundBox Extra Offset to X and Y as desired (Rotational scans only)
 * 14) * Set the Drop Cutter Direction: X or Y. This is the linear direction the cutter(spindle) will travel. (Rotational scans only)
 * 15) * Add a Depth Offset value if you wish to leave a specified thickness of material on the surface, for say a final finish pass
 * 16) * Set the Sample Interval used for the OCL scan.
 * 17) * Set the Step Over value as a percentage of the diameter of the Tool.
 * 18) * Check the Use Start Point box if you wish to provide a start point for the operation in the properties view of the data tab for the operation.
 * 19) * Boundary Enforcement is enabled by default. This forces the cutter to remain inside the boundaries of the feature geometry for the operation, like a pocketing operation. Disable to allow the cutter to extend to the outside of the feature geometry. The Boundary Adjustment property supersedes this property.
 * 20) * Optimize Linear Paths is enabled by default. Disabling will yield a longer gcode result and likely increase cut time.
 * 21) If you wish to preview the result before accepting the settings, click
 * 22) Click  button to confirm and generate paths.

To achieve different, or more complex, effects, adjust additional operation properties within the Data tab of the Properties View for the operation.

Rotational Scans (4th-axis)

 * 1) Initiate a Basic Operation as described above and set the Scan Type to Rotational.
 * 2) Note: Face selection is unavailable for Rotational scans, so changes to Base Geometry are ignored.
 * 3) Locate the Data tab and Properties View for the new 3D Surface operation.  A Rotation section should be available with additional properties to adjust, listed below.It is recommended that you set the desired rotation properties all at once before recomputing. This is done by clicking the ENTER key immediately after changing a property setting. This process will allow you to change and save multiple properties before recomputing the operation.
 * 4) Adjust the following settings as needed:
 * 5) * Set to the offset index(angle) [0-90]. (Used for ball mill cutters)
 * 6) * Change to the axis of travel for the cutter(spindle).
 * 7) * Change to extend the BoundBox in the X and Y directions.
 * 8) * Set to the desired axis.
 * 9) * Adjust to start index(angle) [0-360].
 * 10) * Adjust to stop index(angle) [0-360].
 * 11) Click the  icon in the tool bar.
 * 12) Wait for the results...

Notes About Rotational Scans

 * Rotational scans require much more time and processing than Planar scans. Factors affecting processing time include: Sample Interval, Step Over, tool diameter, and model size.  Again, rotational scans can take a long time.  Some might take 3, 5 or 10 minutes or longer.
 * For time purposes, it is better that you not recompute a rotational scan after every property change; rather, consider one of the following:
 * use the ' change all settings with ENTER key ' technique mentioned in Step 2 above, then the operation.
 * deactivate the operation with the toggle tool, make your changes to the operation's properties, then click the  icon again to re-activate the operation - which triggers a recompute internally.
 * The operation is still considered an experimental feature as of 2019-06-25. As such, it may contain a few bugs yet to be clearly identified.  Please report bugs and issues in the FreeCAD Path/CAM Forum.
 * The built in does NOT support 4th-axis simulation. You will need to use a third party simulator to inspect or verify paths visually.  See the Resources section below for suggestions.
 * You will likely see red rotational lines around your model in the viewport. This is normal in FreeCAD for the time being.

Notes About Scans of complex models
Excessively long processing times (longer than 10 minutes) can occur when processing large complex models. In addition to the factors already mentioned the following steps could help identify potential causes and solutions.

Low Memory Check how much memory is available while the scan is running using a tool such as the Windows Task Manager, Memory tab. If more than 90% of memory is consistently being used then a small Linear Deflection parameter could be generating a mesh that is too large for the available memory. To confirm this ...
 * 1) Create a new  operation.
 * 2) Switch to the Model tab and increase the  value. For example change from 2.5um to 20um
 * 3) Switch back to the Tasks tab to complete setting up the operation.
 * 4) Click  button to confirm and generate paths.

To make this value the default for all new operations, change the GeometryTolerance parameter. . Note as of version 0.19 the default = GeometryTolerance / 4

Invalid Geometry If a model contains invalid geometry the scanning time can increase significantly. A model can be checked using the Part CheckGeometry function in Part Workbench. To run the tool:
 * 1) Switch to the [[Image:Workbench_Part.svg|24px]]Part Workbench and select the model to check
 * 2) Click on the  button available in the Part workbench toolbar OR use the  entry from the top menu.
 * 3) Click the Run Check button and review the results.

If the results includes items like BOPAlgo SelfIntersect then the geometry is invalid and should be corrected by adjusting the model. (Hint: Boolean operations and Loft commands can sometimes introduce Self Intersections)

Available Tool (Cutter) Shapes
This 3D Surface op currently uses OpenCamLib to extract paths from the part base. As such, a tool setting translation is required between the FreeCAD tool controller and OCL in order to complete the scan with your chosen tool(cutter) shape.

These tool shapes are respected and available for this 3D Surface operation:


 * End mill
 * Ball end mill
 * Bull nose end mill
 * Chamfer bit
 * Engraver

Should you choose to run the path simulator in the Path Workbench, it only uses the standard end mill to simulate paths. Therefore, you will not see tool-shape-specific material removal. Material removal is shown using the end mill shape.

NOTE: As of May 2019, only the End Mill has any type of testing to determine accuracy of the FreeCAD-to-OCL tool settings translation. Please post any feedback for non-end-mill usage to the Path/CAM section in the FreeCAD forums.

Properties: Version 0.19
 Note : Not all of these Properties are available in the Task Window Editor. Some are only accessible in the Data tab of the Properties View panel for this Operation.

Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the Path Job model as needed.


 * : Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
 * : Angle in degrees applied to rotation of the object around Axis property value
 * : Axis(one or multiple) around which to rotate the object, set in sub-properties: x, y, z
 * : x axis value
 * : y axis value
 * : z axis value
 * : Position of the object, set in sub-properties: x, y, z - with respect to the origin (or origin of parent object container)
 * : x distance value
 * : y distance value
 * : z distance value
 * : User-provided name of the object (UTF-8)


 * : Should the operation be limited by the stock object or by the bounding box of the base object
 * : The direction that the toolpath should go around the part: Climb(ClockWise) or Conventional(CounterClockWise)
 * : Clearing pattern to use
 * : Reverse the cut order of the stepover paths. For circular cut patterns, begin at the outside and work toward the center
 * : Z-axis offset from the surface of the object
 * : The completion mode for the operation: single or multi-pass
 * : Choose location of the center point for starting the cut pattern
 * : Set the start point for the cut pattern
 * : Profile the edges of the selection
 * : The Sample Interval. Small values cause long wait times
 * : Step over percentage of the drop cutter path


 * : The height needed to clear clamps and obstructions
 * : Final Depth of Tool- lowest value in Z
 * : The above which Rapid motions are allowed.
 * : Starting Depth of Tool- first cut depth in Z
 * : Incremental Step Down of Tool


 * : Smaller values yield a finer, more accurate mesh. Smaller values increase processing time a lot
 * : Smaller values yield a finer, more accurate mesh. Smaller values do not increase processing time much but can increase memory comsumption


 * : Convert co-planar arcs to G2/G3 gcode commands for `Circular` and `CircularZigZag` cut patterns
 * : Feedback: three smallest gaps identified in the path geometry
 * : Collinear and co-radial artifact gaps that are smaller than this threshold are closed in the path
 * : Enable optimization of linear paths (co-linear points). Removes unnecessary co-linear points from G-Code output
 * : Enable separate optimization of transitions between, and breaks within, each step over path


 * : make False, to prevent operation from generating code
 * : The base geometry for this operation
 * : An optional comment for this Operation
 * : Coolant mode for this operation
 * : Operations Cycle Time Estimation
 * : Defines the Tool controller used in the Operation
 * : User assigned label


 * : Set the cutter (spindle) tilt angle.
 * : The direction along which dropcutter lines are created
 * : Additional offset to the selected bounding box - use sub-properties to set values
 * : x distance value
 * : y distance value
 * : z distance value
 * : Set the axis for model rotation.
 * : Start index(angle) for rotation
 * : Stop index(angle) for rotation


 * : Avoid cutting the last 'N' faces in the Base Geometry list of selected faces
 * : Do not cut internal features on avoided faces
 * : Positive values push the cutter toward, or beyond, the boundary. Negative values retract the cutter away from the boundary
 * : If true, the cutter will remain inside the boundaries of the model or selected face(s)
 * : Choose how to process multiple Base Geometry features
 * : Positive values push the cutter toward, or into, the feature. Negative values retract the cutter away from the feature
 * : Cut internal feature areas within a larger selected face


 * : The custom start point for the path of this operation, set in sub-properties: x, y, z
 * : x axis value
 * : y axis value
 * : z axis value
 * : Make True, if specifying a Start Point


 * : Planar: Flat, 3D surface scan. Rotational: 4th-axis rotational scan.


 * : Ignore areas that proceed below specified depth.
 * : Depth used to identify waste areas to ignore.
 * : Cut through waste to depth at model edge, releasing the model.

Tasks Window Editor Layout
Descriptions for the settings are provided in the Properties list above. This section is simply a layout map of the settings in the window editor for the Operation.

Base Location

 * Base Geometry import selection: Use this list to select Base Geometry to be imported from the selected, existing operation
 * Import: imports the selected operation's Base Geometry into the current operations Base Geometry list
 * Base Geometry list for current operation: List of Base Geometry for current operation, if any selected
 * Add: adds selected element(s) which should be the base(s) for the path(s)
 * Remove: remove the selected item(s) in the Base Location list
 * Edit: clear all items in the Base Location list

Operation






Resources

 * G-code(path) simulator: NCViewer
 * G-code(path) simulator: CAMotics