CAM Surface

This is an unfinished experimental feature. Enable Experimental Features

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Simple Copy

Feature area

Path

Path 3DSurface
Menu location
Path → 3D Surface
Workbenches
Path
Default shortcut
None
Introduced in version
-
See also
None

Description

This tool creates a new 3D Surface Operation. The 3D Surface operation uses the entire top surface of the 3D Model to generate G-Code for the Job. Currently, within the operation's settings there is no functionality to select specific areas, faces, or regions of the Job base. The operation is applied to the entire surface of the Job base.

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 to ensure their license is not violated.

Note: In order to use the 3D Surface operation you must:

1. Properly install OpenCamLib.
2. Enable Experimental Features for the Path Workbench.

Usage

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

Basic Operation

1. Press the 3D Surface icon, or select the 3D Surface tool from the Path menu.
2. Select the tool controller for the Operation from the Tool controller dialogue pop up window.
3. Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.
4. Make adjustments in Heights tab if needed.
5. Configure settings in the Operations tab:
   1. Select an operation algorithm: OCL Dropcutter or OCL Waterline.
   2. Choose the BoundBox: Stock or BaseBoundBox
   3. Add additional BoundBox Extra Offset to X and Y as desired
   4. Set the Drop Cutter Direction: X or Y. This is the linear direction the cutter(spindle) will travel.
   5. Add a Depth Offset value if you wish to leave a specified thickness of material on the surface.
   6. Set the Sample Interval used for the OCL scan.
   7. Set the Step Over value as a percentage of the diameter of the Tool.
   8. Optimize Output is enabled by default. It is only a linear path optimization. Disabling will yield a longer gcode result and likely increase cut time.
6. If you wish to preview the result before accepting the settings, click Apply
7. Click OK 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.

Multi-pass Scan

This variation is based on the DataStep Down property. It produces the layering effect - removing material in layers.

1. Create a Basic Operation as described above. Multi-pass is available for both Algorithms.
2. Select the new operation in the object tree in the Combo View.
3. Locate the Algorithm section, In the Data tab in the Properties View of the operation.
4. Toggle the DataLayer Mode property to Multi-pass to achieve the layering(step-down, multi-pass) effect.

Rotational Scans (4th-axis)

1. Create a Basic Operation as described above using the OCL Dropcutter algorithm.
2. Locate the Data tab and Properties View for the new 3D Surface operation.
   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.
3. In the Rotation section set DataEnable Rotation to the correct setting.
4. Adjust the following settings as needed:
   • In the Algorithm section, change DataDrop Cutter Dir to the axis of travel for the cutter(spindle).
   • In the Algorithm section, set DataLayer Mode to single or mulit-pass.
   • In the Rotation section, set DataRotation Axis to the desired axis.
   • In the Rotation section, adjust DataStart Index to start index(angle) [0-360].
   • In the Rotation section, adjust DataStop Index to stop index(angle) [0-360].
   • In the Rotation section, set DataCutter Tilt to the offset index(angle) [0-90]. (Used for ball mill cutters)
5. With rotation-related properties set as needed, in the Algorithm section change the DataScanMode from Planar to Rotational.
6. Click the Recompute icon in the tool bar.
7. 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 Recompute the operation.
  • deactivate the operation with the Active toggle tool, make your changes to the operation's properties, then click the Active icon again to re-activate the operation - which triggers a recompute internally.
• The 3D Surface 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 OCL Waterline algorithm does not support rotational scans.
• The built in CAM Simulator 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.

Available Tool (Cutter) Shapes

This 3D Surface op currently uses OpenCamLib [OCL] 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.

Base

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.

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

Clearing Options

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

Depth

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

Mesh Conversion

• DataAngular Deflection: Smaller values yield a finer, more accurate mesh. Smaller values increase processing time a lot
• DataLinear Deflection: Smaller values yield a finer, more accurate mesh. Smaller values do not increase processing time much

Optimization

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

Path

• DataActive: make False, to prevent operation from generating code
• DataBase: The base geometry for this operation
• DataComment: An optional comment for this Operation
• DataCoolant Mode: Coolant mode for this operation
• DataCycle Time: Operations Cycle Time Estimation
• DataTool Controller: Defines the Tool controller used in the Operation
• DataUser Label: User assigned label

Rotation

• DataCutter Tilt: Set the cutter (spindle) tilt angle.
• DataDrop Cutter Dir: The direction along which dropcutter lines are created
• DataDrop Cutter Extra Offset: Additional offset to the selected bounding box - use sub-properties to set values
  • DataX: x distance value
  • DataY: y distance value
  • DataZ: z distance value
• DataRotation Axis: Set the axis for model rotation.
• DataStart Index: Start index(angle) for rotation
• DataStop Index: Stop index(angle) for rotation

Selected Geometry Settings

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

Start Point

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

Surface

• DataScan Type: Planar: Flat, 3D surface scan. Rotational: 4th-axis rotational scan.

Waste

• DataIgnore Waste: Ignore areas that proceed below specified depth.
• DataIgnore Waste Depth: Depth used to identify waste areas to ignore.
• DataRelease From Waste: 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

Depth

• DataStart Depth
• DataFinal Depth
• DataStep Down

Height

• DataSafe Height
• DataClearance Height

Operation

• DataTool Controller
• DataCoolant Mode

• DataBoundBox
• DataScan Type
• DataLayer Mode
• DataBoundBox extra offset X
• DataBoundBox extra offset Y
• DataDrop Cutter Direction
• DataDepth Offset
• DataStep Over
• DataSample Interval
• DataOptimize Output Enabled

• DataUse Start Point
• DataBoundary Enforcement
• DataOptimize Linear Paths

Resources

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

Simple Copy

Feature area

Path

Path

• Project Commands: Job, Post Process, Check the path job for common errors, Export Template

---

• Tool Commands: Inspect Path Commands, CAM Simulator, Finish Selecting Loop, Toggle the Active State of the Operation, ToolBit Library editor, ToolBit Dock

---

• Basic Operations: Profile, Pocket Shape, Drilling, Face, Helix, Adaptive, Slot, Engrave, Deburr, Vcarve

---

• 3D Operations: 3D Pocket, 3D Surface, Waterline

---

• Path Dressup: Axis Map, Boundary, Dogbone, DragKnife, LeadInOut, RampEntry, Tag, Z Depth Correction

---

• Supplemental Commands: Fixture, Comment, Stop, Custom, Probe, From Shape

---

• Path Modification: Copy the operation in the job, Array, Simple Copy

---

• Specialty Operations: Thread Milling

---

• Miscellaneous: Area, Area workplane

---

• ToolBit architecture: Tools, ToolShape, ToolBit, ToolBit Library, ToolController

---

• Additional: Preferences, Scripting

User documentation

• Getting started
• Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
• Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

---

• Help: Tutorials, Video tutorials
• Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

---

• Addons: Addon Manager, External workbenches, Scripting and macros

---

• Hubs: User hub, Power users hub, Developer hub