CAM Waterline/pt-br: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>


{{VeryImportantMessage|This is an unfinished experimental feature. [[Path_experimental|Enable Experimental Features]]}}
{{VeryImportantMessage|This is an unfinished experimental feature. [[CAM_experimental|Enable Experimental Features]]}}


{{UnfinishedDocu{{#translation:}}}}
{{UnfinishedDocu{{#translation:}}}}


{{Docnav
{{Docnav
|[[Path_Surface|Surface]]
|[[CAM_Surface|Surface]]
|[[CAM_DressupAxisMap|DressupAxisMap]]
|[[Path_DressupPathBoundary|DressupPathBoundary]]
|[[Path_Workbench|Path]]
|[[CAM_Workbench|CAM]]
|IconL=Path_Surface.svg
|IconL=CAM_Surface.svg
|IconR=Path_DressupPathBoundary.svg
|IconR=CAM_DressupAxisMap.svg
|IconC=Workbench_Path.svg
|IconC=Workbench_CAM.svg
}}
}}


{{GuiCommand
{{GuiCommand
|Name=Path Waterline
|Name=CAM Waterline
|MenuLocation=Path → Waterline
|MenuLocation=CAM → Waterline
|Workbenches=[[Path Workbench|Path]]
|Workbenches=[[CAM_Workbench|CAM]]
|Version=0.19
|Version=0.19
}}
}}
Line 23: Line 23:
==Description==
==Description==


This tool creates a new Waterline operation. As of 0.19_pre, the Waterline operation works on the entire 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 model.
The tool [[Image:CAM_Waterline.svg|24px]] [[CAM_Waterline|Waterline]] creates a new Waterline operation. As of 0.19_pre, the operation works on the entire 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 model.


The Waterline operation has two algorithms: OCL Drop Cutter and Experimental.
The Waterline operation has two algorithms: OCL Drop Cutter and Experimental.
* The OCL Drop Cutter algorithm 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.
* The OCL Drop Cutter algorithm interfaces to OCL.pyd, a 3rd party Open Source module titled [[OpenCamLib|OpenCamLib]], that generates tool paths from a 3D Model. OpenCamLib is not integrated directly into FreeCAD.
* The Experimental algorithm makes use of the built-in Path.Area() class.
* The Experimental algorithm makes use of the built-in Path.Area() class.


''' ''Note'' ''': In order to use the Waterline operation you must:
''' ''Note'' ''': In order to use the Waterline operation you must:
# Properly install [[OpenCamLib]].
# Properly install [[OpenCamLib|OpenCamLib]].
# Enable [[Path_experimental|Experimental Features]] for the Path Workbench.
# Enable [[CAM_experimental|Experimental Features]] for the CAM Workbench.
# Check {{MenuCommand|Edit → Preferences... → Path → Advanced → Enable OCL dependent features}}.
# Check {{MenuCommand|Edit → Preferences... → CAM → Advanced → Enable OCL dependent features}}.


==Usage==
==Usage==


Usage instructions for multiple variations of the [[Path_Waterline|Waterline]] operation are presented here.
Usage instructions for multiple variations of the [[CAM_Waterline|Waterline]] operation are presented here.


====Basic Operation====
====Basic Operation====


# Press the {{KEY|[[Image:Path Waterline.svg|24px]] [[Path Waterline|Waterline]]}} icon, or select the [[Path Waterline|Waterline]] tool from the '''Path''' menu.
# Press the {{KEY|[[Image:CAM Waterline.svg|24px]] [[CAM Waterline|Waterline]]}} icon, or select the [[CAM Waterline|Waterline]] tool from the '''CAM''' menu.
# Select the tool controller for the Operation from the Tool controller dialogue pop up window.
# Select the tool controller for the Operation from the Tool controller dialogue pop up window.
# Adjust the operation depths as needed in the Depths tab: Start Depth, Finish Depth, Step Down.
# Adjust the operation depths as needed in the Depths tab: Start Depth, Final Depth, Step Down.
# Make adjustments in Heights tab if needed.
# Make adjustments in Heights tab if needed.
# Configure settings in the Operations tab based on the Algorithm selected:
# Configure settings in the Operations tab based on the Algorithm selected:
## OCL Dropcutter
## OCL Dropcutter
### Choose the BoundBox: Stock or BaseBoundBox.
### Choose the BoundBox: Stock or BaseBoundBox.
### Set the Layer Mode: Single-pass or Multi-pas.
### Set the Layer Mode: Single-pass or Multi-pass.
### Set the Sample Interval used for the OCL scan.
### Set the Sample Interval used for the OCL scan.
## Experimental
## Experimental
### Choose the BoundBox: Stock or BaseBoundBox.
### Choose the BoundBox: Stock or BaseBoundBox.
### Set the Layer Mode: Single-pass or Multi-pas.
### Set the Layer Mode: Single-pass or Multi-pass.
### Set the Cut Pattern if clearing is desired at each layer.
### Set the Cut Pattern if clearing is desired at each layer.
### Set the Boundary Adjustment (material allowance).
### Set the Boundary Adjustment (material allowance).
Line 64: Line 64:
* It only returns paths for an End Mill type cutter (tool bit).
* It only returns paths for an End Mill type cutter (tool bit).
* It might not correctly catch all interior features.
* It might not correctly catch all interior features.
* It is just that, experimental, and not ready for mainstream integration. Please inspect paths with the built-in {{KEY|[[Image:Path_Simulator.svg|16px]] [[Path Simulator|CAM Simulator]]}}, or other 3rd-party g-code inspection tools, before cutting with your machine.
* It is just that, experimental, and not ready for mainstream integration. Please inspect paths with the built-in {{KEY|[[Image:CAM_Simulator.svg|16px]] [[CAM_Simulator|CAM Simulator]]}}, or other 3rd-party G-code inspection tools, before cutting with your machine.


====Available Tool (Cutter) Shapes====
====Available Tool (Cutter) Shapes====


When using the ''' ''OCL Dropcutter'' ''' algorithm, the Waterline operation uses OpenCamLib [OCL] to extract paths from the part base. As such, a tool 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(should be) respected and available for the OCL Dropcutter so long as the built-in tool shapes are used, whether Legacy or ToolBit tools:
When using the ''' ''OCL Dropcutter'' ''' algorithm, the Waterline operation uses OpenCamLib [OCL|OCL] to extract paths from the part base. As such, a tool 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(should be) respected and available for the OCL Dropcutter so long as the built-in tool shapes are used, whether Legacy or ToolBit tools:


* End mill
* End mill
Line 78: Line 78:
====Additional Notes====
====Additional Notes====


* Should you choose to run the path simulator, {{KEY|[[Image:Path_Simulator.svg|16px]] [[Path Simulator|CAM Simulator]]}}, in the Path Workbench, you might not see tool-shape-specific material removal. Be cautious. A small trial job using foam or other very non-dense material is recommended to verify paths are correct with your selected tool controller.
* Should you choose to run the path simulator, {{KEY|[[Image:CAM_Simulator.svg|16px]] [[CAM_Simulator|CAM Simulator]]}}, in the CAM Workbench, you might not see tool-shape-specific material removal. Be cautious. A small trial job using foam or other very non-dense material is recommended to verify paths are correct with your selected tool controller.
* As of May 2020, 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 [https://forum.freecadweb.org/viewforum.php?f=15 Path/CAM] section in the FreeCAD forums.
* As of May 2020, 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 [https://forum.freecadweb.org/viewforum.php?f=15 Path/CAM] section in the FreeCAD forums.


Line 85: Line 85:
''' ''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'' ''': 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.


{{TitleProperty|Base}}
====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.
Note: It is suggested that you do not edit the Placement property of path operations. Rather, move or rotate the CAM Job model as needed.


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


====Clearing Options====
{{TitleProperty|Clearing Options}}


* {{PropertyData|Algorithm}}: The library to use to generate the path
* {{PropertyData|Algorithm}}: The library to use to generate the path
* {{PropertyData|BoundBox}}: Should the operation be limited by the stock object or by the bounding box of the base object
* {{PropertyData|BoundBox}}: Should the operation be limited by the stock object or by the bounding box of the base object
* {{PropertyData|Clear Last Layer}}: Set to clear last layer in `Multi-pass` operation.
* {{PropertyData|Clear Last Layer}}: Set to clear last layer in `Multi-pass` operation.
* {{PropertyData|Cut Mode}}: The direction that the toolpath should go around the part: Climb(ClockWise) or Conventional(CounterClockWise)
* {{PropertyData|Cut Mode}}: The direction that the toolpath should go around the part: Climb (ClockWise) or Conventional (CounterClockWise)
* {{PropertyData|Cut Pattern}}: Clearing pattern to use
* {{PropertyData|Cut Pattern}}: Clearing pattern to use
* {{PropertyData|Depth Offset}}:
* {{PropertyData|Depth Offset}}:
Line 113: Line 113:
* {{PropertyData|Step Over}}:
* {{PropertyData|Step Over}}:


{{TitleProperty|Depth}}
====Depth====


* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
* {{PropertyData|Clearance Height}}: The height needed to clear clamps and obstructions
Line 121: Line 121:
* {{PropertyData|Step Down}}: Incremental Step Down of Tool
* {{PropertyData|Step Down}}: Incremental Step Down of Tool


{{TitleProperty|Path}}
====Path====


* {{PropertyData|Active}}: make False, to prevent operation from generating code
* {{PropertyData|Active}}: Make False, to prevent operation from generating code
* {{PropertyData|Base}}: The base geometry for this operation
* {{PropertyData|Base}}: The base geometry for this operation
* {{PropertyData|Comment}}: An optional comment for this Operation
* {{PropertyData|Comment}}: An optional comment for this Operation
Line 131: Line 131:
* {{PropertyData|User Label}}: User assigned label
* {{PropertyData|User Label}}: User assigned label


====Start Point====
{{TitleProperty|Start Point}}


* {{PropertyData|Start Point}}: The custom start point for the path of this operation.
* {{PropertyData|Start Point}}: The custom start point for the path of this operation.
** {{PropertyData|X}}: x distance value
** {{PropertyData|X}}: X distance value
** {{PropertyData|Y}}: y distance value
** {{PropertyData|Y}}: Y distance value
** {{PropertyData|Z}}: z distance value
** {{PropertyData|Z}}: Z distance value
* {{PropertyData|Use Start Point}}: Make True, if specifying a Start Point
* {{PropertyData|Use Start Point}}: Make True, if specifying a Start Point


Line 142: Line 142:


''Descriptions for the settings are provided in the Properties list above.''
''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.
This section is simply a layout map of the settings in the window editor for the Operation.


====Base Location====
===Base Location===


* '''Add''': adds selected element(s) which should be the base(s) for the path(s)
* '''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
* '''Remove''': Remove the selected item(s) in the Base Location list.
* '''Edit''': clear all items in the Base Location list
* '''Edit''': Clear all items in the Base Location list.


====Depths====
===Depths===


* {{PropertyData|Start Depth}}
* {{PropertyData|Start Depth}}
Line 156: Line 157:
* {{PropertyData|Step Down}}
* {{PropertyData|Step Down}}


====Heights====
===Heights===


* {{PropertyData|Safe Height}}
* {{PropertyData|Safe Height}}
* {{PropertyData|Clearance Height}}
* {{PropertyData|Clearance Height}}


====Operation====
===Operation===


* {{PropertyData|Tool Controller}}
* {{PropertyData|Tool Controller}}
Line 180: Line 181:


{{Docnav
{{Docnav
|[[Path_Surface|Surface]]
|[[CAM_Surface|Surface]]
|[[CAM_DressupAxisMap|DressupAxisMap]]
|[[Path_DressupPathBoundary|DressupPathBoundary]]
|[[Path_Workbench|Path]]
|[[CAM_Workbench|CAM]]
|IconL=Path_Surface.svg
|IconL=CAM_Surface.svg
|IconR=Path_DressupPathBoundary.svg
|IconR=CAM_DressupAxisMap.svg
|IconC=Workbench_Path.svg
|IconC=Workbench_CAM.svg
}}
}}


{{Path Tools navi{{#translation:}}}}
{{CAM_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Latest revision as of 17:53, 1 April 2024

Other languages:
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.

CAM Waterline

Menu location
CAM → Waterline
Workbenches
CAM
Default shortcut
None
Introduced in version
0.19
See also
None

Description

The tool Waterline creates a new Waterline operation. As of 0.19_pre, the operation works on the entire 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 model.

The Waterline operation has two algorithms: OCL Drop Cutter and Experimental.

  • The OCL Drop Cutter algorithm 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.
  • The Experimental algorithm makes use of the built-in Path.Area() class.

Note : In order to use the Waterline operation you must:

  1. Properly install OpenCamLib.
  2. Enable Experimental Features for the CAM Workbench.
  3. Check Edit → Preferences... → CAM → Advanced → Enable OCL dependent features.

Usage

Usage instructions for multiple variations of the Waterline operation are presented here.

Basic Operation

  1. Press the Waterline icon, or select the Waterline tool from the CAM 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, Final Depth, Step Down.
  4. Make adjustments in Heights tab if needed.
  5. Configure settings in the Operations tab based on the Algorithm selected:
    1. OCL Dropcutter
      1. Choose the BoundBox: Stock or BaseBoundBox.
      2. Set the Layer Mode: Single-pass or Multi-pass.
      3. Set the Sample Interval used for the OCL scan.
    2. Experimental
      1. Choose the BoundBox: Stock or BaseBoundBox.
      2. Set the Layer Mode: Single-pass or Multi-pass.
      3. Set the Cut Pattern if clearing is desired at each layer.
      4. Set the Boundary Adjustment (material allowance).
  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.

Notes About Experimental Algorithm
  • It does not handle overhangs correctly.
  • It only returns paths for an End Mill type cutter (tool bit).
  • It might not correctly catch all interior features.
  • It is just that, experimental, and not ready for mainstream integration. Please inspect paths with the built-in CAM Simulator, or other 3rd-party G-code inspection tools, before cutting with your machine.

Available Tool (Cutter) Shapes

When using the OCL Dropcutter algorithm, the Waterline operation uses OpenCamLib [OCL|OCL] to extract paths from the part base. As such, a tool 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(should be) respected and available for the OCL Dropcutter so long as the built-in tool shapes are used, whether Legacy or ToolBit tools:

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

Additional Notes

  • Should you choose to run the path simulator, CAM Simulator, in the CAM Workbench, you might not see tool-shape-specific material removal. Be cautious. A small trial job using foam or other very non-dense material is recommended to verify paths are correct with your selected tool controller.
  • As of May 2020, 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

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 CAM Job model as needed.

  • DadosPlacement: Overall placement[position and rotation] of the object - with respect to the origin (or origin of parent object container)
    • DadosAngle: Angle in degrees applied to rotation of the object around Axis property value
    • DadosAxis: Axis (one or multiple) around which to rotate the object, set in sub-properties: X, Y, Z
      • DadosX: X axis value
      • DadosY: Y axis value
      • DadosZ: Z axis value
    • DadosPosition: Position of the object, set in sub-properties: X, Y, Z - with respect to the origin (or origin of parent object container)
      • DadosX: X distance value
      • DadosY: Y distance value
      • DadosZ: Z distance value
  • DadosLabel: User-provided name of the object (UTF-8)

Clearing Options

  • DadosAlgorithm: The library to use to generate the path
  • DadosBoundBox: Should the operation be limited by the stock object or by the bounding box of the base object
  • DadosClear Last Layer: Set to clear last layer in `Multi-pass` operation.
  • DadosCut Mode: The direction that the toolpath should go around the part: Climb (ClockWise) or Conventional (CounterClockWise)
  • DadosCut Pattern: Clearing pattern to use
  • DadosDepth Offset:
  • DadosIgnore Outer Above:
  • DadosLayer Mode: The completion mode for the operation: single or multi-pass
  • DadosStep Over:

Depth

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

Path

  • DadosActive: Make False, to prevent operation from generating code
  • DadosBase: The base geometry for this operation
  • DadosComment: An optional comment for this Operation
  • DadosCoolant Mode:
  • DadosCycle Time:
  • DadosTool Controller: Defines the Tool controller used in the Operation
  • DadosUser Label: User assigned label

Start Point

  • DadosStart Point: The custom start point for the path of this operation.
    • DadosX: X distance value
    • DadosY: Y distance value
    • DadosZ: Z distance value
  • DadosUse Start Point: Make True, if specifying a Start Point

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

  • 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.

Depths

  • DadosStart Depth
  • DadosFinal Depth
  • DadosStep Down

Heights

  • DadosSafe Height
  • DadosClearance Height

Operation

  • DadosTool Controller
  • DadosCoolant Mode
  • DadosAlgorithm
  • DadosBoundBox
  • DadosLayer Mode
  • DadosCut Pattern~
  • DadosBoundary Adjustment~
  • DadosSample Interval~

~Visibility changes with other settings.

Resources