Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.4 KB

shape.md

File metadata and controls

58 lines (41 loc) · 2.4 KB
Raw

Creating your own shapes

FreeCAD differentiates between tools (toolbits) and tool shapes (tool types). On this page, we explain how to create your own tool shapes.

  1. It is best to start by using an existing tool shape as a template. You can download one from this folder. I recommend you download both, the shape file (.fcstd) and the diagram file (.svg).

  2. Open the shape file in FreeCAD, changing the body as you like. Some notes:

    • Make sure your shape's zero is in the right position.

    • Make sure that your sketch does not hard code the dimensions, it should reference the shape attributes instead.

    • You can add or remove attributes in the properties panel as needed. The names will be important later, because you can reference them from the .svg file to ensure proper labeling in the UI.

      Editing attributes

  3. Once done, save the file and open the diagram file using Inkscape.

  4. Draw your tool diagram as needed. Make sure that for each of your shape's attributes, there is a label in your picture.

  5. Now the important part: To make sure that FreeCAD shows the correct abbreviation for each of your tool parameters, you need to mark each label in your diagram with the name of the FreeCAD attribute.

    Shape labels in BTL

    To do this in Inkscape, start by clicking the label (text element) in the Inkscape canvas.

    Warning Make sure that you have actually selected the label and not just a group that contains the label.

  6. Open the object properties by pressing Shift+Ctrl+o.

  7. In the ID field, enter the FreeCAD attribute name. However, you have to translate the attribute name as follows:

    • Before every capital letter, insert an underscore.

    • Lowercase everything.

    • For example, CuttingEdgeHeight in FreeCAD becomes cutting_edge_height in Inkscape.

      Inkscape object properties

That's it. Now you can place both files in your tool library path into the shapes/ subfolder. Once you re-open BTL and press "+" to add a new tool, the Shape Browser opens. Your new shape should show up under the "My Tools" section in that window (on the bottom).

Also consider contributing your new tool to BTL - just send a pull request or open an issue with the files attached.