Path Tools

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)

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.

The



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

Toolbit Dock For using tools in a Path Job Toolbit Library Manager For managing the users Toolbit collection

Toolbit Dock


The ToolBit dock is easily accessible from the main toolbar in the Path workbench. Pressing the button (button) will toggle the state of the dock. The dock is displayed in the right position by default but may be moved by the user. The dock can also be toggled with the Accelerator sequence (p,t)

The purpose of the dock is to display the currently selected library and allow the user to quickly add tool controllers to the Path Job(s).

Double-clicking on a toolbit will create a single tool controller for the toolbit. Multi-selecting toolbits and pressing the 'Add to Job' button will create tool controllers for all toolbits in the libarary.

The user may also select multiple tools and use the 'add...' button at the bottom to add tool controllers for the selection.

The top of the panel contains an text field showing the current path and a 'browse' button to choose another path. When a path is selected, all tool libraries from that location are scanned and shown in the dock. The dock will remember the last selection between uses

A cog button at the top right allows the user to launch the libarary manager (see below)

Toolbit Library Manager
The library manager (shown above) is the dialog for creating, managing, and organize toolbits. Launching the library manager from either the Path menu or from the 'cog' button in the dock will display the manager as a modal dialog.

From here the user can perform all task related to toolbit management :

* Create/edit/delete Toolbits * Create libraries * Add toolbits to libraries * Remove toolbits from libraries * Export a library to the LinuxCNC tooltable (.tbl) format Only the creation of new toolshapes cannot be done from the toolmanager. This is an advanced topic. (see toolshape creation)

Like the dock, the top of the library manager shows a the current working path and a 'browse' button to choose a different path as the working path. When a path is selected, all tool libraries from that location are scanned and shown in the manager.

The manager will remember the last active tool library and working directory between uses.

Create Tool Controllers

 * 1) Open the Toolbit Dock using several methods:
 * 2) * Press the button in the toolbar to show or hide the dock
 * 3) * Using the then  keyboard shortcut to show or hide the dock
 * 4) Use the dock to add toolcontrollers to a Path Job
 * 5) * Doubleclick on a toolbit node to create a toolcontroller for that toolbit.
 * 6) * select one or more toolbits and press the 'add to Job..' button

Manage Toolbits

 * 1) open the Toolbit Library Manager using several methods:
 * 2) * Using the entry from the top menu
 * 3) * Open the Toolbit dock as described above, then press the XXX button to open the manger
 * 4) Select a library from the list
 * 5) Create/Add/Remove toolbits from the library
 * 6) Save changes.
 * 7) The selected library will become the default library for the dock

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.