CAM ToolShape: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
(34 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
{{Page in progress}}
<translate>


<!--T:1-->
{{Docnav
{{Docnav
|[[Path_Tools|Tools]]

|[[Path_ToolBit|ToolBit]]
|[[Path_Workbench|Path]]
|IconL=
|IconR=
|IconC=Workbench_Path.svg
}}
}}


</translate>
{{TOCright}}
<translate>

== Description == <!--T:2-->

<!--T:3-->
ToolShapes are a core part of the [[Path_Tools|Path Tools]] system. ToolShapes are the templates from which ToolBits are created. They represent the specific physical shape of a tool. A ToolShape does not completely describe the bit - for that some additional parameters are needed which will be added when an actual bit is parameterized from the template.


<!--T:4-->
==Description==
Initially ToolShapes are just FreeCAD documents with a single Body created from the [[Image:Workbench_PartDesign.svg|24px|link=PartDesign_Workbench]] [[PartDesign_Workbench|Part Design ]] workbench.


<!--T:5-->
ToolShapes are a core part of the [[Path_Tools|Path Tools]] system. ToolShapes are the templates from which ToolBits are created. They represent the physical shape of a tool.
Creating new ToolShapes is an advanced topic. The most commonly needed ToolShapes already exist and are provided with the FreeCAD installation at:
A ToolShape does not completely describe the bit - for that some additional parameters are needed which will be added when an actual bit is parameterized from the template.


<!--T:6-->
ToolShapes are just FreeCAD documents with a single Body created from the Part Design workbench.
* On Linux it is usually {{incode|/usr/lib64/FreeCAD/Mod/Path/Tools/Shape}}
* On Windows it is usually {{incode|C:\Program Files\FreeCAD\Mod\Path\Tools\Shape}}
* On macOS it is usually {{incode|/Applications/FreeCAD/Mod/Path/Tools/Shape}}


<!--T:7-->
Creating new ToolShapes is an advanced topic. The most commonly needed shapes already exist and are provided with the FreeCAD installation:
They are:
: {{FileName|ballend.fcstd}}
: {{FileName|bullnose.fcstd}}
: {{FileName|chamfer.fcstd}}
: {{FileName|drill.fcstd}}
: {{FileName|endmill.fcstd}}
: {{FileName|probe.fcstd}}
: {{FileName|slittingsaw.fcstd}}
: {{FileName|thread-mill.fcstd}}
: {{FileName|v-bit.fcstd}}
These can be found in the {{FileName|/Mod/Path/Tools/Shape/}} subdirectory where FreeCAD was installed.


== Usage == <!--T:8-->
* ballend.fcstd
* bullnose.fcstd
* drill.fcstd
* endmill.fcstd
* v-bit.fcstd


<!--T:9-->
These can be found in the /Mod/Path/Tools/Shape/ subdirectory where FreeCAD was installed.
# Create a new FreeCAD document.
# Open the [[Image:Workbench_PartDesign.svg|16px]] [[PartDesign_Workbench|PartDesign Workbench]].
# Create a [[PartDesign_Body|Body]] and give the Body a label you want to show up in the bit selection.
# Create a [[Image:PartDesign_NewSketch.svg|16px]] [[PartDesign_NewSketch|Sketch]] on the XZ plane and draw half the profile of the bit.
# Constrain the bottom most center of the bit on the origin {{incode|(0,0)}}. This will be the center of the axis on which the G-code will rotate the bit.
#* Note: Do not add dimensional constraints at this time.
# Close the Sketch.
# [[Image:PartDesign_Revolution.svg|16px]] [[PartDesign_Revolution|Revolve]] the Sketch around the vertical Sketch axis.
# Open the [[Image:Workbench_Path.svg|16px]] [[Path_Workbench|Path Workbench]].
# Select the Sketch in the [[Tree_view|Tree view]]. This ensures that the PropertyBag created in the next step will be nested in the Body.
# Select the {{MenuCommand|Path → Utils → PropertyBag}} option from the menu.
# A PropertyBag named {{Value|Attributes}} is created. This PropertyBag will be used to control the dimensions in the Sketch.
# Double-click the PropertyBag in the [[Tree_view|Tree view]].
# The {{MenuCommand|Property Bag}} task panel opens.
# Click the {{Button|Add...}} button.
# The {{MenuCommand|Create Property}} dialog opens.
# Create a property named {{Value|Diameter}}. This property is mandatory for ToolBits. Property names are case-sensitive and may not contain spaces.
# Select {{Value|Shape}} from the {{MenuCommand|Group}} dropdown list.
# Select the appropriate {{MenuCommand|Type}}.
# Optionally specify a {{MenuCommand|ToolTip}}.
# Click the {{Button|OK}} button.
# In the {{MenuCommand|Property Bag}} task panel enter a value for the '''Diameter''' property.
# Similarly add all other required properties.
# Click the {{Button|OK}} button in the {{MenuCommand|Property Bag}} task panel when done.
# Double-click the Sketch in the [[Tree_view|Tree view]].
# Add dimensional constraints and apply the properties from the created PropertyBag. For example to apply the '''Diameter''' property:
## Double-click a dimension.
## Click the [[Image:Bound-expression.svg|16px]] icon.
## Enter {{Value|<<Attributes>>.Diameter}} in the {{MenuCommand|Formula editor}}.
## Click the {{Button|OK}} button twice.
# Repeat this until the Sketch is fully constrained.
# Save the {{FileName|FCStd}} file where FreeCAD expects to find ToolBit files. See [[#Description|Description]] above.


<!--T:15-->
==Usage==
* Note 1. If you are denied access to the folder on Windows, start FreeCAD in ADMINISTRATOR mode.
- Create a new FreeCAD document
* Note 2. The Body of the ToolBit must be the first object in the [[Tree_view|Tree view]]. These instructions ensure that this is the case.
- Open the PartDesign workbench, create a body and give the body a label you want to show up in the bit selection.
- Create a sketch in the XZ plane and draw half the profile of the bit.
- Put the top center of the bit on the origin (0,0)
- For any constraint serving as a parameter for the tool (like overall Length) create a named constraint
- The name is the label of the input field
- Names are split at CamelCase boundaries into words in the edit dialog
- Use a ; in the name to add help text which will show up as the entry fields tool tip
- If the tool is used by legacy ops it should at least have one constraint called Diameter
- Use construction lines for constraints that are not directly accessible, like Diameter and Angle
- Any unnamed constraint will not be editable for a specific tool
- Once the sketch is fully constrained, close the sketch
- Rotate the sketch around the z-axis
- Save the document as a new file in the Shape directory


==Tool Thumbnail Images==
== Tool Thumbnail Images == <!--T:10-->
Toolbits will have a small icon image of the tool in the tree if the image is saved with thumbnails active.


<!--T:11-->
- Before saving the document make sure you have Save Thumbnail selected, and Add program logo deselected in FreeCAD's preferences.
ToolBits will have a small icon image of the tool in the [[Tree_view|Tree view]] if the file is saved with thumbnails active.
- Also make sure to switch to Front View and Fit content to screen
- Whatever you see when saving the document will end up being the visual representation of the template


<!--T:12-->
==Options==
Important notes:
* Before saving the document make sure you have Save Thumbnail selected, and Add program logo deselected in FreeCAD's preferences.
* Also make sure to switch to Front View and Fit content to screen
* Whatever you see when saving the document will end up being the visual representation of the template




<!--T:14-->
{{Docnav
{{Docnav
|[[Path_Tools|Tools]]
<!--
|[[Path_Simulator|Simulator]]
|[[Path_ToolBit|ToolBit]]
|[[Path_SelectLoop|Complete Loop]]
|[[Path_Workbench|Path]]
|[[Path_Workbench|Path]]
|IconL=Path_Simulator.png
|IconL=
|IconR=
|IconC=Workbench_Path.svg
|IconC=Workbench_Path.svg
|IconR=Path_SelectLoop.svg
-->
}}
}}


</translate>
{{Path_Tools_navi{{#translation:}}}}
{{Path_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Revision as of 14:39, 15 April 2022

Other languages:

Description

ToolShapes are a core part of the Path Tools system. ToolShapes are the templates from which ToolBits are created. They represent the specific physical shape of a tool. A ToolShape does not completely describe the bit - for that some additional parameters are needed which will be added when an actual bit is parameterized from the template.

Initially ToolShapes are just FreeCAD documents with a single Body created from the Part Design workbench.

Creating new ToolShapes is an advanced topic. The most commonly needed ToolShapes already exist and are provided with the FreeCAD installation at:

  • On Linux it is usually /usr/lib64/FreeCAD/Mod/Path/Tools/Shape
  • On Windows it is usually C:\Program Files\FreeCAD\Mod\Path\Tools\Shape
  • On macOS it is usually /Applications/FreeCAD/Mod/Path/Tools/Shape

They are:

ballend.fcstd
bullnose.fcstd
chamfer.fcstd
drill.fcstd
endmill.fcstd
probe.fcstd
slittingsaw.fcstd
thread-mill.fcstd
v-bit.fcstd

These can be found in the /Mod/Path/Tools/Shape/ subdirectory where FreeCAD was installed.

Usage

  1. Create a new FreeCAD document.
  2. Open the PartDesign Workbench.
  3. Create a Body and give the Body a label you want to show up in the bit selection.
  4. Create a Sketch on the XZ plane and draw half the profile of the bit.
  5. Constrain the bottom most center of the bit on the origin (0,0). This will be the center of the axis on which the G-code will rotate the bit.
    • Note: Do not add dimensional constraints at this time.
  6. Close the Sketch.
  7. Revolve the Sketch around the vertical Sketch axis.
  8. Open the Path Workbench.
  9. Select the Sketch in the Tree view. This ensures that the PropertyBag created in the next step will be nested in the Body.
  10. Select the Path → Utils → PropertyBag option from the menu.
  11. A PropertyBag named Attributes is created. This PropertyBag will be used to control the dimensions in the Sketch.
  12. Double-click the PropertyBag in the Tree view.
  13. The Property Bag task panel opens.
  14. Click the Add... button.
  15. The Create Property dialog opens.
  16. Create a property named Diameter. This property is mandatory for ToolBits. Property names are case-sensitive and may not contain spaces.
  17. Select Shape from the Group dropdown list.
  18. Select the appropriate Type.
  19. Optionally specify a ToolTip.
  20. Click the OK button.
  21. In the Property Bag task panel enter a value for the Diameter property.
  22. Similarly add all other required properties.
  23. Click the OK button in the Property Bag task panel when done.
  24. Double-click the Sketch in the Tree view.
  25. Add dimensional constraints and apply the properties from the created PropertyBag. For example to apply the Diameter property:
    1. Double-click a dimension.
    2. Click the icon.
    3. Enter <<Attributes>>.Diameter in the Formula editor.
    4. Click the OK button twice.
  26. Repeat this until the Sketch is fully constrained.
  27. Save the FCStd file where FreeCAD expects to find ToolBit files. See Description above.
  • Note 1. If you are denied access to the folder on Windows, start FreeCAD in ADMINISTRATOR mode.
  • Note 2. The Body of the ToolBit must be the first object in the Tree view. These instructions ensure that this is the case.

Tool Thumbnail Images

ToolBits will have a small icon image of the tool in the Tree view if the file is saved with thumbnails active.

Important notes:

  • Before saving the document make sure you have Save Thumbnail selected, and Add program logo deselected in FreeCAD's preferences.
  • Also make sure to switch to Front View and Fit content to screen
  • Whatever you see when saving the document will end up being the visual representation of the template