Difference between revisions of "Path Tools"

From FreeCAD Documentation
Jump to navigation Jump to search
Line 16: Line 16:
 
[[Path_ToolBit|ToolBit]]:  Toolbits are instances of a toolshape.  A toolbit will have _specific_ values
 
[[Path_ToolBit|ToolBit]]:  Toolbits are instances of a toolshape.  A toolbit will have _specific_ values
 
for each of the named constraints in the toolshape.  A toolbit is used in a Path Job
 
for each of the named constraints in the toolshape.  A toolbit is used in a Path Job
through a Tool Controller (TC)
+
through a Tool Controller (TC).  The same toolbit can exist in multiple libraries.
  
 
Toolbit [[Path_ToolBit_Library|Library]]:  A library is an arbitrary collection of toolbits.  The specific
 
Toolbit [[Path_ToolBit_Library|Library]]:  A library is an arbitrary collection of toolbits.  The specific
Line 28: Line 28:
 
  * A library may correspond to an automatic tool changer layout.
 
  * A library may correspond to an automatic tool changer layout.
  
 +
A [[Path_Tool_Controller|Tool Controller]] controls how a tool is used in a Path Job.  A controller combines the toolbit with properties for spindle speed, direction and Horizontal/Vertical feed rates.
  
The {{KEY|[[Image:Path Tools.svg|16px]] [[Path Tools|Tool xxxxx]]}}
 
 
[[Image:Toolbitmanager.png]]
 
  
 
==Dialogs==
 
==Dialogs==
The user will typically interact with the tool management system in two different
+
The user will interact with the tool management system in two different workflows.  Each workflow has dedicated GUI elements.
workflows.  Each workflow has dedicated GUI elements.
 
 
 
* [[Path_ToolBit_Dock|Toolbit Dock]] For using tools in a Path Job
 
* [[Path_ToolBit_Library_Manager|Toolbit Library Manager]] For managing the users Toolbit collection
 
  
+
* [[Path_ToolBit_Dock|Toolbit Dock]] For using tools in a Path Job by creating Tool Controllers
Only the creation of new toolshapes cannot be done from the toolmanager.
+
* [[Path_ToolBit_Library_Manager|Toolbit Library Manager]] For managing the user's Toolbit collection
This is an advanced topic. (see toolshape creation)
 
  
  
Line 57: Line 50:
 
The user is encouraged, however, to use a logical structure as shown above to keep toolbits and libraries organized.
 
The user is encouraged, however, to use a logical structure as shown above to keep toolbits and libraries organized.
  
 +
 +
==Options==
 
References to Tool Bits and their shapes can either be stored with an absolute path or with a relative path to the search path.
 
References to Tool Bits and their shapes can either be stored with an absolute path or with a relative path to the search path.
 
Generally it is recommended to use relative paths due to their flexibility and robustness to layout changes.
 
Generally it is recommended to use relative paths due to their flexibility and robustness to layout changes.
Line 62: Line 57:
  
 
See Path Preferences to choose whether absolute or relative paths are used
 
See Path Preferences to choose whether absolute or relative paths are used
 
==Options==
 
 
  
  

Revision as of 18:27, 28 October 2020

Under construction icon-blue.svg
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.

Note: This page describes the ToolBit architecture which became the default in v 0.19. For the older 'Legacy' tool system see Path_ToolLibraryEdit

Description

Tools in the Path workbench are handled differently than in other CAM packages

There are several concepts that the user needs to understand:

ToolShapes: ToolShapes are templates for creating toolbits. Toolshapes are FreeCAD documents that model the tool using named constraints. The toolshape is an _abstract_ tool template from which tool instances (called toolbits) are created. For example, all endmills will share the same toolshape file.

ToolBit: Toolbits are instances of a toolshape. A toolbit will have _specific_ values for each of the named constraints in the toolshape. A toolbit is used in a Path Job through a Tool Controller (TC). The same toolbit can exist in multiple libraries.

Toolbit Library: A library is an arbitrary collection of toolbits. The specific tools in a library is entirely up to the user. Possible use cases for libraries:

* A hobbyist user may have only one library for all of the tools they own.
* A library may contain all the tools used for a specific material like aluminum or wood
* A library may have toolbits for working on specific material
* A library may hold toolbits from a specific supplier
* A library may correspond to an automatic tool changer layout.

A Tool Controller controls how a tool is used in a Path Job. A controller combines the toolbit with properties for spindle speed, direction and Horizontal/Vertical feed rates.


Dialogs

The user will interact with the tool management system in two different workflows. Each workflow has dedicated GUI elements.


Organization

When FreeCAD is installed a default hierarchy of tool libraries and toolbits is created in the installation directory (Mod/Path/)

 Tools
   + Bit
   + Library
   + Shape

The user, however, is free to store their toolbits and libraries anywhere they wish. Even custom toolshapes can be stored in arbitrary locations where they can be backed up. The user is encouraged, however, to use a logical structure as shown above to keep toolbits and libraries organized.


Options

References to Tool Bits and their shapes can either be stored with an absolute path or with a relative path to the search path. Generally it is recommended to use relative paths due to their flexibility and robustness to layout changes. Should multiple tools or tool shapes with the same name exist in different directories it can be required to use absolute paths.

See Path Preferences to choose whether absolute or relative paths are used